【问题标题】:Where is the list of "extended properties" to use in the PropertyFilters parameter of the Azure Devops Release ApiAzure Devops Release Api 的 PropertyFilters 参数中使用的“扩展属性”列表在哪里
【发布时间】:2019-12-20 07:46:28
【问题描述】:

我正在使用 Azure Devops sdk 为我的发布管道构建一些工具,以调用其余 api。

我在documentation 中看到有一个过滤属性的选项。

要检索的扩展属性的逗号分隔列表。如果设置,返回的 Release 将包含指定 property Ids 的值(如果它们存在)。如果未设置,则不会包含属性。

这似乎预先假定调用者知道要过滤的 id(假设属性名称?),但文档没有暗示哪些属性可用。由于 KVP 对象是空的,没有有效的属性 id,并且只包含这些 id 的值,这似乎是一个部落知识问题。

本文档引用的属性列表在哪里?

更新

@Merlin Liang - MSFT 给出的答案的尝试示例

using (var connection = new VssConnection(new Uri(BasePath), _credentialsFactory.GetCredentials()))
            {
                var releaseClient = connection.GetClient<ReleaseHttpClient>();

                var releasesTask = releaseClient.GetReleasesAsync(Project,
                                                                  releaseDefinitionId,
                                                                  expand: ReleaseExpands.Environments
                                                                          | ReleaseExpands.Approvals
                                                                          | ReleaseExpands.Artifacts, 
                                                                  propertyFilters: new []{"DeploymentStatus"});
                releasesTask.Wait();
                return releasesTask.Result;
            }

此请求返回以下内容:

您可以看到我能够为 ?expand={PropertyExpands} 提供标志并且我正在取回这些对象,但属性集合保持为空。

【问题讨论】:

    标签: azure-devops azure-devops-rest-api


    【解决方案1】:

    本文档所在的属性列表在哪里 参考?

    需要说的是文档中有很多很容易误导用户的描述。其实Definitions就是提到的属性。

    但是,我很怕用户会被propertyFilters这个名字误导。

    您需要注意的是,propertyFilters 并不意味着基于发布对象属性的过滤器。它只是用于展开结果。总之,它只是指定了用户希望将其包含在结果中的扩展属性列表。

    查看这个 github 问题:https://github.com/Microsoft/azure-devops-node-api/issues/182

    【讨论】:

    • 我不认为这按您描述的方式工作。我已经编辑了我的问题,以包括对您答案中的内容的尝试。
    猜你喜欢
    • 2020-06-01
    • 1970-01-01
    • 2017-04-20
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2022-08-10
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多