你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Azure DevOps Orgs - List Available

服务:: Defender for Cloud

API 版本:: 2024-04-01

返回连接器使用的用户令牌可访问的所有 Azure DevOps 组织的列表。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/listAvailableAzureDevOpsOrgs?api-version=2024-04-01

URI 参数

名称	在	必需	类型	说明
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。名称不区分大小写。
securityConnectorName	path	True	string	安全连接器名称。
subscriptionId	path	True	string minLength: 1	目标订阅的 ID。
api-version	query	True	string minLength: 1	用于此操作的 API 版本。

响应

名称	类型	说明
200 OK	AzureDevOpsOrgListResponse	提供 Azure DevOps 组织详细信息的列表
Other Status Codes	ErrorResponse	描述操作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

ListAvailable_AzureDevOpsOrgs

示例请求

HTTP

POST https://management.azure.com/subscriptions/0806e1cd-cfda-4ff8-b99c-2b0af42cffd3/resourceGroups/myRg/providers/Microsoft.Security/securityConnectors/mySecurityConnectorName/devops/default/listAvailableAzureDevOpsOrgs?api-version=2024-04-01

示例响应

状态代码:: 200

{
  "value": [
    {
      "properties": {
        "onboardingState": "Onboarded",
        "actionableRemediation": {
          "state": "Enabled"
        },
        "provisioningState": "Succeeded"
      },
      "id": "/subscriptions/0806e1cd-cfda-4ff8-b99c-2b0af42cffd3/resourceGroups/myRg/providers/Microsoft.Security/securityConnectors/mySecurityConnectorName/devops/default/azureDevOpsOrgs/myAzDevOpsOrg",
      "name": "myAzDevOpsOrg",
      "type": "Microsoft.Security/securityConnectors/devops/azureDevOpsOrgs"
    },
    {
      "properties": {
        "onboardingState": "OnboardedByOtherConnector",
        "actionableRemediation": {
          "state": "Enabled"
        },
        "provisioningState": "Succeeded"
      },
      "id": "/subscriptions/0806e1cd-cfda-4ff8-b99c-2b0af42cffd3/resourceGroups/myRg/providers/Microsoft.Security/securityConnectors/mySecurityConnectorName/devops/default/azureDevOpsOrgs/anotherOrg",
      "name": "anotherOrg",
      "type": "Microsoft.Security/securityConnectors/devops/azureDevOpsOrgs"
    },
    {
      "properties": {
        "onboardingState": "NotOnboarded",
        "actionableRemediation": {
          "state": "None"
        }
      },
      "id": "/subscriptions/0806e1cd-cfda-4ff8-b99c-2b0af42cffd3/resourceGroups/myRg/providers/Microsoft.Security/securityConnectors/mySecurityConnectorName/devops/default/azureDevOpsOrgs/notOnboardedOrg",
      "name": "notOnboardedOrg",
      "type": "Microsoft.Security/securityConnectors/devops/azureDevOpsOrgs"
    }
  ]
}

定义

名称	说明
ActionableRemediation	PR 批注的配置有效负载。
ActionableRemediationState	ActionableRemediation 设置。无 - 从未设置过设置。 Enabled - 已启用 ActionableRemediation。 Disabled - ActionableRemediation 已禁用。
AnnotateDefaultBranchState	在默认分支上配置 PR 注释。已启用 - 在资源的默认分支上启用 PR 批注。已禁用 - 在资源的默认分支上禁用 PR 批注。
AzureDevOpsOrg	Azure DevOps 组织资源。
AzureDevOpsOrgListResponse	支持分页的 RP 资源列表。
AzureDevOpsOrgProperties	Azure DevOps 组织属性。
CategoryConfiguration	PR 批注的每个类别配置的严重性级别。
createdByType	创建资源的标识的类型。
DevOpsProvisioningState	资源的预配状态。挂起 - 预配挂起。失败 - 预配失败。成功 - 预配成功。已取消 - 预配已取消。 PendingDeletion - 删除挂起。 DeletionSuccess - 删除成功。 DeletionFailure - 删除失败。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
InheritFromParentState	更新设置。已启用 - 资源应从父级继承配置。已禁用 - 资源不应从父级继承配置。
OnboardingState	有关所有连接器的资源载入状态的详细信息。 OnboardedByOtherConnector - 此资源已载入到另一个连接器。这仅适用于顶级资源。已载入 - 此资源已由指定的连接器载入。 NotOnboarded - 此资源尚未载入到任何连接器。 NotApplicable - 载入状态不适用于当前终结点。
RuleCategory	规则类别。代码 - 代码扫描结果。项目扫描结果。依赖项扫描结果。 IaC 结果。机密扫描结果。容器扫描结果。
systemData	与创建和上次修改资源相关的元数据。
TargetBranchConfiguration	PR 批注的存储库分支配置。

ActionableRemediation

对象

PR 批注的配置有效负载。

名称	类型	说明
branchConfiguration	TargetBranchConfiguration	PR 批注的存储库分支配置。
categoryConfigurations	CategoryConfiguration[]	获取或设置类别和严重性级别的列表。
inheritFromParentState	InheritFromParentState	更新设置。已启用 - 资源应从父级继承配置。已禁用 - 资源不应从父级继承配置。
state	ActionableRemediationState	ActionableRemediation 设置。无 - 从未设置过设置。 Enabled - 已启用 ActionableRemediation。 Disabled - ActionableRemediation 已禁用。

ActionableRemediationState

枚举

ActionableRemediation 设置。无 - 从未设置过设置。 Enabled - 已启用 ActionableRemediation。 Disabled - ActionableRemediation 已禁用。

值	说明
None
Disabled
Enabled

AnnotateDefaultBranchState

枚举

在默认分支上配置 PR 注释。

已启用 - 在资源的默认分支上启用 PR 批注。已禁用 - 在资源的默认分支上禁用 PR 批注。

值	说明
Disabled
Enabled

AzureDevOpsOrg

对象

Azure DevOps 组织资源。

名称	类型	说明
id	string	资源的完全限定资源 ID。示例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	资源的名称
properties	AzureDevOpsOrgProperties	Azure DevOps 组织属性。
systemData	systemData	与创建和上次修改资源相关的元数据。
type	string	资源的类型。例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

AzureDevOpsOrgListResponse

对象

支持分页的 RP 资源列表。

名称	类型	说明
nextLink	string	获取或设置下一个链接以滚动结果。
value	AzureDevOpsOrg[]	获取或设置资源列表。

AzureDevOpsOrgProperties

对象

Azure DevOps 组织属性。

名称	类型	说明
actionableRemediation	ActionableRemediation	PR 批注的配置有效负载。
onboardingState	OnboardingState	有关所有连接器的资源载入状态的详细信息。 OnboardedByOtherConnector - 此资源已载入到另一个连接器。这仅适用于顶级资源。已载入 - 此资源已由指定的连接器载入。 NotOnboarded - 此资源尚未载入到任何连接器。 NotApplicable - 载入状态不适用于当前终结点。
provisioningState	DevOpsProvisioningState	资源的预配状态。挂起 - 预配挂起。失败 - 预配失败。成功 - 预配成功。已取消 - 预配已取消。 PendingDeletion - 删除挂起。 DeletionSuccess - 删除成功。 DeletionFailure - 删除失败。
provisioningStatusMessage	string	获取或设置资源状态消息。
provisioningStatusUpdateTimeUtc	string (date-time)	获取或设置上次检查资源的时间。

CategoryConfiguration

对象

PR 批注的每个类别配置的严重性级别。

名称	类型	说明
category	RuleCategory	规则类别。代码 - 代码扫描结果。项目扫描结果。依赖项扫描结果。 IaC 结果。机密扫描结果。容器扫描结果。
minimumSeverityLevel	string	获取或设置给定类别的最小严重性级别。

createdByType

枚举

创建资源的标识的类型。

值	说明
User
Application
ManagedIdentity
Key

DevOpsProvisioningState

枚举

资源的预配状态。

挂起 - 预配挂起。失败 - 预配失败。成功 - 预配成功。已取消 - 预配已取消。 PendingDeletion - 删除挂起。 DeletionSuccess - 删除成功。 DeletionFailure - 删除失败。

值	说明
Succeeded
Failed
Canceled
Pending
PendingDeletion
DeletionSuccess
DeletionFailure

ErrorAdditionalInfo

对象

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

对象

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

对象

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

InheritFromParentState

枚举

更新设置。

已启用 - 资源应从父级继承配置。已禁用 - 资源不应从父级继承配置。

值	说明
Disabled
Enabled

OnboardingState

枚举

有关所有连接器的资源载入状态的详细信息。

OnboardedByOtherConnector - 此资源已载入到另一个连接器。这仅适用于顶级资源。已载入 - 此资源已由指定的连接器载入。 NotOnboarded - 此资源尚未载入到任何连接器。 NotApplicable - 载入状态不适用于当前终结点。

值	说明
NotApplicable
OnboardedByOtherConnector
Onboarded
NotOnboarded

RuleCategory

枚举

规则类别。代码 - 代码扫描结果。项目扫描结果。依赖项扫描结果。 IaC 结果。机密扫描结果。容器扫描结果。

值	说明
Code
Artifacts
Dependencies
Secrets
IaC
Containers

systemData

对象

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	上次修改的资源时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。

TargetBranchConfiguration

对象

PR 批注的存储库分支配置。

名称	类型	说明
annotateDefaultBranch	AnnotateDefaultBranchState	在默认分支上配置 PR 注释。已启用 - 在资源的默认分支上启用 PR 批注。已禁用 - 在资源的默认分支上禁用 PR 批注。
branchNames	string[]	获取或设置应具有批注的分支。

名称

类型

说明

annotateDefaultBranch

AnnotateDefaultBranchState

在默认分支上配置 PR 注释。

已启用 - 在资源的默认分支上启用 PR 批注。已禁用 - 在资源的默认分支上禁用 PR 批注。

branchNames

string[]

获取或设置应具有批注的分支。

通过

Azure DevOps Orgs - List Available

URI 参数

响应

安全性

azure_auth

作用域

示例

ListAvailable_AzureDevOpsOrgs

示例请求

示例响应

定义

ActionableRemediation

ActionableRemediationState

AnnotateDefaultBranchState

AzureDevOpsOrg

AzureDevOpsOrgListResponse

AzureDevOpsOrgProperties

CategoryConfiguration

createdByType

DevOpsProvisioningState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

InheritFromParentState

OnboardingState

RuleCategory

systemData

TargetBranchConfiguration