Git Hub Repos - Get
返回受监视的 GitHub 存储库。
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/gitHubOwners/{ownerName}/repos/{repoName}?api-version=2024-05-15-preview
URI 参数
| 名称 | 在 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
owner
|
path | True |
string |
GitHub 所有者名称。 |
|
repo
|
path | True |
string |
存储库名称。 |
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
资源组的名称。 名称不区分大小写。 |
|
security
|
path | True |
string |
安全连接器名称。 |
|
subscription
|
path | True |
string minLength: 1 |
目标订阅的 ID。 |
|
api-version
|
query | True |
string minLength: 1 |
用于此操作的 API 版本。 |
响应
| 名称 | 类型 | 说明 |
|---|---|---|
| 200 OK |
提供 GitHub 存储库详细信息 |
|
| Other Status Codes |
描述操作失败的原因的错误响应。 |
安全性
azure_auth
Azure Active Directory OAuth2 流
类型:
oauth2
流向:
implicit
授权 URL:
https://login.microsoftonline.com/common/oauth2/authorize
作用域
| 名称 | 说明 |
|---|---|
| user_impersonation | 模拟用户帐户 |
示例
Get_GitHubRepos
示例请求
示例响应
{
"properties": {
"repoName": "myGitHubRepo",
"repoFullName": "myGitHubOwner/myGitHubRepo",
"onboardingState": "Onboarded",
"repoUrl": "https://github.com/myGitHubOwner/myGitHubRepo",
"parentOwnerName": "myGitHubOwner",
"provisioningState": "Succeeded"
},
"id": "/subscriptions/0806e1cd-cfda-4ff8-b99c-2b0af42cffd3/resourceGroups/myRg/providers/Microsoft.Security/securityConnectors/mySecurityConnectorName/devops/default/gitHubOwners/myGitHubOwner/repos/myGitHubRepo",
"name": "myGitHubRepo",
"type": "Microsoft.Security/securityConnectors/devops/gitHubOwners/repos"
}
定义
| 名称 | 说明 |
|---|---|
|
created |
创建资源的标识的类型。 |
|
Dev |
资源的预配状态。 挂起 - 预配挂起。 失败 - 预配失败。 成功 - 预配成功。 已取消 - 预配已取消。 PendingDeletion - 删除挂起。 DeletionSuccess - 删除成功。 DeletionFailure - 删除失败。 |
|
Error |
资源管理错误附加信息。 |
|
Error |
错误详细信息。 |
|
Error |
错误响应 |
|
Git |
GitHub 存储库资源。 |
|
Git |
GitHub 存储库属性。 |
|
Onboarding |
有关所有连接器的资源载入状态的详细信息。 OnboardedByOtherConnector - 此资源已载入到另一个连接器。 这仅适用于顶级资源。 已载入 - 此资源已由指定的连接器载入。 NotOnboarded - 此资源尚未载入到任何连接器。 NotApplicable - 载入状态不适用于当前终结点。 |
|
system |
与创建和上次修改资源相关的元数据。 |
createdByType
创建资源的标识的类型。
| 值 | 说明 |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
DevOpsProvisioningState
资源的预配状态。
挂起 - 预配挂起。 失败 - 预配失败。 成功 - 预配成功。 已取消 - 预配已取消。 PendingDeletion - 删除挂起。 DeletionSuccess - 删除成功。 DeletionFailure - 删除失败。
| 值 | 说明 |
|---|---|
| Succeeded | |
| Failed | |
| Canceled | |
| Pending | |
| PendingDeletion | |
| DeletionSuccess | |
| DeletionFailure |
ErrorAdditionalInfo
资源管理错误附加信息。
| 名称 | 类型 | 说明 |
|---|---|---|
| info |
object |
其他信息。 |
| type |
string |
其他信息类型。 |
ErrorDetail
错误详细信息。
| 名称 | 类型 | 说明 |
|---|---|---|
| additionalInfo |
错误附加信息。 |
|
| code |
string |
错误代码。 |
| details |
错误详细信息。 |
|
| message |
string |
错误消息。 |
| target |
string |
错误目标。 |
ErrorResponse
错误响应
| 名称 | 类型 | 说明 |
|---|---|---|
| error |
错误对象。 |
GitHubRepository
GitHub 存储库资源。
| 名称 | 类型 | 说明 |
|---|---|---|
| id |
string |
资源的完全限定资源 ID。 示例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
| name |
string |
资源的名称 |
| properties |
GitHub 存储库属性。 |
|
| systemData |
与创建和上次修改资源相关的元数据。 |
|
| type |
string |
资源的类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts” |
GitHubRepositoryProperties
GitHub 存储库属性。
| 名称 | 类型 | 说明 |
|---|---|---|
| onboardingState |
有关所有连接器的资源载入状态的详细信息。 OnboardedByOtherConnector - 此资源已载入到另一个连接器。 这仅适用于顶级资源。 已载入 - 此资源已由指定的连接器载入。 NotOnboarded - 此资源尚未载入到任何连接器。 NotApplicable - 载入状态不适用于当前终结点。 |
|
| parentOwnerName |
string |
获取或设置父 GitHub 所有者名称。 |
| provisioningState |
资源的预配状态。 挂起 - 预配挂起。 失败 - 预配失败。 成功 - 预配成功。 已取消 - 预配已取消。 PendingDeletion - 删除挂起。 DeletionSuccess - 删除成功。 DeletionFailure - 删除失败。 |
|
| provisioningStatusMessage |
string |
获取资源状态消息。 |
| provisioningStatusUpdateTimeUtc |
string (date-time) |
获取上次检查资源的时间。 |
| repoFullName |
string |
获取或设置 GitHub 全名。 存储库名称,以所有者名称为前缀。 例如:“my-org/new-repo-1”。 |
| repoId |
string |
获取或设置 GitHub 存储库 ID。 这是 Github 定义的数值 ID。 例如:“123456”。 |
| repoName |
string |
获取或设置 GitHub 存储库名称。 例如:“new-repo-1”。 |
| repoUrl |
string |
获取或设置 GitHub 存储库 URL。 |
OnboardingState
有关所有连接器的资源载入状态的详细信息。
OnboardedByOtherConnector - 此资源已载入到另一个连接器。 这仅适用于顶级资源。 已载入 - 此资源已由指定的连接器载入。 NotOnboarded - 此资源尚未载入到任何连接器。 NotApplicable - 载入状态不适用于当前终结点。
| 值 | 说明 |
|---|---|
| NotApplicable | |
| OnboardedByOtherConnector | |
| Onboarded | |
| NotOnboarded |
systemData
与创建和上次修改资源相关的元数据。
| 名称 | 类型 | 说明 |
|---|---|---|
| createdAt |
string (date-time) |
资源创建时间戳(UTC)。 |
| createdBy |
string |
创建资源的标识。 |
| createdByType |
创建资源的标识的类型。 |
|
| lastModifiedAt |
string (date-time) |
上次修改的资源时间戳(UTC) |
| lastModifiedBy |
string |
上次修改资源的标识。 |
| lastModifiedByType |
上次修改资源的标识的类型。 |