Azure DevOps Repos - Create Or Update

Referência

Serviço:: Defender for Cloud

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

Cria ou atualiza um recurso de repositório do Azure DevOps monitorado.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName}/devops/default/azureDevOpsOrgs/{orgName}/projects/{projectName}/repos/{repoName}?api-version=2024-05-15-preview

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
orgName	path	True	string	O nome da organização do Azure DevOps.
projectName	path	True	string	O nome do projeto.
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.

Corpo da solicitação

Nome	Tipo	Description
properties	AzureDevOpsRepositoryProperties	Propriedades do repositório do Azure DevOps.

Respostas

Nome	Tipo	Description
200 OK	AzureDevOpsRepository	Cria ou atualiza um recurso de repositório do Azure DevOps monitorado
201 Created	AzureDevOpsRepository	Criado
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

CreateOrUpdate_AzureDevOpsRepos

PUT https://management.azure.com/subscriptions/0806e1cd-cfda-4ff8-b99c-2b0af42cffd3/resourceGroups/myRg/providers/Microsoft.Security/securityConnectors/mySecurityConnectorName/devops/default/azureDevOpsOrgs/myAzDevOpsOrg/projects/myAzDevOpsProject/repos/myAzDevOpsRepo?api-version=2024-05-15-preview

{
  "properties": {
    "onboardingState": "NotApplicable",
    "actionableRemediation": {
      "state": "Enabled"
    }
  }
}


import com.azure.resourcemanager.security.models.ActionableRemediation;
import com.azure.resourcemanager.security.models.ActionableRemediationState;
import com.azure.resourcemanager.security.models.AzureDevOpsRepositoryProperties;
import com.azure.resourcemanager.security.models.OnboardingState;

/**
 * Samples for AzureDevOpsRepos CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/preview/2024-05-15-preview/examples/
     * SecurityConnectorsDevOps/CreateOrUpdateAzureDevOpsRepos_example.json
     */
    /**
     * Sample code: CreateOrUpdate_AzureDevOpsRepos.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void createOrUpdateAzureDevOpsRepos(com.azure.resourcemanager.security.SecurityManager manager) {
        manager.azureDevOpsRepos().define("myAzDevOpsRepo")
            .withExistingProject("myRg", "mySecurityConnectorName", "myAzDevOpsOrg", "myAzDevOpsProject")
            .withProperties(new AzureDevOpsRepositoryProperties().withOnboardingState(OnboardingState.NOT_APPLICABLE)
                .withActionableRemediation(new ActionableRemediation().withState(ActionableRemediationState.ENABLED)))
            .create();
    }
}

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": {
    "parentOrgName": "myAzDevOpsOrg",
    "parentProjectName": "myAzDevOpsProject",
    "repoId": "cb64ab91-c9ba-46df-b44c-c769358bccdf",
    "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/projects/myAzDevOpsProject/repos/myAzDevOpsRepo",
  "name": "myAzDevOpsRepo",
  "type": "Microsoft.Security/securityConnectors/devops/azureDevOpsOrgs/projects/repos"
}

Código de status:: 201

Azure-AsyncOperation: https://management.azure.com/subscriptions/0806e1cd-cfda-4ff8-b99c-2b0af42cffd3/resourceGroups/myRg/providers/Microsoft.Security/securityConnectors/mySecurityConnectorName/devops/default/operationResults/4e826cf1-5c36-4808-a7d2-fb4f5170978b?api-version=2024-05-15-preview

{
  "properties": {
    "parentOrgName": "myAzDevOpsOrg",
    "parentProjectName": "myAzDevOpsProject",
    "repoId": "cb64ab91-c9ba-46df-b44c-c769358bccdf",
    "onboardingState": "NotApplicable",
    "actionableRemediation": {
      "state": "None"
    },
    "provisioningState": "Accepted"
  },
  "id": "/subscriptions/0806e1cd-cfda-4ff8-b99c-2b0af42cffd3/resourceGroups/myRg/providers/Microsoft.Security/securityConnectors/mySecurityConnectorName/devops/default/azureDevOpsOrgs/myAzDevOpsOrg/projects/myAzDevOpsProject/repos/myAzDevOpsRepo",
  "name": "myAzDevOpsRepo",
  "type": "Microsoft.Security/securityConnectors/devops/azureDevOpsOrgs/projects/repos"
}

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.
AzureDevOpsRepository	Recurso de repositório do Azure DevOps.
AzureDevOpsRepositoryProperties	Propriedades do repositório 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

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

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

Nome	Tipo	Description
Disabled	string
Enabled	string
None	string

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.

Nome	Tipo	Description
Disabled	string
Enabled	string

AzureDevOpsRepository

Recurso de repositório 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	AzureDevOpsRepositoryProperties	Propriedades do repositório 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"

AzureDevOpsRepositoryProperties

Propriedades do repositório 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.
parentOrgName	string	Obtém ou define o nome pai da Organização do Azure DevOps.
parentProjectName	string	Obtém ou define o nome do projeto pai do Azure DevOps.
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.
repoId	string	Obtém ou define a ID do Repositório do Azure DevOps.
repoUrl	string	Obtém ou define a URL do Repositório do Azure DevOps.
visibility	string	Obtém ou define a visibilidade do repositório do Azure DevOps, seja ele público ou privado etc.

CategoryConfiguration

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

O tipo de identidade que criou o recurso.

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

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

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.

InheritFromParentState

Atualizar configurações.

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

Nome	Tipo	Description
Disabled	string
Enabled	string

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.

Nome	Tipo	Description
NotApplicable	string
NotOnboarded	string
Onboarded	string
OnboardedByOtherConnector	string

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.

Nome	Tipo	Description
Artifacts	string
Code	string
Containers	string
Dependencies	string
IaC	string
Secrets	string

systemData

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

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

TargetBranchConfiguration

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 Repos - Create Or Update

Parâmetros de URI

Corpo da solicitação

Respostas

Segurança

azure_auth

Escopos

Exemplos

CreateOrUpdate_AzureDevOpsRepos

Solicitação de exemplo

Resposta de exemplo

Definições

ActionableRemediation

ActionableRemediationState

AnnotateDefaultBranchState

AzureDevOpsRepository

AzureDevOpsRepositoryProperties

CategoryConfiguration

createdByType

DevOpsProvisioningState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

InheritFromParentState

OnboardingState

RuleCategory

systemData

TargetBranchConfiguration

Recursos adicionais