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

Azure DevOps Repos - Get

返回受监视的 Azure DevOps 存储库资源。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/azureDevOpsOrgs/{orgName}/projects/{projectName}/repos/{repoName}?api-version=2024-05-15-preview

URI 参数

名称 必需 类型 说明
orgName
path True

string

Azure DevOps 组织名称。

projectName
path True

string

项目名称。

repoName
path True

string

存储库名称。

resourceGroupName
path True

string

资源组的名称。 名称不区分大小写。

securityConnectorName
path True

string

安全连接器名称。

subscriptionId
path True

string

目标订阅的 ID。

api-version
query True

string

用于此操作的 API 版本。

响应

名称 类型 说明
200 OK

AzureDevOpsRepository

提供 Azure DevOps 存储库详细信息

Other Status Codes

ErrorResponse

描述操作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

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

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

Get_AzureDevOpsRepos

示例请求

GET https://management.azure.com/subscriptions/0806e1cd-cfda-4ff8-b99c-2b0af42cffd3/resourceGroups/myRg/providers/Microsoft.Security/securityConnectors/mySecurityConnectorName/devops/default/azureDevOpsOrgs/myAzDevOpsOrg/projects/myAzDevOpsProject/repos/myAzDevOpsRepo?api-version=2024-05-15-preview

示例响应

{
  "properties": {
    "parentOrgName": "myAzDevOpsOrg",
    "parentProjectName": "myAzDevOpsProject",
    "repoId": "cb64ab91-c9ba-46df-b44c-c769358bccdf",
    "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/projects/myAzDevOpsProject/repos/myAzDevOpsRepo",
  "name": "myAzDevOpsRepo",
  "type": "Microsoft.Security/securityConnectors/devops/azureDevOpsOrgs/projects/repos"
}

定义

名称 说明
ActionableRemediation

PR 批注的配置有效负载。

ActionableRemediationState

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

AnnotateDefaultBranchState

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

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

AzureDevOpsRepository

Azure DevOps 存储库资源。

AzureDevOpsRepositoryProperties

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 已禁用。

名称 类型 说明
Disabled

string

Enabled

string

None

string

AnnotateDefaultBranchState

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

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

名称 类型 说明
Disabled

string

Enabled

string

AzureDevOpsRepository

Azure DevOps 存储库资源。

名称 类型 说明
id

string

资源的完全限定资源 ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

资源的名称

properties

AzureDevOpsRepositoryProperties

Azure DevOps 存储库属性。

systemData

systemData

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

type

string

资源的类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

AzureDevOpsRepositoryProperties

Azure DevOps 存储库属性。

名称 类型 说明
actionableRemediation

ActionableRemediation

PR 批注的配置有效负载。

onboardingState

OnboardingState

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

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

parentOrgName

string

获取或设置父 Azure DevOps 组织名称。

parentProjectName

string

获取或设置父 Azure DevOps 项目名称。

provisioningState

DevOpsProvisioningState

资源的预配状态。

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

provisioningStatusMessage

string

获取资源状态消息。

provisioningStatusUpdateTimeUtc

string

获取上次检查资源的时间。

repoId

string

获取或设置 Azure DevOps 存储库 ID。

repoUrl

string

获取或设置 Azure DevOps 存储库 URL。

visibility

string

获取或设置 Azure DevOps 存储库可见性,无论是公共还是专用等。

CategoryConfiguration

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

名称 类型 说明
category

RuleCategory

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

minimumSeverityLevel

string

获取或设置给定类别的最小严重性级别。

createdByType

创建资源的标识的类型。

名称 类型 说明
Application

string

Key

string

ManagedIdentity

string

User

string

DevOpsProvisioningState

资源的预配状态。

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

名称 类型 说明
Canceled

string

DeletionFailure

string

DeletionSuccess

string

Failed

string

Pending

string

PendingDeletion

string

Succeeded

string

ErrorAdditionalInfo

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。

type

string

其他信息类型。

ErrorDetail

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。

code

string

错误代码。

details

ErrorDetail[]

错误详细信息。

message

string

错误消息。

target

string

错误目标。

ErrorResponse

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

InheritFromParentState

更新设置。

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

名称 类型 说明
Disabled

string

Enabled

string

OnboardingState

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

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

名称 类型 说明
NotApplicable

string

NotOnboarded

string

Onboarded

string

OnboardedByOtherConnector

string

RuleCategory

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

名称 类型 说明
Artifacts

string

Code

string

Containers

string

Dependencies

string

IaC

string

Secrets

string

systemData

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

名称 类型 说明
createdAt

string

资源创建时间戳(UTC)。

createdBy

string

创建资源的标识。

createdByType

createdByType

创建资源的标识的类型。

lastModifiedAt

string

上次修改的资源时间戳(UTC)

lastModifiedBy

string

上次修改资源的标识。

lastModifiedByType

createdByType

上次修改资源的标识的类型。

TargetBranchConfiguration

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

名称 类型 说明
annotateDefaultBranch

AnnotateDefaultBranchState

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

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

branchNames

string[]

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