Git Hub Owners - Get

服务:

Defender for Cloud

API 版本:

2024-04-01

返回受监视的 GitHub 所有者。

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

URI 参数

名称	在	必需	类型	说明
ownerName	path	True	string	GitHub 所有者名称。
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	GitHubOwner	提供 GitHub 所有者详细信息
Other Status Codes	ErrorResponse	描述操作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

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

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Get_GitHubOwners

示例请求

HTTP

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

Java

/**
 * Samples for GitHubOwners Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/stable/2024-04-01/examples/SecurityConnectorsDevOps/
     * GetGitHubOwners_example.json
     */
    /**
     * Sample code: Get_GitHubOwners.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void getGitHubOwners(com.azure.resourcemanager.security.SecurityManager manager) {
        manager.gitHubOwners().getWithResponse("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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.security import SecurityCenter

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-security
# USAGE
    python get_git_hub_owners_example.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SecurityCenter(
        credential=DefaultAzureCredential(),
        subscription_id="0806e1cd-cfda-4ff8-b99c-2b0af42cffd3",
    )

    response = client.git_hub_owners.get(
        resource_group_name="myRg",
        security_connector_name="mySecurityConnectorName",
        owner_name="myGitHubOwner",
    )
    print(response)


# x-ms-original-file: specification/security/resource-manager/Microsoft.Security/stable/2024-04-01/examples/SecurityConnectorsDevOps/GetGitHubOwners_example.json
if __name__ == "__main__":
    main()

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

示例响应

状态代码:

200

{
  "properties": {
    "ownerUrl": "https://github.com/myGitHubOwner",
    "onboardingState": "Onboarded",
    "provisioningState": "Succeeded"
  },
  "id": "/subscriptions/0806e1cd-cfda-4ff8-b99c-2b0af42cffd3/resourceGroups/myRg/providers/Microsoft.Security/securityConnectors/mySecurityConnectorName/devops/default/gitHubOwners/myGitHubOwner",
  "name": "myGitHubOwner",
  "type": "Microsoft.Security/securityConnectors/devops/gitHubOwners"
}

定义

名称	说明
createdByType	创建资源的标识的类型。
DevOpsProvisioningState	资源的预配状态。 挂起 - 预配挂起。 失败 - 预配失败。 成功 - 预配成功。 已取消 - 预配已取消。 PendingDeletion - 删除挂起。 DeletionSuccess - 删除成功。 DeletionFailure - 删除失败。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
GitHubOwner	GitHub 所有者资源。
GitHubOwnerProperties	GitHub 所有者属性。
OnboardingState	有关所有连接器的资源载入状态的详细信息。 OnboardedByOtherConnector - 此资源已载入到另一个连接器。 这仅适用于顶级资源。 已载入 - 此资源已由指定的连接器载入。 NotOnboarded - 此资源尚未载入到任何连接器。 NotApplicable - 载入状态不适用于当前终结点。
systemData	与创建和上次修改资源相关的元数据。

createdByType

枚举

创建资源的标识的类型。

值	说明
Application
Key
ManagedIdentity
User

DevOpsProvisioningState

枚举

资源的预配状态。

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

值	说明
Canceled
DeletionFailure
DeletionSuccess
Failed
Pending
PendingDeletion
Succeeded

ErrorAdditionalInfo

Object

资源管理错误附加信息。

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

ErrorDetail

Object

错误详细信息。

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

ErrorResponse

Object

错误响应

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

GitHubOwner

Object

GitHub 所有者资源。

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

GitHubOwnerProperties

Object

GitHub 所有者属性。

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

OnboardingState

枚举

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

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

值	说明
NotApplicable
NotOnboarded
Onboarded
OnboardedByOtherConnector

systemData

Object

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

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