Condividi tramite


Releases - Get Release

Ottenere una versione

GET https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/releases/{releaseId}?api-version=7.1-preview.8
GET https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/releases/{releaseId}?approvalFilters={approvalFilters}&propertyFilters={propertyFilters}&$expand={$expand}&$topGateRecords={$topGateRecords}&api-version=7.1-preview.8

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

releaseId
path True

integer

int32

ID della versione.

api-version
query True

string

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

$expand
query

SingleReleaseExpands

Proprietà che deve essere espansa nella versione.

$topGateRecords
query

integer

int32

Numero di record di controllo di rilascio da ottenere. Il valore predefinito è 5.

approvalFilters
query

ApprovalFilters

Filtro che consente di recuperare i passaggi di approvazione in modo selettivo in base al fatto che sia automatizzato o manuale. In questo modo si deciderà anche se recuperare gli snapshot di pre-approvazione e post-approvazione. Presuppone tutti per impostazione predefinita

propertyFilters
query

string

array (string)

Elenco delimitato da virgole di proprietà estese da recuperare. Se impostato, la versione restituita conterrà i valori per gli ID proprietà specificati (se esistenti). Se non impostata, le proprietà non verranno incluse.

Risposte

Nome Tipo Descrizione
200 OK

Release

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 Concede la possibilità di leggere gli artefatti della versione, incluse cartelle, versioni, definizioni di versione e ambiente di rilascio.

Esempio

Sample Request

GET https://vsrm.dev.azure.com/fabrikam/MyFirstProject/_apis/release/releases/{releaseId}?api-version=7.1-preview.8

Sample Response

{
  "id": 18,
  "name": "Release-18",
  "status": "abandoned",
  "createdOn": "2017-06-16T01:36:20.397Z",
  "modifiedOn": "2017-06-16T01:36:21.07Z",
  "modifiedBy": {
    "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
    "displayName": "Chuck Reinhart",
    "uniqueName": "fabfiber@outlook.com",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
  },
  "createdBy": {
    "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
    "displayName": "Chuck Reinhart",
    "uniqueName": "fabfiber@outlook.com",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
  },
  "environments": [
    {
      "id": 69,
      "releaseId": 18,
      "name": "Dev",
      "status": "notStarted",
      "variables": {},
      "preDeployApprovals": [],
      "postDeployApprovals": [],
      "preApprovalsSnapshot": {
        "approvals": [
          {
            "rank": 1,
            "isAutomated": false,
            "isNotificationOn": false,
            "approver": {
              "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
              "displayName": "Chuck Reinhart",
              "uniqueName": "fabfiber@outlook.com",
              "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
              "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
            },
            "id": 0
          }
        ],
        "approvalOptions": {
          "requiredApproverCount": 0,
          "releaseCreatorCanBeApprover": true,
          "autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped": false,
          "enforceIdentityRevalidation": false,
          "timeoutInMintues": 43200
        }
      },
      "postApprovalsSnapshot": {
        "approvals": [
          {
            "rank": 1,
            "isAutomated": true,
            "isNotificationOn": false,
            "id": 0
          }
        ]
      },
      "deploySteps": [],
      "rank": 1,
      "definitionEnvironmentId": 1,
      "environmentOptions": {
        "emailNotificationType": "OnlyOnFailure",
        "emailRecipients": "release.environment.owner;release.creator",
        "skipArtifactsDownload": false,
        "timeoutInMinutes": 0,
        "enableAccessToken": false,
        "publishDeploymentStatus": false
      },
      "demands": [],
      "conditions": [],
      "workflowTasks": [],
      "deployPhasesSnapshot": [
        {
          "deploymentInput": {
            "parallelExecution": {
              "parallelExecutionType": "none"
            },
            "skipArtifactsDownload": false,
            "timeoutInMinutes": 0,
            "queueId": 2,
            "demands": [],
            "enableAccessToken": false
          },
          "rank": 1,
          "phaseType": "agentBasedDeployment",
          "name": "Run on agent",
          "workflowTasks": [
            {
              "taskId": "e213ff0f-5d5c-4791-802d-52ea3e7be1f1",
              "version": "1.*",
              "name": "PowerShell Script",
              "enabled": true,
              "alwaysRun": false,
              "continueOnError": false,
              "timeoutInMinutes": 0,
              "definitionType": "task",
              "inputs": {
                "scriptType": "inlineScript",
                "scriptName": "",
                "arguments": "",
                "inlineScript": "# You can write your powershell scripts inline here. \n# You can also pass predefined and custom variables to this scripts using arguments\n\n Write-Host \"Hello World\"",
                "workingFolder": "",
                "failOnStandardError": "true"
              }
            }
          ]
        }
      ],
      "owner": {
        "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "displayName": "Chuck Reinhart",
        "uniqueName": "fabfiber@outlook.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
      },
      "schedules": [],
      "release": {
        "id": 18,
        "name": "Release-18",
        "url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/18",
        "_links": {
          "web": {
            "href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?releaseId=18&_a=release-summary"
          },
          "self": {
            "href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/18"
          }
        }
      },
      "releaseDefinition": {
        "id": 1,
        "name": "MyShuttle.CD",
        "url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1",
        "_links": {
          "web": {
            "href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?definitionId=1"
          },
          "self": {
            "href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1"
          }
        }
      },
      "releaseCreatedBy": {
        "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "displayName": "Chuck Reinhart"
      },
      "triggerReason": "Manual"
    },
    {
      "id": 70,
      "releaseId": 18,
      "name": "QA",
      "status": "notStarted",
      "variables": {},
      "preDeployApprovals": [],
      "postDeployApprovals": [],
      "preApprovalsSnapshot": {
        "approvals": [
          {
            "rank": 1,
            "isAutomated": true,
            "isNotificationOn": false,
            "id": 0
          }
        ]
      },
      "postApprovalsSnapshot": {
        "approvals": [
          {
            "rank": 1,
            "isAutomated": true,
            "isNotificationOn": false,
            "id": 0
          }
        ]
      },
      "deploySteps": [],
      "rank": 2,
      "definitionEnvironmentId": 2,
      "environmentOptions": {
        "emailNotificationType": "OnlyOnFailure",
        "emailRecipients": "release.environment.owner;release.creator",
        "skipArtifactsDownload": false,
        "timeoutInMinutes": 0,
        "enableAccessToken": false,
        "publishDeploymentStatus": false
      },
      "demands": [],
      "conditions": [
        {
          "result": false,
          "name": "Dev",
          "conditionType": "environmentState",
          "value": "4"
        }
      ],
      "workflowTasks": [],
      "deployPhasesSnapshot": [
        {
          "deploymentInput": {
            "parallelExecution": {
              "parallelExecutionType": "none"
            },
            "skipArtifactsDownload": false,
            "timeoutInMinutes": 0,
            "queueId": 2,
            "demands": [],
            "enableAccessToken": false
          },
          "rank": 1,
          "phaseType": "agentBasedDeployment",
          "name": "Run on agent",
          "workflowTasks": [
            {
              "taskId": "e213ff0f-5d5c-4791-802d-52ea3e7be1f1",
              "version": "1.*",
              "name": "PowerShell Script",
              "enabled": true,
              "alwaysRun": false,
              "continueOnError": false,
              "timeoutInMinutes": 0,
              "definitionType": "task",
              "inputs": {
                "scriptType": "inlineScript",
                "scriptName": "",
                "arguments": "",
                "inlineScript": "# You can write your powershell scripts inline here. \n# You can also pass predefined and custom variables to this scripts using arguments\n\n Write-Host \"Hello World\"",
                "workingFolder": "",
                "failOnStandardError": "true"
              }
            }
          ]
        }
      ],
      "owner": {
        "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "displayName": "Chuck Reinhart",
        "uniqueName": "fabfiber@outlook.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
      },
      "schedules": [],
      "release": {
        "id": 18,
        "name": "Release-18",
        "url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/18",
        "_links": {
          "web": {
            "href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?releaseId=18&_a=release-summary"
          },
          "self": {
            "href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/18"
          }
        }
      },
      "releaseDefinition": {
        "id": 1,
        "name": "MyShuttle.CD",
        "url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1",
        "_links": {
          "web": {
            "href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?definitionId=1"
          },
          "self": {
            "href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1"
          }
        }
      },
      "releaseCreatedBy": {
        "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "displayName": "Chuck Reinhart"
      },
      "triggerReason": "After successful deployment of Dev"
    },
    {
      "id": 71,
      "releaseId": 18,
      "name": "PPE",
      "status": "notStarted",
      "variables": {},
      "preDeployApprovals": [],
      "postDeployApprovals": [],
      "preApprovalsSnapshot": {
        "approvals": [
          {
            "rank": 1,
            "isAutomated": true,
            "isNotificationOn": false,
            "id": 0
          }
        ]
      },
      "postApprovalsSnapshot": {
        "approvals": [
          {
            "rank": 1,
            "isAutomated": true,
            "isNotificationOn": false,
            "id": 0
          }
        ]
      },
      "deploySteps": [],
      "rank": 3,
      "definitionEnvironmentId": 3,
      "environmentOptions": {
        "emailNotificationType": "OnlyOnFailure",
        "emailRecipients": "release.environment.owner;release.creator",
        "skipArtifactsDownload": false,
        "timeoutInMinutes": 0,
        "enableAccessToken": false,
        "publishDeploymentStatus": false
      },
      "demands": [],
      "conditions": [
        {
          "result": false,
          "name": "QA",
          "conditionType": "environmentState",
          "value": "4"
        }
      ],
      "workflowTasks": [],
      "deployPhasesSnapshot": [
        {
          "deploymentInput": {
            "parallelExecution": {
              "parallelExecutionType": "none"
            },
            "skipArtifactsDownload": false,
            "timeoutInMinutes": 0,
            "queueId": 2,
            "demands": [],
            "enableAccessToken": false
          },
          "rank": 1,
          "phaseType": "agentBasedDeployment",
          "name": "Run on agent",
          "workflowTasks": [
            {
              "taskId": "e213ff0f-5d5c-4791-802d-52ea3e7be1f1",
              "version": "1.*",
              "name": "PowerShell Script",
              "enabled": true,
              "alwaysRun": false,
              "continueOnError": false,
              "timeoutInMinutes": 0,
              "definitionType": "task",
              "inputs": {
                "scriptType": "inlineScript",
                "scriptName": "",
                "arguments": "",
                "inlineScript": "# You can write your powershell scripts inline here. \n# You can also pass predefined and custom variables to this scripts using arguments\n\n Write-Host \"Hello World\"",
                "workingFolder": "",
                "failOnStandardError": "true"
              }
            }
          ]
        }
      ],
      "owner": {
        "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "displayName": "Chuck Reinhart",
        "uniqueName": "fabfiber@outlook.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
      },
      "schedules": [],
      "release": {
        "id": 18,
        "name": "Release-18",
        "url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/18",
        "_links": {
          "web": {
            "href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?releaseId=18&_a=release-summary"
          },
          "self": {
            "href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/18"
          }
        }
      },
      "releaseDefinition": {
        "id": 1,
        "name": "MyShuttle.CD",
        "url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1",
        "_links": {
          "web": {
            "href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?definitionId=1"
          },
          "self": {
            "href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1"
          }
        }
      },
      "releaseCreatedBy": {
        "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "displayName": "Chuck Reinhart"
      },
      "triggerReason": "After successful deployment of QA"
    },
    {
      "id": 72,
      "releaseId": 18,
      "name": "PROD",
      "status": "notStarted",
      "variables": {},
      "preDeployApprovals": [],
      "postDeployApprovals": [],
      "preApprovalsSnapshot": {
        "approvals": [
          {
            "rank": 1,
            "isAutomated": true,
            "isNotificationOn": false,
            "id": 0
          }
        ]
      },
      "postApprovalsSnapshot": {
        "approvals": [
          {
            "rank": 1,
            "isAutomated": true,
            "isNotificationOn": false,
            "id": 0
          }
        ]
      },
      "deploySteps": [],
      "rank": 4,
      "definitionEnvironmentId": 4,
      "environmentOptions": {
        "emailNotificationType": "OnlyOnFailure",
        "emailRecipients": "release.environment.owner;release.creator",
        "skipArtifactsDownload": false,
        "timeoutInMinutes": 0,
        "enableAccessToken": false,
        "publishDeploymentStatus": false
      },
      "demands": [],
      "conditions": [
        {
          "result": false,
          "name": "PPE",
          "conditionType": "environmentState",
          "value": "4"
        }
      ],
      "workflowTasks": [],
      "deployPhasesSnapshot": [
        {
          "deploymentInput": {
            "parallelExecution": {
              "parallelExecutionType": "none"
            },
            "skipArtifactsDownload": false,
            "timeoutInMinutes": 0,
            "queueId": 2,
            "demands": [],
            "enableAccessToken": false
          },
          "rank": 1,
          "phaseType": "agentBasedDeployment",
          "name": "Run on agent",
          "workflowTasks": [
            {
              "taskId": "e213ff0f-5d5c-4791-802d-52ea3e7be1f1",
              "version": "1.*",
              "name": "PowerShell Script",
              "enabled": true,
              "alwaysRun": false,
              "continueOnError": false,
              "timeoutInMinutes": 0,
              "definitionType": "task",
              "inputs": {
                "scriptType": "inlineScript",
                "scriptName": "",
                "arguments": "",
                "inlineScript": "# You can write your powershell scripts inline here. \n# You can also pass predefined and custom variables to this scripts using arguments\n\n Write-Host \"Hello World\"",
                "workingFolder": "",
                "failOnStandardError": "true"
              }
            }
          ]
        }
      ],
      "owner": {
        "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "displayName": "Chuck Reinhart",
        "uniqueName": "fabfiber@outlook.com",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=4adb1680-0eac-6149-b5ee-fc8b4f6ca227"
      },
      "schedules": [],
      "release": {
        "id": 18,
        "name": "Release-18",
        "url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/18",
        "_links": {
          "web": {
            "href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?releaseId=18&_a=release-summary"
          },
          "self": {
            "href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/18"
          }
        }
      },
      "releaseDefinition": {
        "id": 1,
        "name": "MyShuttle.CD",
        "url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1",
        "_links": {
          "web": {
            "href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?definitionId=1"
          },
          "self": {
            "href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1"
          }
        }
      },
      "releaseCreatedBy": {
        "id": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
        "displayName": "Chuck Reinhart"
      },
      "triggerReason": "After successful deployment of PPE"
    }
  ],
  "variables": {},
  "variableGroups": [],
  "artifacts": [
    {
      "sourceId": "d07908bc-118f-47d2-8a13-ff75601a6b1a:1",
      "type": "Build",
      "alias": "Fabrikam.CI",
      "definitionReference": {
        "artifactSourceDefinitionUrl": {
          "id": "https://dev.azure.com/fabrikam/_permalink/_build/index?collectionId=13d3daac-03b8-4a23-9cc4-2c3de65dab63&projectId=d07908bc-118f-47d2-8a13-ff75601a6b1a&definitionId=1",
          "name": ""
        },
        "defaultVersionBranch": {
          "id": "",
          "name": ""
        },
        "defaultVersionSpecific": {
          "id": "",
          "name": ""
        },
        "defaultVersionTags": {
          "id": "",
          "name": ""
        },
        "defaultVersionType": {
          "id": "latestType",
          "name": "Latest"
        },
        "definition": {
          "id": "1",
          "name": "Fabrikam.CI"
        },
        "project": {
          "id": "d07908bc-118f-47d2-8a13-ff75601a6b1a",
          "name": "MyFirstProject"
        },
        "version": {
          "id": "2",
          "name": "2"
        },
        "artifactSourceVersionUrl": {
          "id": "https://dev.azure.com/fabrikam/_permalink/_build/index?collectionId=13d3daac-03b8-4a23-9cc4-2c3de65dab63&projectId=d07908bc-118f-47d2-8a13-ff75601a6b1a&buildId=2",
          "name": ""
        },
        "branch": {
          "id": "refs/heads/master",
          "name": "refs/heads/master"
        }
      },
      "isPrimary": true
    }
  ],
  "releaseDefinition": {
    "id": 1,
    "name": "MyShuttle.CD",
    "url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1",
    "_links": {
      "self": {
        "href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/definitions/1"
      },
      "web": {
        "href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?definitionId=1"
      }
    }
  },
  "description": "Creating Sample release",
  "reason": "manual",
  "releaseNameFormat": "Release-$(rev:r)",
  "keepForever": false,
  "definitionSnapshotRevision": 1,
  "logsContainerUrl": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/18/logs",
  "url": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/18",
  "_links": {
    "self": {
      "href": "https://vsrm.dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_apis/Release/releases/18"
    },
    "web": {
      "href": "https://dev.azure.com/fabrikam/d07908bc-118f-47d2-8a13-ff75601a6b1a/_release?releaseId=18&_a=release-summary"
    }
  },
  "tags": [],
  "projectReference": {
    "id": "d07908bc-118f-47d2-8a13-ff75601a6b1a",
    "name": null
  },
  "properties": {}
}

Definizioni

Nome Descrizione
ApprovalExecutionOrder

Ordine di esecuzione approvazioni.

ApprovalFilters

Filtro che consente di recuperare i passaggi di approvazione in modo selettivo in base al fatto che sia automatizzato o manuale. Ciò potrebbe anche decidere se recuperare snapshot di pre e post approvazione. Presuppone tutto per impostazione predefinita

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 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 con codifica Base64.

ReferenceLinks

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

SingleReleaseExpands

Proprietà che deve essere espansa nella versione.

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.

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.

ApprovalFilters

Filtro che consente di recuperare i passaggi di approvazione in modo selettivo in base al fatto che sia automatizzato o manuale. Ciò potrebbe anche decidere se recuperare snapshot di pre e post approvazione. Presuppone tutto per impostazione predefinita

Nome Tipo Descrizione
all

string

Tutti i passaggi di approvazione e gli snapshot di approvazione.

approvalSnapshots

string

Nessun passaggio di approvazione, ma snapshot di approvazione (usare con ManualApprovals o AutomatedApprovals per i passaggi di approvazione).

automatedApprovals

string

Passaggi di approvazione automatizzati, ma non snapshot di approvazione (Usare con ApprovalSnapshots per gli snapshot).

manualApprovals

string

Passaggi di approvazione manuali ma non snapshot di approvazione (Usare con ApprovalSnapshots per gli snapshot).

none

string

Nessuna approvazione o snapshot di approvazione.

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.

ApprovalStatus

Ottiene o imposta lo stato dell'approvazione.

Nome Tipo Descrizione
approved

string

Indica che l'approvazione è approvata.

canceled

string

Indica che l'approvazione è stata annullata.

pending

string

Indica che l'approvazione è in sospeso.

reassigned

string

Indica che l'approvazione è riassegnata.

rejected

string

Indica che l'approvazione è stata rifiutata.

skipped

string

Indica che l'approvazione viene ignorata.

undefined

string

Indica che l'approvazione non ha lo stato impostato.

ApprovalType

Ottiene o imposta il tipo di approvazione.

Nome Tipo Descrizione
all

string

Indica tutte le approvazioni.

postDeploy

string

Indica le approvazioni eseguite dopo la distribuzione.

preDeploy

string

Indica le approvazioni eseguite prima della distribuzione.

undefined

string

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

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

DeploymentAttempt

Nome Tipo Descrizione
attempt

integer

Tentativo di distribuzione.

deploymentId

integer

ID della distribuzione.

hasStarted

boolean

Specifica se la distribuzione è stata avviata o meno.

id

integer

ID della distribuzione.

issues

Issue[]

Tutti i problemi relativi alla distribuzione.

lastModifiedBy

IdentityRef

Identità dell'ultima modifica di questa distribuzione.

lastModifiedOn

string

Ora dell'ultima modifica della distribuzione.

operationStatus

DeploymentOperationStatus

Stato dell'operazione di distribuzione.

postDeploymentGates

ReleaseGates

Post-deployment gates che sono stati eseguiti in questa distribuzione.

preDeploymentGates

ReleaseGates

Controlli di pre-distribuzione eseguiti in questa distribuzione.

queuedOn

string

Quando questa 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 di attività eseguite con nel processo.

DeploymentOperationStatus

Ottiene lo stato dell'operazione di distribuzione.

Nome Tipo Descrizione
all

string

Lo stato dell'operazione di distribuzione è tutto.

approved

string

Lo stato dell'operazione di distribuzione è approvato.

canceled

string

Lo stato dell'operazione di distribuzione viene annullato.

cancelling

string

Lo stato dell'operazione di distribuzione viene annullato.

deferred

string

Lo stato dell'operazione di distribuzione viene posticipato.

evaluatingGates

string

Lo stato dell'operazione di distribuzione è La valutazione diGate.

gateFailed

string

Lo stato dell'operazione di distribuzione è GateFailed.

manualInterventionPending

string

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

pending

string

Lo stato dell'operazione di distribuzione è in sospeso.

phaseCanceled

string

Lo stato dell'operazione di distribuzione viene annullata.

phaseFailed

string

Lo stato dell'operazione di distribuzione non è riuscito.

phaseInProgress

string

Lo stato dell'operazione di distribuzione è in corso.

phasePartiallySucceeded

string

Lo stato dell'operazione di distribuzione è parzialmente riuscito.

phaseSucceeded

string

Lo stato dell'operazione di distribuzione è stata completata.

queued

string

Lo stato dell'operazione di distribuzione viene accodato.

queuedForAgent

string

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

queuedForPipeline

string

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

rejected

string

Lo stato dell'operazione di distribuzione viene rifiutato.

scheduled

string

Lo stato dell'operazione di distribuzione è pianificato.

undefined

string

Lo stato dell'operazione di distribuzione non è definito.

DeploymentReason

Ottiene il motivo della distribuzione.

Nome Tipo Descrizione
automated

string

Il motivo della distribuzione è automatizzato.

manual

string

Il motivo della distribuzione è manuale.

none

string

Il motivo della distribuzione è nessuno.

redeployTrigger

string

Il motivo della distribuzione è RedeployTrigger.

scheduled

string

Il motivo della distribuzione è pianificato.

DeploymentStatus

Ottiene lo stato della distribuzione.

Nome Tipo Descrizione
all

string

Lo stato della distribuzione è tutto.

failed

string

Lo stato della distribuzione non è riuscito.

inProgress

string

Lo stato della distribuzione è in corso.

notDeployed

string

Lo stato della distribuzione non viene distribuito.

partiallySucceeded

string

Lo stato della distribuzione è parzialmente riuscito.

succeeded

string

Lo stato della distribuzione è riuscito.

undefined

string

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

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.

Nome Tipo Descrizione
canceled

string

Esecuzione della fase annullata.

cancelling

string

La fase è in stato di annullamento.

failed

string

L'esecuzione della fase non è riuscita.

inProgress

string

Esecuzione in fase in corso.

notStarted

string

L'esecuzione della fase non è stata avviata.

partiallySucceeded

string

L'esecuzione della fase è stata completata parzialmente.

skipped

string

Esecuzione della fase ignorata.

succeeded

string

L'esecuzione della fase è riuscita.

undefined

string

Stato fase non impostato.

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.

EnvironmentOptions

Nome Tipo Descrizione
autoLinkWorkItems

boolean

Ottiene e imposta come elementi di lavoro di 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.

Nome Tipo Descrizione
canceled

string

L'ambiente è in stato annullato.

inProgress

string

L'ambiente è in corso.

notStarted

string

L'ambiente non è avviato.

partiallySucceeded

string

L'ambiente è parzialmente riuscito.

queued

string

L'ambiente è in coda.

rejected

string

L'ambiente è in stato rifiutato.

scheduled

string

L'ambiente è in stato pianificato.

succeeded

string

L'ambiente è in stato riuscito.

undefined

string

Stato dell'ambiente non impostato.

GateStatus

Stato dei controlli di rilascio.

Nome Tipo Descrizione
canceled

string

L'esecuzione del gate è stata annullata.

failed

string

L'esecuzione del gate non è riuscita.

inProgress

string

Il cancello è attualmente in corso.

none

string

Il gate non ha lo stato impostato.

pending

string

Il gate è in sospeso.

succeeded

string

Il cancello è 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 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.

IgnoredGate

Nome Tipo Descrizione
lastModifiedOn

string

Ottiene la data in cui l'ultima porta viene ignorata.

name

string

Nome del gate ignorato.

Issue

Nome Tipo Descrizione
data

object

Rilasciare i dati.

issueType

string

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

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

Ottiene la data in cui è stata creata.

id

integer

Ottiene l'identificatore univoco per l'intervento manuale.

instructions

string

Ottiene o imposta le istruzioni per l'approvazione.

modifiedOn

string

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

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.

Nome Tipo Descrizione
approved

string

L'intervento manuale viene approvato.

canceled

string

L'intervento manuale viene annullato.

pending

string

L'intervento manuale è in sospeso.

rejected

string

L'intervento manuale viene rifiutato.

unknown

string

L'intervento manuale non ha lo stato impostato.

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 con codifica Base64.

Nome Tipo Descrizione
count

integer

Conteggio delle proprietà nell'insieme.

item

object

keys

string[]

Set di chiavi nell'insieme.

values

string[]

Set di valori nell'insieme.

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.

Release

Nome Tipo Descrizione
_links

ReferenceLinks

Ottiene collegamenti per accedere alla 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.

createdFor

IdentityRef

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

createdOn

string

Ottiene la data in cui è stata creata.

definitionSnapshotRevision

integer

Ottiene il numero di revisioni dello snapshot della definizione.

description

string

Ottiene o imposta la descrizione della versione.

environments

ReleaseEnvironment[]

Ottiene l'elenco degli ambienti.

id

integer

Ottiene l'identificatore univoco di questo campo.

keepForever

boolean

Se escludere la versione dai criteri di conservazione.

logsContainerUrl

string

Ottiene l'URL del contenitore dei log.

modifiedBy

IdentityRef

Ottiene o imposta l'identità modificata.

modifiedOn

string

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

reason

ReleaseReason

Ottiene il motivo della versione.

releaseDefinition

ReleaseDefinitionShallowReference

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

releaseDefinitionRevision

integer

Ottiene o imposta la revisione della definizione della versione.

releaseNameFormat

string

Ottiene il formato del nome della versione.

status

ReleaseStatus

Ottiene lo stato.

tags

string[]

Ottiene o imposta l'elenco dei tag.

triggeringArtifactAlias

string

variableGroups

VariableGroup[]

Ottiene l'elenco dei 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

Ottiene o imposta un tentativo che specifica il tentativo di distribuzione a cui appartiene.

comments

string

Ottiene o imposta i commenti per l'approvazione.

createdOn

string

Ottiene la data in cui è stata creata.

history

ReleaseApprovalHistory[]

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

id

integer

Ottiene l'identificatore univoco di questo campo.

isAutomated

boolean

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

modifiedOn

string

Ottiene la data in cui è stata modificata.

rank

integer

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 questa 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 versione a cui è associata questa approvazione.

revision

integer

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

createdOn

string

Ora di creazione dell'approvazione.

modifiedOn

string

Ora di modifica dell'approvazione.

revision

integer

Revisione della cronologia delle approvazioni.

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

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.

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

id

integer

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

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

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

Classificazione della fase.

runPlanId

string

Eseguire l'ID piano della fase.

startedOn

string

Ora di inizio fase.

status

DeployPhaseStatus

Stato della fase.

ReleaseEnvironment

Nome Tipo Descrizione
conditions

ReleaseCondition[]

Ottiene l'elenco delle condizioni.

createdOn

string

Ottiene la data in cui è stata creata.

definitionEnvironmentId

integer

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

Ottiene l'identificatore univoco di questo campo.

modifiedOn

string

Ottiene la data in cui è stata modificata.

name

string

Ottiene il nome.

nextScheduledUtcTime

string

Ottiene l'ora UTC pianificata successiva.

owner

IdentityRef

Ottiene l'identità proprietario dell'ambiente di rilascio.

postApprovalsSnapshot

ReleaseDefinitionApprovals

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

postDeployApprovals

ReleaseApproval[]

Ottiene l'elenco delle approvazioni post di distribuzione.

postDeploymentGatesSnapshot

ReleaseDefinitionGatesStep

Post deployment gates snapshot data (Post deployment gates snapshot data).

preApprovalsSnapshot

ReleaseDefinitionApprovals

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

preDeployApprovals

ReleaseApproval[]

Ottiene l'elenco delle approvazioni di pre-distribuzione.

preDeploymentGatesSnapshot

ReleaseDefinitionGatesStep

Pre deployment gates snapshot data.

processParameters

ProcessParameters

Ottiene i parametri del processo.

rank

integer

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 alla definizione della versione a cui è associato questo ambiente di versione.

releaseId

integer

Ottiene l'ID versione.

scheduledDeploymentTime

string

Ottiene l'ora di pianificazione della distribuzione dell'ambiente di rilascio.

schedules

ReleaseSchedule[]

Ottiene l'elenco delle pianificazioni.

status

EnvironmentStatus

Ottiene lo stato dell'ambiente.

timeToDeploy

number

Ottiene il tempo di distribuzione.

triggerReason

string

Ottiene il motivo del trigger.

variableGroups

VariableGroup[]

Ottiene l'elenco dei 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

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 gate di ogni valutazione.

id

integer

ID delle porte di rilascio.

ignoredGates

IgnoredGate[]

Elenco di cancelli ignorati.

lastModifiedOn

string

Gate ultima modificata.

runPlanId

string

Eseguire l'ID piano dei cancelli.

stabilizationCompletedOn

string

Stabilizzazione dei cancelli completata data e ora.

startedOn

string

Data di inizio della valutazione di Gates.

status

GateStatus

Stato delle porte di rilascio.

succeedingSince

string

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

ReleaseReason

Ottiene il motivo della versione.

Nome Tipo Descrizione
continuousIntegration

string

Indica la versione attivata dall'integrazione continua.

manual

string

Indica la versione attivata manualmente.

none

string

Indica il motivo attivato per il rilascio non impostato.

pullRequest

string

Indica la versione attivata da PullRequest.

schedule

string

Indica la versione attivata dalla pianificazione.

ReleaseSchedule

Nome Tipo Descrizione
daysToRelease

ScheduleDays

Giorni della settimana da rilasciare.

jobId

string

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 la definizione di versione è stata modificata.

startHours

integer

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

ReleaseStatus

Ottiene lo stato.

Nome Tipo Descrizione
abandoned

string

Lo stato di rilascio è abbandonato.

active

string

Lo stato della versione è attivo.

draft

string

Il rilascio è in stato bozza.

undefined

string

Stato di rilascio non impostato.

ReleaseTask

Nome Tipo Descrizione
agentName

string

Nome dell'agente in cui è stata eseguita l'attività.

finishTime

string

Ora di fine dell'attività di rilascio.

id

integer

ID dell'attività di rilascio.

issues

Issue[]

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

lineCount

integer

Numero di righe di attività di rilascio del log.

logUrl

string

URL del log dell'attività.

name

string

Nome dell'attività.

percentComplete

integer

Completamento dell'esecuzione dell'attività.

rank

integer

Classificazione dell'attività di rilascio.

resultCode

string

Codice risultato dell'attività.

startTime

string

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

ID record sequenza temporale dell'attività di rilascio.

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

SingleReleaseExpands

Proprietà che deve essere espansa nella versione.

Nome Tipo Descrizione
none

string

Restituire le proprietà di primo livello dell'oggetto.

tasks

string

Espandere la versione con le attività.

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.

Nome Tipo Descrizione
canceled

string

L'esecuzione dell'attività è stata annullata.

failed

string

L'esecuzione dell'attività non è riuscita.

failure

string

L'esecuzione dell'attività non è riuscita.

inProgress

string

L'attività è attualmente in corso.

partiallySucceeded

string

L'esecuzione dell'attività è riuscita parzialmente.

pending

string

L'attività è in sospeso.

skipped

string

L'esecuzione dell'attività è stata ignorata.

succeeded

string

L'attività è stata completata correttamente.

success

string

L'attività è stata completata correttamente.

unknown

string

L'attività non ha il set di stato.

VariableGroup

Nome Tipo Descrizione
createdBy

IdentityRef

Ottiene o imposta l'identità creata.

createdOn

string

Ottiene la data in cui è stata creata.

description

string

Ottiene o imposta la descrizione.

id

integer

Ottiene l'identificatore univoco di questo campo.

isShared

boolean

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

modifiedBy

IdentityRef

Ottiene o imposta l'identità modificata.

modifiedOn

string

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 variabile è segreto 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 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à.

WorkflowTaskReference

Nome Tipo Descrizione
id

string

Identificatore dell'attività.

name

string

Nome dell'attività.

version

string

Versione dell'attività.