Git Hub Owners - Get

Referência

Serviço:: Defender for Cloud

Versão da API:: 2024-04-01

Retorna um proprietário do GitHub monitorado.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ownerName	path	True	string	O nome do proprietário do GitHub.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
securityConnectorName	path	True	string	O nome do conector de segurança.
subscriptionId	path	True	string minLength: 1	A ID da assinatura de destino.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Respostas

Nome	Tipo	Description
200 OK	GitHubOwner	Fornece detalhes do proprietário do GitHub
Other Status Codes	ErrorResponse	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Get_GitHubOwners

Solicitação de exemplo

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


/**
 * 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

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

Resposta de exemplo

Código de status:: 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"
}

Definições

Nome	Description
createdByType	O tipo de identidade que criou o recurso.
DevOpsProvisioningState	O estado de provisionamento do recurso. Pendente – Provisionamento pendente. Falha – Falha no provisionamento. Bem-sucedido – Provisionamento bem-sucedido. Cancelado – Provisionamento cancelado. PendingDeletion – Exclusão pendente. DeletionSuccess – Exclusão bem-sucedida. DeletionFailure – Falha de exclusão.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
GitHubOwner	Recurso proprietário do GitHub.
GitHubOwnerProperties	Propriedades do Proprietário do GitHub.
OnboardingState	Detalhes sobre o status de integração de recursos em todos os conectores. OnboardedByOtherConnector – esse recurso já foi integrado a outro conector. Isso só é aplicável a recursos de nível superior. Integrado – esse recurso já foi integrado pelo conector especificado. NotOnboarded - esse recurso não foi integrado a nenhum conector. NotApplicable - o estado de integração não é aplicável ao ponto de extremidade atual.
systemData	Metadados relativos à criação e última modificação do recurso.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
Application
Key
ManagedIdentity
User

DevOpsProvisioningState

Enumeração

O estado de provisionamento do recurso.

Pendente – Provisionamento pendente. Falha – Falha no provisionamento. Bem-sucedido – Provisionamento bem-sucedido. Cancelado – Provisionamento cancelado. PendingDeletion – Exclusão pendente. DeletionSuccess – Exclusão bem-sucedida. DeletionFailure – Falha de exclusão.

Valor	Description
Canceled
DeletionFailure
DeletionSuccess
Failed
Pending
PendingDeletion
Succeeded

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

GitHubOwner

Objeto

Recurso proprietário do GitHub.

Nome	Tipo	Description
id	string	ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	O nome do recurso
properties	GitHubOwnerProperties	Propriedades do Proprietário do GitHub.
systemData	systemData	Metadados relativos à criação e última modificação do recurso.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

GitHubOwnerProperties

Objeto

Propriedades do Proprietário do GitHub.

Nome	Tipo	Description
gitHubInternalId	string	Obtém ou define a ID interna do GitHub.
onboardingState	OnboardingState	Detalhes sobre o status de integração de recursos em todos os conectores. OnboardedByOtherConnector – esse recurso já foi integrado a outro conector. Isso só é aplicável a recursos de nível superior. Integrado – esse recurso já foi integrado pelo conector especificado. NotOnboarded - esse recurso não foi integrado a nenhum conector. NotApplicable - o estado de integração não é aplicável ao ponto de extremidade atual.
ownerUrl	string	Obtém ou define a URL do Proprietário do GitHub.
provisioningState	DevOpsProvisioningState	O estado de provisionamento do recurso. Pendente – Provisionamento pendente. Falha – Falha no provisionamento. Bem-sucedido – Provisionamento bem-sucedido. Cancelado – Provisionamento cancelado. PendingDeletion – Exclusão pendente. DeletionSuccess – Exclusão bem-sucedida. DeletionFailure – Falha de exclusão.
provisioningStatusMessage	string	Obtém ou define a mensagem de status do recurso.
provisioningStatusUpdateTimeUtc	string (date-time)	Obtém ou define a hora em que o recurso foi verificado pela última vez.

OnboardingState

Enumeração

Detalhes sobre o status de integração de recursos em todos os conectores.

OnboardedByOtherConnector – esse recurso já foi integrado a outro conector. Isso só é aplicável a recursos de nível superior. Integrado – esse recurso já foi integrado pelo conector especificado. NotOnboarded - esse recurso não foi integrado a nenhum conector. NotApplicable - o estado de integração não é aplicável ao ponto de extremidade atual.

Valor	Description
NotApplicable
NotOnboarded
Onboarded
OnboardedByOtherConnector

systemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

Compartilhar via

Git Hub Owners - Get

Parâmetros de URI

Respostas

Segurança

azure_auth

Escopos

Exemplos

Get_GitHubOwners

Solicitação de exemplo

Resposta de exemplo

Definições

createdByType

DevOpsProvisioningState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GitHubOwner

GitHubOwnerProperties

OnboardingState

systemData