Approvals - Update

Referência

Service:: Release

API Version:: 7.1-preview.3

Atualizar status de uma aprovação

PATCH https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/approvals/{approvalId}?api-version=7.1-preview.3

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
approvalId	path	True	integer int32	Id da aprovação.
organization	path	True	string	O nome da organização do Azure DevOps.
project	path	True	string	ID do projeto ou nome do projeto
api-version	query	True	string	Versão da API a ser usada. Isso deve ser definido como '7.1-preview.3' para usar essa versão da api.

Corpo da solicitação

Nome	Tipo	Description
approvalType	ApprovalType	Obtém ou define o tipo de aprovação.
approvedBy	IdentityRef	Obtém a identidade que aprovou.
approver	IdentityRef	Obtém ou define a identidade que deve aprovar.
attempt	integer	Obtém ou define a tentativa que especifica como qual tentativa de implantação pertence.
comments	string	Obtém ou define comentários para aprovação.
createdOn	string	Obtém a data em que ela foi criada.
history	ReleaseApprovalHistory[]	Obtém o histórico que especifica todas as aprovações associadas a essa aprovação.
id	integer	Obtém o identificador exclusivo desse campo.
isAutomated	boolean	Obtém ou define como a aprovação é automatizada ou não.
modifiedOn	string	Obtém a data em que ela foi modificada.
rank	integer	Obtém ou define a classificação que especifica a ordem da aprovação. Por exemplo, a mesma classificação indica aprovação paralela.
release	ReleaseShallowReference	Obtém releaseReference que especifica a referência da versão à qual essa aprovação está associada.
releaseDefinition	ReleaseDefinitionShallowReference	Obtém releaseDefinitionReference que especifica a referência da definição de versão à qual essa aprovação está associada.
releaseEnvironment	ReleaseEnvironmentShallowReference	Obtém releaseEnvironmentReference, que especifica a referência do ambiente de versão ao qual essa aprovação está associada.
revision	integer	Obtém o número de revisão.
status	ApprovalStatus	Obtém ou define o status da aprovação.
url	string	Obtém a URL para acessar a aprovação.

Respostas

Nome	Tipo	Description
200 OK	ReleaseApproval	operação bem-sucedida

Segurança

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Scopes

Nome	Description
vso.release_manage	Concede a capacidade de ler, atualizar e excluir artefatos de versão, incluindo pastas, versões, definições de versão e ambiente de versão e a capacidade de enfileirar e aprovar uma nova versão.

Exemplos

Approve a release

Sample Request

HTTP

PATCH https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/release/approvals/{approvalId}?api-version=7.1-preview.3

{
  "status": "approved",
  "comments": "Good to go!"
}

Sample Response

Status code:: 200

{
  "id": 20,
  "revision": 1,
  "approver": {
    "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
    "displayName": "Chuck Reinhart",
    "uniqueName": "fabfiber@outlook.com",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
  },
  "approvedBy": {
    "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
    "displayName": "Chuck Reinhart",
    "uniqueName": "fabfiber@outlook.com",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
  },
  "approvalType": "preDeploy",
  "createdOn": "2017-05-31T18:07:40.45Z",
  "modifiedOn": "2017-05-31T18:08:09.577Z",
  "status": "approved",
  "comments": "Good to go!",
  "isAutomated": false,
  "isNotificationOn": true,
  "trialNumber": 1,
  "attempt": 1,
  "rank": 1,
  "history": [],
  "release": {
    "id": 3,
    "name": "Release-3",
    "url": "https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/Release/releases/3",
    "_links": {}
  },
  "releaseDefinition": {
    "id": 1,
    "name": "MyShuttle.CD",
    "url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1",
    "_links": {}
  },
  "releaseEnvironment": {
    "id": 9,
    "name": "Dev",
    "_links": {}
  },
  "url": "https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/Release/approvals/20"
}

Definições

Nome	Description
ApprovalStatus	Obtém ou define o status da aprovação.
ApprovalType	Obtém ou define o tipo de aprovação.
IdentityRef
ProjectReference
ReferenceLinks	A classe para representar uma coleção de links de referência REST.
ReleaseApproval
ReleaseApprovalHistory
ReleaseDefinitionShallowReference
ReleaseEnvironmentShallowReference
ReleaseShallowReference

ApprovalStatus

Obtém ou define o status da aprovação.

Nome	Tipo	Description
approved	string	Indica que a aprovação foi aprovada.
canceled	string	Indica que a aprovação foi cancelada.
pending	string	Indica que a aprovação está pendente.
reassigned	string	Indica que a aprovação foi reatribuída.
rejected	string	Indica que a aprovação foi rejeitada.
skipped	string	Indica que a aprovação foi ignorada.
undefined	string	Indica que a aprovação não tem o status definido.

ApprovalType

Obtém ou define o tipo de aprovação.

Nome	Tipo	Description
all	string	Indica todas as aprovações.
postDeploy	string	Indica as aprovações executadas após a implantação.
preDeploy	string	Indica as aprovações executadas antes da implantação.
undefined	string	Indica que o tipo de aprovação não é definido.

IdentityRef

Nome	Tipo	Description
_links	ReferenceLinks	Esse campo contém zero ou mais links interessantes sobre o assunto do grafo. Esses links podem ser invocados para obter relações adicionais ou informações mais detalhadas sobre esse assunto do grafo.
descriptor	string	O descritor é a principal maneira de referenciar o assunto do grafo enquanto o sistema está em execução. Esse campo identificará exclusivamente o mesmo assunto de grafo entre contas e organizações.
directoryAlias	string	Preterido – pode ser recuperado consultando o usuário do Graph referenciado na entrada "self" do dicionário IdentityRef "_links"
displayName	string	Esse é o nome de exibição não exclusivo do assunto do grafo. Para alterar esse campo, você deve alterar seu valor no provedor de origem.
id	string
imageUrl	string	Preterido – Disponível na entrada "avatar" do dicionário IdentityRef "_links"
inactive	boolean	Preterido – pode ser recuperado consultando o estado de associação do Graph referenciado na entrada "membershipState" do dicionário "_links" do GraphUser
isAadIdentity	boolean	Preterido – pode ser inferido do tipo de assunto do descritor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Preterido – pode ser inferido do tipo de assunto do descritor (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Preterido – não em uso na maioria das implementações preexistir de ToIdentityRef
uniqueName	string	Preterido – use Domain+PrincipalName em vez disso
url	string	Essa URL é a rota completa para o recurso de origem desta entidade de grafo.

ProjectReference

Nome	Tipo	Description
id	string	Obtém o identificador exclusivo desse campo.
name	string	Obtém o nome do projeto.

ReferenceLinks

A classe para representar uma coleção de links de referência REST.

Nome	Tipo	Description
links	object	A exibição somente leitura dos links. Como os links de referência são somente leitura, só queremos expô-los como somente leitura.

ReleaseApproval

Nome	Tipo	Description
approvalType	ApprovalType	Obtém ou define o tipo de aprovação.
approvedBy	IdentityRef	Obtém a identidade que aprovou.
approver	IdentityRef	Obtém ou define a identidade que deve aprovar.
attempt	integer	Obtém ou define a tentativa que especifica como qual tentativa de implantação pertence.
comments	string	Obtém ou define comentários para aprovação.
createdOn	string	Obtém a data em que ela foi criada.
history	ReleaseApprovalHistory[]	Obtém o histórico que especifica todas as aprovações associadas a essa aprovação.
id	integer	Obtém o identificador exclusivo desse campo.
isAutomated	boolean	Obtém ou define como a aprovação é automatizada ou não.
modifiedOn	string	Obtém a data em que ela foi modificada.
rank	integer	Obtém ou define a classificação que especifica a ordem da aprovação. Por exemplo, a mesma classificação indica aprovação paralela.
release	ReleaseShallowReference	Obtém releaseReference que especifica a referência da versão à qual essa aprovação está associada.
releaseDefinition	ReleaseDefinitionShallowReference	Obtém releaseDefinitionReference que especifica a referência da definição de versão à qual essa aprovação está associada.
releaseEnvironment	ReleaseEnvironmentShallowReference	Obtém releaseEnvironmentReference, que especifica a referência do ambiente de versão ao qual essa aprovação está associada.
revision	integer	Obtém o número de revisão.
status	ApprovalStatus	Obtém ou define o status da aprovação.
url	string	Obtém a URL para acessar a aprovação.

ReleaseApprovalHistory

Nome	Tipo	Description
approver	IdentityRef	Identidade do aprovador.
changedBy	IdentityRef	Identidade do objeto que alterou a aprovação.
comments	string	Comentários do histórico de aprovação.
createdOn	string	Hora em que essa aprovação foi criada.
modifiedOn	string	Hora em que essa aprovação foi modificada.
revision	integer	Revisão do histórico de aprovação.

ReleaseDefinitionShallowReference

Nome	Tipo	Description
_links	ReferenceLinks	Obtém os links para recursos, APIs e exibições relacionados para a definição de versão.
id	integer	Obtém o identificador exclusivo da definição de versão.
name	string	Obtém ou define o nome da definição de versão.
path	string	Obtém ou define o caminho da definição de versão.
projectReference	ProjectReference	Obtém ou define a referência do projeto.
url	string	Obtém a URL da API REST para acessar a definição de versão.

ReleaseEnvironmentShallowReference

Nome	Tipo	Description
_links	ReferenceLinks	Obtém os links para recursos, APIs e exibições relacionados para o ambiente de lançamento.
id	integer	Obtém o identificador exclusivo do ambiente de versão.
name	string	Obtém ou define o nome do ambiente de versão.
url	string	Obtém a URL da API REST para acessar o ambiente de versão.

ReleaseShallowReference

Nome	Tipo	Description
_links	ReferenceLinks	Obtém os links para recursos, APIs e exibições relacionados para a versão.
id	integer	Obtém o identificador exclusivo da versão.
name	string	Obtém ou define o nome da versão.
url	string	Obtém a URL da API REST para acessar a versão.

Compartilhar via