Definitions - List
Obtenha uma lista de definições de versão.
GET https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/definitions?api-version=5.0
GET https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/definitions?searchText={searchText}&$expand={$expand}&artifactType={artifactType}&artifactSourceId={artifactSourceId}&$top={$top}&continuationToken={continuationToken}&queryOrder={queryOrder}&path={path}&isExactNameMatch={isExactNameMatch}&tagFilter={tagFilter}&propertyFilters={propertyFilters}&definitionIdFilter={definitionIdFilter}&isDeleted={isDeleted}&api-version=5.0
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 '5.0' para usar essa versão da api. |
$expand
|
query |
As propriedades que devem ser expandidas na lista de definições de versão. |
||
$top
|
query |
integer int32 |
Número de definições de versão a serem obtidos. |
|
artifact
|
query |
string |
As definições de versão com o artifactSourceId fornecido serão retornadas. Por exemplo, para compilação seria {projectGuid}:{BuildDefinitionId}, para Jenkins seria {JenkinsConnectionId}:{JenkinsDefinitionId}, para TfsOnPrem seria {TfsOnPremConnectionId}:{ProjectName}:{TfsOnPremDefinitionId}. Para artefatos de terceiros, por exemplo, TeamCity, BitBucket, você pode referir 'uniqueSourceIdentifier' dentro de vss-extension.json em https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensions. |
|
artifact
|
query |
string |
As definições de versão com o artifactType fornecido serão retornadas. Os valores podem ser Build, Jenkins, GitHub, Nuget, Team Build (externo), ExternalTFSBuild, Git, TFVC, ExternalTfsXamlBuild. |
|
continuation
|
query |
string |
Obtém as definições de versão após o token de continuação fornecido. |
|
definition
|
query |
string array (string) |
Uma lista delimitada por vírgulas de definições de versão a serem recuperadas. |
|
is
|
query |
boolean |
'true' para obter definições de versão que foram excluídas. O padrão é 'false' |
|
is
|
query |
boolean |
'true', para obter as definições de versão com correspondência exata, conforme especificado em searchText. O padrão é 'false'. |
|
path
|
query |
string |
Obtém as definições de versão no caminho especificado. |
|
property
|
query |
string array (string) |
Uma lista delimitada por vírgulas de propriedades estendidas a serem recuperadas. Se definido, as Definições de Versão retornadas conterão valores para as IDs de propriedade especificadas (se existirem). Se não estiver definido, as propriedades não serão incluídas. Observe que isso não filtrará nenhuma Definição de Versão dos resultados, independentemente de ter uma propriedade definida ou não. |
|
query
|
query |
Obtém os resultados na ordem definida. O padrão é 'IdAscending'. |
||
search
|
query |
string |
Obtenha definições de versão com nomes que contêm searchText. |
|
tag
|
query |
string array (string) |
Uma lista delimitada por vírgulas de marcas. Somente definições de versão com essas marcas serão retornadas. |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
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 | Concede a capacidade de ler artefatos de versão, incluindo versões, definições de versão e ambiente de versão. |
Exemplos
With artifacts details expanded |
With environments details expanded |
Sample Request
GET https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/release/definitions?api-version=5.0
Sample Response
{
"count": 1,
"value": [
{
"source": "userInterface",
"id": 1,
"revision": 3,
"name": "MyShuttle.CD",
"description": null,
"createdBy": {
"id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"displayName": "Chuck Reinhart",
"uniqueName": "fabfiber@outlook.com",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
},
"createdOn": "2017-05-31T16:39:04.883Z",
"modifiedBy": {
"id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"displayName": "Chuck Reinhart",
"uniqueName": "fabfiber@outlook.com",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
},
"modifiedOn": "2017-05-31T16:39:58.06Z",
"lastRelease": {
"id": 14,
"name": "Release-14",
"artifacts": [],
"webAccessUri": null,
"_links": {},
"description": "",
"releaseDefinition": {
"id": 1,
"_links": {}
},
"createdOn": "2017-06-01T09:42:15.273Z",
"createdBy": {
"id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"displayName": "Chuck Reinhart",
"uniqueName": "fabfiber@outlook.com",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
},
"modifiedBy": null,
"reason": "none"
},
"path": "\\",
"variableGroups": null,
"releaseNameFormat": "Release-$(rev:r)",
"url": "https://https://vsrm.dev.azure.com/fabrikamd07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1",
"_links": {
"self": {
"href": "https://https://vsrm.dev.azure.com/fabrikamd07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1"
},
"web": {
"href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?definitionId=1"
}
},
"properties": {}
}
]
}
With artifacts details expanded
Sample Request
GET https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/release/definitions?$expand=Artifacts&api-version=5.0
Sample Response
{
"count": 1,
"value": [
{
"source": "userInterface",
"id": 1,
"revision": 3,
"name": "MyShuttle.CD",
"description": null,
"createdBy": {
"id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"displayName": "Chuck Reinhart",
"uniqueName": "fabfiber@outlook.com",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
},
"createdOn": "2017-05-31T16:39:04.883Z",
"modifiedBy": {
"id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"displayName": "Chuck Reinhart",
"uniqueName": "fabfiber@outlook.com",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
},
"modifiedOn": "2017-05-31T16:39:58.06Z",
"lastRelease": {
"id": 14,
"name": "Release-14",
"artifacts": [],
"webAccessUri": null,
"_links": {},
"description": "",
"releaseDefinition": {
"id": 1,
"_links": {}
},
"createdOn": "2017-06-01T09:42:15.273Z",
"createdBy": {
"id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"displayName": "Chuck Reinhart",
"uniqueName": "fabfiber@outlook.com",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
},
"modifiedBy": null,
"reason": "none"
},
"path": "\\",
"variableGroups": null,
"artifacts": [],
"releaseNameFormat": "Release-$(rev:r)",
"url": "https://https://vsrm.dev.azure.com/fabrikamd07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1",
"_links": {
"self": {
"href": "https://https://vsrm.dev.azure.com/fabrikamd07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1"
},
"web": {
"href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?definitionId=1"
}
},
"properties": {}
}
]
}
With environments details expanded
Sample Request
GET https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/release/definitions?$expand=Environments&api-version=5.0
Sample Response
{
"count": 1,
"value": [
{
"source": "userInterface",
"id": 1,
"revision": 3,
"name": "MyShuttle.CD",
"description": null,
"createdBy": {
"id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"displayName": "Chuck Reinhart",
"uniqueName": "fabfiber@outlook.com",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
},
"createdOn": "2017-05-31T16:39:04.883Z",
"modifiedBy": {
"id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"displayName": "Chuck Reinhart",
"uniqueName": "fabfiber@outlook.com",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
},
"modifiedOn": "2017-05-31T16:39:58.06Z",
"lastRelease": {
"id": 14,
"name": "Release-14",
"artifacts": [],
"webAccessUri": null,
"_links": {},
"description": "",
"releaseDefinition": {
"id": 1,
"_links": {}
},
"createdOn": "2017-06-01T09:42:15.273Z",
"createdBy": {
"id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"displayName": "Chuck Reinhart",
"uniqueName": "fabfiber@outlook.com",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
},
"modifiedBy": null,
"reason": "none"
},
"path": "\\",
"variableGroups": null,
"environments": [
{
"id": 1,
"name": "Dev",
"rank": 1,
"schedules": [],
"retentionPolicy": {
"daysToKeep": 30,
"releasesToKeep": 3,
"retainBuild": true
}
},
{
"id": 2,
"name": "QA",
"rank": 2,
"schedules": [],
"retentionPolicy": {
"daysToKeep": 30,
"releasesToKeep": 3,
"retainBuild": true
}
},
{
"id": 3,
"name": "PPE",
"rank": 3,
"schedules": [],
"retentionPolicy": {
"daysToKeep": 30,
"releasesToKeep": 3,
"retainBuild": true
}
},
{
"id": 4,
"name": "PROD",
"rank": 4,
"schedules": [],
"retentionPolicy": {
"daysToKeep": 30,
"releasesToKeep": 3,
"retainBuild": true
}
}
],
"releaseNameFormat": "Release-$(rev:r)",
"retentionPolicy": {
"daysToKeep": 30
},
"url": "https://https://vsrm.dev.azure.com/fabrikamd07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1",
"_links": {
"self": {
"href": "https://https://vsrm.dev.azure.com/fabrikamd07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1"
},
"web": {
"href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?definitionId=1"
}
},
"properties": {}
}
]
}
Definições
Nome | Description |
---|---|
Approval |
|
Approval |
|
Artifact | |
Artifact |
|
Authorization |
|
Condition | |
Condition |
Obtém ou define o tipo de condição. |
Configuration |
|
Data |
Representa a associação da fonte de dados para a solicitação de ponto de extremidade de serviço. |
Demand | |
Deploy |
|
Deploy |
|
Environment |
Define a política no enfileiramento de ambiente em Release Management fila lateral. Enviaremos ao Executor de Ambiente [criando pré-implantação e outras etapas] somente quando as políticas mencionadas forem atendidas. |
Environment |
|
Environment |
|
Environment |
|
Environment |
|
Identity |
|
Process |
|
Project |
|
Properties |
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 |
Reference |
A classe para representar uma coleção de links de referência REST. |
Release |
|
Release |
|
Release |
|
Release |
|
Release |
|
Release |
As propriedades que devem ser expandidas na lista de definições de versão. |
Release |
|
Release |
|
Release |
|
Release |
Obtém os resultados na ordem definida. O padrão é 'IdAscending'. |
Release |
|
Release |
Obtém ou define a origem da definição de versão. |
Release |
Obtém o motivo da liberação. |
Release |
|
Release |
|
Release |
|
Release |
|
Release |
|
Schedule |
Dias da semana para lançamento |
Task |
|
Task |
|
Task |
|
Workflow |
ApprovalExecutionOrder
Nome | Tipo | Description |
---|---|---|
afterGatesAlways |
string |
|
afterSuccessfulGates |
string |
|
beforeGates |
string |
ApprovalOptions
Nome | Tipo | Description |
---|---|---|
autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped |
boolean |
|
enforceIdentityRevalidation |
boolean |
|
executionOrder | ||
releaseCreatorCanBeApprover |
boolean |
|
requiredApproverCount |
integer |
|
timeoutInMinutes |
integer |
Artifact
Nome | Tipo | Description |
---|---|---|
alias |
string |
Obtém ou define o alias. |
definitionReference |
<string,
Artifact |
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 |
Obtém ou define como artefato é primário ou não. |
isRetained |
boolean |
|
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 |
|
name |
string |
AuthorizationHeader
Nome | Tipo | Description |
---|---|---|
name |
string |
|
value |
string |
Condition
Nome | Tipo | Description |
---|---|---|
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 ou 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 ou 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 |
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. |
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 |
|
value |
string |
DeployPhase
Nome | Tipo | Description |
---|---|---|
name |
string |
|
phaseType | ||
rank |
integer |
|
refName |
string |
|
workflowTasks |
DeployPhaseTypes
Nome | Tipo | Description |
---|---|---|
agentBasedDeployment |
string |
|
deploymentGates |
string |
Tipo de fase que contém tarefas que atuam como Portões para que a implantação avance. |
machineGroupBasedDeployment |
string |
|
runOnServer |
string |
|
undefined |
string |
EnvironmentExecutionPolicy
Define a política no enfileiramento de ambiente em Release Management fila lateral. Enviaremos ao Executor 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 Executor de Ambiente. |
queueDepthCount |
integer |
Profundidade da fila na tabela EnvironmentQueue, essa tabela mantém as entradas de ambiente até que o Environment Runner esteja livre [de acordo com sua política] para usar outro ambiente para execução. |
EnvironmentOptions
Nome | Tipo | Description |
---|---|---|
autoLinkWorkItems |
boolean |
|
badgeEnabled |
boolean |
|
emailNotificationType |
string |
|
emailRecipients |
string |
|
enableAccessToken |
boolean |
|
publishDeploymentStatus |
boolean |
|
pullRequestDeploymentEnabled |
boolean |
|
skipArtifactsDownload |
boolean |
|
timeoutInMinutes |
integer |
EnvironmentRetentionPolicy
Nome | Tipo | Description |
---|---|---|
daysToKeep |
integer |
|
releasesToKeep |
integer |
|
retainBuild |
boolean |
EnvironmentTrigger
Nome | Tipo | Description |
---|---|---|
definitionEnvironmentId |
integer |
|
releaseDefinitionId |
integer |
|
triggerContent |
string |
|
triggerType |
EnvironmentTriggerType
Nome | Tipo | Description |
---|---|---|
deploymentGroupRedeploy |
string |
|
rollbackRedeploy |
string |
|
undefined |
string |
IdentityRef
Nome | Tipo | Description |
---|---|---|
_links |
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 do grafo entre contas e organizações. |
directoryAlias |
string |
|
displayName |
string |
Este é 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 |
|
inactive |
boolean |
|
isAadIdentity |
boolean |
|
isContainer |
boolean |
|
isDeletedInOrigin |
boolean |
|
profileUrl |
string |
|
uniqueName |
string |
|
url |
string |
Essa URL é a rota completa para o recurso de origem desta entidade de grafo. |
ProcessParameters
Nome | Tipo | Description |
---|---|---|
dataSourceBindings |
Representa a associação da fonte de dados para a solicitação de ponto de extremidade de serviço. |
|
inputs | ||
sourceDefinitions |
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. 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 |
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 |
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 |
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 da versão é excluída. |
lastRelease |
Obtém a referência da última versão. |
|
modifiedBy |
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 |
Obtém ou define a referência do projeto. |
|
properties |
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 |
Obtém ou define a origem da definição de versão. |
|
tags |
string[] |
Obtém ou define a lista de marcas. |
triggers |
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,
Configuration |
Obtém ou define o dicionário de variáveis. |
ReleaseDefinitionApprovals
Nome | Tipo | Description |
---|---|---|
approvalOptions | ||
approvals |
ReleaseDefinitionApprovalStep
Nome | Tipo | Description |
---|---|---|
approver | ||
id |
integer |
|
isAutomated |
boolean |
|
isNotificationOn |
boolean |
|
rank |
integer |
ReleaseDefinitionDeployStep
Nome | Tipo | Description |
---|---|---|
id |
integer |
|
tasks |
A lista de etapas para essa definição. |
ReleaseDefinitionEnvironment
Nome | Tipo | Description |
---|---|---|
badgeUrl |
string |
|
conditions | ||
currentRelease | ||
demands |
Demand[] |
|
deployPhases | ||
deployStep | ||
environmentOptions | ||
environmentTriggers | ||
executionPolicy |
Define a política no enfileiramento de ambiente em Release Management fila lateral. Enviaremos ao Executor de Ambiente [criando pré-implantação e outras etapas] somente quando as políticas mencionadas forem atendidas. |
|
id |
integer |
|
name |
string |
|
owner | ||
postDeployApprovals | ||
postDeploymentGates | ||
preDeployApprovals | ||
preDeploymentGates | ||
processParameters | ||
properties |
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 |
|
queueId |
integer |
|
rank |
integer |
|
retentionPolicy | ||
schedules | ||
variableGroups |
integer[] |
|
variables |
<string,
Configuration |
ReleaseDefinitionExpands
As propriedades que devem ser expandidas na lista de definições de versão.
Nome | Tipo | Description |
---|---|---|
artifacts |
string |
|
environments |
string |
|
lastRelease |
string |
|
none |
string |
|
tags |
string |
|
triggers |
string |
|
variables |
string |
ReleaseDefinitionGate
Nome | Tipo | Description |
---|---|---|
tasks |
ReleaseDefinitionGatesOptions
Nome | Tipo | Description |
---|---|---|
isEnabled |
boolean |
|
minimumSuccessDuration |
integer |
|
samplingInterval |
integer |
|
stabilizationTime |
integer |
|
timeout |
integer |
ReleaseDefinitionGatesStep
Nome | Tipo | Description |
---|---|---|
gates | ||
gatesOptions | ||
id |
integer |
ReleaseDefinitionQueryOrder
Obtém os resultados na ordem definida. O padrão é 'IdAscending'.
Nome | Tipo | Description |
---|---|---|
idAscending |
string |
|
idDescending |
string |
|
nameAscending |
string |
|
nameDescending |
string |
ReleaseDefinitionShallowReference
Nome | Tipo | Description |
---|---|---|
_links |
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 |
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 |
|
portalExtensionApi |
string |
|
restApi |
string |
|
undefined |
string |
|
userInterface |
string |
ReleaseReason
Obtém o motivo da liberação.
Nome | Tipo | Description |
---|---|---|
continuousIntegration |
string |
|
manual |
string |
|
none |
string |
|
pullRequest |
string |
|
schedule |
string |
ReleaseReference
Nome | Tipo | Description |
---|---|---|
_links |
Obtém links para acessar a versão. |
|
artifacts |
Artifact[] |
Obtém a lista de artefatos. |
createdBy |
Obtém a identidade que criou. |
|
createdOn |
string |
Obtém a data em que ela foi criada. |
description |
string |
Obtém a descrição. |
id |
integer |
Obtém o identificador exclusivo desse campo. |
modifiedBy |
Obtém a identidade que modificou. |
|
name |
string |
Obtém o nome da versão. |
reason |
Obtém o motivo da liberação. |
|
releaseDefinition |
Obtém a referência superficial da definição de versão. |
ReleaseSchedule
Nome | Tipo | Description |
---|---|---|
daysToRelease |
Dias da semana para lançamento |
|
jobId |
string |
ID do trabalho de definição de trabalho do Team Foundation |
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 |
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
Nome | Tipo | Description |
---|---|---|
artifactSource |
string |
|
containerImage |
string |
|
package |
string |
|
pullRequest |
string |
|
schedule |
string |
|
sourceRepo |
string |
|
undefined |
string |
ScheduleDays
Dias da semana para lançamento
Nome | Tipo | Description |
---|---|---|
all |
string |
|
friday |
string |
|
monday |
string |
|
none |
string |
|
saturday |
string |
|
sunday |
string |
|
thursday |
string |
|
tuesday |
string |
|
wednesday |
string |
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 | ||
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 |
|
condition |
string |
|
continueOnError |
boolean |
|
definitionType |
string |
|
enabled |
boolean |
|
environment |
object |
|
inputs |
object |
|
name |
string |
|
overrideInputs |
object |
|
refName |
string |
|
taskId |
string |
|
timeoutInMinutes |
integer |
|
version |
string |
Comentários
https://aka.ms/ContentUserFeedback.
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulteEnviar e exibir comentários de