Releases - Get Release

Référence

Service:: Release

API Version:: 7.1-preview.8

Obtenir une mise en production

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

With optional parameters:

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
organization	path	True	string	Nom de l’organisation Azure DevOps.
project	path	True	string	ID de projet ou nom du projet
releaseId	path	True	integer int32	ID de la version.
api-version	query	True	string	Version de l’API à utiliser. Cette valeur doit être définie sur « 7.1-preview.8 » pour utiliser cette version de l’API.
$expand	query		SingleReleaseExpands	Propriété qui doit être développée dans la version.
$topGateRecords	query		integer int32	Nombre d’enregistrements de la porte de mise en production à obtenir. La valeur par défaut est 5.
approvalFilters	query		ApprovalFilters	Filtre qui permet d’extraire les étapes d’approbation de manière sélective selon qu’elle est automatisée ou manuelle. Cela déciderait également si nous devons récupérer les instantanés avant et après l’approbation. Suppose tout par défaut
propertyFilters	query		string array (string)	Liste délimitée par des virgules des propriétés étendues à récupérer. Si elle est définie, la version renvoyée contient des valeurs pour les ID de propriété spécifiés (s’ils existent). Si elles ne sont pas définies, les propriétés ne sont pas incluses.

Réponses

Nom	Type	Description
200 OK	Release	opération réussie

Sécurité

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

Nom	Description
vso.release	Accorde la possibilité de lire les artefacts de mise en production, y compris les dossiers, les versions, les définitions de mise en production et l’environnement de mise en production.

Exemples

Sample Request

HTTP

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

Sample Response

Status code:: 200

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

Définitions

Nom	Description
ApprovalExecutionOrder	Ordre d’exécution des approbations.
ApprovalFilters	Filtre qui permet d’extraire les étapes d’approbation de manière sélective selon qu’elle est automatisée ou manuelle. Cela déciderait également si nous devons récupérer les instantanés avant et après l’approbation. Suppose tout par défaut
ApprovalOptions
ApprovalStatus	Obtient ou définit le status de l’approbation.
ApprovalType	Obtient ou définit le type d’approbation.
Artifact
ArtifactSourceReference
AuthorizationHeader
ConditionType	Obtient ou définit le type de condition.
ConfigurationVariableValue
DataSourceBindingBase	Représente la liaison de la source de données pour la demande de point de terminaison de service.
DeploymentAttempt
DeploymentJob
DeploymentOperationStatus	Obtient l’opération status de déploiement.
DeploymentReason	Obtient la raison du déploiement.
DeploymentStatus	Obtient status du déploiement.
DeployPhase
DeployPhaseStatus	État de la phase.
DeployPhaseTypes	Indique le type de phase de déploiement.
EnvironmentOptions
EnvironmentStatus	Obtient les status d’environnement.
GateStatus	État des portes de mise en production.
IdentityRef
IgnoredGate
Issue
ManualIntervention
ManualInterventionStatus	Obtient ou définit la status de l’intervention manuelle.
ProcessParameters
ProjectReference
PropertiesCollection	La classe représente un conteneur de propriétés sous la forme d’une collection de paires clé-valeur. Les valeurs de tous les types primitifs (tout type avec un `TypeCode != TypeCode.Object`) à l’exception de `DBNull` sont acceptées. Les valeurs de type Byte[], Int32, Double, DateType et String conservent leur type. Les autres primitives sont réinsérées sous forme de chaîne. Byte[] attendu sous forme de chaîne encodée en base64.
ReferenceLinks	Classe pour représenter une collection de liens de référence REST.
Release
ReleaseApproval
ReleaseApprovalHistory
ReleaseCondition
ReleaseDefinitionApprovals
ReleaseDefinitionApprovalStep
ReleaseDefinitionGate
ReleaseDefinitionGatesOptions
ReleaseDefinitionGatesStep
ReleaseDefinitionShallowReference
ReleaseDeployPhase
ReleaseEnvironment
ReleaseEnvironmentShallowReference
ReleaseGates
ReleaseReason	Obtient le motif de la mise en production.
ReleaseSchedule
ReleaseShallowReference
ReleaseStatus	Obtient status.
ReleaseTask
ScheduleDays	Jours de la semaine à publier.
SingleReleaseExpands	Propriété qui doit être développée dans la version.
TaskInputDefinitionBase
TaskInputValidation
TaskSourceDefinitionBase
TaskStatus	État de la tâche de mise en production.
VariableGroup
VariableGroupProjectReference	Une référence de groupe de variables est une référence superficielle au groupe de variables.
VariableGroupProviderData
VariableValue
WorkflowTask
WorkflowTaskReference

ApprovalExecutionOrder

Ordre d’exécution des approbations.

Nom	Type	Description
afterGatesAlways	string	Approbations affichées toujours après l’exécution des portes.
afterSuccessfulGates	string	Approbations affichées après l’exécution réussie des portes.
beforeGates	string	Approbations affichées avant les portes.

ApprovalFilters

Filtre qui permet d’extraire les étapes d’approbation de manière sélective selon qu’elle est automatisée ou manuelle. Cela déciderait également si nous devons récupérer les instantanés avant et après l’approbation. Suppose tout par défaut

Nom	Type	Description
all	string	Toutes les étapes d’approbation et les instantanés d’approbation.
approvalSnapshots	string	Aucune étape d’approbation, mais des instantanés d’approbation (à utiliser avec ManualApprovals ou AutomatedApprovals pour les étapes d’approbation).
automatedApprovals	string	Étapes d’approbation automatisées, mais pas d’instantanés d’approbation (à utiliser avec ApprovalSnapshots pour les instantanés).
manualApprovals	string	Étapes d’approbation manuelles, mais pas d’instantanés d’approbation (à utiliser avec ApprovalSnapshots pour les instantanés).
none	string	Aucune approbation ni instantané d’approbation.

ApprovalOptions

Nom	Type	Description
autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped	boolean	Spécifiez si l’approbation peut être ignorée si le même approbateur a approuvé l’étape précédente.
enforceIdentityRevalidation	boolean	Spécifiez si revalidez l’identité de l’approbateur avant de terminer l’approbation.
executionOrder	ApprovalExecutionOrder	Ordre d’exécution des approbations.
releaseCreatorCanBeApprover	boolean	Spécifiez si l’utilisateur qui demande une mise en production ou un déploiement doit autoriser l’approbateur.
requiredApproverCount	integer	Nombre d’approbations requises pour avancer la mise en production. « 0 » désigne toutes les approbations requises.
timeoutInMinutes	integer	Délai d’expiration de l’approbation. Le délai d’expiration par défaut de l’approbation est de 30 jours. Le délai d’expiration maximal autorisé est de 365 jours. '0' signifie le délai d’expiration par défaut, c’est-à-dire 30 jours.

ApprovalStatus

Obtient ou définit le status de l’approbation.

Nom	Type	Description
approved	string	Indique que l’approbation est approuvée.
canceled	string	Indique que l’approbation est annulée.
pending	string	Indique que l’approbation est en attente.
reassigned	string	Indique que l’approbation est réaffectée.
rejected	string	Indique que l’approbation est rejetée.
skipped	string	Indique que l’approbation est ignorée.
undefined	string	Indique que l’approbation n’a pas le status défini.

ApprovalType

Obtient ou définit le type d’approbation.

Nom	Type	Description
all	string	Indique toutes les approbations.
postDeploy	string	Indique les approbations qui ont été exécutées après le déploiement.
preDeploy	string	Indique les approbations exécutées avant le déploiement.
undefined	string	Indique que le type d’approbation n’est pas défini.

Artifact

Nom	Type	Description
alias	string	Obtient ou définit l’alias.
definitionReference	<string, ArtifactSourceReference>	Obtient ou définit une référence de définition. Par exemple, {"project »:{"id »:"fed755ea-49c5-4399-acea-fd5b5aa90a6c »,"name »:"myProject"},"definition »:{"id »:"1 »,"name »:"mybuildDefinition"},"connection »:{"id »:"1 »,"name »:"myConnection"}}.
isPrimary	boolean	Indique si l’artefact est principal ou non.
isRetained	boolean	Indique si l’artefact est conservé par mise en production ou non.
type	string	Obtient ou définit le type. Il peut avoir la valeur « Build », « Jenkins », « GitHub », « Nuget », « Team Build (externe) », « ExternalTFSBuild », « Git », « TFVC », « ExternalTfsXamlBuild ».

ArtifactSourceReference

Nom	Type	Description
id	string	ID de la source de l’artefact.
name	string	Nom de la source de l’artefact.

AuthorizationHeader

Nom	Type	Description
name	string
value	string

ConditionType

Obtient ou définit le type de condition.

Nom	Type	Description
artifact	string	Le type de condition est artefact.
environmentState	string	Le type de condition est l’état de l’environnement.
event	string	Le type de condition est event.
undefined	string	Le type de condition n’est pas défini.

ConfigurationVariableValue

Nom	Type	Description
allowOverride	boolean	Obtient et définit si une variable peut être remplacée au moment du déploiement ou non.
isSecret	boolean	Obtient ou définit en tant que variable secrète ou non.
value	string	Obtient et définit la valeur de la variable de configuration.

DataSourceBindingBase

Représente la liaison de la source de données pour la demande de point de terminaison de service.

Nom	Type	Description
callbackContextTemplate	string	Format de pagination pris en charge par cette source de données (ContinuationToken/SkipTop).
callbackRequiredTemplate	string	Appels suivants nécessaires ?
dataSourceName	string	Obtient ou définit le nom de la source de données.
endpointId	string	Obtient ou définit l’ID du point de terminaison.
endpointUrl	string	Obtient ou définit l’URL du point de terminaison de service.
headers	AuthorizationHeader[]	Obtient ou définit les en-têtes d’autorisation.
initialContextTemplate	string	Définit la valeur initiale des paramètres de requête
parameters	object	Obtient ou définit les paramètres de la source de données.
requestContent	string	Obtient ou définit le corps de la requête HTTP
requestVerb	string	Obtient ou définit le verbe de requête HTTP
resultSelector	string	Obtient ou définit le sélecteur de résultats.
resultTemplate	string	Obtient ou définit le modèle de résultat.
target	string	Obtient ou définit la cible de la source de données.

DeploymentAttempt

Nom	Type	Description
attempt	integer	Tentative de déploiement.
deploymentId	integer	ID du déploiement.
hasStarted	boolean	Spécifie si le déploiement a démarré ou non.
id	integer	ID du déploiement.
issues	Issue[]	Tous les problèmes liés au déploiement.
lastModifiedBy	IdentityRef	Identité qui a modifié ce déploiement pour la dernière fois.
lastModifiedOn	string	Heure de la dernière modification de ce déploiement.
operationStatus	DeploymentOperationStatus	Opération de déploiement status.
postDeploymentGates	ReleaseGates	Portes postérieures au déploiement exécutées dans ce déploiement.
preDeploymentGates	ReleaseGates	Portes de prédéploiement exécutées dans ce déploiement.
queuedOn	string	Lorsque ce déploiement a été mis en file d’attente.
reason	DeploymentReason	Raison du déploiement.
releaseDeployPhases	ReleaseDeployPhase[]	Liste des phases de déploiement de mise en production exécutées dans ce déploiement.
requestedBy	IdentityRef	Identité qui a demandé ce déploiement.
requestedFor	IdentityRef	Identité pour ce déploiement demandé.
status	DeploymentStatus	status du déploiement.

DeploymentJob

Nom	Type	Description
job	ReleaseTask	Tâche parente de toutes les tâches exécutées.
tasks	ReleaseTask[]	Liste des tâches exécutées avec dans le travail.

DeploymentOperationStatus

Obtient l’opération status de déploiement.

Nom	Type	Description
all	string	L’opération de déploiement status est tout.
approved	string	L’opération de déploiement status est approuvée.
canceled	string	L’opération de déploiement status est annulée.
cancelling	string	L’opération de déploiement status est annulée.
deferred	string	L’opération de déploiement status est différée.
evaluatingGates	string	L’opération de déploiement status est EvaluatingGates.
gateFailed	string	L’opération de déploiement status est GateFailed.
manualInterventionPending	string	L’opération de déploiement status est manuelleintervention en attente.
pending	string	L’opération de déploiement status est en attente.
phaseCanceled	string	L’opération de déploiement status est annulée par phase.
phaseFailed	string	L’opération de déploiement status de phase a échoué.
phaseInProgress	string	L’opération de déploiement status est en cours.
phasePartiallySucceeded	string	L’opération de déploiement status est partiellement réussie.
phaseSucceeded	string	L’opération de déploiement status est la phase réussie.
queued	string	L’opération de déploiement status est mise en file d’attente.
queuedForAgent	string	L’opération de déploiement status est mise en file d’attente pour l’agent.
queuedForPipeline	string	L’opération de déploiement status est mise en file d’attente pour le pipeline.
rejected	string	L’opération de déploiement status est rejetée.
scheduled	string	L’opération de déploiement status est planifiée.
undefined	string	L’opération de déploiement status n’est pas définie.

DeploymentReason

Obtient la raison du déploiement.

Nom	Type	Description
automated	string	La raison du déploiement est automatisée.
manual	string	La raison du déploiement est manuelle.
none	string	La raison du déploiement est aucune.
redeployTrigger	string	La raison du déploiement est RedeployTrigger.
scheduled	string	La raison du déploiement est planifiée.

DeploymentStatus

Obtient status du déploiement.

Nom	Type	Description
all	string	La status de déploiement est tout.
failed	string	Le déploiement status a échoué.
inProgress	string	Le déploiement status est en cours.
notDeployed	string	Le status de déploiement n’est pas déployé.
partiallySucceeded	string	Le déploiement status est partiellement terminé.
succeeded	string	Le déploiement status a réussi.
undefined	string	Le status de déploiement n’est pas défini.

DeployPhase

Nom	Type	Description
name	string	Obtient et définit le nom de la phase de déploiement.
phaseType	DeployPhaseTypes	Indique le type de phase de déploiement.
rank	integer	Obtient et définit le rang de la phase de déploiement.
refName	string	Obtient et définit le nom de référence de la phase de déploiement.
workflowTasks	WorkflowTask[]	Obtient et définit les tâches de workflow pour la phase de déploiement.

DeployPhaseStatus

État de la phase.

Nom	Type	Description
canceled	string	Exécution de phase annulée.
cancelling	string	La phase est à l’état d’annulation.
failed	string	Échec de l’exécution de la phase.
inProgress	string	Exécution de phase en cours.
notStarted	string	L’exécution de phase n’a pas démarré.
partiallySucceeded	string	L’exécution de phase a partiellement réussi.
skipped	string	Exécution de phase ignorée.
succeeded	string	L’exécution de la phase a réussi.
undefined	string	La phase status pas définie.

DeployPhaseTypes

Indique le type de phase de déploiement.

Nom	Type	Description
agentBasedDeployment	string	Type de phase qui contient les tâches exécutées sur l’agent.
deploymentGates	string	Type de phase qui contient des tâches qui jouent le rôle de portes pour le déploiement à poursuivre.
machineGroupBasedDeployment	string	Type de phase qui contient des tâches exécutées sur des machines de groupe de déploiement.
runOnServer	string	Type de phase qui contient les tâches exécutées par le serveur.
undefined	string	Type de phase non défini. N’utilisez pas ce paramètre.

EnvironmentOptions

Nom	Type	Description
autoLinkWorkItems	boolean	Obtient et définit en tant qu’éléments de travail de liaison automatique ou non.
badgeEnabled	boolean	Obtient et définit comme badge activé ou non.
publishDeploymentStatus	boolean	Obtient et définit en tant que déploiement de publication status ou non.
pullRequestDeploymentEnabled	boolean	Obtient et définit comme le déploiement de la demande .pull activé ou non.

EnvironmentStatus

Obtient les status d’environnement.

Nom	Type	Description
canceled	string	L’environnement est à l’état annulé.
inProgress	string	L’environnement est à l’état en cours.
notStarted	string	L’environnement n’est pas démarré.
partiallySucceeded	string	L’environnement est dans un état partiellement réussi.
queued	string	L’environnement est à l’état mis en file d’attente.
rejected	string	L’environnement est à l’état rejeté.
scheduled	string	L’environnement est à l’état planifié.
succeeded	string	L’environnement est à l’état réussi.
undefined	string	L’environnement status pas défini.

GateStatus

État des portes de mise en production.

Nom	Type	Description
canceled	string	L’exécution de la porte a été annulée.
failed	string	L’exécution de la porte a échoué.
inProgress	string	La porte est en cours.
none	string	La porte n’a pas le status défini.
pending	string	La porte est dans l’état en attente.
succeeded	string	La porte s’est terminée avec succès.

IdentityRef

Nom	Type	Description
_links	ReferenceLinks	Ce champ contient zéro ou plus de liens intéressants sur l’objet du graphique. Ces liens peuvent être appelés pour obtenir des relations supplémentaires ou des informations plus détaillées sur ce sujet de graphique.
descriptor	string	Le descripteur est le principal moyen de référencer l’objet du graphique pendant l’exécution du système. Ce champ identifie de manière unique le même sujet de graphique dans les comptes et les organisations.
directoryAlias	string	Déconseillé : peut être récupéré en interrogeant l’utilisateur Graph référencé dans l’entrée « self » du dictionnaire IdentityRef « _links »
displayName	string	Il s’agit du nom d’affichage non unique de l’objet du graphique. Pour modifier ce champ, vous devez modifier sa valeur dans le fournisseur source.
id	string
imageUrl	string	Déprécié : disponible dans l’entrée « avatar » du dictionnaire IdentityRef « _links »
inactive	boolean	Déconseillé : peut être récupéré en interrogeant l’état d’appartenance Graph référencé dans l’entrée « membershipState » du dictionnaire GraphUser « _links »
isAadIdentity	boolean	Déprécié : peut être déduit du type d’objet du descripteur (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Déprécié : peut être déduit du type d’objet du descripteur (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Déconseillé : non utilisé dans la plupart des implémentations préexistantes de ToIdentityRef
uniqueName	string	Déconseillé : utilisez à la place Domain+PrincipalName
url	string	Cette URL est l’itinéraire complet vers la ressource source de ce sujet de graphique.

IgnoredGate

Nom	Type	Description
lastModifiedOn	string	Obtient la date à laquelle la porte est ignorée pour la dernière fois.
name	string	Nom de la porte ignorée.

Issue

Nom	Type	Description
data	object	Données de problème.
issueType	string	Type de problème, par exemple erreur, avertissement ou informations.
message	string	Message de problème.

ManualIntervention

Nom	Type	Description
approver	IdentityRef	Obtient ou définit l’identité qui doit approuver.
comments	string	Obtient ou définit des commentaires pour approbation.
createdOn	string	Obtient la date à laquelle il a été créé.
id	integer	Obtient l’identificateur unique pour l’intervention manuelle.
instructions	string	Obtient ou définit des instructions pour l’approbation.
modifiedOn	string	Obtient la date à laquelle il a été modifié.
name	string	Obtient ou définit le nom.
release	ReleaseShallowReference	Obtient releaseReference pour une intervention manuelle.
releaseDefinition	ReleaseDefinitionShallowReference	Obtient releaseDefinitionReference pour une intervention manuelle.
releaseEnvironment	ReleaseEnvironmentShallowReference	Obtient releaseEnvironmentReference pour une intervention manuelle.
status	ManualInterventionStatus	Obtient ou définit la status de l’intervention manuelle.
taskInstanceId	string	Obtenir l’identificateur de instance de tâche.
url	string	Obtient l’URL pour accéder à l’intervention manuelle.

ManualInterventionStatus

Obtient ou définit la status de l’intervention manuelle.

Nom	Type	Description
approved	string	L’intervention manuelle est approuvée.
canceled	string	L’intervention manuelle est annulée.
pending	string	L’intervention manuelle est en attente.
rejected	string	L’intervention manuelle est rejetée.
unknown	string	L’intervention manuelle n’a pas la status définie.

ProcessParameters

Nom	Type	Description
dataSourceBindings	DataSourceBindingBase[]	Représente la liaison de la source de données pour la demande de point de terminaison de service.
inputs	TaskInputDefinitionBase[]
sourceDefinitions	TaskSourceDefinitionBase[]

ProjectReference

Nom	Type	Description
id	string	Obtient l’identificateur unique de ce champ.
name	string	Obtient le nom du projet.

PropertiesCollection

La classe représente un conteneur de propriétés sous la forme d’une collection de paires clé-valeur. Les valeurs de tous les types primitifs (tout type avec un TypeCode != TypeCode.Object) à l’exception de DBNull sont acceptées. Les valeurs de type Byte[], Int32, Double, DateType et String conservent leur type. Les autres primitives sont réinsérées sous forme de chaîne. Byte[] attendu sous forme de chaîne encodée en base64.

Nom	Type	Description
count	integer	Nombre de propriétés dans la collection.
item	object
keys	string[]	Ensemble de clés dans la collection.
values	string[]	Ensemble de valeurs dans la collection.

ReferenceLinks

Classe pour représenter une collection de liens de référence REST.

Nom	Type	Description
links	object	Vue en lecture seule des liens. Étant donné que les liens référence sont en lecture seule, nous voulons uniquement les exposer en lecture seule.

Release

Nom	Type	Description
_links	ReferenceLinks	Obtient des liens pour accéder à la version.
artifacts	Artifact[]	Obtient ou définit la liste des artefacts.
comment	string	Obtient ou définit un commentaire.
createdBy	IdentityRef	Obtient ou définit l’identité créée.
createdFor	IdentityRef	Obtient ou définit l’identité pour laquelle la mise en production a été créée.
createdOn	string	Obtient la date à laquelle il a été créé.
definitionSnapshotRevision	integer	Obtient le numéro de révision des instantané de définition.
description	string	Obtient ou définit la description de la mise en production.
environments	ReleaseEnvironment[]	Obtient la liste des environnements.
id	integer	Obtient l’identificateur unique de ce champ.
keepForever	boolean	Indique s’il faut exclure la mise en production des stratégies de rétention.
logsContainerUrl	string	Obtient l’URL du conteneur des journaux.
modifiedBy	IdentityRef	Obtient ou définit l’identité qui a été modifiée.
modifiedOn	string	Obtient la date à laquelle il a été modifié.
name	string	Obtient le nom.
poolName	string	Obtient le nom du pool.
projectReference	ProjectReference	Obtient ou définit une référence de projet.
properties	PropertiesCollection	La classe représente un conteneur de propriétés sous la forme d’une collection de paires clé-valeur. Les valeurs de tous les types primitifs (tout type avec un `TypeCode != TypeCode.Object`) à l’exception de `DBNull` sont acceptées. Les valeurs de type Byte[], Int32, Double, DateType et String conservent leur type. Les autres primitives sont réinsérées sous forme de chaîne. Byte[] attendu sous forme de chaîne encodée en base64.
reason	ReleaseReason	Obtient la raison de la mise en production.
releaseDefinition	ReleaseDefinitionShallowReference	Obtient releaseDefinitionReference qui spécifie la référence de la définition de mise en production à laquelle cette version est associée.
releaseDefinitionRevision	integer	Obtient ou définit la révision de définition de mise en production.
releaseNameFormat	string	Obtient le format de nom de mise en production.
status	ReleaseStatus	Obtient status.
tags	string[]	Obtient ou définit la liste des balises.
triggeringArtifactAlias	string
variableGroups	VariableGroup[]	Obtient la liste des groupes de variables.
variables	<string, ConfigurationVariableValue>	Obtient ou définit le dictionnaire de variables.

ReleaseApproval

Nom	Type	Description
approvalType	ApprovalType	Obtient ou définit le type d’approbation.
approvedBy	IdentityRef	Obtient l’identité qui a approuvé.
approver	IdentityRef	Obtient ou définit l’identité qui doit approuver.
attempt	integer	Obtient ou définit la tentative qui spécifie à quelle tentative de déploiement elle appartient.
comments	string	Obtient ou définit des commentaires pour approbation.
createdOn	string	Obtient la date à laquelle il a été créé.
history	ReleaseApprovalHistory[]	Obtient l’historique qui spécifie toutes les approbations associées à cette approbation.
id	integer	Obtient l’identificateur unique de ce champ.
isAutomated	boolean	Obtient ou définit à mesure que l’approbation est automatisée ou non.
modifiedOn	string	Obtient la date à laquelle il a été modifié.
rank	integer	Obtient ou définit le rang qui spécifie l’ordre de l’approbation. Par exemple, le même rang indique une approbation parallèle.
release	ReleaseShallowReference	Obtient releaseReference qui spécifie la référence de la version à laquelle cette approbation est associée.
releaseDefinition	ReleaseDefinitionShallowReference	Obtient releaseDefinitionReference qui spécifie la référence de la définition de mise en production à laquelle cette approbation est associée.
releaseEnvironment	ReleaseEnvironmentShallowReference	Obtient releaseEnvironmentReference qui spécifie la référence de l’environnement de mise en production auquel cette approbation est associée.
revision	integer	Obtient le numéro de révision.
status	ApprovalStatus	Obtient ou définit le status de l’approbation.
url	string	Obtient l’URL pour accéder à l’approbation.

ReleaseApprovalHistory

Nom	Type	Description
approver	IdentityRef	Identité de l’approbateur.
changedBy	IdentityRef	Identité de l’objet qui a modifié l’approbation.
comments	string	Commentaires de l’historique d’approbation.
createdOn	string	Heure de création de cette approbation.
modifiedOn	string	Heure à laquelle cette approbation a été modifiée.
revision	integer	Révision de l’historique d’approbation.

ReleaseCondition

Nom	Type	Description
conditionType	ConditionType	Obtient ou définit le type de condition.
name	string	Obtient ou définit le nom de la condition. Par exemple, « ReleaseStarted ».
result	boolean	Résultat de la condition de mise en production.
value	string	Obtient ou définit la valeur de la condition.

ReleaseDefinitionApprovals

Nom	Type	Description
approvalOptions	ApprovalOptions	Obtient ou définit les options d’approbation.
approvals	ReleaseDefinitionApprovalStep[]	Obtient ou définit les approbations.

ReleaseDefinitionApprovalStep

Nom	Type	Description
approver	IdentityRef	Obtient et définit l’approbateur.
id	integer	ID de l’étape d’approbation ou de déploiement.
isAutomated	boolean	Indique si l’approbation a été automatisée.
isNotificationOn	boolean	Indique si la notification d’approbation a été définie.
rank	integer	Obtient ou définit le rang de l’étape d’approbation.

ReleaseDefinitionGate

Nom	Type	Description
tasks	WorkflowTask[]	Obtient ou définit le flux de travail des portes.

ReleaseDefinitionGatesOptions

Nom	Type	Description
isEnabled	boolean	Obtient ou définit comme portes activées ou non.
minimumSuccessDuration	integer	Obtient ou définit la durée minimale des résultats stables après une évaluation réussie des portes.
samplingInterval	integer	Obtient ou définit le délai entre la réévaluation des portes.
stabilizationTime	integer	Obtient ou définit le délai avant l’évaluation.
timeout	integer	Obtient ou définit le délai d’expiration après lequel les portes échouent.

ReleaseDefinitionGatesStep

Nom	Type	Description
gates	ReleaseDefinitionGate[]	Obtient ou définit les portes.
gatesOptions	ReleaseDefinitionGatesOptions	Obtient ou définit les options de porte.
id	integer	ID du ReleaseDefinitionGateStep.

ReleaseDefinitionShallowReference

Nom	Type	Description
_links	ReferenceLinks	Obtient les liens vers les ressources, LES API et les vues associées pour la définition de mise en production.
id	integer	Obtient l’identificateur unique de la définition de mise en production.
name	string	Obtient ou définit le nom de la définition de mise en production.
path	string	Obtient ou définit le chemin d’accès de la définition de mise en production.
projectReference	ProjectReference	Obtient ou définit une référence de projet.
url	string	Obtient l’URL de l’API REST pour accéder à la définition de mise en production.

ReleaseDeployPhase

Nom	Type	Description
deploymentJobs	DeploymentJob[]	Travaux de déploiement de la phase.
errorLog	string	Journaux des erreurs d’exécution de phase.
manualInterventions	ManualIntervention[]	Liste des informations d’exécution des tâches d’intervention manuelles en phase.
name	string	Nom de la phase.
phaseId	string	ID de la phase.
phaseType	DeployPhaseTypes	Type de la phase.
rank	integer	Classement de la phase.
runPlanId	string	ID de plan d’exécution de la phase.
startedOn	string	Heure de début de phase.
status	DeployPhaseStatus	État de la phase.

ReleaseEnvironment

Nom	Type	Description
conditions	ReleaseCondition[]	Obtient la liste des conditions.
createdOn	string	Obtient la date à laquelle il a été créé.
definitionEnvironmentId	integer	Obtient l’ID d’environnement de définition.
deployPhasesSnapshot	DeployPhase[]	Obtient la liste des phases de déploiement instantané.
deploySteps	DeploymentAttempt[]	Obtient les étapes de déploiement.
environmentOptions	EnvironmentOptions	Obtient les options d’environnement.
id	integer	Obtient l’identificateur unique de ce champ.
modifiedOn	string	Obtient la date à laquelle il a été modifié.
name	string	Obtient le nom.
nextScheduledUtcTime	string	Obtient l’heure UTC planifiée suivante.
owner	IdentityRef	Obtient l’identité propriétaire de l’environnement de mise en production.
postApprovalsSnapshot	ReleaseDefinitionApprovals	Obtient la liste des approbations post-déploiement instantané.
postDeployApprovals	ReleaseApproval[]	Obtient la liste des approbations post-déploiement.
postDeploymentGatesSnapshot	ReleaseDefinitionGatesStep	Les portes post-déploiement instantané données.
preApprovalsSnapshot	ReleaseDefinitionApprovals	Obtient la liste des approbations préalables au déploiement instantané.
preDeployApprovals	ReleaseApproval[]	Obtient la liste des approbations préalables au déploiement.
preDeploymentGatesSnapshot	ReleaseDefinitionGatesStep	Les portes de prédéploiement instantané données.
processParameters	ProcessParameters	Obtient les paramètres de processus.
rank	integer	Obtient le classement.
release	ReleaseShallowReference	Obtient une référence de mise en production qui spécifie la référence de la version à laquelle cet environnement de mise en production est associé.
releaseCreatedBy	IdentityRef	Obtient l’identité qui a créé la mise en production.
releaseDefinition	ReleaseDefinitionShallowReference	Obtient releaseDefinitionReference qui spécifie la référence de la définition de mise en production à laquelle cet environnement de mise en production est associé.
releaseId	integer	Obtient l’ID de mise en production.
scheduledDeploymentTime	string	Obtient l’heure de déploiement planifiée de l’environnement de mise en production.
schedules	ReleaseSchedule[]	Obtient la liste des planifications.
status	EnvironmentStatus	Obtient les status d’environnement.
timeToDeploy	number	Obtient le temps de déploiement.
triggerReason	string	Obtient la raison du déclencheur.
variableGroups	VariableGroup[]	Obtient la liste des groupes de variables.
variables	<string, ConfigurationVariableValue>	Obtient le dictionnaire des variables.

ReleaseEnvironmentShallowReference

Nom	Type	Description
_links	ReferenceLinks	Obtient les liens vers les ressources, LES API et les vues associées pour l’environnement de mise en production.
id	integer	Obtient l’identificateur unique de l’environnement de mise en production.
name	string	Obtient ou définit le nom de l’environnement de mise en production.
url	string	Obtient l’URL de l’API REST pour accéder à l’environnement de mise en production.

ReleaseGates

Nom	Type	Description
deploymentJobs	DeploymentJob[]	Contient les détails du travail de portes de chaque évaluation.
id	integer	ID des portes de mise en production.
ignoredGates	IgnoredGate[]	Liste des portes ignorées.
lastModifiedOn	string	Heure de la dernière modification des portes.
runPlanId	string	ID de plan d’exécution des portes.
stabilizationCompletedOn	string	Date et heure de la stabilisation des portes terminées.
startedOn	string	Heure de début de l’évaluation des portes.
status	GateStatus	État des portes de mise en production.
succeedingSince	string	Date et heure auxquelles toutes les portes ont été exécutées avec succès.

ReleaseReason

Obtient le motif de la mise en production.

Nom	Type	Description
continuousIntegration	string	Indique la mise en production déclenchée par l’intégration continue.
manual	string	Indique la mise en production déclenchée manuellement.
none	string	Indique que la raison déclenchée par la mise en production n’est pas définie.
pullRequest	string	Indique la mise en production déclenchée par PullRequest.
schedule	string	Indique la mise en production déclenchée par la planification.

ReleaseSchedule

Nom	Type	Description
daysToRelease	ScheduleDays	Jours de la semaine à publier.
jobId	string	Id de travail de définition de travail Team Foundation.
scheduleOnlyWithChanges	boolean	Indicateur permettant de déterminer si cette planification doit être mise en production uniquement si l’artefact associé a été modifié ou si la définition de mise en production a changé.
startHours	integer	Heure de début du fuseau horaire local.
startMinutes	integer	Minute de fuseau horaire local pour commencer.
timeZoneId	string	ID de fuseau horaire de la planification de mise en production, tel que « UTC ».

ReleaseShallowReference

Nom	Type	Description
_links	ReferenceLinks	Obtient les liens vers les ressources, LES API et les vues associées pour la version.
id	integer	Obtient l’identificateur unique de la mise en production.
name	string	Obtient ou définit le nom de la mise en production.
url	string	Obtient l’URL de l’API REST pour accéder à la mise en production.

ReleaseStatus

Obtient status.

Nom	Type	Description
abandoned	string	Le status de mise en production est abandonné.
active	string	Le status de mise en production est actif.
draft	string	La mise en production est à l’état brouillon.
undefined	string	La mise en production status pas définie.

ReleaseTask

Nom	Type	Description
agentName	string	Nom de l’agent sur lequel la tâche a été exécutée.
finishTime	string	Heure de fin de la tâche de mise en production.
id	integer	ID de la tâche de mise en production.
issues	Issue[]	Liste des problèmes qui se sont produits lors de l’exécution de la tâche.
lineCount	integer	Nombre de lignes de la tâche de publication du journal a.
logUrl	string	URL du journal de la tâche.
name	string	Nom de la tâche.
percentComplete	integer	L’exécution des tâches est terminée avant la fin.
rank	integer	Classement de la tâche de mise en production.
resultCode	string	Code de résultat de la tâche.
startTime	string	ID de la tâche de mise en production.
status	TaskStatus	État de la tâche de mise en production.
task	WorkflowTaskReference	Informations de référence sur les tâches de flux de travail.
timelineRecordId	string	ID d’enregistrement de chronologie de la tâche de mise en production.

ScheduleDays

Jours de la semaine à publier.

Nom	Type	Description
all	string	Planifié tous les jours de la semaine.
friday	string	Prévu le vendredi.
monday	string	Prévu le lundi.
none	string	Jour planifié non défini.
saturday	string	Prévu le samedi.
sunday	string	Prévu le dimanche.
thursday	string	Prévu le jeudi.
tuesday	string	Prévu le mardi.
wednesday	string	Prévu le mercredi.

SingleReleaseExpands

Propriété qui doit être développée dans la version.

Nom	Type	Description
none	string	Retourne les propriétés de niveau supérieur de l’objet.
tasks	string	Développez la mise en production avec des tâches.

TaskInputDefinitionBase

Nom	Type	Description
aliases	string[]
defaultValue	string
groupName	string
helpMarkDown	string
label	string
name	string
options	object
properties	object
required	boolean
type	string
validation	TaskInputValidation
visibleRule	string

TaskInputValidation

Nom	Type	Description
expression	string	Expression conditionnelle
message	string	Message expliquant comment l’utilisateur peut corriger en cas d’échec de la validation

TaskSourceDefinitionBase

Nom	Type	Description
authKey	string
endpoint	string
keySelector	string
selector	string
target	string

TaskStatus

État de la tâche de mise en production.

Nom	Type	Description
canceled	string	L’exécution de la tâche a été annulée.
failed	string	L’exécution de la tâche a échoué.
failure	string	L’exécution de la tâche a échoué.
inProgress	string	La tâche est en cours.
partiallySucceeded	string	L’exécution de la tâche a partiellement réussi.
pending	string	La tâche est en attente status.
skipped	string	L’exécution de la tâche a été ignorée.
succeeded	string	La tâche a été terminée avec succès.
success	string	La tâche a été terminée avec succès.
unknown	string	La tâche n’a pas la status définie.

VariableGroup

Nom	Type	Description
createdBy	IdentityRef	Obtient ou définit l’identité créée.
createdOn	string	Obtient la date à laquelle il a été créé.
description	string	Obtient ou définit la description.
id	integer	Obtient l’identificateur unique de ce champ.
isShared	boolean	Indique si un groupe de variables est partagé ou non avec un autre projet.
modifiedBy	IdentityRef	Obtient ou définit l’identité qui a été modifiée.
modifiedOn	string	Obtient la date à laquelle il a été modifié.
name	string	Obtient ou définit le nom.
providerData	VariableGroupProviderData	Obtient ou définit les données du fournisseur.
type	string	Obtient ou définit le type.
variableGroupProjectReferences	VariableGroupProjectReference[]	toutes les références de projet où le groupe de variables est partagé avec d’autres projets.
variables	<string, VariableValue>	Obtient et définit le dictionnaire de variables.

VariableGroupProjectReference

Une référence de groupe de variables est une référence superficielle au groupe de variables.

Nom	Type	Description
description	string	Obtient ou définit la description du groupe de variables.
name	string	Obtient ou définit le nom du groupe de variables.
projectReference	ProjectReference	Obtient ou définit la référence de projet du groupe de variables.

VariableGroupProviderData

VariableValue

Nom	Type	Description
isReadOnly	boolean	Obtient ou définit si la variable est en lecture seule ou non.
isSecret	boolean	Obtient ou définit car la variable est secrète ou non.
value	string	Obtient ou définit la valeur.

WorkflowTask

Nom	Type	Description
alwaysRun	boolean	Obtient ou définit comme la tâche s’exécute toujours ou non.
condition	string	Obtient ou définit la condition de tâche.
continueOnError	boolean	Obtient ou définit à mesure que la tâche continue à s’exécuter en cas d’erreur ou non.
definitionType	string	Obtient ou définit le type de définition de tâche. Exemple : « Agent », « DeploymentGroup », « Server » ou « ServerGate ».
enabled	boolean	Obtient ou définit en tant que tâche activée ou non.
environment	object	Obtient ou définit les variables d’environnement de tâche.
inputs	object	Obtient ou définit les entrées de tâche.
name	string	Obtient ou définit le nom de la tâche.
overrideInputs	object	Obtient ou définit les entrées de remplacement de tâche.
refName	string	Obtient ou définit le nom de référence de la tâche.
retryCountOnTaskFailure	integer	Obtient ou définit la tâche retryCount.
taskId	string	Obtient ou définit l’ID de la tâche.
timeoutInMinutes	integer	Obtient ou définit le délai d’expiration de la tâche.
version	string	Obtient ou définit la version de la tâche.

WorkflowTaskReference

Nom	Type	Description
id	string	Identificateur de tâche.
name	string	Nom de la tâche.
version	string	Version de la tâche.

Partager via