Definitions - Update

Service:

Release

API Version:

7.1-preview.4

Aggiornare una definizione di versione.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
organization	path	True	string	Nome dell'organizzazione di Azure DevOps.
project	path	True	string	ID progetto o nome del progetto
api-version	query	True	string	Versione dell'API da usare. Deve essere impostato su '7.1-preview.4' per usare questa versione dell'API.

Corpo della richiesta

Nome	Tipo	Descrizione
_links	ReferenceLinks	Ottiene i collegamenti a risorse, API e viste correlate per la definizione di versione.
artifacts	Artifact[]	Ottiene o imposta l'elenco degli artefatti.
comment	string	Ottiene o imposta il commento.
createdBy	IdentityRef	Ottiene o imposta l'identità creata.
createdOn	string	Ottiene la data in cui è stata creata.
description	string	Ottiene o imposta la descrizione.
environments	ReleaseDefinitionEnvironment[]	Ottiene o imposta l'elenco di ambienti.
id	integer	Ottiene l'identificatore univoco della definizione di versione.
isDeleted	boolean	Indica se la definizione di versione viene eliminata.
lastRelease	ReleaseReference	Ottiene il riferimento dell'ultima versione.
modifiedBy	IdentityRef	Ottiene o imposta l'identità modificata.
modifiedOn	string	Ottiene la data in cui è stata modificata.
name	string	Ottiene o imposta il nome della definizione di versione.
path	string	Ottiene o imposta il percorso della definizione di versione.
projectReference	ProjectReference	Ottiene o imposta il riferimento al progetto.
properties	PropertiesCollection	Ottiene o imposta le proprietà.
releaseNameFormat	string	Ottiene o imposta il formato del nome della versione.
revision	integer	Ottiene il numero di revisione.
source	ReleaseDefinitionSource	Ottiene o imposta l'origine della definizione di versione.
tags	string[]	Ottiene o imposta l'elenco di tag.
triggers	ReleaseTriggerBase[]	Ottiene o imposta l'elenco di trigger.
url	string	Ottiene l'URL dell'API REST per accedere alla definizione di versione.
variableGroups	integer[]	Ottiene o imposta l'elenco di gruppi di variabili.
variables	<string,  ConfigurationVariableValue>	Ottiene o imposta il dizionario delle variabili.

Risposte

Nome	Tipo	Descrizione
200 OK	ReleaseDefinition	operazione riuscita

Sicurezza

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	Descrizione
vso.release_execute	Concede la possibilità di leggere e aggiornare gli artefatti della versione, incluse cartelle, versioni, definizioni di versione e ambiente di rilascio e la possibilità di accodare una nuova versione.

Esempio

Update the release definition

Sample Request

HTTP

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

{
  "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-11T05:33:56.573Z",
  "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-11T05:33:56.573Z",
  "isDeleted": false,
  "variables": {
    "NonSecretVariable": {
      "value": "NonSecretValue"
    }
  },
  "variableGroups": [],
  "environments": [
    {
      "id": 43,
      "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": 127
          }
        ],
        "approvalOptions": {
          "requiredApproverCount": 0,
          "releaseCreatorCanBeApprover": true,
          "autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped": false,
          "enforceIdentityRevalidation": false,
          "timeoutInMinutes": 0,
          "executionOrder": "beforeGates"
        }
      },
      "deployStep": {
        "tasks": [],
        "id": 128
      },
      "postDeployApprovals": {
        "approvals": [
          {
            "rank": 1,
            "isAutomated": true,
            "isNotificationOn": false,
            "id": 129
          }
        ]
      },
      "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",
          "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/43/43"
    }
  ],
  "artifacts": [],
  "triggers": [],
  "releaseNameFormat": "",
  "tags": [],
  "properties": {},
  "id": 43,
  "name": "Fabrikam-web",
  "path": "\\",
  "projectReference": null,
  "url": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/43",
  "_links": {
    "self": {
      "href": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/43"
    },
    "web": {
      "href": "https://dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_release?definitionId=43"
    }
  }
}

Sample Response

Status code:

200

{
  "source": "restApi",
  "revision": 2,
  "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-11T05:33:56.573Z",
  "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-11T05:33:58.433Z",
  "isDeleted": false,
  "variables": {
    "NonSecretVariable": {
      "value": "NonSecretValue"
    }
  },
  "variableGroups": [],
  "environments": [
    {
      "id": 43,
      "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": 127
          }
        ],
        "approvalOptions": {
          "requiredApproverCount": 0,
          "releaseCreatorCanBeApprover": true,
          "autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped": false,
          "enforceIdentityRevalidation": false,
          "timeoutInMinutes": 0,
          "executionOrder": "beforeGates"
        }
      },
      "deployStep": {
        "id": 128
      },
      "postDeployApprovals": {
        "approvals": [
          {
            "rank": 1,
            "isAutomated": true,
            "isNotificationOn": false,
            "id": 129
          }
        ]
      },
      "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/43/43"
    }
  ],
  "artifacts": [],
  "triggers": [],
  "releaseNameFormat": "",
  "tags": [],
  "properties": {},
  "id": 43,
  "name": "Fabrikam-web",
  "path": "\\",
  "projectReference": null,
  "url": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/43",
  "_links": {
    "self": {
      "href": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/43"
    },
    "web": {
      "href": "https://dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_release?definitionId=43"
    }
  }
}

Definizioni

Nome	Descrizione
ApprovalExecutionOrder	Ordine di esecuzione approvazioni.
ApprovalOptions
Artifact
ArtifactSourceReference
AuthorizationHeader
Condition
ConditionType	Ottiene o imposta il tipo di condizione.
ConfigurationVariableValue
DataSourceBindingBase	Rappresenta l'associazione dell'origine dati per la richiesta dell'endpoint di servizio.
Demand
DeployPhase
DeployPhaseTypes	Indica il tipo di fase di distribuzione.
EnvironmentExecutionPolicy	Definisce i criteri sull'accodamento dell'ambiente in Release Management coda laterale. Verrà inviato a Environment Runner [creazione di pre-distribuzione e altri passaggi] solo quando i criteri indicati sono soddisfatti.
EnvironmentOptions
EnvironmentRetentionPolicy
EnvironmentTrigger
EnvironmentTriggerType	Ottiene o imposta il tipo di trigger.
IdentityRef
ProcessParameters
ProjectReference
PropertiesCollection	La classe rappresenta un contenitore di proprietà come raccolta di coppie chiave-valore. I valori di tutti i tipi primitivi (qualsiasi tipo con un TypeCode != TypeCode.Object) ad eccezione DBNull di sono accettati. I valori di tipo Byte[], Int32, Double, DateType e String mantengono il tipo, altre primitive vengono ritunate come String. Byte[] previsto come stringa codificata base64.
ReferenceLinks	Classe da rappresentare una raccolta di collegamenti di riferimento REST.
ReleaseDefinition
ReleaseDefinitionApprovals
ReleaseDefinitionApprovalStep
ReleaseDefinitionDeployStep
ReleaseDefinitionEnvironment
ReleaseDefinitionGate
ReleaseDefinitionGatesOptions
ReleaseDefinitionGatesStep
ReleaseDefinitionShallowReference
ReleaseDefinitionSource	Ottiene o imposta l'origine della definizione della versione.
ReleaseReason	Ottiene il motivo della versione.
ReleaseReference
ReleaseSchedule
ReleaseShallowReference
ReleaseTriggerBase
ReleaseTriggerType	Tipo di trigger di rilascio.
ScheduleDays	Giorni della settimana da rilasciare.
TaskInputDefinitionBase
TaskInputValidation
TaskSourceDefinitionBase
WorkflowTask

ApprovalExecutionOrder

Ordine di esecuzione approvazioni.

Nome	Tipo	Descrizione
afterGatesAlways	string	Approvazioni visualizzate sempre dopo l'esecuzione dei controlli.
afterSuccessfulGates	string	Approvazioni visualizzate dopo l'esecuzione corretta dei controlli.
beforeGates	string	Approvazioni visualizzate prima dei controlli.

ApprovalOptions

Nome	Tipo	Descrizione
autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped	boolean	Specificare se l'approvazione può essere ignorata se lo stesso responsabile approvazione ha approvato la fase precedente.
enforceIdentityRevalidation	boolean	Specificare se riconvalidare l'identità del responsabile approvazione prima di completare l'approvazione.
executionOrder	ApprovalExecutionOrder	Ordine di esecuzione approvazioni.
releaseCreatorCanBeApprover	boolean	Specificare se l'utente che richiede una versione o una distribuzione deve consentire al responsabile approvazione.
requiredApproverCount	integer	Numero di approvazioni necessarie per il rilascio in avanti. '0' indica tutte le approvazioni necessarie.
timeoutInMinutes	integer	Timeout approvazione. Il timeout predefinito dell'approvazione è 30 giorni. Il timeout massimo consentito è 365 giorni. '0' indica il timeout predefinito, ad esempio 30 giorni.

Artifact

Nome	Tipo	Descrizione
alias	string	Ottiene o imposta l'alias.
definitionReference	<string,  ArtifactSourceReference>	Ottiene o imposta informazioni di riferimento sulla definizione. ad esempio {"project":{"id":"fed755ea-49c5-4399-acea-fd5b5a90a6c","name":"myProject"},"definition":{"id":"1","name":"mybuildDefinition"},"connection":{"id":"1","name":"myConnection"}}.
isPrimary	boolean	Indica se l'artefatto è primario o meno.
isRetained	boolean	Indica se l'artefatto viene mantenuto dalla versione o meno.
type	string	Ottiene o imposta il tipo. Può avere valore come 'Build', 'Jenkins', 'GitHub', 'Nuget', 'Team Build (external)', 'ExternalTFSBuild', 'Git', 'TFVC', 'ExternalTfsXamlBuild'.

ArtifactSourceReference

Nome	Tipo	Descrizione
id	string	ID dell'origine dell'artefatto.
name	string	Nome dell'origine dell'artefatto.

AuthorizationHeader

Nome	Tipo	Descrizione
name	string
value	string

Condition

Nome	Tipo	Descrizione
conditionType	ConditionType	Ottiene o imposta il tipo di condizione.
name	string	Ottiene o imposta il nome della condizione. Ad esempio, 'ReleaseStarted'.
value	string	Ottiene o imposta il valore della condizione.

ConditionType

Ottiene o imposta il tipo di condizione.

Nome	Tipo	Descrizione
artifact	string	Il tipo di condizione è artefatto.
environmentState	string	Il tipo di condizione è lo stato dell'ambiente.
event	string	Il tipo di condizione è l'evento.
undefined	string	Il tipo di condizione non è definito.

ConfigurationVariableValue

Nome	Tipo	Descrizione
allowOverride	boolean	Ottiene e imposta se una variabile può essere sottoposta a override in fase di distribuzione o meno.
isSecret	boolean	Ottiene o imposta come variabile è segreta o meno.
value	string	Ottiene e imposta il valore della variabile di configurazione.

DataSourceBindingBase

Rappresenta l'associazione dell'origine dati per la richiesta dell'endpoint di servizio.

Nome	Tipo	Descrizione
callbackContextTemplate	string	Formato di paginazione supportato da questa origine dati(ContinuationToken/SkipTop).
callbackRequiredTemplate	string	Chiamate successive necessarie?
dataSourceName	string	Ottiene o imposta il nome dell'origine dati.
endpointId	string	Ottiene o imposta l'ID endpoint.
endpointUrl	string	Ottiene o imposta l'URL dell'endpoint di servizio.
headers	AuthorizationHeader[]	Ottiene o imposta le intestazioni di autorizzazione.
initialContextTemplate	string	Definisce il valore iniziale dei parametri della query
parameters	object	Ottiene o imposta i parametri per l'origine dati.
requestContent	string	Ottiene o imposta il corpo della richiesta HTTP
requestVerb	string	Ottiene o imposta il verbo della richiesta HTTP
resultSelector	string	Ottiene o imposta il selettore dei risultati.
resultTemplate	string	Ottiene o imposta il modello di risultato.
target	string	Ottiene o imposta la destinazione dell'origine dati.

Demand

Nome	Tipo	Descrizione
name	string	Ottiene e imposta il nome della richiesta.
value	string	Ottiene e imposta il valore della domanda.

DeployPhase

Nome	Tipo	Descrizione
name	string	Ottiene e imposta il nome della fase di distribuzione.
phaseType	DeployPhaseTypes	Indica il tipo di fase di distribuzione.
rank	integer	Ottiene e imposta la classificazione della fase di distribuzione.
refName	string	Ottiene e imposta il nome di riferimento della fase di distribuzione.
workflowTasks	WorkflowTask[]	Ottiene e imposta le attività del flusso di lavoro per la fase di distribuzione.

DeployPhaseTypes

Indica il tipo di fase di distribuzione.

Nome	Tipo	Descrizione
agentBasedDeployment	string	Tipo di fase che contiene attività eseguite nell'agente.
deploymentGates	string	Tipo di fase che contiene attività che fungono da Gates per la distribuzione in corso.
machineGroupBasedDeployment	string	Tipo di fase che contiene attività eseguite nei computer del gruppo di distribuzione.
runOnServer	string	Tipo di fase che contiene attività eseguite dal server.
undefined	string	Tipo di fase non definito. Non usarla.

EnvironmentExecutionPolicy

Definisce i criteri sull'accodamento dell'ambiente in Release Management coda laterale. Verrà inviato a Environment Runner [creazione di pre-distribuzione e altri passaggi] solo quando i criteri indicati sono soddisfatti.

Nome	Tipo	Descrizione
concurrencyCount	integer	Questo criterio decide il numero di ambienti con Environment Runner.
queueDepthCount	integer	Profondità della coda nella tabella EnvironmentQueue, questa tabella mantiene le voci dell'ambiente fino a quando Environment Runner è gratuito [in base ai criteri] per accettare un altro ambiente per l'esecuzione.

EnvironmentOptions

Nome	Tipo	Descrizione
autoLinkWorkItems	boolean	Ottiene e imposta come elementi di lavoro del collegamento automatico o meno.
badgeEnabled	boolean	Ottiene e imposta come badge abilitato o meno.
publishDeploymentStatus	boolean	Ottiene e imposta come stato di distribuzione di pubblicazione o meno.
pullRequestDeploymentEnabled	boolean	Ottiene e imposta come distribuzione della richiesta.pull abilitata o meno.

EnvironmentRetentionPolicy

Nome	Tipo	Descrizione
daysToKeep	integer	Ottiene e imposta il numero di giorni per mantenere l'ambiente.
releasesToKeep	integer	Ottiene e imposta il numero di versioni da mantenere.
retainBuild	boolean	Ottiene e imposta come compilazione da conservare o meno.

EnvironmentTrigger

Nome	Tipo	Descrizione
definitionEnvironmentId	integer	ID dell'ambiente di definizione in cui è applicabile questo trigger.
releaseDefinitionId	integer	ID ReleaseDefinition in cui è applicabile questo trigger.
triggerContent	string	Ottiene o imposta il contenuto del trigger.
triggerType	EnvironmentTriggerType	Ottiene o imposta il tipo di trigger.

EnvironmentTriggerType

Ottiene o imposta il tipo di trigger.

Nome	Tipo	Descrizione
deploymentGroupRedeploy	string	Il tipo di trigger di ambiente è la ridistribuzione del gruppo di distribuzione.
rollbackRedeploy	string	Il tipo di trigger di ambiente è Rollback.
undefined	string	Tipo di trigger di ambiente non definito.

IdentityRef

Nome	Tipo	Descrizione
_links	ReferenceLinks	Questo campo contiene zero o più collegamenti interessanti sull'oggetto grafico. Questi collegamenti possono essere richiamati per ottenere relazioni aggiuntive o informazioni più dettagliate su questo argomento grafico.
descriptor	string	Il descrittore è il modo principale per fare riferimento all'oggetto del grafico durante l'esecuzione del sistema. Questo campo identificherà in modo univoco lo stesso soggetto grafo in account e organizzazioni.
directoryAlias	string	Deprecato: può essere recuperato eseguendo query sull'utente Graph a cui si fa riferimento nella voce "self" del dizionario IdentityRef "_links"
displayName	string	Si tratta del nome visualizzato non univoco dell'oggetto grafico. Per modificare questo campo, è necessario modificarlo nel provider di origine.
id	string
imageUrl	string	Deprecato - Disponibile nella voce "avatar" del dizionario IdentityRef "_links"
inactive	boolean	Deprecato: può essere recuperato eseguendo una query sullo stato di appartenenza Graph a cui fa riferimento nella voce "membershipState" del dizionario GraphUser "_links"
isAadIdentity	boolean	Deprecato: può essere dedotto dal tipo di soggetto del descrittore (Descrittore.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Deprecato: può essere dedotto dal tipo di soggetto del descrittore (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Deprecato : non in uso nella maggior parte delle implementazioni preesistenti di ToIdentityRef
uniqueName	string	Deprecato: usare invece Domain+PrincipalName
url	string	Questo URL è la route completa alla risorsa di origine di questo oggetto grafico.

ProcessParameters

Nome	Tipo	Descrizione
dataSourceBindings	DataSourceBindingBase[]	Rappresenta l'associazione dell'origine dati per la richiesta dell'endpoint di servizio.
inputs	TaskInputDefinitionBase[]
sourceDefinitions	TaskSourceDefinitionBase[]

ProjectReference

Nome	Tipo	Descrizione
id	string	Ottiene l'identificatore univoco di questo campo.
name	string	Ottiene il nome del progetto.

PropertiesCollection

La classe rappresenta un contenitore di proprietà come raccolta di coppie chiave-valore. I valori di tutti i tipi primitivi (qualsiasi tipo con un TypeCode != TypeCode.Object) ad eccezione DBNull di sono accettati. I valori di tipo Byte[], Int32, Double, DateType e String mantengono il tipo, altre primitive vengono ritunate come String. Byte[] previsto come stringa codificata base64.

Nome	Tipo	Descrizione
count	integer	Numero di proprietà nell'insieme.
item	object
keys	string[]	Set di chiavi nella raccolta.
values	string[]	Set di valori nella raccolta.

ReferenceLinks

Classe da rappresentare una raccolta di collegamenti di riferimento REST.

Nome	Tipo	Descrizione
links	object	Visualizzazione di lettura dei collegamenti. Poiché i collegamenti di riferimento sono in sola lettura, si vuole esporre solo i collegamenti di riferimento come sola lettura.

ReleaseDefinition

Nome	Tipo	Descrizione
_links	ReferenceLinks	Ottiene i collegamenti a risorse, API e viste correlate per la definizione della versione.
artifacts	Artifact[]	Ottiene o imposta l'elenco degli artefatti.
comment	string	Ottiene o imposta il commento.
createdBy	IdentityRef	Ottiene o imposta l'identità creata.
createdOn	string	Ottiene la data in cui è stata creata.
description	string	Ottiene o imposta la descrizione.
environments	ReleaseDefinitionEnvironment[]	Ottiene o imposta l'elenco di ambienti.
id	integer	Ottiene l'identificatore univoco della definizione della versione.
isDeleted	boolean	Indica se la definizione della versione viene eliminata.
lastRelease	ReleaseReference	Ottiene il riferimento dell'ultima versione.
modifiedBy	IdentityRef	Ottiene o imposta l'identità modificata.
modifiedOn	string	Ottiene la data in cui è stata modificata.
name	string	Ottiene o imposta il nome della definizione della versione.
path	string	Ottiene o imposta il percorso della definizione della versione.
projectReference	ProjectReference	Ottiene o imposta il riferimento al progetto.
properties	PropertiesCollection	Ottiene o imposta le proprietà.
releaseNameFormat	string	Ottiene o imposta il formato del nome della versione.
revision	integer	Ottiene il numero di revisione.
source	ReleaseDefinitionSource	Ottiene o imposta l'origine della definizione della versione.
tags	string[]	Ottiene o imposta l'elenco dei tag.
triggers	ReleaseTriggerBase[]	Ottiene o imposta l'elenco dei trigger.
url	string	Ottiene l'URL dell'API REST per accedere alla definizione di versione.
variableGroups	integer[]	Ottiene o imposta l'elenco dei gruppi di variabili.
variables	<string,  ConfigurationVariableValue>	Ottiene o imposta il dizionario delle variabili.

ReleaseDefinitionApprovals

Nome	Tipo	Descrizione
approvalOptions	ApprovalOptions	Ottiene o imposta le opzioni di approvazione.
approvals	ReleaseDefinitionApprovalStep[]	Ottiene o imposta le approvazioni.

ReleaseDefinitionApprovalStep

Nome	Tipo	Descrizione
approver	IdentityRef	Ottiene e imposta il responsabile approvazione.
id	integer	ID del passaggio di approvazione o distribuzione.
isAutomated	boolean	Indica se l'approvazione è automatizzata.
isNotificationOn	boolean	Indica se il set di notifiche di approvazione.
rank	integer	Ottiene o imposta la classificazione del passaggio di approvazione.

ReleaseDefinitionDeployStep

Nome	Tipo	Descrizione
id	integer	ID del passaggio di approvazione o distribuzione.
tasks	WorkflowTask[]	Elenco di passaggi per questa definizione.

ReleaseDefinitionEnvironment

Nome	Tipo	Descrizione
badgeUrl	string	Ottiene o imposta badgeUrl. BadgeUrl verrà usato quando il badge verrà abilitato nell'ambiente di definizione della versione.
conditions	Condition[]	Ottiene o imposta le condizioni di ambiente.
currentRelease	ReleaseShallowReference	Ottiene o imposta il riferimento alla versione corrente.
demands	Demand[]	Ottiene o imposta le richieste.
deployPhases	DeployPhase[]	Ottiene o imposta le fasi di distribuzione dell'ambiente.
deployStep	ReleaseDefinitionDeployStep	Ottiene o imposta il passaggio di distribuzione.
environmentOptions	EnvironmentOptions	Ottiene o imposta le opzioni di ambiente.
environmentTriggers	EnvironmentTrigger[]	Ottiene o imposta i trigger nell'ambiente.
executionPolicy	EnvironmentExecutionPolicy	Ottiene o imposta i criteri di esecuzione dell'ambiente.
id	integer	Ottiene e imposta l'ID dell'oggetto ReleaseDefinitionEnvironment.
name	string	Ottiene e imposta il nome dell'oggetto ReleaseDefinitionEnvironment.
owner	IdentityRef	Ottiene e imposta il proprietario dell'oggetto ReleaseDefinitionEnvironment.
postDeployApprovals	ReleaseDefinitionApprovals	Ottiene o imposta le approvazioni post distribuzione.
postDeploymentGates	ReleaseDefinitionGatesStep	Ottiene o imposta i cancelli di distribuzione post.
preDeployApprovals	ReleaseDefinitionApprovals	Ottiene o imposta le approvazioni di pre-distribuzione.
preDeploymentGates	ReleaseDefinitionGatesStep	Ottiene o imposta i cancelli di distribuzione preliminare.
processParameters	ProcessParameters	Ottiene o imposta i parametri del processo di ambiente.
properties	PropertiesCollection	Ottiene o imposta le proprietà nell'ambiente.
queueId	integer	Ottiene o imposta l'ID coda.
rank	integer	Ottiene e imposta la classificazione dell'oggetto ReleaseDefinitionEnvironment.
retentionPolicy	EnvironmentRetentionPolicy	Ottiene o imposta i criteri di conservazione dell'ambiente.
schedules	ReleaseSchedule[]	Ottiene o imposta le pianificazioni
variableGroups	integer[]	Ottiene o imposta i gruppi di variabili.
variables	<string,  ConfigurationVariableValue>	Ottiene e imposta le variabili.

ReleaseDefinitionGate

Nome	Tipo	Descrizione
tasks	WorkflowTask[]	Ottiene o imposta il flusso di lavoro gate.

ReleaseDefinitionGatesOptions

Nome	Tipo	Descrizione
isEnabled	boolean	Ottiene o imposta come cancelli abilitati o meno.
minimumSuccessDuration	integer	Ottiene o imposta la durata minima per i risultati stabili dopo una valutazione dei controlli completata.
samplingInterval	integer	Ottiene o imposta il tempo tra la rivalutazione dei controlli.
stabilizationTime	integer	Ottiene o imposta il ritardo prima della valutazione.
timeout	integer	Ottiene o imposta il timeout dopo il quale i controlli hanno esito negativo.

ReleaseDefinitionGatesStep

Nome	Tipo	Descrizione
gates	ReleaseDefinitionGate[]	Ottiene o imposta i cancelli.
gatesOptions	ReleaseDefinitionGatesOptions	Ottiene o imposta le opzioni di gate.
id	integer	ID della versioneDefinitionGateStep.

ReleaseDefinitionShallowReference

Nome	Tipo	Descrizione
_links	ReferenceLinks	Ottiene i collegamenti a risorse, API e viste correlate per la definizione della versione.
id	integer	Ottiene l'identificatore univoco della definizione della versione.
name	string	Ottiene o imposta il nome della definizione della versione.
path	string	Ottiene o imposta il percorso della definizione della versione.
projectReference	ProjectReference	Ottiene o imposta il riferimento al progetto.
url	string	Ottiene l'URL dell'API REST per accedere alla definizione di versione.

ReleaseDefinitionSource

Ottiene o imposta l'origine della definizione della versione.

Nome	Tipo	Descrizione
ibiza	string	Indica ReleaseDefinition creato da Ibiza.
portalExtensionApi	string	Indica ReleaseDefinition creato dall'API PortalExtension.
restApi	string	Indica ReleaseDefinition creato usando l'API REST.
undefined	string	Indica l'origine ReleaseDefinition non definita.
userInterface	string	Indica ReleaseDefinition creato usando l'interfaccia utente.

ReleaseReason

Ottiene il motivo della versione.

Nome	Tipo	Descrizione
continuousIntegration	string	Indica la versione attivata dall'integrazione continua.
manual	string	Indica il rilascio attivato manualmente.
none	string	Indica il motivo attivato per il rilascio non impostato.
pullRequest	string	Indica la versione attivata da PullRequest.
schedule	string	Indica il rilascio attivato dalla pianificazione.

ReleaseReference

Nome	Tipo	Descrizione
_links	ReferenceLinks	Ottiene collegamenti per accedere alla versione.
artifacts	Artifact[]	Ottiene l'elenco degli artefatti.
createdBy	IdentityRef	Ottiene l'identità che ha creato la versione.
createdOn	string	Ottiene la data di creazione di questa versione.
description	string	Ottiene la descrizione.
id	integer	ID della versione.
modifiedBy	IdentityRef	Ottiene l'identità che ha modificato la versione.
name	string	Ottiene il nome della versione.
reason	ReleaseReason	Ottiene il motivo della versione.
releaseDefinition	ReleaseDefinitionShallowReference	Ottiene informazioni di riferimento superficiali sulla definizione di versione.

ReleaseSchedule

Nome	Tipo	Descrizione
daysToRelease	ScheduleDays	Giorni della settimana da rilasciare.
jobId	string	ID processo definizione processo Team Foundation.
scheduleOnlyWithChanges	boolean	Contrassegno per determinare se questa pianificazione deve essere rilasciata solo se l'artefatto associato è stato modificato o la definizione della versione è stata modificata.
startHours	integer	Ora di fuso orario locale da avviare.
startMinutes	integer	Fuso orario locale per iniziare.
timeZoneId	string	Id fuso orario della pianificazione della versione, ad esempio 'UTC'.

ReleaseShallowReference

Nome	Tipo	Descrizione
_links	ReferenceLinks	Ottiene i collegamenti a risorse, API e viste correlate per la versione.
id	integer	Ottiene l'identificatore univoco della versione.
name	string	Ottiene o imposta il nome della versione.
url	string	Ottiene l'URL dell'API REST per accedere alla versione.

ReleaseTriggerBase

Nome	Tipo	Descrizione
triggerType	ReleaseTriggerType	Tipo di trigger di rilascio.

ReleaseTriggerType

Tipo di trigger di rilascio.

Nome	Tipo	Descrizione
artifactSource	string	Trigger di rilascio basato sull'artefatto.
containerImage	string	Trigger di rilascio basato sull'immagine del contenitore.
package	string	Trigger di rilascio basato sul pacchetto.
pullRequest	string	Trigger di rilascio basato su richiesta pull.
schedule	string	Trigger di rilascio basato sulla pianificazione.
sourceRepo	string	Trigger di rilascio basato sul repository di origine.
undefined	string	Tipo di trigger di rilascio non impostato.

ScheduleDays

Giorni della settimana da rilasciare.

Nome	Tipo	Descrizione
all	string	Pianificato in tutti i giorni della settimana.
friday	string	Programmato venerdì.
monday	string	Programmato lunedì.
none	string	Giorno pianificato non impostato.
saturday	string	Programmato sabato.
sunday	string	Programmata la domenica.
thursday	string	Programmato giovedì.
tuesday	string	Programmato martedì.
wednesday	string	Programmato mercoledì.

TaskInputDefinitionBase

Nome	Tipo	Descrizione
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	Descrizione
expression	string	Espressione condizionale
message	string	Messaggio che spiega come l'utente può correggere se la convalida ha esito negativo

TaskSourceDefinitionBase

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

WorkflowTask

Nome	Tipo	Descrizione
alwaysRun	boolean	Ottiene o imposta come l'attività viene sempre eseguita o meno.
condition	string	Ottiene o imposta la condizione dell'attività.
continueOnError	boolean	Ottiene o imposta come l'attività continua l'esecuzione in caso di errore o meno.
definitionType	string	Ottiene o imposta il tipo di definizione dell'attività. Esempio:- 'Agent', DeploymentGroup', 'Server' o 'ServerGate'.
enabled	boolean	Ottiene o imposta come attività abilitata o meno.
environment	object	Ottiene o imposta le variabili di ambiente dell'attività.
inputs	object	Ottiene o imposta gli input dell'attività.
name	string	Ottiene o imposta il nome dell'attività.
overrideInputs	object	Ottiene o imposta gli input di override dell'attività.
refName	string	Ottiene o imposta il nome di riferimento dell'attività.
retryCountOnTaskFailure	integer	Ottiene o imposta l'attività retryCount.
taskId	string	Ottiene o imposta l'ID dell'attività.
timeoutInMinutes	integer	Ottiene o imposta il timeout dell'attività.
version	string	Ottiene o imposta la versione dell'attività.