Azure DevOps Projects - Create Or Update

Referência

Serviço:: Defender for Cloud

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

Cria ou atualiza um recurso de projeto do Azure DevOps monitorado.

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

Parâmetros do URI

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

Name	Tipo	Description
properties	AzureDevOpsProjectProperties	Propriedades do Azure DevOps Project.

Respostas

Name	Tipo	Description
200 OK	AzureDevOpsProject	Cria ou atualiza um recurso de projeto do Azure DevOps monitorado
201 Created	AzureDevOpsProject	Criado
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

CreateOrUpdate_AzureDevOpsProjects

PUT https://management.azure.com/subscriptions/0806e1cd-cfda-4ff8-b99c-2b0af42cffd3/resourceGroups/myRg/providers/Microsoft.Security/securityConnectors/mySecurityConnectorName/devops/default/azureDevOpsOrgs/myAzDevOpsOrg/projects/myAzDevOpsProject?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.AzureDevOpsProjectProperties;
import com.azure.resourcemanager.security.models.OnboardingState;

/**
 * Samples for AzureDevOpsProjects CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/preview/2024-05-15-preview/examples/
     * SecurityConnectorsDevOps/CreateOrUpdateAzureDevOpsProjects_example.json
     */
    /**
     * Sample code: CreateOrUpdate_AzureDevOpsProjects.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void createOrUpdateAzureDevOpsProjects(com.azure.resourcemanager.security.SecurityManager manager) {
        manager.azureDevOpsProjects().define("myAzDevOpsProject")
            .withExistingAzureDevOpsOrg("myRg", "mySecurityConnectorName", "myAzDevOpsOrg")
            .withProperties(new AzureDevOpsProjectProperties().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 da amostra

Código de estado:: 200

{
  "properties": {
    "parentOrgName": "myAzDevOpsOrg",
    "projectId": "9ebbed8f-a9cc-405f-a647-b235e22179de",
    "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",
  "name": "myAzDevOpsProject",
  "type": "Microsoft.Security/securityConnectors/devops/azureDevOpsOrgs/projects"
}

Código de estado:: 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",
    "projectId": "9ebbed8f-a9cc-405f-a647-b235e22179de",
    "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",
  "name": "myAzDevOpsProject",
  "type": "Microsoft.Security/securityConnectors/devops/azureDevOpsOrgs/projects"
}

Definições

Name	Description
ActionableRemediation	Carga útil de configuração para anotações PR.
ActionableRemediationState	Configuração ActionableRemedia. Nenhum - o cenário nunca foi definido. Ativado - ActionableRemediation está habilitado. Desabilitado - ActionableRemediation está desabilitado.
AnnotateDefaultBranchState	Configuração de anotações PR na ramificação padrão. Habilitado - As anotações PR são habilitadas na ramificação padrão do recurso. Desabilitado - As anotações PR são desabilitadas na ramificação padrão do recurso.
AzureDevOpsProject	Recurso do Azure DevOps Project.
AzureDevOpsProjectProperties	Propriedades do Azure DevOps Project.
CategoryConfiguration	Nível de severidade por configuração de categoria para anotações 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	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
InheritFromParentState	Atualizar configurações. Habilitado - O recurso deve herdar as 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 - 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.
RuleCategory	Categorias de regras. Código - resultados da verificação de código. Resultados da varredura de artefatos. Resultados da verificação de dependências. Resultados do IAC. Resultados da verificação de segredos. Resultados da varredura de contêineres.
systemData	Metadados referentes à criação e última modificação do recurso.
TargetBranchConfiguration	Configuração de ramificação do repositório para anotações PR.

ActionableRemediation

Carga útil de configuração para anotações PR.

Name	Tipo	Description
branchConfiguration	TargetBranchConfiguration	Configuração de ramificação do repositório para anotações 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 as configurações do pai. Desabilitado - O recurso não deve herdar configurações do pai.
state	ActionableRemediationState	Configuração ActionableRemedia. Nenhum - o cenário nunca foi definido. Ativado - ActionableRemediation está habilitado. Desabilitado - ActionableRemediation está desabilitado.

ActionableRemediationState

Configuração ActionableRemedia. Nenhum - o cenário nunca foi definido. Ativado - ActionableRemediation está habilitado. Desabilitado - ActionableRemediation está desabilitado.

Name	Tipo	Description
Disabled	string
Enabled	string
None	string

AnnotateDefaultBranchState

Configuração de anotações PR na ramificação padrão.

Habilitado - As anotações PR são habilitadas na ramificação padrão do recurso. Desabilitado - As anotações PR são desabilitadas na ramificação padrão do recurso.

Name	Tipo	Description
Disabled	string
Enabled	string

AzureDevOpsProject

Recurso do Azure DevOps Project.

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	AzureDevOpsProjectProperties	Propriedades do Azure DevOps Project.
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"

AzureDevOpsProjectProperties

Propriedades do Azure DevOps Project.

Name	Tipo	Description
actionableRemediation	ActionableRemediation	Carga útil de configuração para anotações PR.
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.
parentOrgName	string	Obtém ou define o nome pai da Organização de DevOps do Azure.
projectId	string	Obtém ou define a ID do Projeto 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.

CategoryConfiguration

Nível de severidade por configuração de categoria para anotações PR.

Name	Tipo	Description
category	RuleCategory	Categorias de regras. Código - resultados da verificação de código. Resultados da varredura de artefatos. Resultados da verificação de dependências. Resultados do IAC. Resultados da verificação de segredos. Resultados da varredura de contêineres.
minimumSeverityLevel	string	Obtém ou define o nível mínimo de gravidade para uma determinada categoria.

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.

InheritFromParentState

Atualizar configurações.

Habilitado - O recurso deve herdar as configurações do pai. Desabilitado - O recurso não deve herdar configurações do pai.

Name	Tipo	Description
Disabled	string
Enabled	string

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

RuleCategory

Categorias de regras. Código - resultados da verificação de código. Resultados da varredura de artefatos. Resultados da verificação de dependências. Resultados do IAC. Resultados da verificação de segredos. Resultados da varredura de contêineres.

Name	Tipo	Description
Artifacts	string
Code	string
Containers	string
Dependencies	string
IaC	string
Secrets	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.

TargetBranchConfiguration

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

Name	Tipo	Description
annotateDefaultBranch	AnnotateDefaultBranchState	Configuração de anotações PR na ramificação padrão. Habilitado - As anotações PR são habilitadas na ramificação padrão do recurso. Desabilitado - As anotações PR são desabilitadas na ramificação padrão do recurso.
branchNames	string[]	Obtém ou define ramificações que devem ter anotações.

Name

Tipo

Description

annotateDefaultBranch

AnnotateDefaultBranchState

Configuração de anotações PR na ramificação padrão.

Habilitado - As anotações PR são habilitadas na ramificação padrão do recurso. Desabilitado - As anotações PR são desabilitadas na ramificação padrão do recurso.

branchNames

string[]

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

Partilhar via

Azure DevOps Projects - Create Or Update

Parâmetros do URI

Corpo do Pedido

Respostas

Segurança

azure_auth

Âmbitos

Exemplos

CreateOrUpdate_AzureDevOpsProjects

Pedido de amostra

Resposta da amostra

Definições

ActionableRemediation

ActionableRemediationState

AnnotateDefaultBranchState

AzureDevOpsProject

AzureDevOpsProjectProperties

CategoryConfiguration

createdByType

DevOpsProvisioningState

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

InheritFromParentState

OnboardingState

RuleCategory

systemData

TargetBranchConfiguration

Recursos adicionais