Condividi tramite


Releases - Update Release

Aggiornare un oggetto versione completo.

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

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 progetto

releaseId
path True

integer (int32)

ID della versione da aggiornare.

api-version
query True

string

Versione dell'API da usare. Deve essere impostato su '7.1' per usare questa versione dell'API.

Corpo della richiesta

Nome Tipo Descrizione
_links

ReferenceLinks

Ottiene i collegamenti per accedere alla versione.

artifacts

Artifact[]

Ottiene o imposta l'elenco di artefatti.

comment

string

Ottiene o imposta il commento.

createdBy

IdentityRef

Ottiene o imposta l'identità creata.

createdFor

IdentityRef

Ottiene o imposta l'identità per cui è stata creata la versione.

createdOn

string (date-time)

Ottiene la data in cui è stata creata.

definitionSnapshotRevision

integer (int32)

Ottiene il numero di revisione dello snapshot di definizione.

description

string

Ottiene o imposta la descrizione della versione.

environments

ReleaseEnvironment[]

Ottiene l'elenco di ambienti.

id

integer (int32)

Ottiene l'identificatore univoco di questo campo.

keepForever

boolean

Indica se escludere il rilascio dai criteri di conservazione.

logsContainerUrl

string

Ottiene l'URL del contenitore dei log.

modifiedBy

IdentityRef

Ottiene o imposta l'identità modificata.

modifiedOn

string (date-time)

Ottiene la data in cui è stata modificata.

name

string

Ottiene il nome.

poolName

string

Ottiene il nome del pool.

projectReference

ProjectReference

Ottiene o imposta il riferimento al progetto.

properties

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 di DBNull vengono accettati. I valori di tipo Byte[], Int32, Double, DateType e String mantengono il tipo, le altre primitive vengono ricreate come String. Byte[] previsto come stringa con codifica Base64.

reason

ReleaseReason

Ottiene il motivo della versione.

releaseDefinition

ReleaseDefinitionShallowReference

Ottiene releaseDefinitionReference che specifica il riferimento della definizione di versione a cui è associata questa versione.

releaseDefinitionRevision

integer (int32)

Ottiene o imposta la revisione della definizione di versione.

releaseNameFormat

string

Ottiene il formato del nome della versione.

status

ReleaseStatus

Ottiene lo stato.

tags

string[]

Ottiene o imposta un elenco di tag.

triggeringArtifactAlias

string

variableGroups

VariableGroup[]

Ottiene l'elenco di gruppi di variabili.

variables

<string,  ConfigurationVariableValue>

Ottiene o imposta il dizionario delle variabili.

Risposte

Nome Tipo Descrizione
200 OK

Release

operazione riuscita

Sicurezza

oauth2

Tipo: oauth2
Flow: accessCode
URL di autorizzazione: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL 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

Ambiti

Nome Descrizione
vso.release_execute Concede la possibilità di leggere e aggiornare gli artefatti di versione, incluse cartelle, versioni, definizioni di versione e ambiente di rilascio e la possibilità di accodare una nuova versione.

Esempio

Update the release

Esempio di richiesta

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

{
  "id": 39,
  "name": "Release-1",
  "status": "active",
  "createdOn": "2018-12-10T12:43:34.223Z",
  "modifiedOn": "2018-12-10T12:43:34.223Z",
  "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"
  },
  "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"
  },
  "environments": [
    {
      "id": 39,
      "releaseId": 39,
      "name": "PROD",
      "status": "notStarted",
      "variables": {},
      "variableGroups": [],
      "preDeployApprovals": [],
      "postDeployApprovals": [],
      "preApprovalsSnapshot": {
        "approvals": [
          {
            "rank": 1,
            "isAutomated": false,
            "isNotificationOn": false,
            "approver": {
              "displayName": "Chuck Reinhart",
              "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/aeb95c63-4fac-4948-84ce-711b0a9dda97",
              "_links": {
                "avatar": {
                  "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
                }
              },
              "id": "aeb95c63-4fac-4948-84ce-711b0a9dda97",
              "uniqueName": "fabfiber@outlook.com",
              "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=aeb95c63-4fac-4948-84ce-711b0a9dda97",
              "descriptor": "aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
            },
            "id": 0
          }
        ],
        "approvalOptions": {
          "requiredApproverCount": 0,
          "releaseCreatorCanBeApprover": true,
          "autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped": false,
          "enforceIdentityRevalidation": false,
          "timeoutInMinutes": 0,
          "executionOrder": "beforeGates"
        }
      },
      "postApprovalsSnapshot": {
        "approvals": [
          {
            "rank": 1,
            "isAutomated": true,
            "isNotificationOn": false,
            "id": 0
          }
        ]
      },
      "deploySteps": [],
      "rank": 1,
      "definitionEnvironmentId": 21,
      "environmentOptions": {
        "emailNotificationType": "OnlyOnFailure",
        "emailRecipients": "release.environment.owner;release.creator",
        "skipArtifactsDownload": false,
        "timeoutInMinutes": 0,
        "enableAccessToken": false,
        "publishDeploymentStatus": false,
        "badgeEnabled": false,
        "autoLinkWorkItems": false,
        "pullRequestDeploymentEnabled": false
      },
      "demands": [],
      "conditions": [],
      "workflowTasks": [],
      "deployPhasesSnapshot": [
        {
          "deploymentInput": {
            "parallelExecution": {
              "parallelExecutionType": "none"
            },
            "skipArtifactsDownload": false,
            "artifactsDownloadInput": {
              "downloadInputs": []
            },
            "queueId": 0,
            "demands": [],
            "enableAccessToken": false,
            "timeoutInMinutes": 0,
            "jobCancelTimeoutInMinutes": 1,
            "condition": "succeeded()",
            "overrideInputs": {}
          },
          "rank": 1,
          "phaseType": "agentBasedDeployment",
          "name": "Run on agent",
          "workflowTasks": []
        }
      ],
      "owner": {
        "displayName": "Chuck Reinhart",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/aeb95c63-4fac-4948-84ce-711b0a9dda97",
        "_links": {
          "avatar": {
            "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
          }
        },
        "id": "aeb95c63-4fac-4948-84ce-711b0a9dda97",
        "uniqueName": "fabfiber@outlook.com",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=aeb95c63-4fac-4948-84ce-711b0a9dda97",
        "descriptor": "aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
      },
      "schedules": [],
      "release": {
        "id": 39,
        "name": "Release-1",
        "url": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/releases/39",
        "_links": {
          "web": {
            "href": "https://dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_release?releaseId=39&_a=release-summary"
          },
          "self": {
            "href": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/releases/39"
          }
        }
      },
      "releaseDefinition": {
        "id": 21,
        "name": "Fabrikam-web",
        "path": "\\",
        "projectReference": null,
        "url": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/21",
        "_links": {
          "web": {
            "href": "https://dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_release?definitionId=21"
          },
          "self": {
            "href": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/21"
          }
        }
      },
      "releaseCreatedBy": {
        "displayName": "Chuck Reinhart",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/aeb95c63-4fac-4948-84ce-711b0a9dda97",
        "_links": {
          "avatar": {
            "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
          }
        },
        "id": "aeb95c63-4fac-4948-84ce-711b0a9dda97",
        "uniqueName": "fabfiber@outlook.com",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=aeb95c63-4fac-4948-84ce-711b0a9dda97",
        "descriptor": "aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
      },
      "triggerReason": "Manual",
      "preDeploymentGatesSnapshot": {
        "id": 0,
        "gatesOptions": null,
        "gates": []
      },
      "postDeploymentGatesSnapshot": {
        "id": 0,
        "gatesOptions": null,
        "gates": []
      }
    }
  ],
  "variables": {
    "NonSecretVariable": {
      "value": "NonSecretValue"
    },
    "System.Debug": {
      "value": "false",
      "allowOverride": true
    }
  },
  "variableGroups": [],
  "artifacts": [],
  "releaseDefinition": {
    "id": 21,
    "name": "Fabrikam-web",
    "path": "\\",
    "projectReference": null,
    "url": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/21",
    "_links": {
      "self": {
        "href": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/21"
      },
      "web": {
        "href": "https://dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_release?definitionId=21"
      }
    }
  },
  "description": "Creating Sample release",
  "reason": "manual",
  "releaseNameFormat": "Release-$(Rev:r)",
  "keepForever": false,
  "definitionSnapshotRevision": 1,
  "logsContainerUrl": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/releases/39/logs",
  "url": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/releases/39",
  "_links": {
    "self": {
      "href": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/releases/39"
    },
    "web": {
      "href": "https://dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_release?releaseId=39&_a=release-summary"
    }
  },
  "tags": [],
  "triggeringArtifactAlias": null,
  "projectReference": {
    "id": "42fa3371-9e49-4858-8f49-9d4f2d0b32e8",
    "name": null
  },
  "properties": {}
}

Risposta di esempio

{
  "id": 39,
  "name": "Release-1",
  "status": "active",
  "createdOn": "2018-12-10T12:43:34.223Z",
  "modifiedOn": "2018-12-10T12:43:36.537Z",
  "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"
  },
  "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"
  },
  "environments": [
    {
      "id": 39,
      "releaseId": 39,
      "name": "PROD",
      "status": "notStarted",
      "variables": {},
      "variableGroups": [],
      "preDeployApprovals": [],
      "postDeployApprovals": [],
      "preApprovalsSnapshot": {
        "approvals": [
          {
            "rank": 1,
            "isAutomated": false,
            "isNotificationOn": false,
            "approver": {
              "displayName": "Chuck Reinhart",
              "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/aeb95c63-4fac-4948-84ce-711b0a9dda97",
              "_links": {
                "avatar": {
                  "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
                }
              },
              "id": "aeb95c63-4fac-4948-84ce-711b0a9dda97",
              "uniqueName": "fabfiber@outlook.com",
              "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=aeb95c63-4fac-4948-84ce-711b0a9dda97",
              "descriptor": "aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
            },
            "id": 0
          }
        ],
        "approvalOptions": {
          "requiredApproverCount": 0,
          "releaseCreatorCanBeApprover": true,
          "autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped": false,
          "enforceIdentityRevalidation": false,
          "timeoutInMinutes": 0,
          "executionOrder": "beforeGates"
        }
      },
      "postApprovalsSnapshot": {
        "approvals": [
          {
            "rank": 1,
            "isAutomated": true,
            "isNotificationOn": false,
            "id": 0
          }
        ]
      },
      "deploySteps": [],
      "rank": 1,
      "definitionEnvironmentId": 21,
      "environmentOptions": {
        "emailNotificationType": "OnlyOnFailure",
        "emailRecipients": "release.environment.owner;release.creator",
        "skipArtifactsDownload": false,
        "timeoutInMinutes": 0,
        "enableAccessToken": false,
        "publishDeploymentStatus": false,
        "badgeEnabled": false,
        "autoLinkWorkItems": false,
        "pullRequestDeploymentEnabled": false
      },
      "demands": [],
      "conditions": [],
      "workflowTasks": [],
      "deployPhasesSnapshot": [
        {
          "deploymentInput": {
            "parallelExecution": {
              "parallelExecutionType": "none"
            },
            "skipArtifactsDownload": false,
            "artifactsDownloadInput": {
              "downloadInputs": []
            },
            "queueId": 0,
            "demands": [],
            "enableAccessToken": false,
            "timeoutInMinutes": 0,
            "jobCancelTimeoutInMinutes": 1,
            "condition": "succeeded()",
            "overrideInputs": {}
          },
          "rank": 1,
          "phaseType": "agentBasedDeployment",
          "name": "Run on agent",
          "refName": null,
          "workflowTasks": []
        }
      ],
      "owner": {
        "displayName": "Chuck Reinhart",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/aeb95c63-4fac-4948-84ce-711b0a9dda97",
        "_links": {
          "avatar": {
            "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
          }
        },
        "id": "aeb95c63-4fac-4948-84ce-711b0a9dda97",
        "uniqueName": "fabfiber@outlook.com",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=aeb95c63-4fac-4948-84ce-711b0a9dda97",
        "descriptor": "aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
      },
      "schedules": [],
      "release": {
        "id": 39,
        "name": "Release-1",
        "url": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/releases/39",
        "_links": {
          "web": {
            "href": "https://dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_release?releaseId=39&_a=release-summary"
          },
          "self": {
            "href": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/releases/39"
          }
        }
      },
      "releaseDefinition": {
        "id": 21,
        "name": "Fabrikam-web",
        "path": "\\",
        "projectReference": null,
        "url": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/21",
        "_links": {
          "web": {
            "href": "https://dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_release?definitionId=21"
          },
          "self": {
            "href": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/21"
          }
        }
      },
      "releaseCreatedBy": {
        "displayName": "Chuck Reinhart",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/aeb95c63-4fac-4948-84ce-711b0a9dda97",
        "_links": {
          "avatar": {
            "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
          }
        },
        "id": "aeb95c63-4fac-4948-84ce-711b0a9dda97",
        "uniqueName": "fabfiber@outlook.com",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=aeb95c63-4fac-4948-84ce-711b0a9dda97",
        "descriptor": "aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
      },
      "triggerReason": "Manual",
      "preDeploymentGatesSnapshot": {
        "id": 0,
        "gatesOptions": null,
        "gates": []
      },
      "postDeploymentGatesSnapshot": {
        "id": 0,
        "gatesOptions": null,
        "gates": []
      }
    }
  ],
  "variables": {
    "NonSecretVariable": {
      "value": "NonSecretValue"
    },
    "System.Debug": {
      "value": "false",
      "allowOverride": true
    }
  },
  "variableGroups": [],
  "artifacts": [],
  "releaseDefinition": {
    "id": 21,
    "name": "Fabrikam-web",
    "path": "\\",
    "projectReference": null,
    "url": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/21",
    "_links": {
      "self": {
        "href": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/21"
      },
      "web": {
        "href": "https://dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_release?definitionId=21"
      }
    }
  },
  "description": "Creating Sample release",
  "reason": "manual",
  "releaseNameFormat": "Release-$(Rev:r)",
  "keepForever": false,
  "definitionSnapshotRevision": 2,
  "logsContainerUrl": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/releases/39/logs",
  "url": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/releases/39",
  "_links": {
    "self": {
      "href": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/releases/39"
    },
    "web": {
      "href": "https://dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_release?releaseId=39&_a=release-summary"
    }
  },
  "tags": [],
  "triggeringArtifactAlias": null,
  "projectReference": {
    "id": "42fa3371-9e49-4858-8f49-9d4f2d0b32e8",
    "name": null
  },
  "properties": {}
}

Definizioni

Nome Descrizione
ApprovalExecutionOrder

Ordine di esecuzione approvazioni.

ApprovalOptions
ApprovalStatus

Ottiene o imposta lo stato dell'approvazione.

ApprovalType

Ottiene o imposta il tipo di approvazione.

Artifact
ArtifactSourceReference
AuthorizationHeader
ConditionType

Ottiene o imposta il tipo di condizione.

ConfigurationVariableValue
DataSourceBindingBase

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

DeploymentAttempt
DeploymentJob
DeploymentOperationStatus

Ottiene lo stato dell'operazione di distribuzione.

DeploymentReason

Ottiene il motivo della distribuzione.

DeploymentStatus

Ottiene lo stato della distribuzione.

DeployPhase
DeployPhaseStatus

Stato della fase.

DeployPhaseTypes

Indica il tipo di fase di distribuzione.

EnvironmentOptions
EnvironmentStatus

Ottiene lo stato dell'ambiente.

GateStatus

Stato dei controlli di rilascio.

IdentityRef
IgnoredGate
Issue
ManualIntervention
ManualInterventionStatus

Ottiene o imposta lo stato dell'intervento manuale.

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 di DBNull vengono accettati. I valori di tipo Byte[], Int32, Double, DateType e String mantengono il tipo, le altre primitive vengono ricreate come String. Byte[] previsto come stringa con codifica Base64.

ReferenceLinks

Classe per rappresentare una raccolta di collegamenti di riferimento REST.

Release
ReleaseApproval
ReleaseApprovalHistory
ReleaseCondition
ReleaseDefinitionApprovals
ReleaseDefinitionApprovalStep
ReleaseDefinitionGate
ReleaseDefinitionGatesOptions
ReleaseDefinitionGatesStep
ReleaseDefinitionShallowReference
ReleaseDeployPhase
ReleaseEnvironment
ReleaseEnvironmentShallowReference
ReleaseGates
ReleaseReason

Ottiene il motivo della versione.

ReleaseSchedule
ReleaseShallowReference
ReleaseStatus

Ottiene lo stato.

ReleaseTask
ScheduleDays

Giorni della settimana da rilasciare.

TaskInputDefinitionBase
TaskInputValidation
TaskSourceDefinitionBase
TaskStatus

Stato dell'attività di rilascio.

VariableGroup
VariableGroupProjectReference

Un riferimento a un gruppo di variabili è un riferimento superficiale al gruppo di variabili.

VariableGroupProviderData
VariableValue
WorkflowTask
WorkflowTaskReference

ApprovalExecutionOrder

Ordine di esecuzione approvazioni.

Valore Descrizione
afterGatesAlways

Le approvazioni vengono visualizzate sempre dopo l'esecuzione dei controlli.

afterSuccessfulGates

Approvazioni visualizzate dopo l'esecuzione corretta dei controlli.

beforeGates

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

Numero di approvazioni necessarie per il rilascio in avanti. '0' indica tutte le approvazioni necessarie.

timeoutInMinutes

integer (int32)

Timeout approvazione. Il timeout predefinito dell'approvazione è 30 giorni. Il timeout massimo consentito è 365 giorni. '0' indica il timeout predefinito, ad esempio 30 giorni.

ApprovalStatus

Ottiene o imposta lo stato dell'approvazione.

Valore Descrizione
approved

Indica che l'approvazione è approvata.

canceled

Indica che l'approvazione è stata annullata.

pending

Indica che l'approvazione è in sospeso.

reassigned

Indica che l'approvazione è riassegnata.

rejected

Indica che l'approvazione è stata rifiutata.

skipped

Indica che l'approvazione viene ignorata.

undefined

Indica che l'approvazione non ha il set di stato.

ApprovalType

Ottiene o imposta il tipo di approvazione.

Valore Descrizione
all

Indica tutte le approvazioni.

postDeploy

Indica le approvazioni eseguite dopo la distribuzione.

preDeploy

Indica le approvazioni eseguite prima della distribuzione.

undefined

Indica che il tipo di approvazione non è impostato.

Artifact

Nome Tipo Descrizione
alias

string

Ottiene o imposta l'alias.

definitionReference

<string,  ArtifactSourceReference>

Ottiene o imposta il riferimento alla 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 in base al rilascio 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

ConditionType

Ottiene o imposta il tipo di condizione.

Valore Descrizione
artifact

Il tipo di condizione è artefatto.

environmentState

Il tipo di condizione è lo stato dell'ambiente.

event

Il tipo di condizione è event.

undefined

Il tipo di condizione non è definito.

ConfigurationVariableValue

Nome Tipo Descrizione
allowOverride

boolean

Ottiene e imposta se una variabile può essere sottoposta o meno a override in fase di distribuzione.

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

DeploymentAttempt

Nome Tipo Descrizione
attempt

integer (int32)

Tentativo di distribuzione.

deploymentId

integer (int32)

ID della distribuzione.

hasStarted

boolean

Specifica se la distribuzione è stata avviata o meno.

id

integer (int32)

ID della distribuzione.

issues

Issue[]

Tutti i problemi relativi alla distribuzione.

lastModifiedBy

IdentityRef

Identità che ha modificato l'ultima distribuzione.

lastModifiedOn

string (date-time)

Ora dell'ultima modifica della distribuzione.

operationStatus

DeploymentOperationStatus

Stato dell'operazione di distribuzione.

postDeploymentGates

ReleaseGates

Controlli post-distribuzione eseguiti in questa distribuzione.

preDeploymentGates

ReleaseGates

Controlli di pre-distribuzione eseguiti in questa distribuzione.

queuedOn

string (date-time)

Quando la distribuzione è stata accodata.

reason

DeploymentReason

Motivo della distribuzione.

releaseDeployPhases

ReleaseDeployPhase[]

Elenco delle distribuzioni di versione eseguite in questa distribuzione.

requestedBy

IdentityRef

Identità che ha richiesto questa distribuzione.

requestedFor

IdentityRef

Identità per questa distribuzione richiesta.

status

DeploymentStatus

stato della distribuzione.

DeploymentJob

Nome Tipo Descrizione
job

ReleaseTask

Attività padre di tutte le attività eseguite.

tasks

ReleaseTask[]

Elenco delle attività eseguite con nel processo.

DeploymentOperationStatus

Ottiene lo stato dell'operazione di distribuzione.

Valore Descrizione
all

Lo stato dell'operazione di distribuzione è tutto.

approved

Lo stato dell'operazione di distribuzione è approvato.

canceled

Lo stato dell'operazione di distribuzione viene annullato.

cancelling

Lo stato dell'operazione di distribuzione viene annullato.

deferred

Lo stato dell'operazione di distribuzione è posticipato.

evaluatingGates

Lo stato dell'operazione di distribuzione è EvaluatingGates.

gateFailed

Lo stato dell'operazione di distribuzione è GateFailed.

manualInterventionPending

Lo stato dell'operazione di distribuzione è manualintervention in sospeso.

pending

Lo stato dell'operazione di distribuzione è in sospeso.

phaseCanceled

Lo stato dell'operazione di distribuzione viene annullato in fase.

phaseFailed

Lo stato dell'operazione di distribuzione non è riuscito.

phaseInProgress

Lo stato dell'operazione di distribuzione è in corso.

phasePartiallySucceeded

Lo stato dell'operazione di distribuzione è parzialmente completato.

phaseSucceeded

Lo stato dell'operazione di distribuzione è stato completato.

queued

Lo stato dell'operazione di distribuzione viene accodato.

queuedForAgent

Lo stato dell'operazione di distribuzione viene accodato per l'agente.

queuedForPipeline

Lo stato dell'operazione di distribuzione viene accodato per la pipeline.

rejected

Lo stato dell'operazione di distribuzione viene rifiutato.

scheduled

Lo stato dell'operazione di distribuzione è pianificato.

undefined

Lo stato dell'operazione di distribuzione non è definito.

DeploymentReason

Ottiene il motivo della distribuzione.

Valore Descrizione
automated

Il motivo della distribuzione è automatizzato.

manual

Il motivo della distribuzione è manuale.

none

Il motivo della distribuzione è nessuno.

redeployTrigger

Il motivo della distribuzione è RedeployTrigger.

scheduled

Il motivo della distribuzione è pianificato.

DeploymentStatus

Ottiene lo stato della distribuzione.

Valore Descrizione
all

Lo stato della distribuzione è tutto.

failed

Lo stato della distribuzione non è riuscito.

inProgress

Lo stato della distribuzione è in corso.

notDeployed

Lo stato della distribuzione non viene distribuito.

partiallySucceeded

Lo stato della distribuzione è parzialmente completato.

succeeded

Lo stato della distribuzione è riuscito.

undefined

Lo stato della distribuzione non è definito.

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

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.

DeployPhaseStatus

Stato della fase.

Valore Descrizione
canceled

Esecuzione della fase annullata.

cancelling

La fase è in stato di annullamento.

failed

Esecuzione della fase non riuscita.

inProgress

Esecuzione in fase in corso.

notStarted

L'esecuzione della fase non è stata avviata.

partiallySucceeded

Esecuzione parziale della fase completata.

skipped

Esecuzione in fase ignorata.

succeeded

Esecuzione della fase completata.

undefined

Stato fase non impostato.

DeployPhaseTypes

Indica il tipo di fase di distribuzione.

Valore Descrizione
agentBasedDeployment

Tipo di fase che contiene le attività eseguite sull'agente.

deploymentGates

Tipo di fase che contiene attività che fungono da gate per la distribuzione da inoltrare.

machineGroupBasedDeployment

Tipo di fase che contiene le attività eseguite nei computer del gruppo di distribuzione.

runOnServer

Tipo di fase che contiene le attività eseguite dal server.

undefined

Tipo di fase non definito. Non usarlo.

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.

EnvironmentStatus

Ottiene lo stato dell'ambiente.

Valore Descrizione
canceled

L'ambiente è in stato annullato.

inProgress

Lo stato dell'ambiente è in corso.

notStarted

L'ambiente non è in stato avviato.

partiallySucceeded

L'ambiente è in stato parzialmente completato.

queued

L'ambiente è in stato in coda.

rejected

L'ambiente è in stato rifiutato.

scheduled

L'ambiente è in stato pianificato.

succeeded

L'ambiente è in stato completato.

undefined

Stato dell'ambiente non impostato.

GateStatus

Stato dei controlli di rilascio.

Valore Descrizione
canceled

L'esecuzione del gate è stata annullata.

failed

L'esecuzione del gate non è riuscita.

inProgress

Il gate è attualmente in corso.

none

Il gate non ha lo stato impostato.

pending

Lo stato del gate è in sospeso.

succeeded

Il gate è stato completato correttamente.

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 sull'oggetto grafico.

descriptor

string

Il descrittore è il modo principale per fare riferimento all'oggetto del grafo mentre il sistema è in esecuzione. Questo campo identificherà in modo univoco lo stesso soggetto del grafico in account e organizzazioni.

directoryAlias

string

Deprecato: può essere recuperato eseguendo una 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 del grafico. Per modificare questo campo, è necessario modificarne il valore 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 si fa riferimento nella voce "membershipState" del dizionario "_links" GraphUser

isAadIdentity

boolean

Deprecato: può essere dedotto dal tipo di soggetto del descrittore (Descriptor.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.

IgnoredGate

Nome Tipo Descrizione
lastModifiedOn

string (date-time)

Ottiene la data dell'ultima ignorata.

name

string

Nome del gate ignorato.

Issue

Nome Tipo Descrizione
data

object

Rilasciare dati.

issueType

string

Tipo di problema, ad esempio errore, avviso o informazioni.

message

string

Messaggio di problema.

ManualIntervention

Nome Tipo Descrizione
approver

IdentityRef

Ottiene o imposta l'identità che deve approvare.

comments

string

Ottiene o imposta i commenti per l'approvazione.

createdOn

string (date-time)

Ottiene la data in cui è stata creata.

id

integer (int32)

Ottiene l'identificatore univoco per l'intervento manuale.

instructions

string

Ottiene o imposta istruzioni per l'approvazione.

modifiedOn

string (date-time)

Ottiene la data in cui è stata modificata.

name

string

Ottiene o imposta il nome.

release

ReleaseShallowReference

Ottiene releaseReference per l'intervento manuale.

releaseDefinition

ReleaseDefinitionShallowReference

Ottiene releaseDefinitionReference per l'intervento manuale.

releaseEnvironment

ReleaseEnvironmentShallowReference

Ottiene releaseEnvironmentReference per l'intervento manuale.

status

ManualInterventionStatus

Ottiene o imposta lo stato dell'intervento manuale.

taskInstanceId

string (uuid)

Ottiene l'identificatore dell'istanza dell'attività.

url

string

Ottiene l'URL per accedere all'intervento manuale.

ManualInterventionStatus

Ottiene o imposta lo stato dell'intervento manuale.

Valore Descrizione
approved

L'intervento manuale viene approvato.

canceled

L'intervento manuale viene annullato.

pending

L'intervento manuale è in sospeso.

rejected

L'intervento manuale viene rifiutato.

unknown

L'intervento manuale non dispone del set di stato.

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 (uuid)

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 di DBNull vengono accettati. I valori di tipo Byte[], Int32, Double, DateType e String mantengono il tipo, le altre primitive vengono ricreate come String. Byte[] previsto come stringa con codifica Base64.

Nome Tipo Descrizione
count

integer (int32)

Conteggio delle proprietà nell'insieme.

item

object

keys

string[]

Set di chiavi nella raccolta.

values

string[]

Set di valori nell'insieme.

Classe per rappresentare una raccolta di collegamenti di riferimento REST.

Nome Tipo Descrizione
links

object

Visualizzazione di sola lettura dei collegamenti. Poiché i collegamenti di riferimento sono di sola lettura, è consigliabile esporli solo come di sola lettura.

Release

Nome Tipo Descrizione
_links

ReferenceLinks

Ottiene i collegamenti per accedere alla versione.

artifacts

Artifact[]

Ottiene o imposta l'elenco di artefatti.

comment

string

Ottiene o imposta il commento.

createdBy

IdentityRef

Ottiene o imposta l'identità creata.

createdFor

IdentityRef

Ottiene o imposta l'identità per cui è stata creata la versione.

createdOn

string (date-time)

Ottiene la data in cui è stata creata.

definitionSnapshotRevision

integer (int32)

Ottiene il numero di revisione dello snapshot di definizione.

description

string

Ottiene o imposta la descrizione della versione.

environments

ReleaseEnvironment[]

Ottiene l'elenco di ambienti.

id

integer (int32)

Ottiene l'identificatore univoco di questo campo.

keepForever

boolean

Indica se escludere il rilascio dai criteri di conservazione.

logsContainerUrl

string

Ottiene l'URL del contenitore dei log.

modifiedBy

IdentityRef

Ottiene o imposta l'identità modificata.

modifiedOn

string (date-time)

Ottiene la data in cui è stata modificata.

name

string

Ottiene il nome.

poolName

string

Ottiene il nome del pool.

projectReference

ProjectReference

Ottiene o imposta il riferimento al progetto.

properties

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 di DBNull vengono accettati. I valori di tipo Byte[], Int32, Double, DateType e String mantengono il tipo, le altre primitive vengono ricreate come String. Byte[] previsto come stringa con codifica Base64.

reason

ReleaseReason

Ottiene il motivo della versione.

releaseDefinition

ReleaseDefinitionShallowReference

Ottiene releaseDefinitionReference che specifica il riferimento della definizione di versione a cui è associata questa versione.

releaseDefinitionRevision

integer (int32)

Ottiene o imposta la revisione della definizione di versione.

releaseNameFormat

string

Ottiene il formato del nome della versione.

status

ReleaseStatus

Ottiene lo stato.

tags

string[]

Ottiene o imposta un elenco di tag.

triggeringArtifactAlias

string

variableGroups

VariableGroup[]

Ottiene l'elenco di gruppi di variabili.

variables

<string,  ConfigurationVariableValue>

Ottiene o imposta il dizionario delle variabili.

ReleaseApproval

Nome Tipo Descrizione
approvalType

ApprovalType

Ottiene o imposta il tipo di approvazione.

approvedBy

IdentityRef

Ottiene l'identità approvata.

approver

IdentityRef

Ottiene o imposta l'identità che deve approvare.

attempt

integer (int32)

Ottiene o imposta un tentativo che specifica come quale tentativo di distribuzione appartiene.

comments

string

Ottiene o imposta i commenti per l'approvazione.

createdOn

string (date-time)

Ottiene la data in cui è stata creata.

history

ReleaseApprovalHistory[]

Ottiene la cronologia che specifica tutte le approvazioni associate all'approvazione.

id

integer (int32)

Ottiene l'identificatore univoco di questo campo.

isAutomated

boolean

Ottiene o imposta quando l'approvazione è automatizzata o meno.

modifiedOn

string (date-time)

Ottiene la data in cui è stata modificata.

rank

integer (int32)

Ottiene o imposta la classificazione che specifica l'ordine dell'approvazione. Ad esempio, lo stesso rango indica l'approvazione parallela.

release

ReleaseShallowReference

Ottiene releaseReference che specifica il riferimento della versione a cui è associata l'approvazione.

releaseDefinition

ReleaseDefinitionShallowReference

Ottiene releaseDefinitionReference che specifica il riferimento della definizione di versione a cui è associata l'approvazione.

releaseEnvironment

ReleaseEnvironmentShallowReference

Ottiene releaseEnvironmentReference che specifica il riferimento dell'ambiente di rilascio a cui è associata questa approvazione.

revision

integer (int32)

Ottiene il numero di revisione.

status

ApprovalStatus

Ottiene o imposta lo stato dell'approvazione.

url

string

Ottiene l'URL per accedere all'approvazione.

ReleaseApprovalHistory

Nome Tipo Descrizione
approver

IdentityRef

Identità del responsabile approvazione.

changedBy

IdentityRef

Identità dell'oggetto che ha modificato l'approvazione.

comments

string

Commenti della cronologia approvazione.

createdOn

string (date-time)

Ora di creazione dell'approvazione.

modifiedOn

string (date-time)

Ora di modifica dell'approvazione.

revision

integer (int32)

Revisione della cronologia di approvazione.

ReleaseCondition

Nome Tipo Descrizione
conditionType

ConditionType

Ottiene o imposta il tipo di condizione.

name

string

Ottiene o imposta il nome della condizione. ad esempio 'ReleaseStarted'.

result

boolean

Risultato della condizione di rilascio.

value

string

Ottiene o imposta il valore della condizione.

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

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

Ottiene o imposta la classificazione del passaggio di approvazione.

ReleaseDefinitionGate

Nome Tipo Descrizione
tasks

WorkflowTask[]

Ottiene o imposta il flusso di lavoro dei controlli.

ReleaseDefinitionGatesOptions

Nome Tipo Descrizione
isEnabled

boolean

Ottiene o imposta come cancelli abilitati o meno.

minimumSuccessDuration

integer (int32)

Ottiene o imposta la durata minima per i risultati costanti dopo una valutazione di gate riusciti.

samplingInterval

integer (int32)

Ottiene o imposta il tempo tra la rivalutazione dei controlli.

stabilizationTime

integer (int32)

Ottiene o imposta il ritardo prima della valutazione.

timeout

integer (int32)

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

id

integer (int32)

ID di ReleaseDefinitionGateStep.

ReleaseDefinitionShallowReference

Nome Tipo Descrizione
_links

ReferenceLinks

Ottiene i collegamenti a risorse, API e viste correlate per la definizione di versione.

id

integer (int32)

Ottiene l'identificatore univoco della definizione di versione.

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.

url

string

Ottiene l'URL dell'API REST per accedere alla definizione di versione.

ReleaseDeployPhase

Nome Tipo Descrizione
deploymentJobs

DeploymentJob[]

Processi di distribuzione della fase.

errorLog

string

Log degli errori di esecuzione delle fasi.

manualInterventions

ManualIntervention[]

Elenco delle informazioni sull'esecuzione delle attività di intervento manuale in fase.

name

string

Nome della fase.

phaseId

string

ID della fase.

phaseType

DeployPhaseTypes

Tipo della fase.

rank

integer (int32)

Classificazione della fase.

runPlanId

string (uuid)

ID piano di esecuzione della fase.

startedOn

string (date-time)

Ora di inizio della fase.

status

DeployPhaseStatus

Stato della fase.

ReleaseEnvironment

Nome Tipo Descrizione
conditions

ReleaseCondition[]

Ottiene l'elenco di condizioni.

createdOn

string (date-time)

Ottiene la data in cui è stata creata.

definitionEnvironmentId

integer (int32)

Ottiene l'ID dell'ambiente di definizione.

deployPhasesSnapshot

DeployPhase[]

Ottiene l'elenco degli snapshot delle fasi di distribuzione.

deploySteps

DeploymentAttempt[]

Ottiene i passaggi di distribuzione.

environmentOptions

EnvironmentOptions

Ottiene le opzioni di ambiente.

id

integer (int32)

Ottiene l'identificatore univoco di questo campo.

modifiedOn

string (date-time)

Ottiene la data in cui è stata modificata.

name

string

Ottiene il nome.

nextScheduledUtcTime

string (date-time)

Ottiene l'ora UTC pianificata successiva.

owner

IdentityRef

Ottiene l'identità proprietaria per l'ambiente di rilascio.

postApprovalsSnapshot

ReleaseDefinitionApprovals

Ottiene l'elenco dello snapshot delle approvazioni post-distribuzione.

postDeployApprovals

ReleaseApproval[]

Ottiene l'elenco delle approvazioni post-distribuzione.

postDeploymentGatesSnapshot

ReleaseDefinitionGatesStep

Dopo la distribuzione, i dati degli snapshot di controllo post-distribuzione.

preApprovalsSnapshot

ReleaseDefinitionApprovals

Ottiene l'elenco di snapshot delle approvazioni di pre-distribuzione.

preDeployApprovals

ReleaseApproval[]

Ottiene l'elenco delle approvazioni di pre-distribuzione.

preDeploymentGatesSnapshot

ReleaseDefinitionGatesStep

Pre-deployment gate snapshot data .Pre deployment gates snapshot data.Pre deployment gates snapshot data.

processParameters

ProcessParameters

Ottiene i parametri del processo.

rank

integer (int32)

Ottiene la classificazione.

release

ReleaseShallowReference

Ottiene il riferimento alla versione che specifica il riferimento della versione a cui è associato questo ambiente di versione.

releaseCreatedBy

IdentityRef

Ottiene l'identità che ha creato la versione.

releaseDefinition

ReleaseDefinitionShallowReference

Ottiene releaseDefinitionReference che specifica il riferimento della definizione di versione a cui è associato questo ambiente di versione.

releaseId

integer (int32)

Ottiene l'ID versione.

scheduledDeploymentTime

string (date-time)

Ottiene l'ora di distribuzione pianificata dell'ambiente di rilascio.

schedules

ReleaseSchedule[]

Ottiene l'elenco delle pianificazioni.

status

EnvironmentStatus

Ottiene lo stato dell'ambiente.

timeToDeploy

number (double)

Ottiene il tempo necessario per la distribuzione.

triggerReason

string

Ottiene il motivo del trigger.

variableGroups

VariableGroup[]

Ottiene l'elenco di gruppi di variabili.

variables

<string,  ConfigurationVariableValue>

Ottiene il dizionario delle variabili.

ReleaseEnvironmentShallowReference

Nome Tipo Descrizione
_links

ReferenceLinks

Ottiene i collegamenti a risorse, API e viste correlate per l'ambiente di rilascio.

id

integer (int32)

Ottiene l'identificatore univoco dell'ambiente di rilascio.

name

string

Ottiene o imposta il nome dell'ambiente di rilascio.

url

string

Ottiene l'URL dell'API REST per accedere all'ambiente di rilascio.

ReleaseGates

Nome Tipo Descrizione
deploymentJobs

DeploymentJob[]

Contiene i dettagli del processo di controllo di ogni valutazione.

id

integer (int32)

ID dei controlli di rilascio.

ignoredGates

IgnoredGate[]

Elenco di cancelli ignorati.

lastModifiedOn

string (date-time)

Ora dell'ultima modifica di Gates.

runPlanId

string (uuid)

ID del piano di esecuzione dei controlli.

stabilizationCompletedOn

string (date-time)

Stabilizzazione dei cancelli completata data e ora.

startedOn

string (date-time)

Tempo di inizio della valutazione di Gates.

status

GateStatus

Stato dei controlli di rilascio.

succeedingSince

string (date-time)

Data e ora in cui tutti i controlli sono stati eseguiti correttamente.

ReleaseReason

Ottiene il motivo della versione.

Valore Descrizione
continuousIntegration

Indica la versione attivata dall'integrazione continua.

manual

Indica la versione attivata manualmente.

none

Indica il motivo attivato per il rilascio non impostato.

pullRequest

Indica la versione attivata da PullRequest.

schedule

Indica la versione attivata dalla pianificazione.

ReleaseSchedule

Nome Tipo Descrizione
daysToRelease

ScheduleDays

Giorni della settimana da rilasciare.

jobId

string (uuid)

ID processo definizione processo Team Foundation.

scheduleOnlyWithChanges

boolean

Flag per determinare se questa pianificazione deve essere rilasciata solo se l'artefatto associato è stato modificato o se la definizione di versione è stata modificata.

startHours

integer (int32)

Ora di fuso orario locale da avviare.

startMinutes

integer (int32)

Fuso orario locale per l'avvio.

timeZoneId

string

ID fuso orario della pianificazione del rilascio, ad esempio 'UTC'.

ReleaseShallowReference

Nome Tipo Descrizione
_links

ReferenceLinks

Ottiene i collegamenti a risorse, API e viste correlate per la versione.

id

integer (int32)

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.

ReleaseStatus

Ottiene lo stato.

Valore Descrizione
abandoned

Lo stato di rilascio è abbandonato.

active

Lo stato della versione è attivo.

draft

Il rilascio è in fase di bozza.

undefined

Stato di rilascio non impostato.

ReleaseTask

Nome Tipo Descrizione
agentName

string

Nome dell'agente in cui viene eseguita l'attività.

finishTime

string (date-time)

Ora di fine dell'attività di rilascio.

id

integer (int32)

ID dell'attività di rilascio.

issues

Issue[]

Elenco di problemi che si sono verificati durante l'esecuzione dell'attività.

lineCount

integer (int64)

Numero di righe di attività di rilascio del log.

logUrl

string

URL del log dell'attività.

name

string

Nome dell'attività.

percentComplete

integer (int32)

Completamento dell'esecuzione dell'attività.

rank

integer (int32)

Classificazione dell'attività di rilascio.

resultCode

string

Codice di risultato dell'attività.

startTime

string (date-time)

ID dell'attività di rilascio.

status

TaskStatus

Stato dell'attività di rilascio.

task

WorkflowTaskReference

Informazioni di riferimento sulle attività del flusso di lavoro.

timelineRecordId

string (uuid)

ID record sequenza temporale dell'attività di rilascio.

ScheduleDays

Giorni della settimana da rilasciare.

Valore Descrizione
all

Pianificato in tutti i giorni della settimana.

friday

Programmato il venerdì.

monday

Programmato il lunedì.

none

Giorno pianificato non impostato.

saturday

Programmato sabato.

sunday

Programmata la domenica.

thursday

Programmato giovedì.

tuesday

Programmato martedì.

wednesday

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

TaskStatus

Stato dell'attività di rilascio.

Valore Descrizione
canceled

Esecuzione dell'attività annullata.

failed

L'esecuzione dell'attività non è riuscita.

failure

L'esecuzione dell'attività non è riuscita.

inProgress

L'attività è attualmente in corso.

partiallySucceeded

L'esecuzione dell'attività è stata completata parzialmente.

pending

L'attività è in sospeso.

skipped

Esecuzione dell'attività ignorata.

succeeded

L'attività è stata completata correttamente.

success

L'attività è stata completata correttamente.

unknown

L'attività non ha il set di stato.

VariableGroup

Nome Tipo Descrizione
createdBy

IdentityRef

Ottiene o imposta l'identità creata.

createdOn

string (date-time)

Ottiene la data in cui è stata creata.

description

string

Ottiene o imposta la descrizione.

id

integer (int32)

Ottiene l'identificatore univoco di questo campo.

isShared

boolean

Indica se un gruppo di variabili viene condiviso con un altro progetto o meno.

modifiedBy

IdentityRef

Ottiene o imposta l'identità modificata.

modifiedOn

string (date-time)

Ottiene la data in cui è stata modificata.

name

string

Ottiene o imposta il nome.

providerData

VariableGroupProviderData

Ottiene o imposta i dati del provider.

type

string

Ottiene o imposta il tipo.

variableGroupProjectReferences

VariableGroupProjectReference[]

tutti i riferimenti al progetto in cui il gruppo di variabili è condiviso con altri progetti.

variables

<string,  VariableValue>

Ottiene e imposta il dizionario delle variabili.

VariableGroupProjectReference

Un riferimento a un gruppo di variabili è un riferimento superficiale al gruppo di variabili.

Nome Tipo Descrizione
description

string

Ottiene o imposta la descrizione del gruppo di variabili.

name

string

Ottiene o imposta il nome del gruppo di variabili.

projectReference

ProjectReference

Ottiene o imposta il riferimento al progetto del gruppo di variabili.

VariableGroupProviderData

VariableValue

Nome Tipo Descrizione
isReadOnly

boolean

Ottiene o imposta se la variabile è di sola lettura o meno.

isSecret

boolean

Ottiene o imposta come la variabile è segreta o meno.

value

string

Ottiene o imposta il valore.

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 quando 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 l'override degli input dell'attività.

refName

string

Ottiene o imposta il nome di riferimento dell'attività.

retryCountOnTaskFailure

integer (int32)

Ottiene o imposta l'attività retryCount.

taskId

string (uuid)

Ottiene o imposta l'ID dell'attività.

timeoutInMinutes

integer (int32)

Ottiene o imposta il timeout dell'attività.

version

string

Ottiene o imposta la versione dell'attività.

WorkflowTaskReference

Nome Tipo Descrizione
id

string (uuid)

Identificatore dell'attività.

name

string

Nome dell'attività.

version

string

Versione dell'attività.