다음을 통해 공유


Definitions - Create

릴리스 정의 만들기

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

URI 매개 변수

Name In(다음 안에) 필수 형식 Description
organization
path True

string

Azure DevOps 조직의 이름입니다.

project
path True

string

프로젝트 ID 또는 프로젝트 이름

api-version
query True

string

사용할 API의 버전입니다. 이 버전의 API를 사용하려면 '7.1-preview.4'로 설정해야 합니다.

요청 본문

Name 형식 Description
_links

ReferenceLinks

릴리스 정의에 대한 관련 리소스, API 및 뷰에 대한 링크를 가져옵니다.

artifacts

Artifact[]

아티팩트 목록을 가져오거나 설정합니다.

comment

string

주석을 가져오거나 설정합니다.

createdBy

IdentityRef

만든 ID를 가져오거나 설정합니다.

createdOn

string

만든 날짜를 가져옵니다.

description

string

설명을 가져오거나 설정합니다.

environments

ReleaseDefinitionEnvironment[]

환경 목록을 가져오거나 설정합니다.

id

integer

릴리스 정의의 고유 식별자를 가져옵니다.

isDeleted

boolean

릴리스 정의를 삭제할지 여부입니다.

lastRelease

ReleaseReference

마지막 릴리스의 참조를 가져옵니다.

modifiedBy

IdentityRef

수정한 ID를 가져오거나 설정합니다.

modifiedOn

string

수정된 날짜를 가져옵니다.

name

string

릴리스 정의의 이름을 가져오거나 설정합니다.

path

string

릴리스 정의의 경로를 가져오거나 설정합니다.

projectReference

ProjectReference

프로젝트 참조를 가져오거나 설정합니다.

properties

PropertiesCollection

속성을 가져오거나 설정합니다.

releaseNameFormat

string

릴리스 이름 형식을 가져오거나 설정합니다.

revision

integer

수정 번호를 가져옵니다.

source

ReleaseDefinitionSource

릴리스 정의의 원본을 가져오거나 설정합니다.

tags

string[]

태그 목록을 가져오거나 설정합니다.

triggers

ReleaseTriggerBase[]

트리거 목록을 가져오거나 설정합니다.

url

string

릴리스 정의에 액세스하기 위한 REST API URL을 가져옵니다.

variableGroups

integer[]

변수 그룹 목록을 가져오거나 설정합니다.

variables

<string,  ConfigurationVariableValue>

변수 사전을 가져오거나 설정합니다.

응답

Name 형식 Description
200 OK

ReleaseDefinition

성공적인 작업

보안

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

Name Description
vso.release_execute 폴더, 릴리스, 릴리스 정의 및 릴리스 환경, 새 릴리스 큐에 대기하는 기능을 포함하여 릴리스 아티팩트 읽기 및 업데이트 기능을 부여합니다.

예제

Create release definition

Sample Request

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

{
  "source": "undefined",
  "revision": 1,
  "description": null,
  "createdBy": null,
  "createdOn": "0001-01-01T00:00:00",
  "modifiedBy": null,
  "modifiedOn": "0001-01-01T00:00:00",
  "isDeleted": false,
  "variables": {},
  "variableGroups": [],
  "environments": [
    {
      "id": 0,
      "name": "PROD",
      "variables": {},
      "variableGroups": [],
      "preDeployApprovals": {
        "approvals": [
          {
            "rank": 1,
            "isAutomated": false,
            "isNotificationOn": false,
            "approver": {
              "displayName": null,
              "id": "aeb95c63-4fac-4948-84ce-711b0a9dda97"
            },
            "id": 0
          }
        ]
      },
      "postDeployApprovals": {
        "approvals": [
          {
            "rank": 1,
            "isAutomated": true,
            "isNotificationOn": false,
            "id": 0
          }
        ]
      },
      "deployPhases": [
        {
          "deploymentInput": {
            "parallelExecution": {
              "parallelExecutionType": "none"
            },
            "skipArtifactsDownload": false,
            "artifactsDownloadInput": {},
            "queueId": 15,
            "demands": [],
            "enableAccessToken": false,
            "timeoutInMinutes": 0,
            "jobCancelTimeoutInMinutes": 1,
            "condition": "succeeded()",
            "overrideInputs": {}
          },
          "rank": 1,
          "phaseType": "agentBasedDeployment",
          "name": "Run on agent",
          "workflowTasks": []
        }
      ],
      "environmentOptions": {
        "emailNotificationType": "OnlyOnFailure",
        "emailRecipients": "release.environment.owner;release.creator",
        "skipArtifactsDownload": false,
        "timeoutInMinutes": 0,
        "enableAccessToken": false,
        "publishDeploymentStatus": false,
        "badgeEnabled": false,
        "autoLinkWorkItems": false,
        "pullRequestDeploymentEnabled": false
      },
      "demands": [],
      "conditions": [],
      "executionPolicy": {
        "concurrencyCount": 0,
        "queueDepthCount": 0
      },
      "schedules": [],
      "retentionPolicy": {
        "daysToKeep": 30,
        "releasesToKeep": 3,
        "retainBuild": true
      },
      "properties": {},
      "preDeploymentGates": {
        "id": 0,
        "gatesOptions": null,
        "gates": []
      },
      "postDeploymentGates": {
        "id": 0,
        "gatesOptions": null,
        "gates": []
      },
      "environmentTriggers": []
    }
  ],
  "artifacts": [],
  "triggers": [],
  "releaseNameFormat": null,
  "tags": [],
  "properties": {},
  "id": 0,
  "name": "Fabrikam-web",
  "projectReference": null,
  "_links": {}
}

Sample Response

{
  "source": "restApi",
  "revision": 1,
  "description": null,
  "createdBy": {
    "displayName": "Chuck Reinhart",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/aeb95c63-4fac-4948-84ce-711b0a9dda97",
    "_links": {
      "avatar": {
        "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
      }
    },
    "id": "aeb95c63-4fac-4948-84ce-711b0a9dda97",
    "uniqueName": "fabfiber@outlook.com",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=aeb95c63-4fac-4948-84ce-711b0a9dda97",
    "descriptor": "aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
  },
  "createdOn": "2018-12-11T04:56:42.237Z",
  "modifiedBy": {
    "displayName": "Chuck Reinhart",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/aeb95c63-4fac-4948-84ce-711b0a9dda97",
    "_links": {
      "avatar": {
        "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
      }
    },
    "id": "aeb95c63-4fac-4948-84ce-711b0a9dda97",
    "uniqueName": "fabfiber@outlook.com",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=aeb95c63-4fac-4948-84ce-711b0a9dda97",
    "descriptor": "aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
  },
  "modifiedOn": "2018-12-11T04:56:42.237Z",
  "isDeleted": false,
  "variables": {},
  "variableGroups": [],
  "environments": [
    {
      "id": 42,
      "name": "PROD",
      "rank": 1,
      "owner": {
        "displayName": "Chuck Reinhart",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/aeb95c63-4fac-4948-84ce-711b0a9dda97",
        "_links": {
          "avatar": {
            "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
          }
        },
        "id": "aeb95c63-4fac-4948-84ce-711b0a9dda97",
        "uniqueName": "fabfiber@outlook.com",
        "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=aeb95c63-4fac-4948-84ce-711b0a9dda97",
        "descriptor": "aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
      },
      "variables": {},
      "variableGroups": [],
      "preDeployApprovals": {
        "approvals": [
          {
            "rank": 1,
            "isAutomated": false,
            "isNotificationOn": false,
            "approver": {
              "displayName": "Chuck Reinhart",
              "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/aeb95c63-4fac-4948-84ce-711b0a9dda97",
              "_links": {
                "avatar": {
                  "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
                }
              },
              "id": "aeb95c63-4fac-4948-84ce-711b0a9dda97",
              "uniqueName": "fabfiber@outlook.com",
              "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=aeb95c63-4fac-4948-84ce-711b0a9dda97",
              "descriptor": "aad.YjYxMjE5ZWQtODEwYS03OTU3LWJjYzAtMjQ0YTI5ZDk0ZjFl"
            },
            "id": 124
          }
        ],
        "approvalOptions": {
          "requiredApproverCount": 0,
          "releaseCreatorCanBeApprover": true,
          "autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped": false,
          "enforceIdentityRevalidation": false,
          "timeoutInMinutes": 0,
          "executionOrder": "beforeGates"
        }
      },
      "deployStep": {
        "id": 125
      },
      "postDeployApprovals": {
        "approvals": [
          {
            "rank": 1,
            "isAutomated": true,
            "isNotificationOn": false,
            "id": 126
          }
        ]
      },
      "deployPhases": [
        {
          "deploymentInput": {
            "parallelExecution": {
              "parallelExecutionType": "none"
            },
            "skipArtifactsDownload": false,
            "artifactsDownloadInput": {
              "downloadInputs": []
            },
            "queueId": 15,
            "demands": [],
            "enableAccessToken": false,
            "timeoutInMinutes": 0,
            "jobCancelTimeoutInMinutes": 1,
            "condition": "succeeded()",
            "overrideInputs": {}
          },
          "rank": 1,
          "phaseType": "agentBasedDeployment",
          "name": "Run on agent",
          "refName": null,
          "workflowTasks": []
        }
      ],
      "environmentOptions": {
        "emailNotificationType": "OnlyOnFailure",
        "emailRecipients": "release.environment.owner;release.creator",
        "skipArtifactsDownload": false,
        "timeoutInMinutes": 0,
        "enableAccessToken": false,
        "publishDeploymentStatus": false,
        "badgeEnabled": false,
        "autoLinkWorkItems": false,
        "pullRequestDeploymentEnabled": false
      },
      "demands": [],
      "conditions": [],
      "executionPolicy": {
        "concurrencyCount": 0,
        "queueDepthCount": 0
      },
      "schedules": [],
      "currentRelease": {
        "id": 0,
        "url": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/releases/0",
        "_links": {}
      },
      "retentionPolicy": {
        "daysToKeep": 30,
        "releasesToKeep": 3,
        "retainBuild": true
      },
      "properties": {},
      "preDeploymentGates": {
        "id": 0,
        "gatesOptions": null,
        "gates": []
      },
      "postDeploymentGates": {
        "id": 0,
        "gatesOptions": null,
        "gates": []
      },
      "environmentTriggers": [],
      "badgeUrl": "https://vsrm.dev.azure.com/fabrikam/_apis/public/Release/badge/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/42/42"
    }
  ],
  "artifacts": [],
  "triggers": [],
  "releaseNameFormat": "",
  "tags": [],
  "properties": {},
  "id": 42,
  "name": "Fabrikam-web",
  "path": "\\",
  "projectReference": null,
  "url": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/42",
  "_links": {
    "self": {
      "href": "https://vsrm.dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_apis/Release/definitions/42"
    },
    "web": {
      "href": "https://dev.azure.com/fabrikam/42fa3371-9e49-4858-8f49-9d4f2d0b32e8/_release?definitionId=42"
    }
  }
}

정의

Name Description
ApprovalExecutionOrder

승인 실행 순서입니다.

ApprovalOptions
Artifact
ArtifactSourceReference
AuthorizationHeader
Condition
ConditionType

조건 유형을 가져오거나 설정합니다.

ConfigurationVariableValue
DataSourceBindingBase

서비스 엔드포인트 요청에 대한 데이터 원본의 바인딩을 나타냅니다.

Demand
DeployPhase
DeployPhaseTypes

배포 단계 유형을 나타냅니다.

EnvironmentExecutionPolicy

Release Management 쪽 큐에서 환경 큐에 대한 정책을 정의합니다. 언급된 정책이 충족되는 경우에만 환경 실행기[사전 배포 및 기타 단계 만들기]로 보냅니다.

EnvironmentOptions
EnvironmentRetentionPolicy
EnvironmentTrigger
EnvironmentTriggerType

트리거 유형을 가져오거나 설정합니다.

IdentityRef
ProcessParameters
ProjectReference
PropertiesCollection

클래스는 키-값 쌍의 컬렉션으로 속성 모음을 나타냅니다. 를 제외한 모든 기본 형식의 값(을 TypeCode != TypeCode.Object제외한 DBNull 모든 형식)이 허용됩니다. Byte[], Int32, Double, DateType 및 String 형식의 값은 해당 형식을 유지하며 다른 기본 형식은 String으로 다시 조정됩니다. byte[] base64로 인코딩된 문자열로 예상됩니다.

ReferenceLinks

REST 참조 링크의 컬렉션을 나타내는 클래스입니다.

ReleaseDefinition
ReleaseDefinitionApprovals
ReleaseDefinitionApprovalStep
ReleaseDefinitionDeployStep
ReleaseDefinitionEnvironment
ReleaseDefinitionGate
ReleaseDefinitionGatesOptions
ReleaseDefinitionGatesStep
ReleaseDefinitionShallowReference
ReleaseDefinitionSource

릴리스 정의의 원본을 가져오거나 설정합니다.

ReleaseReason

릴리스 이유를 가져옵니다.

ReleaseReference
ReleaseSchedule
ReleaseShallowReference
ReleaseTriggerBase
ReleaseTriggerType

릴리스 트리거의 유형입니다.

ScheduleDays

릴리스할 요일입니다.

TaskInputDefinitionBase
TaskInputValidation
TaskSourceDefinitionBase
WorkflowTask

ApprovalExecutionOrder

승인 실행 순서입니다.

Name 형식 Description
afterGatesAlways

string

승인은 게이트 실행 후 항상 표시됩니다.

afterSuccessfulGates

string

게이트를 성공적으로 실행한 후 표시되는 승인입니다.

beforeGates

string

게이트 앞에 표시된 승인입니다.

ApprovalOptions

Name 형식 Description
autoTriggeredAndPreviousEnvironmentApprovedCanBeSkipped

boolean

동일한 승인자가 이전 단계를 승인한 경우 승인을 건너뛸 수 있는지 여부를 지정합니다.

enforceIdentityRevalidation

boolean

승인을 완료하기 전에 승인자의 ID 유효성을 다시 검사할지 여부를 지정합니다.

executionOrder

ApprovalExecutionOrder

승인 실행 순서입니다.

releaseCreatorCanBeApprover

boolean

릴리스 또는 배포를 요청하는 사용자가 승인자를 허용할지 여부를 지정합니다.

requiredApproverCount

integer

릴리스를 진행하는 데 필요한 승인 수입니다. '0'은 필요한 모든 승인을 의미합니다.

timeoutInMinutes

integer

승인 시간 제한. 승인 기본 시간 제한은 30일입니다. 허용되는 최대 제한 시간은 365일입니다. '0'은 기본 시간 제한(예: 30일)을 의미합니다.

Artifact

Name 형식 Description
alias

string

별칭을 가져오거나 설정합니다.

definitionReference

<string,  ArtifactSourceReference>

정의 참조를 가져오거나 설정합니다. 예: {"project":{"id":"fed755ea-49c5-4399-acea-fd5b5aa90a6c","name":"myProject"},"definition":{"id":"1","name":"mybuildDefinition"},"connection":{"id":"1","name":"myConnection"}}

isPrimary

boolean

아티팩트가 기본인지 여부를 나타냅니다.

isRetained

boolean

아티팩트가 릴리스로 보존되는지 여부를 나타냅니다.

type

string

형식을 가져오거나 설정합니다. 'Build', 'Jenkins', 'GitHub', 'Nuget', 'Team Build(외부)', 'ExternalTFSBuild', 'Git', 'TFVC', 'ExternalTfsXamlBuild' 등의 값을 가질 수 있습니다.

ArtifactSourceReference

Name 형식 Description
id

string

아티팩트 원본의 ID입니다.

name

string

아티팩트 원본의 이름입니다.

AuthorizationHeader

Name 형식 Description
name

string

value

string

Condition

Name 형식 Description
conditionType

ConditionType

조건 유형을 가져오거나 설정합니다.

name

string

조건의 이름을 가져오거나 설정합니다. 예: 'ReleaseStarted'.

value

string

조건의 값을 가져오거나 설정합니다.

ConditionType

조건 유형을 가져오거나 설정합니다.

Name 형식 Description
artifact

string

조건 유형이 아티팩트입니다.

environmentState

string

조건 유형은 환경 상태입니다.

event

string

조건 유형은 이벤트입니다.

undefined

string

조건 유형이 정의되지 않았습니다.

ConfigurationVariableValue

Name 형식 Description
allowOverride

boolean

배포 시 변수를 재정의할 수 있는지 여부를 가져오고 설정합니다.

isSecret

boolean

변수가 비밀인지 여부를 가져오거나 설정합니다.

value

string

구성 변수의 값을 가져오고 설정합니다.

DataSourceBindingBase

서비스 엔드포인트 요청에 대한 데이터 원본의 바인딩을 나타냅니다.

Name 형식 Description
callbackContextTemplate

string

이 데이터 원본에서 지원하는 페이지 매김 형식(ContinuationToken/SkipTop).

callbackRequiredTemplate

string

후속 호출이 필요하신가요?

dataSourceName

string

데이터 원본의 이름을 가져오거나 설정합니다.

endpointId

string

엔드포인트 ID를 가져오거나 설정합니다.

endpointUrl

string

서비스 엔드포인트의 URL을 가져오거나 설정합니다.

headers

AuthorizationHeader[]

권한 부여 헤더를 가져오거나 설정합니다.

initialContextTemplate

string

쿼리 매개 변수의 초기 값을 정의합니다.

parameters

object

데이터 원본에 대한 매개 변수를 가져오거나 설정합니다.

requestContent

string

http 요청 본문을 가져오거나 설정합니다.

requestVerb

string

http 요청 동사를 가져오거나 설정합니다.

resultSelector

string

결과 선택기를 가져오거나 설정합니다.

resultTemplate

string

결과 템플릿을 가져오거나 설정합니다.

target

string

데이터 원본의 대상을 가져오거나 설정합니다.

Demand

Name 형식 Description
name

string

수요의 이름을 가져오고 설정합니다.

value

string

수요 값을 가져오고 설정합니다.

DeployPhase

Name 형식 Description
name

string

배포 단계의 이름을 가져오고 설정합니다.

phaseType

DeployPhaseTypes

배포 단계 유형을 나타냅니다.

rank

integer

배포 단계의 순위를 가져오고 설정합니다.

refName

string

배포 단계의 참조 이름을 가져오고 설정합니다.

workflowTasks

WorkflowTask[]

배포 단계에 대한 워크플로 작업을 가져오고 설정합니다.

DeployPhaseTypes

배포 단계 유형을 나타냅니다.

Name 형식 Description
agentBasedDeployment

string

에이전트에서 실행되는 작업이 포함된 단계 유형입니다.

deploymentGates

string

배포가 진행되도록 게이트 역할을 하는 작업을 포함하는 단계 유형입니다.

machineGroupBasedDeployment

string

배포 그룹 컴퓨터에서 실행되는 작업을 포함하는 단계 유형입니다.

runOnServer

string

서버에서 실행된 작업을 포함하는 단계 유형입니다.

undefined

string

단계 유형이 정의되지 않았습니다. 이 항목을 사용하지 마세요.

EnvironmentExecutionPolicy

Release Management 쪽 큐에서 환경 큐에 대한 정책을 정의합니다. 언급된 정책이 충족되는 경우에만 환경 실행기[사전 배포 및 기타 단계 만들기]로 보냅니다.

Name 형식 Description
concurrencyCount

integer

이 정책은 Environment Runner를 사용하는 환경 수를 결정합니다.

queueDepthCount

integer

EnvironmentQueue 테이블의 큐 깊이에서 이 테이블은 환경 실행기가 실행하기 위해 다른 환경을 사용할 수 있도록 [정책에 따라] 무료가 될 때까지 환경 항목을 유지합니다.

EnvironmentOptions

Name 형식 Description
autoLinkWorkItems

boolean

자동 연결 작업 영역으로 가져오거나 설정합니다.

badgeEnabled

boolean

배지를 사용할지 여부를 가져오고 설정합니다.

publishDeploymentStatus

boolean

게시 배포 상태 여부를 가져오고 설정합니다.

pullRequestDeploymentEnabled

boolean

.pull 요청 배포를 사용하도록 설정했는지 여부를 가져오고 설정합니다.

EnvironmentRetentionPolicy

Name 형식 Description
daysToKeep

integer

환경을 유지할 일 수를 가져오고 설정합니다.

releasesToKeep

integer

유지할 릴리스 수를 가져오고 설정합니다.

retainBuild

boolean

보존할 빌드를 가져오고 설정합니다.

EnvironmentTrigger

Name 형식 Description
definitionEnvironmentId

integer

이 트리거를 적용할 수 있는 정의 환경 ID입니다.

releaseDefinitionId

integer

이 트리거를 적용할 수 있는 ReleaseDefinition ID입니다.

triggerContent

string

트리거 콘텐츠를 가져오거나 설정합니다.

triggerType

EnvironmentTriggerType

트리거 유형을 가져오거나 설정합니다.

EnvironmentTriggerType

트리거 유형을 가져오거나 설정합니다.

Name 형식 Description
deploymentGroupRedeploy

string

환경 트리거 유형은 배포 그룹 재배포입니다.

rollbackRedeploy

string

환경 트리거 유형은 롤백입니다.

undefined

string

환경 트리거 유형이 정의되지 않았습니다.

IdentityRef

Name 형식 Description
_links

ReferenceLinks

이 필드에는 그래프 제목에 대한 0개 이상의 흥미로운 링크가 포함되어 있습니다. 이러한 링크를 호출하여 이 그래프 제목에 대한 추가 관계 또는 자세한 정보를 얻을 수 있습니다.

descriptor

string

설명자는 시스템이 실행되는 동안 그래프 제목을 참조하는 기본 방법입니다. 이 필드는 계정과 조직 모두에서 동일한 그래프 제목을 고유하게 식별합니다.

directoryAlias

string

사용되지 않음 - IdentityRef "_links" 사전의 "자체" 항목에서 참조된 Graph 사용자를 쿼리하여 검색할 수 있습니다.

displayName

string

그래프 주체의 고유하지 않은 표시 이름입니다. 이 필드를 변경하려면 원본 공급자에서 해당 값을 변경해야 합니다.

id

string

imageUrl

string

사용되지 않음 - IdentityRef "_links" 사전의 "아바타" 항목에서 사용할 수 있습니다.

inactive

boolean

사용되지 않음 - GraphUser "_links" 사전의 "membershipState" 항목에서 참조되는 Graph 멤버 자격 상태를 쿼리하여 검색할 수 있습니다.

isAadIdentity

boolean

사용되지 않음 - 설명자의 주체 형식(Descriptor.IsAadUserType/Descriptor.IsAadGroupType)에서 유추할 수 있습니다.

isContainer

boolean

사용되지 않음 - 설명자의 주체 형식에서 유추할 수 있음(Descriptor.IsGroupType)

isDeletedInOrigin

boolean

profileUrl

string

사용되지 않음 - ToIdentityRef의 대부분의 기존 구현에서 사용되지 않음

uniqueName

string

사용되지 않음 - 대신 Domain+PrincipalName 사용

url

string

이 URL은 이 그래프 주체의 원본 리소스에 대한 전체 경로입니다.

ProcessParameters

Name 형식 Description
dataSourceBindings

DataSourceBindingBase[]

서비스 엔드포인트 요청에 대한 데이터 원본의 바인딩을 나타냅니다.

inputs

TaskInputDefinitionBase[]

sourceDefinitions

TaskSourceDefinitionBase[]

ProjectReference

Name 형식 Description
id

string

이 필드의 고유 식별자를 가져옵니다.

name

string

프로젝트의 이름을 가져옵니다.

PropertiesCollection

클래스는 키-값 쌍의 컬렉션으로 속성 모음을 나타냅니다. 를 제외한 모든 기본 형식의 값(을 TypeCode != TypeCode.Object제외한 DBNull 모든 형식)이 허용됩니다. Byte[], Int32, Double, DateType 및 String 형식의 값은 해당 형식을 유지하며 다른 기본 형식은 String으로 다시 조정됩니다. byte[] base64로 인코딩된 문자열로 예상됩니다.

Name 형식 Description
count

integer

컬렉션의 속성 수입니다.

item

object

keys

string[]

컬렉션의 키 집합입니다.

values

string[]

컬렉션의 값 집합입니다.

REST 참조 링크의 컬렉션을 나타내는 클래스입니다.

Name 형식 Description
links

object

링크의 읽기 전용 보기입니다. 참조 링크는 읽기 전용이므로 읽기 전용으로만 노출하려고 합니다.

ReleaseDefinition

Name 형식 Description
_links

ReferenceLinks

릴리스 정의에 대한 관련 리소스, API 및 뷰에 대한 링크를 가져옵니다.

artifacts

Artifact[]

아티팩트 목록을 가져오거나 설정합니다.

comment

string

주석을 가져오거나 설정합니다.

createdBy

IdentityRef

만든 ID를 가져오거나 설정합니다.

createdOn

string

만든 날짜를 가져옵니다.

description

string

설명을 가져오거나 설정합니다.

environments

ReleaseDefinitionEnvironment[]

환경 목록을 가져오거나 설정합니다.

id

integer

릴리스 정의의 고유 식별자를 가져옵니다.

isDeleted

boolean

릴리스 정의를 삭제할지 여부입니다.

lastRelease

ReleaseReference

마지막 릴리스의 참조를 가져옵니다.

modifiedBy

IdentityRef

수정한 ID를 가져오거나 설정합니다.

modifiedOn

string

수정된 날짜를 가져옵니다.

name

string

릴리스 정의의 이름을 가져오거나 설정합니다.

path

string

릴리스 정의의 경로를 가져오거나 설정합니다.

projectReference

ProjectReference

프로젝트 참조를 가져오거나 설정합니다.

properties

PropertiesCollection

속성을 가져오거나 설정합니다.

releaseNameFormat

string

릴리스 이름 형식을 가져오거나 설정합니다.

revision

integer

수정 번호를 가져옵니다.

source

ReleaseDefinitionSource

릴리스 정의의 원본을 가져오거나 설정합니다.

tags

string[]

태그 목록을 가져오거나 설정합니다.

triggers

ReleaseTriggerBase[]

트리거 목록을 가져오거나 설정합니다.

url

string

릴리스 정의에 액세스하기 위한 REST API URL을 가져옵니다.

variableGroups

integer[]

변수 그룹 목록을 가져오거나 설정합니다.

variables

<string,  ConfigurationVariableValue>

변수 사전을 가져오거나 설정합니다.

ReleaseDefinitionApprovals

Name 형식 Description
approvalOptions

ApprovalOptions

승인 옵션을 가져오거나 설정합니다.

approvals

ReleaseDefinitionApprovalStep[]

승인을 가져오거나 설정합니다.

ReleaseDefinitionApprovalStep

Name 형식 Description
approver

IdentityRef

승인자를 가져오고 설정합니다.

id

integer

승인 또는 배포 단계의 ID입니다.

isAutomated

boolean

승인이 자동화되었는지 여부를 나타냅니다.

isNotificationOn

boolean

승인 알림 집합 여부를 나타냅니다.

rank

integer

승인 단계의 순위를 가져오거나 설정합니다.

ReleaseDefinitionDeployStep

Name 형식 Description
id

integer

승인 또는 배포 단계의 ID입니다.

tasks

WorkflowTask[]

이 정의에 대한 단계 목록입니다.

ReleaseDefinitionEnvironment

Name 형식 Description
badgeUrl

string

BadgeUrl을 가져오거나 설정합니다. 배지는 릴리스 정의 환경에서 배지를 사용하도록 설정할 때 사용됩니다.

conditions

Condition[]

환경 조건을 가져오거나 설정합니다.

currentRelease

ReleaseShallowReference

현재 릴리스 참조를 가져오거나 설정합니다.

demands

Demand[]

요구를 가져오거나 설정합니다.

deployPhases

DeployPhase[]

환경의 배포 단계를 가져오거나 설정합니다.

deployStep

ReleaseDefinitionDeployStep

deploystep을 가져오거나 설정합니다.

environmentOptions

EnvironmentOptions

환경 옵션을 가져오거나 설정합니다.

environmentTriggers

EnvironmentTrigger[]

환경에서 트리거를 가져오거나 설정합니다.

executionPolicy

EnvironmentExecutionPolicy

환경 실행 정책을 가져오거나 설정합니다.

id

integer

ReleaseDefinitionEnvironment의 ID를 가져오고 설정합니다.

name

string

ReleaseDefinitionEnvironment의 이름을 가져오고 설정합니다.

owner

IdentityRef

ReleaseDefinitionEnvironment의 소유자를 가져오고 설정합니다.

postDeployApprovals

ReleaseDefinitionApprovals

배포 후 승인을 가져오거나 설정합니다.

postDeploymentGates

ReleaseDefinitionGatesStep

배포 후 게이트를 가져오거나 설정합니다.

preDeployApprovals

ReleaseDefinitionApprovals

배포 전 승인을 가져오거나 설정합니다.

preDeploymentGates

ReleaseDefinitionGatesStep

배포 전 게이트를 가져오거나 설정합니다.

processParameters

ProcessParameters

환경 프로세스 매개 변수를 가져오거나 설정합니다.

properties

PropertiesCollection

환경의 속성을 가져오거나 설정합니다.

queueId

integer

큐 ID를 가져오거나 설정합니다.

rank

integer

ReleaseDefinitionEnvironment의 순위를 가져오고 설정합니다.

retentionPolicy

EnvironmentRetentionPolicy

환경 보존 정책을 가져오거나 설정합니다.

schedules

ReleaseSchedule[]

일정을 가져오거나 설정합니다.

variableGroups

integer[]

변수 그룹을 가져오거나 설정합니다.

variables

<string,  ConfigurationVariableValue>

변수를 가져오고 설정합니다.

ReleaseDefinitionGate

Name 형식 Description
tasks

WorkflowTask[]

게이트 워크플로를 가져오거나 설정합니다.

ReleaseDefinitionGatesOptions

Name 형식 Description
isEnabled

boolean

게이트 사용 여부를 가져오거나 설정합니다.

minimumSuccessDuration

integer

게이트 평가에 성공한 후 안정적인 결과의 최소 기간을 가져오거나 설정합니다.

samplingInterval

integer

게이트 다시 평가 사이의 시간을 가져오거나 설정합니다.

stabilizationTime

integer

평가 전 지연을 가져오거나 설정합니다.

timeout

integer

게이트가 실패한 시간 제한을 가져오거나 설정합니다.

ReleaseDefinitionGatesStep

Name 형식 Description
gates

ReleaseDefinitionGate[]

게이트를 가져오거나 설정합니다.

gatesOptions

ReleaseDefinitionGatesOptions

게이트 옵션을 가져오거나 설정합니다.

id

integer

ReleaseDefinitionGateStep의 ID입니다.

ReleaseDefinitionShallowReference

Name 형식 Description
_links

ReferenceLinks

릴리스 정의에 대한 관련 리소스, API 및 뷰에 대한 링크를 가져옵니다.

id

integer

릴리스 정의의 고유 식별자를 가져옵니다.

name

string

릴리스 정의의 이름을 가져오거나 설정합니다.

path

string

릴리스 정의의 경로를 가져오거나 설정합니다.

projectReference

ProjectReference

프로젝트 참조를 가져오거나 설정합니다.

url

string

릴리스 정의에 액세스하기 위한 REST API URL을 가져옵니다.

ReleaseDefinitionSource

릴리스 정의의 원본을 가져오거나 설정합니다.

Name 형식 Description
ibiza

string

Ibiza에서 만든 ReleaseDefinition을 나타냅니다.

portalExtensionApi

string

PortalExtension API에서 만든 ReleaseDefinition을 나타냅니다.

restApi

string

REST API를 사용하여 만든 ReleaseDefinition을 나타냅니다.

undefined

string

ReleaseDefinition 원본이 정의되지 않음을 나타냅니다.

userInterface

string

UI를 사용하여 만든 ReleaseDefinition을 나타냅니다.

ReleaseReason

릴리스 이유를 가져옵니다.

Name 형식 Description
continuousIntegration

string

연속 통합에 의해 트리거되는 릴리스를 나타냅니다.

manual

string

수동으로 트리거된 릴리스를 나타냅니다.

none

string

릴리스 트리거 이유를 설정하지 않음을 나타냅니다.

pullRequest

string

PullRequest에 의해 트리거된 릴리스를 나타냅니다.

schedule

string

일정에 따라 트리거되는 릴리스를 나타냅니다.

ReleaseReference

Name 형식 Description
_links

ReferenceLinks

릴리스에 액세스할 링크를 가져옵니다.

artifacts

Artifact[]

아티팩트 목록을 가져옵니다.

createdBy

IdentityRef

릴리스를 만든 ID를 가져옵니다.

createdOn

string

이 릴리스를 만든 날짜를 가져옵니다.

description

string

설명을 가져옵니다.

id

integer

릴리스의 ID입니다.

modifiedBy

IdentityRef

릴리스를 수정한 ID를 가져옵니다.

name

string

릴리스의 이름을 가져옵니다.

reason

ReleaseReason

릴리스 이유를 가져옵니다.

releaseDefinition

ReleaseDefinitionShallowReference

릴리스 정의 단순 참조를 가져옵니다.

ReleaseSchedule

Name 형식 Description
daysToRelease

ScheduleDays

릴리스할 요일입니다.

jobId

string

Team Foundation 작업 정의 작업 ID입니다.

scheduleOnlyWithChanges

boolean

연결된 아티팩트가 변경되었거나 릴리스 정의가 변경된 경우에만 이 일정을 해제해야 하는지 여부를 확인하는 플래그입니다.

startHours

integer

시작할 현지 표준 시간대 시간입니다.

startMinutes

integer

시작할 현지 표준 시간대 분입니다.

timeZoneId

string

릴리스 일정의 표준 시간대 ID(예: 'UTC')입니다.

ReleaseShallowReference

Name 형식 Description
_links

ReferenceLinks

릴리스에 대한 관련 리소스, API 및 뷰에 대한 링크를 가져옵니다.

id

integer

릴리스의 고유 식별자를 가져옵니다.

name

string

릴리스의 이름을 가져오거나 설정합니다.

url

string

릴리스에 액세스하기 위한 REST API URL을 가져옵니다.

ReleaseTriggerBase

Name 형식 Description
triggerType

ReleaseTriggerType

릴리스 트리거의 유형입니다.

ReleaseTriggerType

릴리스 트리거의 유형입니다.

Name 형식 Description
artifactSource

string

아티팩트 기반 릴리스 트리거입니다.

containerImage

string

컨테이너 이미지 기반 릴리스 트리거입니다.

package

string

패키지 기반 릴리스 트리거입니다.

pullRequest

string

끌어오기 요청 기반 릴리스 트리거입니다.

schedule

string

일정 기반 릴리스 트리거.

sourceRepo

string

원본 리포지토리 기반 릴리스 트리거입니다.

undefined

string

릴리스 트리거 유형이 설정되지 않았습니다.

ScheduleDays

릴리스할 요일입니다.

Name 형식 Description
all

string

요일의 모든 날짜에 예약됩니다.

friday

string

금요일에 예약됩니다.

monday

string

월요일에 예약됩니다.

none

string

예약된 날짜가 설정되지 않았습니다.

saturday

string

토요일에 예약됩니다.

sunday

string

일요일에 예약되었습니다.

thursday

string

목요일에 예약됩니다.

tuesday

string

화요일에 예약되었습니다.

wednesday

string

수요일에 예약되었습니다.

TaskInputDefinitionBase

Name 형식 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

Name 형식 Description
expression

string

조건 식

message

string

유효성 검사에 실패할 경우 사용자가 수정할 수 있는 방법을 설명하는 메시지

TaskSourceDefinitionBase

Name 형식 Description
authKey

string

endpoint

string

keySelector

string

selector

string

target

string

WorkflowTask

Name 형식 Description
alwaysRun

boolean

작업이 항상 실행되거나 실행되지 않을 때 를 가져오거나 설정합니다.

condition

string

작업 조건을 가져오거나 설정합니다.

continueOnError

boolean

오류가 발생하거나 실행되지 않을 때 작업을 계속 실행할 때 를 가져오거나 설정합니다.

definitionType

string

작업 정의 형식을 가져오거나 설정합니다. 예:- 'Agent', DeploymentGroup', 'Server' 또는 'ServerGate'.

enabled

boolean

작업 사용 여부를 가져오거나 설정합니다.

environment

object

작업 환경 변수를 가져오거나 설정합니다.

inputs

object

작업 입력을 가져오거나 설정합니다.

name

string

태스크 이름을 가져오거나 설정합니다.

overrideInputs

object

태스크 재정의 입력을 가져오거나 설정합니다.

refName

string

작업의 참조 이름을 가져오거나 설정합니다.

retryCountOnTaskFailure

integer

작업 retryCount를 가져오거나 설정합니다.

taskId

string

작업의 ID를 가져오거나 설정합니다.

timeoutInMinutes

integer

작업 시간 제한을 가져오거나 설정합니다.

version

string

작업의 버전을 가져오거나 설정합니다.