Definitions - Create

Referência

Serviço:: Release

Versão da API:: 7.1

Criar uma definição de versão

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

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' 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 (date-time)	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 (int32)	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 (date-time)	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 (int32)	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[] (int32)	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

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

Create release definition

Solicitação de exemplo

HTTP

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

{
  "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": {}
}

Resposta de exemplo

Código de status:: 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	Ordem de execução de aprovações.
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 do 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 na fila lateral do Gerenciamento de Lançamentos. Enviaremos ao Executor do 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. Valores de todos os tipos primitivos (qualquer tipo com um `TypeCode != TypeCode.Object`), exceto `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 liberação.
ReleaseReference
ReleaseSchedule
ReleaseShallowReference
ReleaseTriggerBase
ReleaseTriggerType	Tipo de gatilho de liberação.
ScheduleDays	Dias da semana para lançamento.
TaskInputDefinitionBase
TaskInputValidation
TaskSourceDefinitionBase
WorkflowTask

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.

Artifact

Objeto

Nome	Tipo	Description
alias	string	Obtém ou define alias.
definitionReference	<string, ArtifactSourceReference>	Obtém ou define a referência de definição. por exemplo, {"project":{"id":"fed755ea-49c5-4399-acea-fd5b5aa90a6c", "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

Objeto

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

AuthorizationHeader

Objeto

Nome	Tipo	Description
name	string
value	string

Condition

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

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.

Demand

Objeto

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

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.

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.

EnvironmentExecutionPolicy

Objeto

Define a política no enfileiramento de ambiente na fila lateral do Gerenciamento de Lançamentos. Enviaremos ao Executor do Ambiente [criando pré-implantação e outras etapas] somente quando as políticas mencionadas forem atendidas.

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

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.

EnvironmentRetentionPolicy

Objeto

Nome	Tipo	Description
daysToKeep	integer (int32)	Obtém e define o número de dias para manter o ambiente.
releasesToKeep	integer (int32)	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

Objeto

Nome	Tipo	Description
definitionEnvironmentId	integer (int32)	ID do ambiente de definição na qual esse gatilho é aplicável.
releaseDefinitionId	integer (int32)	ID de 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

Enumeração

Obtém ou define o tipo de gatilho.

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

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.

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.

PropertiesCollection

Objeto

A classe representa um recipiente de propriedades como uma coleção de pares chave-valor. Valores de todos os tipos primitivos (qualquer tipo com um TypeCode != TypeCode.Object), exceto 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 (int32)	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

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.

ReleaseDefinition

Objeto

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 (date-time)	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 (int32)	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 (date-time)	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 (int32)	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[] (int32)	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

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.

ReleaseDefinitionDeployStep

Objeto

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

ReleaseDefinitionEnvironment

Objeto

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 o passo de 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 (int32)	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 (int32)	Obtém ou define a ID da fila.
rank	integer (int32)	Obtém e define a classificação do 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[] (int32)	Obtém ou define os grupos de variáveis.
variables	<string, ConfigurationVariableValue>	Obtém e define as variáveis.

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.

ReleaseDefinitionSource

Enumeração

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

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

ReleaseReason

Enumeração

Obtém o motivo da liberação.

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

ReleaseReference

Objeto

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 (date-time)	Obtém a data em que esta versão foi criada.
description	string	Obtém a descrição.
id	integer (int32)	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 liberação.
releaseDefinition	ReleaseDefinitionShallowReference	Obtém referência superficial de definição de versão.

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.

ReleaseTriggerBase

Objeto

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

ReleaseTriggerType

Enumeração

Tipo de gatilho de liberação.

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

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

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.

Partilhar via

Definitions - Create

Parâmetros de URI

Corpo da solicitação

Respostas

Segurança

oauth2

Escopos

Exemplos

Create release definition

Solicitação de exemplo

Resposta de exemplo

Definições

ApprovalExecutionOrder

ApprovalOptions

Artifact

ArtifactSourceReference

AuthorizationHeader

Condition

ConditionType

ConfigurationVariableValue

DataSourceBindingBase

Demand

DeployPhase

DeployPhaseTypes

EnvironmentExecutionPolicy

EnvironmentOptions

EnvironmentRetentionPolicy

EnvironmentTrigger

EnvironmentTriggerType

IdentityRef

ProcessParameters

ProjectReference

PropertiesCollection

ReferenceLinks

ReleaseDefinition

ReleaseDefinitionApprovals

ReleaseDefinitionApprovalStep

ReleaseDefinitionDeployStep

ReleaseDefinitionEnvironment

ReleaseDefinitionGate

ReleaseDefinitionGatesOptions

ReleaseDefinitionGatesStep

ReleaseDefinitionShallowReference

ReleaseDefinitionSource

ReleaseReason

ReleaseReference

ReleaseSchedule

ReleaseShallowReference

ReleaseTriggerBase

ReleaseTriggerType

ScheduleDays

TaskInputDefinitionBase

TaskInputValidation

TaskSourceDefinitionBase

WorkflowTask