Compartilhar via


Git Hub Repos - List

Retorna uma lista de repositórios do GitHub integrados ao conector.

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

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

GitHubRepositoryListResponse

Fornece uma lista de recursos do repositório 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

List_GitHubRepos

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/repos?api-version=2024-05-15-preview

Resposta de exemplo

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

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

GitHubRepository

Recurso do Repositório GitHub.

GitHubRepositoryListResponse

Lista de recursos rp que dão suporte à paginação.

GitHubRepositoryProperties

Propriedades do Repositório 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

O tipo de identidade que criou o recurso.

Valor Description
Application
Key
ManagedIdentity
User

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.

Valor Description
Canceled
DeletionFailure
DeletionSuccess
Failed
Pending
PendingDeletion
Succeeded

ErrorAdditionalInfo

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

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

Resposta de erro

Nome Tipo Description
error

ErrorDetail

O objeto de erro.

GitHubRepository

Recurso do Repositório 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

GitHubRepositoryProperties

Propriedades do Repositório 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"

GitHubRepositoryListResponse

Lista de recursos rp que dão suporte à paginação.

Nome Tipo Description
nextLink

string

Obtém ou define o próximo link para rolar sobre os resultados.

value

GitHubRepository[]

Obtém ou define a lista de recursos.

GitHubRepositoryProperties

Propriedades do Repositório GitHub.

Nome Tipo Description
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.

parentOwnerName

string

Obtém ou define o nome do Proprietário do GitHub pai.

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 (date-time)

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 o nome do proprietário. Por exemplo: "my-org/new-repo-1".

repoId

string

Obtém ou define a ID do Repositório GitHub.

Essa é uma ID numérica definida pelo Github. Por exemplo: "123456".

repoName

string

Obtém ou define o nome do Repositório GitHub. Por exemplo: "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 – 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

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.