Releases - Update Release Environment

Serviço:

Release

Versão da API:

7.1

Atualizar o status de um ambiente de versão

PATCH https://vsrm.dev.azure.com/{organization}/{project}/_apis/Release/releases/{releaseId}/environments/{environmentId}?api-version=7.1

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
environmentId	path	True	integer (int32)	ID do ambiente de lançamento.
organization	path	True	string	O nome da organização do Azure DevOps.
project	path	True	string	ID do projeto ou nome do projeto
releaseId	path	True	integer (int32)	ID da versão.
api-version	query	True	string	Versão da API a ser usada. Isso deve ser definido como '7.1' para usar essa versão da api.

Corpo da solicitação

Nome	Tipo	Description
comment	string	Obtém ou define o comentário.
scheduledDeploymentTime	string (date-time)	Obtém ou define o tempo de implantação agendado.
status	EnvironmentStatus	Obtém ou define o status do ambiente.
variables	<string,  ConfigurationVariableValue>	Define a lista de variáveis de ambiente a serem substituídas no momento da implantação.

Respostas

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

Segurança

oauth2

Tipo: oauth2
Flow: accessCode
URL de Autorização: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL do Token: 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

Escopos

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

Exemplos

Start deployment on an environment

Solicitação de exemplo

HTTP

PATCH https://vsrm.dev.azure.com/{organization}/{project}/_apis/Release/releases/{releaseId}/environments/{environmentId}?api-version=7.1

{
  "status": "inProgress",
  "scheduledDeploymentTime": null,
  "comment": null,
  "variables": {}
}

Resposta de exemplo

Código de status:

200

{
  "id": 45,
  "releaseId": 45,
  "name": "PROD",
  "status": "queued",
  "variables": {},
  "variableGroups": [],
  "preDeployApprovals": [],
  "postDeployApprovals": [],
  "preApprovalsSnapshot": {
    "approvals": [
      {
        "rank": 1,
        "isAutomated": false,
        "isNotificationOn": false,
        "approver": {
          "displayName": "Chuck Reinhart",
          "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/aeb95c63-4fac-4948-84ce-711b0a9dda97",
          "_links": {
            "avatar": {
              "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
            }
          },
          "id": "aeb95c63-4fac-4948-84ce-711b0a9dda97",
          "uniqueName": "fabfiber@outlook.com",
          "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=aeb95c63-4fac-4948-84ce-711b0a9dda97",
          "descriptor": "aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
        },
        "id": 0
      }
    ],
    "approvalOptions": {
      "requiredApproverCount": 0,
      "releaseCreatorCanBeApprover": true,
      "autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped": false,
      "enforceIdentityRevalidation": false,
      "timeoutInMinutes": 0,
      "executionOrder": "beforeGates"
    }
  },
  "postApprovalsSnapshot": {
    "approvals": [
      {
        "rank": 1,
        "isAutomated": true,
        "isNotificationOn": false,
        "id": 0
      }
    ]
  },
  "deploySteps": [],
  "rank": 1,
  "definitionEnvironmentId": 23,
  "environmentOptions": {
    "emailNotificationType": "OnlyOnFailure",
    "emailRecipients": "release.environment.owner;release.creator",
    "skipArtifactsDownload": false,
    "timeoutInMinutes": 0,
    "enableAccessToken": false,
    "publishDeploymentStatus": false,
    "badgeEnabled": false,
    "autoLinkWorkItems": false,
    "pullRequestDeploymentEnabled": false
  },
  "demands": [],
  "conditions": [],
  "workflowTasks": [],
  "deployPhasesSnapshot": [
    {
      "deploymentInput": {
        "parallelExecution": {
          "parallelExecutionType": "none"
        },
        "skipArtifactsDownload": false,
        "artifactsDownloadInput": {
          "downloadInputs": []
        },
        "queueId": 0,
        "demands": [],
        "enableAccessToken": false,
        "timeoutInMinutes": 0,
        "jobCancelTimeoutInMinutes": 1,
        "condition": "succeeded()",
        "overrideInputs": {}
      },
      "rank": 1,
      "phaseType": "agentBasedDeployment",
      "name": "Run on agent",
      "refName": null,
      "workflowTasks": []
    }
  ],
  "owner": {
    "displayName": "Chuck Reinhart",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/aeb95c63-4fac-4948-84ce-711b0a9dda97",
    "_links": {
      "avatar": {
        "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
      }
    },
    "id": "aeb95c63-4fac-4948-84ce-711b0a9dda97",
    "uniqueName": "fabfiber@outlook.com",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=aeb95c63-4fac-4948-84ce-711b0a9dda97",
    "descriptor": "aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
  },
  "schedules": [],
  "release": {
    "id": 45,
    "name": "Release-2",
    "url": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/releases/45",
    "_links": {
      "web": {
        "href": "https://dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_release?releaseId=45&_a=release-summary"
      },
      "self": {
        "href": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/releases/45"
      }
    }
  },
  "releaseDefinition": {
    "id": 23,
    "name": "Fabrikam-web",
    "path": "\\",
    "projectReference": null,
    "url": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/23",
    "_links": {
      "web": {
        "href": "https://dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_release?definitionId=23"
      },
      "self": {
        "href": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/23"
      }
    }
  },
  "releaseCreatedBy": {
    "displayName": "Chuck Reinhart",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/aeb95c63-4fac-4948-84ce-711b0a9dda97",
    "_links": {
      "avatar": {
        "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
      }
    },
    "id": "aeb95c63-4fac-4948-84ce-711b0a9dda97",
    "uniqueName": "fabfiber@outlook.com",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=aeb95c63-4fac-4948-84ce-711b0a9dda97",
    "descriptor": "aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
  },
  "triggerReason": "Manual",
  "preDeploymentGatesSnapshot": {
    "id": 0,
    "gatesOptions": null,
    "gates": []
  },
  "postDeploymentGatesSnapshot": {
    "id": 0,
    "gatesOptions": null,
    "gates": []
  }
}

Definições

Nome	Description
ApprovalExecutionOrder	Ordem de execução de aprovações.
ApprovalOptions
ApprovalStatus	Obtém ou define o status da aprovação.
ApprovalType	Obtém ou define o tipo de aprovação.
AuthorizationHeader
ConditionType	Obtém ou define o tipo de condição.
ConfigurationVariableValue
DataSourceBindingBase	Representa a associação da fonte de dados para a solicitação do ponto de extremidade de serviço.
DeploymentAttempt
DeploymentJob
DeploymentOperationStatus	Obtém o status da operação da implantação.
DeploymentReason	Obtém o motivo da implantação.
DeploymentStatus	Obtém o status da implantação.
DeployPhase
DeployPhaseStatus	Status da fase.
DeployPhaseTypes	Indica o tipo de fase de implantação.
EnvironmentOptions
EnvironmentStatus	Obtém o status do ambiente.
GateStatus	Status das portas de liberação.
IdentityRef
IgnoredGate
Issue
ManualIntervention
ManualInterventionStatus	Obtém ou define o status da intervenção manual.
ProcessParameters
ProjectReference
ReferenceLinks	A classe para representar uma coleção de links de referência REST.
ReleaseApproval
ReleaseApprovalHistory
ReleaseCondition
ReleaseDefinitionApprovals
ReleaseDefinitionApprovalStep
ReleaseDefinitionGate
ReleaseDefinitionGatesOptions
ReleaseDefinitionGatesStep
ReleaseDefinitionShallowReference
ReleaseDeployPhase
ReleaseEnvironment
ReleaseEnvironmentShallowReference
ReleaseEnvironmentUpdateMetadata
ReleaseGates
ReleaseSchedule
ReleaseShallowReference
ReleaseTask
ScheduleDays	Dias da semana para lançamento.
TaskInputDefinitionBase
TaskInputValidation
TaskSourceDefinitionBase
TaskStatus	Status da tarefa de versão.
VariableGroup
VariableGroupProjectReference	Uma referência de grupo de variáveis é uma referência superficial ao grupo de variáveis.
VariableGroupProviderData
VariableValue
WorkflowTask
WorkflowTaskReference

ApprovalExecutionOrder

Enumeração

Ordem de execução de aprovações.

Valor	Description
afterGatesAlways	Aprovações mostradas sempre após a execução de portões.
afterSuccessfulGates	Aprovações mostradas após a execução bem-sucedida de portões.
beforeGates	Aprovações mostradas antes dos portões.

ApprovalOptions

Objeto

Nome	Tipo	Description
autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped	boolean	Especifique se a aprovação pode ser ignorada se o mesmo aprovador aprovou o estágio anterior.
enforceIdentityRevalidation	boolean	Especifique se revalidar a identidade do aprovador antes de concluir a aprovação.
executionOrder	ApprovalExecutionOrder	Ordem de execução de aprovações.
releaseCreatorCanBeApprover	boolean	Especifique se o usuário que solicita uma versão ou implantação deve permitir aprovar.
requiredApproverCount	integer (int32)	O número de aprovações necessárias para avançar na versão. "0" significa todas as aprovações necessárias.
timeoutInMinutes	integer (int32)	Tempo limite de aprovação. O tempo limite padrão de aprovação é de 30 dias. O tempo limite máximo permitido é de 365 dias. '0' significa tempo limite padrão, ou seja, 30 dias.

ApprovalStatus

Enumeração

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

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

ApprovalType

Enumeração

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

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

AuthorizationHeader

Objeto

Nome	Tipo	Description
name	string
value	string

ConditionType

Enumeração

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

Valor	Description
artifact	O tipo de condição é artefato.
environmentState	O tipo de condição é o estado do ambiente.
event	O tipo de condição é evento.
undefined	O tipo de condição é indefinido.

ConfigurationVariableValue

Objeto

Nome	Tipo	Description
allowOverride	boolean	Obtém e define se uma variável pode ser substituída no momento da implantação ou não.
isSecret	boolean	Obtém ou define como variável é segredo ou não.
value	string	Obtém e define o valor da variável de configuração.

DataSourceBindingBase

Objeto

Representa a associação da fonte de dados para a solicitação do ponto de extremidade de serviço.

Nome	Tipo	Description
callbackContextTemplate	string	Formato de paginação compatível com essa fonte de dados (ContinuationToken/SkipTop).
callbackRequiredTemplate	string	Chamadas subsequentes necessárias?
dataSourceName	string	Obtém ou define o nome da fonte de dados.
endpointId	string	Obtém ou define a ID do ponto de extremidade.
endpointUrl	string	Obtém ou define a URL do ponto de extremidade de serviço.
headers	AuthorizationHeader[]	Obtém ou define os cabeçalhos de autorização.
initialContextTemplate	string	Define o valor inicial dos parâmetros de consulta
parameters	object	Obtém ou define os parâmetros da fonte de dados.
requestContent	string	Obtém ou define o corpo da solicitação http
requestVerb	string	Obtém ou define o verbo de solicitação http
resultSelector	string	Obtém ou define o seletor de resultados.
resultTemplate	string	Obtém ou define o modelo de resultado.
target	string	Obtém ou define o destino da fonte de dados.

DeploymentAttempt

Objeto

Nome	Tipo	Description
attempt	integer (int32)	Tentativa de implantação.
deploymentId	integer (int32)	ID da implantação.
hasStarted	boolean	Especifica se a implantação foi iniciada ou não.
id	integer (int32)	ID da implantação.
issues	Issue[]	Todos os problemas relacionados à implantação.
lastModifiedBy	IdentityRef	Identidade que modificou essa implantação pela última vez.
lastModifiedOn	string (date-time)	Hora em que essa implantação foi modificada pela última vez.
operationStatus	DeploymentOperationStatus	Status da operação de implantação.
postDeploymentGates	ReleaseGates	Post deployment gates that executed in this deployment.
preDeploymentGates	ReleaseGates	Portões de pré-implantação executados nesta implantação.
queuedOn	string (date-time)	Quando essa implantação foi enfileirada.
reason	DeploymentReason	Motivo da implantação.
releaseDeployPhases	ReleaseDeployPhase[]	Lista de implantações de versão executadas nesta implantação.
requestedBy	IdentityRef	Identidade que solicitou essa implantação.
requestedFor	IdentityRef	Identidade para essa implantação solicitada.
status	DeploymentStatus	status da implantação.

DeploymentJob

Objeto

Nome	Tipo	Description
job	ReleaseTask	Tarefa pai de todas as tarefas executadas.
tasks	ReleaseTask[]	Lista de tarefas executadas com no trabalho.

DeploymentOperationStatus

Enumeração

Obtém o status da operação da implantação.

Valor	Description
all	O status da operação de implantação é tudo.
approved	O status da operação de implantação é aprovado.
canceled	O status da operação de implantação é cancelado.
cancelling	O status da operação de implantação está sendo cancelado.
deferred	O status da operação de implantação é adiado.
evaluatingGates	O status da operação de implantação é EvaluatingGates.
gateFailed	O status da operação de implantação é GateFailed.
manualInterventionPending	O status da operação de implantação é manualmente pendente.
pending	O status da operação de implantação está pendente.
phaseCanceled	O status da operação de implantação é cancelado em fase.
phaseFailed	O status da operação de implantação falhou em fases.
phaseInProgress	O status da operação de implantação está em fase em andamento.
phasePartiallySucceeded	O status da operação de implantação é parcialmente bem-sucedido.
phaseSucceeded	O status da operação de implantação foi bem-sucedido.
queued	O status da operação de implantação está na fila.
queuedForAgent	O status da operação de implantação está na fila para o agente.
queuedForPipeline	O status da operação de implantação está na fila para o pipeline.
rejected	O status da operação de implantação é rejeitado.
scheduled	O status da operação de implantação está agendado.
undefined	O status da operação de implantação é indefinido.

DeploymentReason

Enumeração

Obtém o motivo da implantação.

Valor	Description
automated	O motivo da implantação é automatizado.
manual	O motivo da implantação é manual.
none	O motivo da implantação não é nenhum.
redeployTrigger	O motivo da implantação é ReimplantarTrigger.
scheduled	O motivo da implantação está agendado.

DeploymentStatus

Enumeração

Obtém o status da implantação.

Valor	Description
all	O status da implantação é tudo.
failed	O status da implantação falhou.
inProgress	O status da implantação está em andamento.
notDeployed	O status da implantação não é implantado.
partiallySucceeded	O status da implantação é parcialmente especificado.
succeeded	O status da implantação foi bem-sucedido.
undefined	O status da implantação é indefinido.

DeployPhase

Objeto

Nome	Tipo	Description
name	string	Obtém e define o nome da fase de implantação.
phaseType	DeployPhaseTypes	Indica o tipo de fase de implantação.
rank	integer (int32)	Obtém e define a classificação da fase de implantação.
refName	string	Obtém e define o nome de referência da fase de implantação.
workflowTasks	WorkflowTask[]	Obtém e define as tarefas de fluxo de trabalho para a fase de implantação.

DeployPhaseStatus

Enumeração

Status da fase.

Valor	Description
canceled	Execução de fase cancelada.
cancelling	A fase está no estado de cancelamento.
failed	Falha na execução da fase.
inProgress	Execução de fase em andamento.
notStarted	Execução de fase não iniciada.
partiallySucceeded	Execução de fase parcialmente bem-sucedida.
skipped	Execução de fase ignorada.
succeeded	Execução de fase bem-sucedida.
undefined	Status da fase não definido.

DeployPhaseTypes

Enumeração

Indica o tipo de fase de implantação.

Valor	Description
agentBasedDeployment	Tipo de fase que contém tarefas executadas no agente.
deploymentGates	Tipo de fase que contém tarefas que atuam como Gates para que a implantação prossira.
machineGroupBasedDeployment	Tipo de fase que contém tarefas executadas em computadores de grupo de implantação.
runOnServer	Tipo de fase que contém tarefas executadas pelo servidor.
undefined	Tipo de fase não definido. Não use isso.

EnvironmentOptions

Objeto

Nome	Tipo	Description
autoLinkWorkItems	boolean	Obtém e define como os workitems de link automático ou não.
badgeEnabled	boolean	Obtém e define como o selo habilitado ou não.
publishDeploymentStatus	boolean	Obtém e define como o status de implantação de publicação ou não.
pullRequestDeploymentEnabled	boolean	Obtém e define como a implantação da solicitação.pull habilitada ou não.

EnvironmentStatus

Enumeração

Obtém o status do ambiente.

Valor	Description
canceled	O ambiente está no estado cancelado.
inProgress	O ambiente está em andamento.
notStarted	O ambiente não está no estado iniciado.
partiallySucceeded	O ambiente está em estado parcialmente bem-sucedido.
queued	O ambiente está em estado de fila.
rejected	O ambiente está em estado rejeitado.
scheduled	O ambiente está em estado agendado.
succeeded	O ambiente está em estado de êxito.
undefined	Status do ambiente não definido.

GateStatus

Enumeração

Status das portas de liberação.

Valor	Description
canceled	A execução do portão foi cancelada.
failed	Falha na execução do portão.
inProgress	O portão está em andamento no momento.
none	O portão não tem o status definido.
pending	O portão está em estado pendente.
succeeded	O portão foi concluído com êxito.

IdentityRef

Objeto

Nome	Tipo	Description
_links	ReferenceLinks	Este 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 em contas e organizações.
directoryAlias	string	Preterido – pode ser recuperado consultando o usuário do Graph referenciado na entrada "self" do dicionário "_links" identityRef
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 "_links" do IdentityRef
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 adiado 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 pré-existentes 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.

IgnoredGate

Objeto

Nome	Tipo	Description
lastModifiedOn	string (date-time)	Obtém a data em que o portão é ignorado pela última vez.
name	string	Nome do portão ignorado.

Issue

Objeto

Nome	Tipo	Description
data	object	Emitir dados.
issueType	string	Tipo de problema, por exemplo, erro, aviso ou informações.
message	string	Mensagem de problema.

ManualIntervention

Objeto

Nome	Tipo	Description
approver	IdentityRef	Obtém ou define a identidade que deve aprovar.
comments	string	Obtém ou define comentários para aprovação.
createdOn	string (date-time)	Obtém a data em que ela foi criada.
id	integer (int32)	Obtém o identificador exclusivo para intervenção manual.
instructions	string	Obtém ou define instruções para aprovação.
modifiedOn	string (date-time)	Obtém a data em que ela foi modificada.
name	string	Obtém ou define o nome.
release	ReleaseShallowReference	Obtém releaseReference para intervenção manual.
releaseDefinition	ReleaseDefinitionShallowReference	Obtém releaseDefinitionReference para intervenção manual.
releaseEnvironment	ReleaseEnvironmentShallowReference	Obtém releaseEnvironmentReference para intervenção manual.
status	ManualInterventionStatus	Obtém ou define o status da intervenção manual.
taskInstanceId	string (uuid)	Obter o identificador da instância de tarefa.
url	string	Obtém a URL para acessar a intervenção manual.

ManualInterventionStatus

Enumeração

Obtém ou define o status da intervenção manual.

Valor	Description
approved	A intervenção manual é aprovada.
canceled	A intervenção manual é cancelada.
pending	A intervenção manual está pendente.
rejected	A intervenção manual é rejeitada.
unknown	A intervenção manual não tem o status definido.

ProcessParameters

Objeto

Nome	Tipo	Description
dataSourceBindings	DataSourceBindingBase[]	Representa a associação da fonte de dados para a solicitação do ponto de extremidade de serviço.
inputs	TaskInputDefinitionBase[]
sourceDefinitions	TaskSourceDefinitionBase[]

ProjectReference

Objeto

Nome	Tipo	Description
id	string (uuid)	Obtém o identificador exclusivo deste campo.
name	string	Obtém o nome do projeto.

ReferenceLinks

Objeto

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

Objeto

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 (int32)	Obtém ou define a tentativa que especifica qual tentativa de implantação pertence.
comments	string	Obtém ou define comentários para aprovação.
createdOn	string (date-time)	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 (int32)	Obtém o identificador exclusivo deste campo.
isAutomated	boolean	Obtém ou define como a aprovação é automatizada ou não.
modifiedOn	string (date-time)	Obtém a data em que ela foi modificada.
rank	integer (int32)	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 (int32)	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

Objeto

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 (date-time)	Hora em que essa aprovação foi criada.
modifiedOn	string (date-time)	Hora em que essa aprovação foi modificada.
revision	integer (int32)	Revisão do histórico de aprovação.

ReleaseCondition

Objeto

Nome	Tipo	Description
conditionType	ConditionType	Obtém ou define o tipo de condição.
name	string	Obtém ou define o nome da condição. por exemplo, "ReleaseStarted".
result	boolean	O resultado da condição de liberação.
value	string	Obtém ou define o valor da condição.

ReleaseDefinitionApprovals

Objeto

Nome	Tipo	Description
approvalOptions	ApprovalOptions	Obtém ou define as opções de aprovação.
approvals	ReleaseDefinitionApprovalStep[]	Obtém ou define as aprovações.

ReleaseDefinitionApprovalStep

Objeto

Nome	Tipo	Description
approver	IdentityRef	Obtém e define o aprovador.
id	integer (int32)	ID da etapa de aprovação ou implantação.
isAutomated	boolean	Indica se a aprovação foi automatizada.
isNotificationOn	boolean	Indica se o conjunto de notificação de aprovação.
rank	integer (int32)	Obtém ou define a classificação da etapa de aprovação.

ReleaseDefinitionGate

Objeto

Nome	Tipo	Description
tasks	WorkflowTask[]	Obtém ou define o fluxo de trabalho de portões.

ReleaseDefinitionGatesOptions

Objeto

Nome	Tipo	Description
isEnabled	boolean	Obtém ou define como os portões habilitados ou não.
minimumSuccessDuration	integer (int32)	Obtém ou define a duração mínima para resultados estáveis após uma avaliação bem-sucedida dos portões.
samplingInterval	integer (int32)	Obtém ou define o tempo entre a reavaliação dos portões.
stabilizationTime	integer (int32)	Obtém ou define o atraso antes da avaliação.
timeout	integer (int32)	Obtém ou define o tempo limite após o qual os portões falham.

ReleaseDefinitionGatesStep

Objeto

Nome	Tipo	Description
gates	ReleaseDefinitionGate[]	Obtém ou define os portões.
gatesOptions	ReleaseDefinitionGatesOptions	Obtém ou define as opções de portão.
id	integer (int32)	ID do ReleaseDefinitionGateStep.

ReleaseDefinitionShallowReference

Objeto

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 (int32)	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.

ReleaseDeployPhase

Objeto

Nome	Tipo	Description
deploymentJobs	DeploymentJob[]	Trabalhos de implantação da fase.
errorLog	string	Logs de erros de execução de fase.
manualInterventions	ManualIntervention[]	Lista de informações de execução de tarefas de intervenção manual em fase.
name	string	Nome da fase.
phaseId	string	ID da fase.
phaseType	DeployPhaseTypes	Tipo da fase.
rank	integer (int32)	Classificação da fase.
runPlanId	string (uuid)	Execute a ID do plano da fase.
startedOn	string (date-time)	Hora de início da fase.
status	DeployPhaseStatus	Status da fase.

ReleaseEnvironment

Objeto

Nome	Tipo	Description
conditions	ReleaseCondition[]	Obtém a lista de condições.
createdOn	string (date-time)	Obtém a data em que ela foi criada.
definitionEnvironmentId	integer (int32)	Obtém a ID do ambiente de definição.
deployPhasesSnapshot	DeployPhase[]	Obtém a lista de instantâneos de fases de implantação.
deploySteps	DeploymentAttempt[]	Obtém as etapas de implantação.
environmentOptions	EnvironmentOptions	Obtém opções de ambiente.
id	integer (int32)	Obtém o identificador exclusivo deste campo.
modifiedOn	string (date-time)	Obtém a data em que ela foi modificada.
name	string	Obtém o nome.
nextScheduledUtcTime	string (date-time)	Obtém a próxima hora UTC agendada.
owner	IdentityRef	Obtém a identidade que é proprietário do ambiente de lançamento.
postApprovalsSnapshot	ReleaseDefinitionApprovals	Obtém a lista de instantâneo de aprovações pós-implantação.
postDeployApprovals	ReleaseApproval[]	Obtém a lista de aprovações pós-implantação.
postDeploymentGatesSnapshot	ReleaseDefinitionGatesStep	Dados de instantâneo de portões de implantação pós-implantação.
preApprovalsSnapshot	ReleaseDefinitionApprovals	Obtém a lista de instantâneos de aprovações de pré-implantação.
preDeployApprovals	ReleaseApproval[]	Obtém a lista de aprovações de pré-implantação.
preDeploymentGatesSnapshot	ReleaseDefinitionGatesStep	Dados de instantâneo de portões de pré-implantação.
processParameters	ProcessParameters	Obtém parâmetros de processo.
rank	integer (int32)	Obtém classificação.
release	ReleaseShallowReference	Obtém a referência de versão que especifica a referência da versão à qual esse ambiente de versão está associado.
releaseCreatedBy	IdentityRef	Obtém a identidade que criou a versão.
releaseDefinition	ReleaseDefinitionShallowReference	Obtém releaseDefinitionReference que especifica a referência da definição de versão à qual esse ambiente de versão está associado.
releaseId	integer (int32)	Obtém a ID da versão.
scheduledDeploymentTime	string (date-time)	Obtém o tempo de implantação de agendamento do ambiente de lançamento.
schedules	ReleaseSchedule[]	Obtém a lista de agendamentos.
status	EnvironmentStatus	Obtém o status do ambiente.
timeToDeploy	number (double)	Obtém tempo para implantar.
triggerReason	string	Obtém o motivo do gatilho.
variableGroups	VariableGroup[]	Obtém a lista de grupos de variáveis.
variables	<string,  ConfigurationVariableValue>	Obtém o dicionário de variáveis.

ReleaseEnvironmentShallowReference

Objeto

Nome	Tipo	Description
_links	ReferenceLinks	Obtém os links para recursos, APIs e exibições relacionados para o ambiente de lançamento.
id	integer (int32)	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.

ReleaseEnvironmentUpdateMetadata

Objeto

Nome	Tipo	Description
comment	string	Obtém ou define o comentário.
scheduledDeploymentTime	string (date-time)	Obtém ou define o tempo de implantação agendado.
status	EnvironmentStatus	Obtém ou define o status do ambiente.
variables	<string,  ConfigurationVariableValue>	Define a lista de variáveis de ambiente a serem substituídas no momento da implantação.

ReleaseGates

Objeto

Nome	Tipo	Description
deploymentJobs	DeploymentJob[]	Contém os detalhes do trabalho de portões de cada avaliação.
id	integer (int32)	ID dos portões de liberação.
ignoredGates	IgnoredGate[]	Lista de portões ignorados.
lastModifiedOn	string (date-time)	A hora da última modificação dos portões.
runPlanId	string (uuid)	Execute a ID do plano dos portões.
stabilizationCompletedOn	string (date-time)	A estabilização dos portões completou a data e a hora.
startedOn	string (date-time)	Hora de início da avaliação dos portões.
status	GateStatus	Status das portas de liberação.
succeedingSince	string (date-time)	Data e hora em que todos os portões foram executados com êxito.

ReleaseSchedule

Objeto

Nome	Tipo	Description
daysToRelease	ScheduleDays	Dias da semana para lançamento.
jobId	string (uuid)	ID do trabalho de definição de trabalho do Team Foundation.
scheduleOnlyWithChanges	boolean	Sinalizador para determinar se esse agendamento só deve ser liberado se o artefato associado tiver sido alterado ou a definição de versão alterada.
startHours	integer (int32)	Hora de fuso horário local a ser iniciada.
startMinutes	integer (int32)	Minuto de fuso horário local para começar.
timeZoneId	string	ID de fuso horário do agendamento de lançamento, como 'UTC'.

ReleaseShallowReference

Objeto

Nome	Tipo	Description
_links	ReferenceLinks	Obtém os links para recursos, APIs e exibições relacionados para a versão.
id	integer (int32)	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.

ReleaseTask

Objeto

Nome	Tipo	Description
agentName	string	Nome do agente no qual a tarefa foi executada.
finishTime	string (date-time)	Hora de término da tarefa de lançamento.
id	integer (int32)	ID da tarefa de versão.
issues	Issue[]	A lista de problemas ocorreu durante a execução da tarefa.
lineCount	integer (int64)	Número de linhas que a tarefa de versão de log tem.
logUrl	string	URL de log da tarefa.
name	string	Nome da tarefa.
percentComplete	integer (int32)	Precent da execução da tarefa.
rank	integer (int32)	Classificação da tarefa de versão.
resultCode	string	Código de resultado da tarefa.
startTime	string (date-time)	ID da tarefa de versão.
status	TaskStatus	Status da tarefa de versão.
task	WorkflowTaskReference	Referência de tarefa de fluxo de trabalho.
timelineRecordId	string (uuid)	ID do registro da linha do tempo da tarefa de versão.

ScheduleDays

Enumeração

Dias da semana para lançamento.

Valor	Description
all	Agendado em todos os dias da semana.
friday	Agendado para sexta-feira.
monday	Agendado para segunda-feira.
none	Dia agendado não definido.
saturday	Agendado para sábado.
sunday	Agendado para domingo.
thursday	Agendado para quinta-feira.
tuesday	Agendado para terça-feira.
wednesday	Agendado para quarta-feira.

TaskInputDefinitionBase

Objeto

Nome	Tipo	Description
aliases	string[]
defaultValue	string
groupName	string
helpMarkDown	string
label	string
name	string
options	object
properties	object
required	boolean
type	string
validation	TaskInputValidation
visibleRule	string

TaskInputValidation

Objeto

Nome	Tipo	Description
expression	string	Expressão condicional
message	string	Mensagem explicando como o usuário pode corrigir se a validação falhar

TaskSourceDefinitionBase

Objeto

Nome	Tipo	Description
authKey	string
endpoint	string
keySelector	string
selector	string
target	string

TaskStatus

Enumeração

Status da tarefa de versão.

Valor	Description
canceled	A execução da tarefa foi cancelada.
failed	Falha na execução da tarefa.
failure	Falha na execução da tarefa.
inProgress	A tarefa está em andamento no momento.
partiallySucceeded	A execução da tarefa foi parcialmente bem-sucedida.
pending	A tarefa está em status pendente.
skipped	A execução da tarefa foi ignorada.
succeeded	A tarefa foi concluída com êxito.
success	A tarefa foi concluída com êxito.
unknown	A tarefa não tem o status definido.

VariableGroup

Objeto

Nome	Tipo	Description
createdBy	IdentityRef	Obtém ou define a identidade que criou.
createdOn	string (date-time)	Obtém a data em que ela foi criada.
description	string	Obtém ou define a descrição.
id	integer (int32)	Obtém o identificador exclusivo deste campo.
isShared	boolean	Indica se um grupo de variáveis é compartilhado com outro projeto ou não.
modifiedBy	IdentityRef	Obtém ou define a identidade que modificou.
modifiedOn	string (date-time)	Obtém a data em que ela foi modificada.
name	string	Obtém ou define o nome.
providerData	VariableGroupProviderData	Obtém ou define dados do provedor.
type	string	Obtém ou define o tipo.
variableGroupProjectReferences	VariableGroupProjectReference[]	todas as referências de projeto em que o grupo de variáveis é compartilhado com outros projetos.
variables	<string,  VariableValue>	Obtém e define o dicionário de variáveis.

VariableGroupProjectReference

Objeto

Uma referência de grupo de variáveis é uma referência superficial ao grupo de variáveis.

Nome	Tipo	Description
description	string	Obtém ou define a descrição do grupo de variáveis.
name	string	Obtém ou define o nome do grupo de variáveis.
projectReference	ProjectReference	Obtém ou define a referência de projeto do grupo de variáveis.

VariableGroupProviderData

Objeto

VariableValue

Objeto

Nome	Tipo	Description
isReadOnly	boolean	Obtém ou define se a variável é somente leitura ou não.
isSecret	boolean	Obtém ou define como a variável é secreta ou não.
value	string	Obtém ou define o valor.

WorkflowTask

Objeto

Nome	Tipo	Description
alwaysRun	boolean	Obtém ou define como a tarefa sempre executada ou não.
condition	string	Obtém ou define a condição da tarefa.
continueOnError	boolean	Obtém ou define como a tarefa continua sendo executada com erro ou não.
definitionType	string	Obtém ou define o tipo de definição de tarefa. Exemplo:- 'Agent', DeploymentGroup', 'Server' ou 'ServerGate'.
enabled	boolean	Obtém ou define como a tarefa habilitada ou não.
environment	object	Obtém ou define as variáveis de ambiente de tarefa.
inputs	object	Obtém ou define as entradas da tarefa.
name	string	Obtém ou define o nome da tarefa.
overrideInputs	object	Obtém ou define as entradas de substituição da tarefa.
refName	string	Obtém ou define o nome de referência da tarefa.
retryCountOnTaskFailure	integer (int32)	Obtém ou define a tarefa retryCount.
taskId	string (uuid)	Obtém ou define a ID da tarefa.
timeoutInMinutes	integer (int32)	Obtém ou define o tempo limite da tarefa.
version	string	Obtém ou define a versão da tarefa.

WorkflowTaskReference

Objeto

Nome	Tipo	Description
id	string (uuid)	Identificador de tarefa.
name	string	Nome da tarefa.
version	string	Versão da tarefa.