Azure DevOps Orgs - List Available

Referência

Serviço:: Defender for Cloud

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

Retorna uma lista de todas as organizações do Azure DevOps acessíveis pelo token de usuário consumido pelo conector.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
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	AzureDevOpsOrgListResponse	Fornece uma lista de detalhes da organização do Azure DevOps
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

ListAvailable_AzureDevOpsOrgs

Solicitação de exemplo

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


/**
 * Samples for AzureDevOpsOrgs ListAvailable.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/stable/2024-04-01/examples/SecurityConnectorsDevOps/
     * ListAvailableAzureDevOpsOrgs_example.json
     */
    /**
     * Sample code: ListAvailable_AzureDevOpsOrgs.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void listAvailableAzureDevOpsOrgs(com.azure.resourcemanager.security.SecurityManager manager) {
        manager.azureDevOpsOrgs().listAvailableWithResponse("myRg", "mySecurityConnectorName",
            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 list_available_azure_dev_ops_orgs_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.azure_dev_ops_orgs.list_available(
        resource_group_name="myRg",
        security_connector_name="mySecurityConnectorName",
    )
    print(response)


# x-ms-original-file: specification/security/resource-manager/Microsoft.Security/stable/2024-04-01/examples/SecurityConnectorsDevOps/ListAvailableAzureDevOpsOrgs_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

{
  "value": [
    {
      "properties": {
        "onboardingState": "Onboarded",
        "actionableRemediation": {
          "state": "Enabled"
        },
        "provisioningState": "Succeeded"
      },
      "id": "/subscriptions/0806e1cd-cfda-4ff8-b99c-2b0af42cffd3/resourceGroups/myRg/providers/Microsoft.Security/securityConnectors/mySecurityConnectorName/devops/default/azureDevOpsOrgs/myAzDevOpsOrg",
      "name": "myAzDevOpsOrg",
      "type": "Microsoft.Security/securityConnectors/devops/azureDevOpsOrgs"
    },
    {
      "properties": {
        "onboardingState": "OnboardedByOtherConnector",
        "actionableRemediation": {
          "state": "Enabled"
        },
        "provisioningState": "Succeeded"
      },
      "id": "/subscriptions/0806e1cd-cfda-4ff8-b99c-2b0af42cffd3/resourceGroups/myRg/providers/Microsoft.Security/securityConnectors/mySecurityConnectorName/devops/default/azureDevOpsOrgs/anotherOrg",
      "name": "anotherOrg",
      "type": "Microsoft.Security/securityConnectors/devops/azureDevOpsOrgs"
    },
    {
      "properties": {
        "onboardingState": "NotOnboarded",
        "actionableRemediation": {
          "state": "None"
        }
      },
      "id": "/subscriptions/0806e1cd-cfda-4ff8-b99c-2b0af42cffd3/resourceGroups/myRg/providers/Microsoft.Security/securityConnectors/mySecurityConnectorName/devops/default/azureDevOpsOrgs/notOnboardedOrg",
      "name": "notOnboardedOrg",
      "type": "Microsoft.Security/securityConnectors/devops/azureDevOpsOrgs"
    }
  ]
}

Definições

Nome	Description
ActionableRemediation	Conteúdo de configuração para anotações de PR.
ActionableRemediationState	Configuração ActionableRemediation. Nenhum - a configuração nunca foi definida. Habilitado – ActionableRemediation está habilitado. Desabilitado – ActionableRemediation está desabilitado.
AnnotateDefaultBranchState	Configuração de anotações de PR no branch padrão. Habilitados – As anotações de PR estão habilitadas no branch padrão do recurso. Desabilitado – As anotações de PR estão desabilitadas no branch padrão do recurso.
AzureDevOpsOrg	Recurso da Organização do Azure DevOps.
AzureDevOpsOrgListResponse	Lista de recursos rp que dão suporte à paginação.
AzureDevOpsOrgProperties	Propriedades da Organização do Azure DevOps.
CategoryConfiguration	Configuração de nível de severidade por categoria para anotações de PR.
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
InheritFromParentState	Atualizar configurações. Habilitado – o recurso deve herdar configurações do pai. Desabilitado – o recurso não deve herdar configurações do pai.
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.
RuleCategory	Categorias de regra. Código – resultados de verificação de código. Resultados da verificação de artefatos. Resultados da verificação de dependências. Resultados de IaC. Resultados da verificação de segredos. Resultados da verificação de contêiner.
systemData	Metadados relativos à criação e última modificação do recurso.
TargetBranchConfiguration	Configuração do branch do repositório para anotações de PR.

ActionableRemediation

Objeto

Conteúdo de configuração para anotações de PR.

Nome	Tipo	Description
branchConfiguration	TargetBranchConfiguration	Configuração do branch do repositório para anotações de PR.
categoryConfigurations	CategoryConfiguration[]	Obtém ou define a lista de categorias e níveis de gravidade.
inheritFromParentState	InheritFromParentState	Atualizar configurações. Habilitado – o recurso deve herdar configurações do pai. Desabilitado – o recurso não deve herdar configurações do pai.
state	ActionableRemediationState	Configuração ActionableRemediation. Nenhum - a configuração nunca foi definida. Habilitado – ActionableRemediation está habilitado. Desabilitado – ActionableRemediation está desabilitado.

ActionableRemediationState

Enumeração

Configuração ActionableRemediation. Nenhum - a configuração nunca foi definida. Habilitado – ActionableRemediation está habilitado. Desabilitado – ActionableRemediation está desabilitado.

Valor	Description
Disabled
Enabled
None

AnnotateDefaultBranchState

Enumeração

Configuração de anotações de PR no branch padrão.

Habilitados – As anotações de PR estão habilitadas no branch padrão do recurso. Desabilitado – As anotações de PR estão desabilitadas no branch padrão do recurso.

Valor	Description
Disabled
Enabled

AzureDevOpsOrg

Objeto

Recurso da Organização do Azure DevOps.

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	AzureDevOpsOrgProperties	Propriedades da Organização do Azure DevOps.
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"

AzureDevOpsOrgListResponse

Objeto

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	AzureDevOpsOrg[]	Obtém ou define a lista de recursos.

AzureDevOpsOrgProperties

Objeto

Propriedades da Organização do Azure DevOps.

Nome	Tipo	Description
actionableRemediation	ActionableRemediation	Conteúdo de configuração para anotações de PR.
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.
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.

CategoryConfiguration

Objeto

Configuração de nível de severidade por categoria para anotações de PR.

Nome	Tipo	Description
category	RuleCategory	Categorias de regra. Código – resultados de verificação de código. Resultados da verificação de artefatos. Resultados da verificação de dependências. Resultados de IaC. Resultados da verificação de segredos. Resultados da verificação de contêiner.
minimumSeverityLevel	string	Obtém ou define o nível mínimo de severidade para uma determinada categoria.

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.

InheritFromParentState

Enumeração

Atualizar configurações.

Habilitado – o recurso deve herdar configurações do pai. Desabilitado – o recurso não deve herdar configurações do pai.

Valor	Description
Disabled
Enabled

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

RuleCategory

Enumeração

Categorias de regra. Código – resultados de verificação de código. Resultados da verificação de artefatos. Resultados da verificação de dependências. Resultados de IaC. Resultados da verificação de segredos. Resultados da verificação de contêiner.

Valor	Description
Artifacts
Code
Containers
Dependencies
IaC
Secrets

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.

TargetBranchConfiguration

Objeto

Configuração do branch do repositório para anotações de PR.

Nome	Tipo	Description
annotateDefaultBranch	AnnotateDefaultBranchState	Configuração de anotações de PR no branch padrão. Habilitados – As anotações de PR estão habilitadas no branch padrão do recurso. Desabilitado – As anotações de PR estão desabilitadas no branch padrão do recurso.
branchNames	string[]	Obtém ou define branches que devem ter anotações.

Nome

Tipo

Description

annotateDefaultBranch

AnnotateDefaultBranchState

Configuração de anotações de PR no branch padrão.

Habilitados – As anotações de PR estão habilitadas no branch padrão do recurso. Desabilitado – As anotações de PR estão desabilitadas no branch padrão do recurso.

branchNames

string[]

Obtém ou define branches que devem ter anotações.

Compartilhar via

Azure DevOps Orgs - List Available

Parâmetros de URI

Respostas

Segurança

azure_auth

Escopos

Exemplos

ListAvailable_AzureDevOpsOrgs

Solicitação de exemplo

Resposta de exemplo

Definições

ActionableRemediation

ActionableRemediationState

AnnotateDefaultBranchState

AzureDevOpsOrg

AzureDevOpsOrgListResponse

AzureDevOpsOrgProperties

CategoryConfiguration

createdByType

DevOpsProvisioningState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

InheritFromParentState

OnboardingState

RuleCategory

systemData

TargetBranchConfiguration