Git Hub Repos - List

參考

服務:: Defender for Cloud

API 版本:: 2024-05-15-preview

傳回上線至連接器的 GitHub 存放庫清單。

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

URI 參數

名稱	位於	必要	類型	Description
ownerName	path	True	string	GitHub 擁有者名稱。
resourceGroupName	path	True	string	資源群組的名稱。名稱不區分大小寫。
securityConnectorName	path	True	string	安全性連接器名稱。
subscriptionId	path	True	string	目標訂用帳戶的標識碼。
api-version	query	True	string	要用於這項作業的 API 版本。

回應

名稱	類型	Description
200 OK	GitHubRepositoryListResponse	提供 GitHub 存放庫資源的清單
Other Status Codes	ErrorResponse	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

List_GitHubRepos

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


/**
 * Samples for GitHubRepos List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/preview/2024-05-15-preview/examples/
     * SecurityConnectorsDevOps/ListGitHubRepos_example.json
     */
    /**
     * Sample code: List_GitHubRepos.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void listGitHubRepos(com.azure.resourcemanager.security.SecurityManager manager) {
        manager.gitHubRepos().list("myRg", "mySecurityConnectorName", "myGitHubOwner",
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

範例回覆

狀態碼:: 200

{
  "value": [
    {
      "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"
    }
  ]
}

定義

名稱	Description
createdByType	建立資源的身分識別類型。
DevOpsProvisioningState	資源的布建狀態。擱置 - 布建擱置中。失敗 - 布建失敗。成功 - 布建成功。已取消 - 已取消布建。 PendingDeletion - 刪除擱置中。 DeletionSuccess - 刪除成功。 DeletionFailure - 刪除失敗。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
GitHubRepository	GitHub 存放庫資源。
GitHubRepositoryListResponse	支援分頁的 RP 資源清單。
GitHubRepositoryProperties	GitHub 存放庫屬性。
OnboardingState	所有連接器的資源上線狀態詳細數據。 OnboardedByOtherConnector - 此資源已上線至另一個連接器。這隻適用於最上層資源。上線 - 此資源已由指定的連接器上線。 NotOnboarded - 此資源尚未上線至任何連接器。 NotApplicable - 上線狀態不適用於目前的端點。
systemData	與建立和上次修改資源相關的元數據。

createdByType

建立資源的身分識別類型。

名稱	類型	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DevOpsProvisioningState

資源的布建狀態。

擱置 - 布建擱置中。失敗 - 布建失敗。成功 - 布建成功。已取消 - 已取消布建。 PendingDeletion - 刪除擱置中。 DeletionSuccess - 刪除成功。 DeletionFailure - 刪除失敗。

名稱	類型	Description
Canceled	string
DeletionFailure	string
DeletionSuccess	string
Failed	string
Pending	string
PendingDeletion	string
Succeeded	string

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細數據。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

GitHubRepository

GitHub 存放庫資源。

名稱	類型	Description
id	string	資源的完整資源標識碼。例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	資源的名稱
properties	GitHubRepositoryProperties	GitHub 存放庫屬性。
systemData	systemData	與建立和上次修改資源相關的元數據。
type	string	資源的型別。例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

GitHubRepositoryListResponse

支援分頁的 RP 資源清單。

名稱	類型	Description
nextLink	string	取得或設定下一個連結，以捲動結果。
value	GitHubRepository[]	取得或設定資源清單。

GitHubRepositoryProperties

GitHub 存放庫屬性。

名稱	類型	Description
onboardingState	OnboardingState	所有連接器的資源上線狀態詳細數據。 OnboardedByOtherConnector - 此資源已上線至另一個連接器。這隻適用於最上層資源。上線 - 此資源已由指定的連接器上線。 NotOnboarded - 此資源尚未上線至任何連接器。 NotApplicable - 上線狀態不適用於目前的端點。
parentOwnerName	string	取得或設定父系 GitHub 擁有者名稱。
provisioningState	DevOpsProvisioningState	資源的布建狀態。擱置 - 布建擱置中。失敗 - 布建失敗。成功 - 布建成功。已取消 - 已取消布建。 PendingDeletion - 刪除擱置中。 DeletionSuccess - 刪除成功。 DeletionFailure - 刪除失敗。
provisioningStatusMessage	string	取得資源狀態消息。
provisioningStatusUpdateTimeUtc	string	取得上次檢查資源的時間。
repoFullName	string	取得或設定 GitHub 完整名稱。存放庫名稱，前面加上擁有者名稱。例如：「my-org/new-repo-1」。
repoId	string	取得或設定 GitHub 存放庫標識碼。這是 Github 所定義的數值識別碼。例如：「123456」。
repoName	string	取得或設定 GitHub 存放庫名稱。例如：「new-repo-1」。
repoUrl	string	取得或設定 GitHub 存放庫 URL。

OnboardingState

所有連接器的資源上線狀態詳細數據。

OnboardedByOtherConnector - 此資源已上線至另一個連接器。這隻適用於最上層資源。上線 - 此資源已由指定的連接器上線。 NotOnboarded - 此資源尚未上線至任何連接器。 NotApplicable - 上線狀態不適用於目前的端點。

名稱	類型	Description
NotApplicable	string
NotOnboarded	string
Onboarded	string
OnboardedByOtherConnector	string

systemData

與建立和上次修改資源相關的元數據。

名稱	類型	Description
createdAt	string	資源建立的時間戳（UTC）。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string	上次修改的資源時間戳（UTC）
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	createdByType	上次修改資源的身分識別類型。

共用方式為