Definitions - Create

Service:

Release

API Version:

7.1-preview.4

Criar uma definição de versão

POST https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/definitions?api-version=7.1-preview.4

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
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.4' para usar essa versão da api.

Corpo da solicitação

Nome	Tipo	Description
_links	ReferenceLinks	Obtém os links para recursos, APIs e exibições relacionados para a definição de versão.
artifacts	Artifact[]	Obtém ou define a lista de artefatos.
comment	string	Obtém ou define o comentário.
createdBy	IdentityRef	Obtém ou define a identidade que criou.
createdOn	string	Obtém a data em que ela foi criada.
description	string	Obtém ou define a descrição.
environments	ReleaseDefinitionEnvironment[]	Obtém ou define a lista de ambientes.
id	integer	Obtém o identificador exclusivo da definição de versão.
isDeleted	boolean	Se a definição de versão é excluída.
lastRelease	ReleaseReference	Obtém a referência da última versão.
modifiedBy	IdentityRef	Obtém ou define a identidade que modificou.
modifiedOn	string	Obtém a data em que ela foi modificada.
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.
properties	PropertiesCollection	Obtém ou define propriedades.
releaseNameFormat	string	Obtém ou define o formato do nome da versão.
revision	integer	Obtém o número de revisão.
source	ReleaseDefinitionSource	Obtém ou define a origem da definição de versão.
tags	string[]	Obtém ou define a lista de marcas.
triggers	ReleaseTriggerBase[]	Obtém ou define a lista de gatilhos.
url	string	Obtém a URL da API REST para acessar a definição de versão.
variableGroups	integer[]	Obtém ou define a lista de grupos de variáveis.
variables	<string,  ConfigurationVariableValue>	Obtém ou define o dicionário de variáveis.

Respostas

Nome	Tipo	Description
200 OK	ReleaseDefinition	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_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

Create release definition

Sample Request

HTTP

POST https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/definitions?api-version=7.1-preview.4

{
  "source": "undefined",
  "revision": 1,
  "description": null,
  "createdBy": null,
  "createdOn": "0001-01-01T00:00:00",
  "modifiedBy": null,
  "modifiedOn": "0001-01-01T00:00:00",
  "isDeleted": false,
  "variables": {},
  "variableGroups": [],
  "environments": [
    {
      "id": 0,
      "name": "PROD",
      "variables": {},
      "variableGroups": [],
      "preDeployApprovals": {
        "approvals": [
          {
            "rank": 1,
            "isAutomated": false,
            "isNotificationOn": false,
            "approver": {
              "displayName": null,
              "id": "aeb95c63-4fac-4948-84ce-711b0a9dda97"
            },
            "id": 0
          }
        ]
      },
      "postDeployApprovals": {
        "approvals": [
          {
            "rank": 1,
            "isAutomated": true,
            "isNotificationOn": false,
            "id": 0
          }
        ]
      },
      "deployPhases": [
        {
          "deploymentInput": {
            "parallelExecution": {
              "parallelExecutionType": "none"
            },
            "skipArtifactsDownload": false,
            "artifactsDownloadInput": {},
            "queueId": 15,
            "demands": [],
            "enableAccessToken": false,
            "timeoutInMinutes": 0,
            "jobCancelTimeoutInMinutes": 1,
            "condition": "succeeded()",
            "overrideInputs": {}
          },
          "rank": 1,
          "phaseType": "agentBasedDeployment",
          "name": "Run on agent",
          "workflowTasks": []
        }
      ],
      "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": [],
      "executionPolicy": {
        "concurrencyCount": 0,
        "queueDepthCount": 0
      },
      "schedules": [],
      "retentionPolicy": {
        "daysToKeep": 30,
        "releasesToKeep": 3,
        "retainBuild": true
      },
      "properties": {},
      "preDeploymentGates": {
        "id": 0,
        "gatesOptions": null,
        "gates": []
      },
      "postDeploymentGates": {
        "id": 0,
        "gatesOptions": null,
        "gates": []
      },
      "environmentTriggers": []
    }
  ],
  "artifacts": [],
  "triggers": [],
  "releaseNameFormat": null,
  "tags": [],
  "properties": {},
  "id": 0,
  "name": "Fabrikam-web",
  "projectReference": null,
  "_links": {}
}

Sample Response

Status code:

200

{
  "source": "restApi",
  "revision": 1,
  "description": null,
  "createdBy": {
    "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"
  },
  "createdOn": "2018-12-11T04:56:42.237Z",
  "modifiedBy": {
    "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"
  },
  "modifiedOn": "2018-12-11T04:56:42.237Z",
  "isDeleted": false,
  "variables": {},
  "variableGroups": [],
  "environments": [
    {
      "id": 42,
      "name": "PROD",
      "rank": 1,
      "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"
      },
      "variables": {},
      "variableGroups": [],
      "preDeployApprovals": {
        "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": 124
          }
        ],
        "approvalOptions": {
          "requiredApproverCount": 0,
          "releaseCreatorCanBeApprover": true,
          "autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped": false,
          "enforceIdentityRevalidation": false,
          "timeoutInMinutes": 0,
          "executionOrder": "beforeGates"
        }
      },
      "deployStep": {
        "id": 125
      },
      "postDeployApprovals": {
        "approvals": [
          {
            "rank": 1,
            "isAutomated": true,
            "isNotificationOn": false,
            "id": 126
          }
        ]
      },
      "deployPhases": [
        {
          "deploymentInput": {
            "parallelExecution": {
              "parallelExecutionType": "none"
            },
            "skipArtifactsDownload": false,
            "artifactsDownloadInput": {
              "downloadInputs": []
            },
            "queueId": 15,
            "demands": [],
            "enableAccessToken": false,
            "timeoutInMinutes": 0,
            "jobCancelTimeoutInMinutes": 1,
            "condition": "succeeded()",
            "overrideInputs": {}
          },
          "rank": 1,
          "phaseType": "agentBasedDeployment",
          "name": "Run on agent",
          "refName": null,
          "workflowTasks": []
        }
      ],
      "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": [],
      "executionPolicy": {
        "concurrencyCount": 0,
        "queueDepthCount": 0
      },
      "schedules": [],
      "currentRelease": {
        "id": 0,
        "url": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/releases/0",
        "_links": {}
      },
      "retentionPolicy": {
        "daysToKeep": 30,
        "releasesToKeep": 3,
        "retainBuild": true
      },
      "properties": {},
      "preDeploymentGates": {
        "id": 0,
        "gatesOptions": null,
        "gates": []
      },
      "postDeploymentGates": {
        "id": 0,
        "gatesOptions": null,
        "gates": []
      },
      "environmentTriggers": [],
      "badgeUrl": "https://vsrm.dev.azure.com/fabrikam/_apis/public/Release/badge/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/42/42"
    }
  ],
  "artifacts": [],
  "triggers": [],
  "releaseNameFormat": "",
  "tags": [],
  "properties": {},
  "id": 42,
  "name": "Fabrikam-web",
  "path": "\\",
  "projectReference": null,
  "url": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/42",
  "_links": {
    "self": {
      "href": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/42"
    },
    "web": {
      "href": "https://dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_release?definitionId=42"
    }
  }
}

Definições

Nome	Description
ApprovalExecutionOrder	Aprova a ordem de execução.
ApprovalOptions
Artifact
ArtifactSourceReference
AuthorizationHeader
Condition
ConditionType	Obtém ou define o tipo de condição.
ConfigurationVariableValue
DataSourceBindingBase	Representa a associação da fonte de dados para a solicitação de ponto de extremidade de serviço.
Demand
DeployPhase
DeployPhaseTypes	Indica o tipo de fase de implantação.
EnvironmentExecutionPolicy	Define a política no enfileiramento de ambiente em Release Management fila lateral. Enviaremos ao Gerenciador de Ambiente [criando pré-implantação e outras etapas] somente quando as políticas mencionadas forem atendidas.
EnvironmentOptions
EnvironmentRetentionPolicy
EnvironmentTrigger
EnvironmentTriggerType	Obtém ou define o tipo de gatilho.
IdentityRef
ProcessParameters
ProjectReference
PropertiesCollection	A classe representa um recipiente de propriedades como uma coleção de pares chave-valor. Os valores de todos os tipos primitivos (qualquer tipo com um TypeCode != TypeCode.Object) exceto para DBNull são aceitos. Valores do tipo Byte[], Int32, Double, DateType e String preservam seu tipo, outros primitivos são reajustados como uma Cadeia de Caracteres. Byte[] esperado como cadeia de caracteres codificada em base64.
ReferenceLinks	A classe para representar uma coleção de links de referência REST.
ReleaseDefinition
ReleaseDefinitionApprovals
ReleaseDefinitionApprovalStep
ReleaseDefinitionDeployStep
ReleaseDefinitionEnvironment
ReleaseDefinitionGate
ReleaseDefinitionGatesOptions
ReleaseDefinitionGatesStep
ReleaseDefinitionShallowReference
ReleaseDefinitionSource	Obtém ou define a origem da definição de versão.
ReleaseReason	Obtém o motivo da versão.
ReleaseReference
ReleaseSchedule
ReleaseShallowReference
ReleaseTriggerBase
ReleaseTriggerType	Tipo de gatilho de liberação.
ScheduleDays	Dias da semana a serem lançados.
TaskInputDefinitionBase
TaskInputValidation
TaskSourceDefinitionBase
WorkflowTask

ApprovalExecutionOrder

Aprova a ordem de execução.

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

ApprovalOptions

Nome	Tipo	Description
autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped	boolean	Especifique se a aprovação poderá ser ignorada se o mesmo aprovador aprovar o estágio anterior.
enforceIdentityRevalidation	boolean	Especifique se revalidar a identidade do aprovador antes de concluir a aprovação.
executionOrder	ApprovalExecutionOrder	Aprova a ordem de execução.
releaseCreatorCanBeApprover	boolean	Especifique se o usuário que solicita uma versão ou implantação deve permitir o aprovador.
requiredApproverCount	integer	O número de aprovações necessárias para avançar na versão. "0" significa todas as aprovações necessárias.
timeoutInMinutes	integer	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.

Artifact

Nome	Tipo	Description
alias	string	Obtém ou define o alias.
definitionReference	<string,  ArtifactSourceReference>	Obtém ou define a referência de definição. por exemplo, {"project":{"id":"fed755ea-49c5-4399-acea-fd5b5aaa90a6c", "name":"myProject"},"definition":{"id":"1","name":"mybuildDefinition"},"connection":{"id":"1","name":"myConnection"}}.
isPrimary	boolean	Indica se o artefato é primário ou não.
isRetained	boolean	Indica se o artefato é retido por versão ou não.
type	string	Obtém ou define o tipo. Ele pode ter valor como 'Build', 'Jenkins', 'GitHub', 'Nuget', 'Team Build (externo)', 'ExternalTFSBuild', 'Git', 'TFVC', 'ExternalTfsXamlBuild'.

ArtifactSourceReference

Nome	Tipo	Description
id	string	ID da origem do artefato.
name	string	Nome da origem do artefato.

AuthorizationHeader

Nome	Tipo	Description
name	string
value	string

Condition

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'.
value	string	Obtém ou define o valor da condição.

ConditionType

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

Nome	Tipo	Description
artifact	string	O tipo de condição é artefato.
environmentState	string	O tipo de condição é o estado do ambiente.
event	string	O tipo de condição é event.
undefined	string	O tipo de condição é indefinido.

ConfigurationVariableValue

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

Representa a associação da fonte de dados para a solicitação de 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 para a 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.

Demand

Nome	Tipo	Description
name	string	Obtém e define o nome da demanda.
value	string	Obtém e define o valor da demanda.

DeployPhase

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

DeployPhaseTypes

Indica o tipo de fase de implantação.

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

EnvironmentExecutionPolicy

Define a política no enfileiramento de ambiente em Release Management fila lateral. Enviaremos ao Gerenciador de Ambiente [criando pré-implantação e outras etapas] somente quando as políticas mencionadas forem atendidas.

Nome	Tipo	Description
concurrencyCount	integer	Essa política decide quantos ambientes seriam com o Gerenciador de Ambiente.
queueDepthCount	integer	Profundidade da fila na tabela EnvironmentQueue, essa tabela mantém as entradas de ambiente até que o Gerenciador de Ambiente esteja livre [de acordo com sua política] para usar outro ambiente para execução.

EnvironmentOptions

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 a implantação de publicação status ou não.
pullRequestDeploymentEnabled	boolean	Obtém e define como a implantação.pull request habilitada ou não.

EnvironmentRetentionPolicy

Nome	Tipo	Description
daysToKeep	integer	Obtém e define o número de dias para manter o ambiente.
releasesToKeep	integer	Obtém e define o número de versões a serem mantidas.
retainBuild	boolean	Obtém e define como o build a ser retido ou não.

EnvironmentTrigger

Nome	Tipo	Description
definitionEnvironmentId	integer	ID do ambiente de definição na qual esse gatilho se aplica.
releaseDefinitionId	integer	ID releaseDefinition na qual esse gatilho se aplica.
triggerContent	string	Obtém ou define o conteúdo do gatilho.
triggerType	EnvironmentTriggerType	Obtém ou define o tipo de gatilho.

EnvironmentTriggerType

Obtém ou define o tipo de gatilho.

Nome	Tipo	Description
deploymentGroupRedeploy	string	O tipo de gatilho de ambiente é reimplantação do grupo de implantação.
rollbackRedeploy	string	O tipo de gatilho de ambiente é Reversão.
undefined	string	Tipo de gatilho de ambiente indefinido.

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.

ProcessParameters

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

ProjectReference

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

PropertiesCollection

A classe representa um recipiente de propriedades como uma coleção de pares chave-valor. Os valores de todos os tipos primitivos (qualquer tipo com um TypeCode != TypeCode.Object) exceto para DBNull são aceitos. Valores do tipo Byte[], Int32, Double, DateType e String preservam seu tipo, outros primitivos são reajustados como uma Cadeia de Caracteres. Byte[] esperado como cadeia de caracteres codificada em base64.

Nome	Tipo	Description
count	integer	A contagem de propriedades na coleção.
item	object
keys	string[]	O conjunto de chaves na coleção.
values	string[]	O conjunto de valores na coleção.

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.

ReleaseDefinition

Nome	Tipo	Description
_links	ReferenceLinks	Obtém os links para recursos, APIs e exibições relacionados para a definição de versão.
artifacts	Artifact[]	Obtém ou define a lista de artefatos.
comment	string	Obtém ou define o comentário.
createdBy	IdentityRef	Obtém ou define a identidade que criou.
createdOn	string	Obtém a data em que ela foi criada.
description	string	Obtém ou define a descrição.
environments	ReleaseDefinitionEnvironment[]	Obtém ou define a lista de ambientes.
id	integer	Obtém o identificador exclusivo da definição de versão.
isDeleted	boolean	Se a definição de versão é excluída.
lastRelease	ReleaseReference	Obtém a referência da última versão.
modifiedBy	IdentityRef	Obtém ou define a identidade que modificou.
modifiedOn	string	Obtém a data em que ela foi modificada.
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.
properties	PropertiesCollection	Obtém ou define propriedades.
releaseNameFormat	string	Obtém ou define o formato do nome da versão.
revision	integer	Obtém o número de revisão.
source	ReleaseDefinitionSource	Obtém ou define a origem da definição de versão.
tags	string[]	Obtém ou define a lista de marcas.
triggers	ReleaseTriggerBase[]	Obtém ou define a lista de gatilhos.
url	string	Obtém a URL da API REST para acessar a definição de versão.
variableGroups	integer[]	Obtém ou define a lista de grupos de variáveis.
variables	<string,  ConfigurationVariableValue>	Obtém ou define o dicionário de variáveis.

ReleaseDefinitionApprovals

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

Nome	Tipo	Description
approver	IdentityRef	Obtém e define o aprovador.
id	integer	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	Obtém ou define a classificação da etapa de aprovação.

ReleaseDefinitionDeployStep

Nome	Tipo	Description
id	integer	ID da etapa de aprovação ou implantação.
tasks	WorkflowTask[]	A lista de etapas para essa definição.

ReleaseDefinitionEnvironment

Nome	Tipo	Description
badgeUrl	string	Obtém ou define o BadgeUrl. BadgeUrl será usado quando o Selo for habilitado no Ambiente de Definição de Versão.
conditions	Condition[]	Obtém ou define as condições de ambiente.
currentRelease	ReleaseShallowReference	Obtém ou define a referência de versão atual.
demands	Demand[]	Obtém ou define as demandas.
deployPhases	DeployPhase[]	Obtém ou define as fases de implantação do ambiente.
deployStep	ReleaseDefinitionDeployStep	Obtém ou define a implantação.
environmentOptions	EnvironmentOptions	Obtém ou define as opções de ambiente.
environmentTriggers	EnvironmentTrigger[]	Obtém ou define os gatilhos no ambiente.
executionPolicy	EnvironmentExecutionPolicy	Obtém ou define a política de execução do ambiente.
id	integer	Obtém e define a ID do ReleaseDefinitionEnvironment.
name	string	Obtém e define o nome do ReleaseDefinitionEnvironment.
owner	IdentityRef	Obtém e define o Proprietário do ReleaseDefinitionEnvironment.
postDeployApprovals	ReleaseDefinitionApprovals	Obtém ou define as aprovações pós-implantação.
postDeploymentGates	ReleaseDefinitionGatesStep	Obtém ou define os portões pós-implantação.
preDeployApprovals	ReleaseDefinitionApprovals	Obtém ou define as aprovações de pré-implantação.
preDeploymentGates	ReleaseDefinitionGatesStep	Obtém ou define os portões de pré-implantação.
processParameters	ProcessParameters	Obtém ou define os parâmetros do processo de ambiente.
properties	PropertiesCollection	Obtém ou define as propriedades no ambiente.
queueId	integer	Obtém ou define a ID da fila.
rank	integer	Obtém e define a classificação de ReleaseDefinitionEnvironment.
retentionPolicy	EnvironmentRetentionPolicy	Obtém ou define a política de retenção de ambiente.
schedules	ReleaseSchedule[]	Obtém ou define os agendamentos
variableGroups	integer[]	Obtém ou define os grupos de variáveis.
variables	<string,  ConfigurationVariableValue>	Obtém e define as variáveis.

ReleaseDefinitionGate

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

ReleaseDefinitionGatesOptions

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

ReleaseDefinitionGatesStep

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	ID do ReleaseDefinitionGateStep.

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.

ReleaseDefinitionSource

Obtém ou define a origem da definição de versão.

Nome	Tipo	Description
ibiza	string	Indica ReleaseDefinition criado de Ibiza.
portalExtensionApi	string	Indica ReleaseDefinition criado a partir da API PortalExtension.
restApi	string	Indica ReleaseDefinition criado usando a API REST.
undefined	string	Indica a fonte ReleaseDefinition não definida.
userInterface	string	Indica ReleaseDefinition criado usando a interface do usuário.

ReleaseReason

Obtém o motivo da versão.

Nome	Tipo	Description
continuousIntegration	string	Indica a versão disparada pela integração contínua.
manual	string	Indica a versão disparada manualmente.
none	string	Indica o motivo disparado pela versão não definido.
pullRequest	string	Indica a versão disparada por PullRequest.
schedule	string	Indica a versão disparada pelo agendamento.

ReleaseReference

Nome	Tipo	Description
_links	ReferenceLinks	Obtém links para acessar a versão.
artifacts	Artifact[]	Obtém a lista de artefatos.
createdBy	IdentityRef	Obtém a identidade que criou a versão.
createdOn	string	Obtém a data em que esta versão foi criada.
description	string	Obtém a descrição.
id	integer	ID da Versão.
modifiedBy	IdentityRef	Obtém a identidade que modificou a versão.
name	string	Obtém o nome da versão.
reason	ReleaseReason	Obtém o motivo da versão.
releaseDefinition	ReleaseDefinitionShallowReference	Obtém a referência superficial da definição de versão.

ReleaseSchedule

Nome	Tipo	Description
daysToRelease	ScheduleDays	Dias da semana a serem lançados.
jobId	string	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	Hora de fuso horário local para iniciar.
startMinutes	integer	Minuto de fuso horário local para iniciar.
timeZoneId	string	ID de fuso horário do agendamento de lançamento, como 'UTC'.

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.

ReleaseTriggerBase

Nome	Tipo	Description
triggerType	ReleaseTriggerType	Tipo de gatilho de liberação.

ReleaseTriggerType

Tipo de gatilho de liberação.

Nome	Tipo	Description
artifactSource	string	Gatilho de versão baseado em artefato.
containerImage	string	Gatilho de versão baseado em imagem de contêiner.
package	string	Gatilho de versão baseado em pacote.
pullRequest	string	Gatilho de versão baseado em solicitação de pull.
schedule	string	Gatilho de versão baseado em agendamento.
sourceRepo	string	Gatilho de versão baseado em repositório de origem.
undefined	string	Tipo de gatilho de liberação não definido.

ScheduleDays

Dias da semana a serem lançados.

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

TaskInputDefinitionBase

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

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

TaskSourceDefinitionBase

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

WorkflowTask

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	Obtém ou define a tarefa retryCount.
taskId	string	Obtém ou define a ID da tarefa.
timeoutInMinutes	integer	Obtém ou define o tempo limite da tarefa.
version	string	Obtém ou define a versão da tarefa.