Git Hub Repos - Get

Referência

Serviço:: Defender for Cloud

Versão da API:: 2024-05-15-preview

Retorna um repositório GitHub monitorado.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
ownerName	path	True	string	O nome do proprietário do GitHub.
repoName	path	True	string	O nome do repositório.
resourceGroupName	path	True	string	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	A ID da assinatura de destino.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Respostas

Name	Tipo	Description
200 OK	GitHubRepository	Fornece detalhes do repositório GitHub
Other Status Codes	ErrorResponse	Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

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

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

Get_GitHubRepos

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


/**
 * Samples for GitHubRepos Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/preview/2024-05-15-preview/examples/
     * SecurityConnectorsDevOps/GetGitHubRepos_example.json
     */
    /**
     * Sample code: Get_GitHubRepos.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void getGitHubRepos(com.azure.resourcemanager.security.SecurityManager manager) {
        manager.gitHubRepos().getWithResponse("myRg", "mySecurityConnectorName", "myGitHubOwner", "myGitHubRepo",
            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

Resposta da amostra

Código de estado:: 200

{
  "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"
}

Definições

Name	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	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
GitHubRepository	Recurso do repositório GitHub.
GitHubRepositoryProperties	Propriedades do repositório GitHub.
OnboardingState	Detalhes sobre o status de integração de recursos em todos os conectores. OnboardedByOtherConnector - este recurso já foi integrado a outro conector. Isto só se aplica a recursos de nível superior. Integrado - este recurso já foi integrado pelo conector especificado. NotOnboarded - este recurso não foi integrado a nenhum conector. NotApplicable - o estado de integração não é aplicável ao endpoint atual.
systemData	Metadados referentes à criação e última modificação do recurso.

createdByType

O tipo de identidade que criou o recurso.

Name	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

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.

Name	Tipo	Description
Canceled	string
DeletionFailure	string
DeletionSuccess	string
Failed	string
Pending	string
PendingDeletion	string
Succeeded	string

ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

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

ErrorDetail

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
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

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

GitHubRepository

Recurso do repositório GitHub.

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

GitHubRepositoryProperties

Propriedades do repositório GitHub.

Name	Tipo	Description
onboardingState	OnboardingState	Detalhes sobre o status de integração de recursos em todos os conectores. OnboardedByOtherConnector - este recurso já foi integrado a outro conector. Isto só se aplica a recursos de nível superior. Integrado - este recurso já foi integrado pelo conector especificado. NotOnboarded - este recurso não foi integrado a nenhum conector. NotApplicable - o estado de integração não é aplicável ao endpoint atual.
parentOwnerName	string	Obtém ou define o nome do proprietário pai 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 a mensagem de status do recurso.
provisioningStatusUpdateTimeUtc	string	Obtém a hora em que o recurso foi verificado pela última vez.
repoFullName	string	Obtém ou define o nome completo do GitHub. Nome do repositório, prefixado com Nome do proprietário. Ex: "my-org/new-repo-1".
repoId	string	Obtém ou define a ID do repositório GitHub. Este é um id numérico definido pelo Github. Ex: "123456".
repoName	string	Obtém ou define o nome do repositório GitHub. Ex: "new-repo-1".
repoUrl	string	Obtém ou define a URL do repositório GitHub.

OnboardingState

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

OnboardedByOtherConnector - este recurso já foi integrado a outro conector. Isto só se aplica a recursos de nível superior. Integrado - este recurso já foi integrado pelo conector especificado. NotOnboarded - este recurso não foi integrado a nenhum conector. NotApplicable - o estado de integração não é aplicável ao endpoint atual.

Name	Tipo	Description
NotApplicable	string
NotOnboarded	string
Onboarded	string
OnboardedByOtherConnector	string

systemData

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

Name	Tipo	Description
createdAt	string	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	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.

Partilhar via