ReleaseRestClient class
VSS REST API への要求を行うために (から派生) 使用する必要がある基底クラス
- Extends
コンストラクター
Release |
プロパティ
RESOURCE_AREA_ID |
メソッド
コンストラクターの詳細
ReleaseRestClient(IVssRestClientOptions)
プロパティの詳細
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: string
プロパティ値
string
メソッドの詳細
addDefinitionTag(string, number, string)
定義にタグを追加します
function addDefinitionTag(project: string, releaseDefinitionId: number, tag: string): Promise<string[]>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- releaseDefinitionId
-
number
- tag
-
string
戻り値
Promise<string[]>
addDefinitionTags(string[], string, number)
1 つの定義に複数のタグを追加します
function addDefinitionTags(tags: string[], project: string, releaseDefinitionId: number): Promise<string[]>
パラメーター
- tags
-
string[]
- project
-
string
プロジェクト ID またはプロジェクト名
- releaseDefinitionId
-
number
戻り値
Promise<string[]>
addReleaseTag(string, number, string)
releaseId にタグを追加します
function addReleaseTag(project: string, releaseId: number, tag: string): Promise<string[]>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- releaseId
-
number
- tag
-
string
戻り値
Promise<string[]>
addReleaseTags(string[], string, number)
リリースにタグを追加します
function addReleaseTags(tags: string[], project: string, releaseId: number): Promise<string[]>
パラメーター
- tags
-
string[]
- project
-
string
プロジェクト ID またはプロジェクト名
- releaseId
-
number
戻り値
Promise<string[]>
createDefinitionEnvironmentTemplate(ReleaseDefinitionEnvironmentTemplate, string)
定義環境テンプレートを作成します
function createDefinitionEnvironmentTemplate(template: ReleaseDefinitionEnvironmentTemplate, project: string): Promise<ReleaseDefinitionEnvironmentTemplate>
パラメーター
- template
- ReleaseDefinitionEnvironmentTemplate
作成する定義環境テンプレート
- project
-
string
プロジェクト ID またはプロジェクト名
戻り値
Promise<ReleaseDefinitionEnvironmentTemplate>
createFavorites(FavoriteItem[], string, string, string)
function createFavorites(favoriteItems: FavoriteItem[], project: string, scope: string, identityId?: string): Promise<FavoriteItem[]>
パラメーター
- favoriteItems
- project
-
string
プロジェクト ID またはプロジェクト名
- scope
-
string
- identityId
-
string
戻り値
Promise<FavoriteItem[]>
createFolder(Folder, string, string)
新しいフォルダーを作成します。
function createFolder(folder: Folder, project: string, path?: string): Promise<Folder>
パラメーター
- folder
- Folder
フォルダーにある静的 JSON ファイルからデータを読み込みます。
- project
-
string
プロジェクト ID またはプロジェクト名
- path
-
string
フォルダーのパス。
戻り値
Promise<Folder>
createRelease(ReleaseStartMetadata, string)
リリースを作成します。
function createRelease(releaseStartMetadata: ReleaseStartMetadata, project: string): Promise<Release>
パラメーター
- releaseStartMetadata
- ReleaseStartMetadata
リリースを作成するためのメタデータ。
- project
-
string
プロジェクト ID またはプロジェクト名
戻り値
Promise<Release>
createReleaseDefinition(ReleaseDefinition, string)
リリース定義の作成
function createReleaseDefinition(releaseDefinition: ReleaseDefinition, project: string): Promise<ReleaseDefinition>
パラメーター
- releaseDefinition
- ReleaseDefinition
作成するリリース定義オブジェクト。
- project
-
string
プロジェクト ID またはプロジェクト名
戻り値
Promise<ReleaseDefinition>
deleteDefinitionEnvironmentTemplate(string, string)
定義環境テンプレートを削除する
function deleteDefinitionEnvironmentTemplate(project: string, templateId: string): Promise<void>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- templateId
-
string
定義環境テンプレートの ID
戻り値
Promise<void>
deleteDefinitionTag(string, number, string)
定義からタグを削除します
function deleteDefinitionTag(project: string, releaseDefinitionId: number, tag: string): Promise<string[]>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- releaseDefinitionId
-
number
- tag
-
string
戻り値
Promise<string[]>
deleteFavorites(string, string, string, string)
function deleteFavorites(project: string, scope: string, identityId?: string, favoriteItemIds?: string): Promise<void>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- scope
-
string
- identityId
-
string
- favoriteItemIds
-
string
戻り値
Promise<void>
deleteFolder(string, string)
特定のフォルダー名とパス、および既存のすべての定義の定義フォルダーを削除します。
function deleteFolder(project: string, path: string): Promise<void>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- path
-
string
削除するフォルダーのパス。
戻り値
Promise<void>
deleteRelease(string, number, string)
リリースを論理的に削除する
function deleteRelease(project: string, releaseId: number, comment?: string): Promise<void>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- releaseId
-
number
リリースの ID。
- comment
-
string
リリースを削除するためのコメント。
戻り値
Promise<void>
deleteReleaseDefinition(string, number, string, boolean)
リリース定義を削除します。
function deleteReleaseDefinition(project: string, definitionId: number, comment?: string, forceDelete?: boolean): Promise<void>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- definitionId
-
number
リリース定義の ID。
- comment
-
string
リリース定義を削除するためのコメント。
- forceDelete
-
boolean
進行中のリリースデプロイを自動的に取り消し、リリース定義の削除を続行するには、'true' を指定します。 既定値は 'false' です。
戻り値
Promise<void>
deleteReleaseTag(string, number, string)
リリースからタグを削除します
function deleteReleaseTag(project: string, releaseId: number, tag: string): Promise<string[]>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- releaseId
-
number
- tag
-
string
戻り値
Promise<string[]>
getAgentArtifactDefinitions(string, number)
オートメーション エージェントに必要な成果物の詳細を返します
function getAgentArtifactDefinitions(project: string, releaseId: number): Promise<AgentArtifactDefinition[]>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- releaseId
-
number
戻り値
Promise<AgentArtifactDefinition[]>
getApproval(string, number, boolean)
承認を取得します。
function getApproval(project: string, approvalId: number, includeHistory?: boolean): Promise<ReleaseApproval>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- approvalId
-
number
承認の ID。
- includeHistory
-
boolean
承認の履歴を含める場合は 'true' です。 既定値は 'false' です。
戻り値
Promise<ReleaseApproval>
getApprovalHistory(string, number)
承認履歴を取得します。
function getApprovalHistory(project: string, approvalStepId: number): Promise<ReleaseApproval>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- approvalStepId
-
number
承認の ID。
戻り値
Promise<ReleaseApproval>
getApprovals(string, string, ApprovalStatus, number[], ApprovalType, number, number, ReleaseQueryOrder, boolean)
承認の一覧を取得する
function getApprovals(project: string, assignedToFilter?: string, statusFilter?: ApprovalStatus, releaseIdsFilter?: number[], typeFilter?: ApprovalType, top?: number, continuationToken?: number, queryOrder?: ReleaseQueryOrder, includeMyGroupApprovals?: boolean): Promise<PagedList<ReleaseApproval>>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- assignedToFilter
-
string
このユーザーに割り当てられた承認。
- statusFilter
- ApprovalStatus
この状態の承認。 既定値は '保留中' です。
- releaseIdsFilter
-
number[]
フィルターに記載されているリリース ID の承認。 releaseIdsFilter=1,2,3,4 など、複数のリリースを ',' で区切ることで言及できます。
- typeFilter
- ApprovalType
この種類の承認。
- top
-
number
取得する承認の数。 既定は 50 です。
- continuationToken
-
number
継続トークンが指定された後の承認を取得します。
- queryOrder
- ReleaseQueryOrder
作成された承認の定義された順序で結果を取得します。 既定値は "降順" です。
- includeMyGroupApprovals
-
boolean
グループの承認を含める場合は 'true' です。 既定値は 'false' です。
戻り値
Promise<PagedList<ReleaseApproval>>
getArtifactTypeDefinitions(string)
function getArtifactTypeDefinitions(project: string): Promise<ArtifactTypeDefinition[]>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
戻り値
Promise<ArtifactTypeDefinition[]>
getArtifactVersions(string, number)
function getArtifactVersions(project: string, releaseDefinitionId: number): Promise<ArtifactVersionQueryResult>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- releaseDefinitionId
-
number
戻り値
Promise<ArtifactVersionQueryResult>
getArtifactVersionsForSources(Artifact[], string)
function getArtifactVersionsForSources(artifacts: Artifact[], project: string): Promise<ArtifactVersionQueryResult>
パラメーター
- artifacts
-
Artifact[]
- project
-
string
プロジェクト ID またはプロジェクト名
戻り値
Promise<ArtifactVersionQueryResult>
getAutoTriggerIssues(string, string, string, string)
function getAutoTriggerIssues(artifactType: string, sourceId: string, artifactVersionId: string, project?: string): Promise<AutoTriggerIssue[]>
パラメーター
- artifactType
-
string
- sourceId
-
string
- artifactVersionId
-
string
- project
-
string
プロジェクト ID またはプロジェクト名
戻り値
Promise<AutoTriggerIssue[]>
getDefinitionEnvironments(string, string, string[])
function getDefinitionEnvironments(project: string, taskGroupId?: string, propertyFilters?: string[]): Promise<DefinitionEnvironmentReference[]>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- taskGroupId
-
string
- propertyFilters
-
string[]
戻り値
Promise<DefinitionEnvironmentReference[]>
getDefinitionEnvironmentTemplate(string, string)
定義環境テンプレートを取得します
function getDefinitionEnvironmentTemplate(project: string, templateId: string): Promise<ReleaseDefinitionEnvironmentTemplate>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- templateId
-
string
定義環境テンプレートの ID
戻り値
Promise<ReleaseDefinitionEnvironmentTemplate>
getDefinitionRevision(string, number, number)
特定の definitionId とリビジョンのリリース定義を取得する
function getDefinitionRevision(project: string, definitionId: number, revision: number): Promise<string>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- definitionId
-
number
定義の ID。
- revision
-
number
リビジョンの ID。
戻り値
Promise<string>
getDefinitionTags(string, number)
定義のタグを取得します
function getDefinitionTags(project: string, releaseDefinitionId: number): Promise<string[]>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- releaseDefinitionId
-
number
戻り値
Promise<string[]>
getDeploymentBadge(string, number, number, string)
環境の最新のデプロイの状態を示すバッジを取得します。
function getDeploymentBadge(projectId: string, releaseDefinitionId: number, environmentId: number, branchName?: string): Promise<string>
パラメーター
- projectId
-
string
プロジェクトの ID。
- releaseDefinitionId
-
number
リリース定義の ID。
- environmentId
-
number
環境の ID。
- branchName
-
string
ブランチの名前。
戻り値
Promise<string>
getDeployments(string, number, number, string, Date, Date, DeploymentStatus, DeploymentOperationStatus, boolean, ReleaseQueryOrder, number, number, string, Date, Date, string)
デプロイの一覧を取得する
function getDeployments(project: string, definitionId?: number, definitionEnvironmentId?: number, createdBy?: string, minModifiedTime?: Date, maxModifiedTime?: Date, deploymentStatus?: DeploymentStatus, operationStatus?: DeploymentOperationStatus, latestAttemptsOnly?: boolean, queryOrder?: ReleaseQueryOrder, top?: number, continuationToken?: number, createdFor?: string, minStartedTime?: Date, maxStartedTime?: Date, sourceBranch?: string): Promise<PagedList<Deployment>>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- definitionId
-
number
特定の定義 ID のデプロイを一覧表示します。
- definitionEnvironmentId
-
number
特定の定義環境 ID のデプロイを一覧表示します。
- createdBy
-
string
指定された ID としてデプロイが作成されるデプロイを一覧表示します。
- minModifiedTime
-
Date
LastModified time >= minModifiedTime を使用してデプロイを一覧表示します。
- maxModifiedTime
-
Date
LastModified time <= maxModifiedTime を使用してデプロイを一覧表示します。
- deploymentStatus
- DeploymentStatus
特定のデプロイの状態を含むデプロイを一覧表示します。 既定値は 'All' です。
- operationStatus
- DeploymentOperationStatus
特定の操作状態のデプロイを一覧表示します。 既定値は 'All' です。
- latestAttemptsOnly
-
boolean
'true' を指定すると、最新の試行のみを含むデプロイが含まれます。 既定値は 'false' です。
- queryOrder
- ReleaseQueryOrder
特定のクエリ順序でデプロイを一覧表示します。 既定値は "降順" です。
- top
-
number
指定された top を使用してデプロイを一覧表示します。 既定の top は '50' で、max top は '100' です。
- continuationToken
-
number
デプロイ ID >= continuationToken を使用してデプロイを一覧表示します。
- createdFor
-
string
デプロイが要求されるデプロイを ID 指定として一覧表示します。
- minStartedTime
-
Date
StartedOn time >= minStartedTime を使用してデプロイを一覧表示します。
- maxStartedTime
-
Date
StartedOn time <= maxStartedTime を使用してデプロイを一覧表示します。
- sourceBranch
-
string
指定されたブランチ名からデプロイされたデプロイを一覧表示します。
戻り値
Promise<PagedList<Deployment>>
getDeploymentsForMultipleEnvironments(DeploymentQueryParameters, string)
function getDeploymentsForMultipleEnvironments(queryParameters: DeploymentQueryParameters, project: string): Promise<Deployment[]>
パラメーター
- queryParameters
- DeploymentQueryParameters
- project
-
string
プロジェクト ID またはプロジェクト名
戻り値
Promise<Deployment[]>
getFavorites(string, string, string)
function getFavorites(project: string, scope: string, identityId?: string): Promise<FavoriteItem[]>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- scope
-
string
- identityId
-
string
戻り値
Promise<FavoriteItem[]>
getFlightAssignments(string)
function getFlightAssignments(flightName?: string): Promise<string[]>
パラメーター
- flightName
-
string
戻り値
Promise<string[]>
getFolders(string, string, FolderPathQueryOrder)
フォルダーを取得します。
function getFolders(project: string, path?: string, queryOrder?: FolderPathQueryOrder): Promise<Folder[]>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- path
-
string
フォルダーのパス。
- queryOrder
- FolderPathQueryOrder
定義された順序で結果を取得します。 既定値は 'None' です。
戻り値
Promise<Folder[]>
getGateLog(string, number, number, number, number)
ゲート ログを取得します
function getGateLog(project: string, releaseId: number, environmentId: number, gateId: number, taskId: number): Promise<string>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- releaseId
-
number
リリースの ID。
- environmentId
-
number
リリース環境の ID。
- gateId
-
number
ゲートの ID。
- taskId
-
number
ログの ReleaseTask ID。
戻り値
Promise<string>
getInputValues(InputValuesQuery, string)
function getInputValues(query: InputValuesQuery, project: string): Promise<InputValuesQuery>
パラメーター
- query
- InputValuesQuery
- project
-
string
プロジェクト ID またはプロジェクト名
戻り値
Promise<InputValuesQuery>
getIssues(string, number, string)
function getIssues(project: string, buildId: number, sourceId?: string): Promise<AutoTriggerIssue[]>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- buildId
-
number
- sourceId
-
string
戻り値
Promise<AutoTriggerIssue[]>
getLog(string, number, number, number, number)
ログを取得します
function getLog(project: string, releaseId: number, environmentId: number, taskId: number, attemptId?: number): Promise<string>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- releaseId
-
number
リリースの ID。
- environmentId
-
number
リリース環境の ID。
- taskId
-
number
ログの ReleaseTask ID。
- attemptId
-
number
試行の ID。
戻り値
Promise<string>
getLogs(string, number)
リリース ID のログを取得します。
function getLogs(project: string, releaseId: number): Promise<ArrayBuffer>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- releaseId
-
number
リリースの ID。
戻り値
Promise<ArrayBuffer>
getManualIntervention(string, number, number)
特定のリリースの手動介入と手動介入 ID を取得します。
function getManualIntervention(project: string, releaseId: number, manualInterventionId: number): Promise<ManualIntervention>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- releaseId
-
number
リリースの ID。
- manualInterventionId
-
number
手動介入の ID。
戻り値
Promise<ManualIntervention>
getManualInterventions(string, number)
特定のリリースのすべての手動介入を一覧表示します。
function getManualInterventions(project: string, releaseId: number): Promise<ManualIntervention[]>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- releaseId
-
number
リリースの ID。
戻り値
Promise<ManualIntervention[]>
getMetrics(string, Date)
function getMetrics(project: string, minMetricsTime?: Date): Promise<Metric[]>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- minMetricsTime
-
Date
戻り値
Promise<Metric[]>
getOrgPipelineReleaseSettings()
組織パイプラインのリリース設定を取得します
function getOrgPipelineReleaseSettings(): Promise<OrgPipelineReleaseSettings>
戻り値
Promise<OrgPipelineReleaseSettings>
getPipelineReleaseSettings(string)
パイプラインのリリース設定を取得します
function getPipelineReleaseSettings(project: string): Promise<ProjectPipelineReleaseSettings>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
戻り値
Promise<ProjectPipelineReleaseSettings>
getRelease(string, number, ApprovalFilters, string[], SingleReleaseExpands, number)
リリースを取得する
function getRelease(project: string, releaseId: number, approvalFilters?: ApprovalFilters, propertyFilters?: string[], expand?: SingleReleaseExpands, topGateRecords?: number): Promise<Release>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- releaseId
-
number
リリースの ID。
- approvalFilters
- ApprovalFilters
自動化されているか手動かに基づいて、承認ステップを選択的にフェッチできるようにするフィルター。 これにより、承認前スナップショットと事後承認スナップショットをフェッチする必要があるかどうかも決定されます。 既定ではすべてと見なされます
- propertyFilters
-
string[]
取得する拡張プロパティのコンマ区切りのリスト。 設定されている場合、返される Release には、指定されたプロパティ ID の値が含まれます (存在する場合)。 設定しない場合、プロパティは含まれません。
- expand
- SingleReleaseExpands
リリースで展開する必要があるプロパティ。
- topGateRecords
-
number
取得するリリース ゲート レコードの数。 既定値は 5 です。
戻り値
Promise<Release>
getReleaseChanges(string, number, number, number, string)
function getReleaseChanges(project: string, releaseId: number, baseReleaseId?: number, top?: number, artifactAlias?: string): Promise<Change[]>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- releaseId
-
number
- baseReleaseId
-
number
- top
-
number
- artifactAlias
-
string
戻り値
Promise<Change[]>
getReleaseDefinition(string, number, string[])
リリース定義を取得します。
function getReleaseDefinition(project: string, definitionId: number, propertyFilters?: string[]): Promise<ReleaseDefinition>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- definitionId
-
number
リリース定義の ID。
- propertyFilters
-
string[]
取得する拡張プロパティのコンマ区切りのリスト。 設定されている場合、返されるリリース定義には、指定されたプロパティ ID の値が含まれます (存在する場合)。 設定しない場合、プロパティは含まれません。
戻り値
Promise<ReleaseDefinition>
getReleaseDefinitionHistory(string, number)
リリース定義のリビジョン履歴を取得する
function getReleaseDefinitionHistory(project: string, definitionId: number): Promise<ReleaseDefinitionRevision[]>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- definitionId
-
number
定義の ID。
戻り値
Promise<ReleaseDefinitionRevision[]>
getReleaseDefinitionRevision(string, number, number)
特定のリビジョンのリリース定義を取得します。
function getReleaseDefinitionRevision(project: string, definitionId: number, revision: number): Promise<string>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- definitionId
-
number
リリース定義の ID。
- revision
-
number
リリース定義のリビジョン番号。
戻り値
Promise<string>
getReleaseDefinitions(string, string, ReleaseDefinitionExpands, string, string, number, string, ReleaseDefinitionQueryOrder, string, boolean, string[], string[], string[], boolean, boolean)
リリース定義の一覧を取得します。
function getReleaseDefinitions(project: string, searchText?: string, expand?: ReleaseDefinitionExpands, artifactType?: string, artifactSourceId?: string, top?: number, continuationToken?: string, queryOrder?: ReleaseDefinitionQueryOrder, path?: string, isExactNameMatch?: boolean, tagFilter?: string[], propertyFilters?: string[], definitionIdFilter?: string[], isDeleted?: boolean, searchTextContainsFolderName?: boolean): Promise<PagedList<ReleaseDefinition>>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- searchText
-
string
searchText を含む名前を持つリリース定義を取得します。
- expand
- ReleaseDefinitionExpands
リリース定義の一覧で展開する必要があるプロパティ。
- artifactType
-
string
指定された artifactType を持つリリース定義が返されます。 値には、Build、Jenkins、GitHub、Nuget、Team Build (external)、ExternalTFSBuild、Git、TFVC、ExternalTfsXamlBuild を指定できます。
- artifactSourceId
-
string
指定された artifactSourceId を持つリリース定義が返されます。 たとえば、ビルドの場合は {projectGuid}:{BuildDefinitionId}、Jenkins の場合は {JenkinsConnectionId}:{JenkinsDefinitionId}、TfsOnPrem の場合は {TfsOnPremConnectionId}:{ProjectName}:{TfsOnPremDefinitionId} になります。 TeamCity、BitBucket などのサードパーティの成果物の場合は、 のvss-extension.json https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensions内で 'uniqueSourceIdentifier' を参照できます。
- top
-
number
取得するリリース定義の数。
- continuationToken
-
string
指定された継続トークンの後のリリース定義を取得します。
- queryOrder
- ReleaseDefinitionQueryOrder
定義された順序で結果を取得します。 既定値は 'IdAscending' です。
- path
-
string
指定したパスの下にあるリリース定義を取得します。
- isExactNameMatch
-
boolean
'true' は、searchText で指定されたとおりに完全に一致するリリース定義を取得します。 既定値は 'false' です。
- tagFilter
-
string[]
タグのコンマ区切りのリスト。 これらのタグを持つリリース定義のみが返されます。
- propertyFilters
-
string[]
取得する拡張プロパティのコンマ区切りのリスト。 設定されている場合、返されるリリース定義には、指定されたプロパティ ID の値が含まれます (存在する場合)。 設定されていない場合、プロパティは含まれません。 これにより、プロパティが設定されているかどうかに関係なく、結果からリリース定義が除外されないことに注意してください。
- definitionIdFilter
-
string[]
取得するリリース定義のコンマ区切りのリスト。
- isDeleted
-
boolean
削除されたリリース定義を取得するには、'true' を指定します。 既定値は 'false' です
- searchTextContainsFolderName
-
boolean
'true' を指定すると、searchText で指定された名前のフォルダーの下にあるリリース定義が取得されます。 既定値は 'false' です。
戻り値
Promise<PagedList<ReleaseDefinition>>
getReleaseDefinitionSummary(string, number, number, boolean, number[])
特定の定義 ID のリリースの概要を取得します。
function getReleaseDefinitionSummary(project: string, definitionId: number, releaseCount: number, includeArtifact?: boolean, definitionEnvironmentIdsFilter?: number[]): Promise<ReleaseDefinitionSummary>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- definitionId
-
number
リリースの概要を取得する定義の ID。
- releaseCount
-
number
概要に含めるリリースの数。
- includeArtifact
-
boolean
成果物の詳細を含めます。既定値は 'false' です。
- definitionEnvironmentIdsFilter
-
number[]
戻り値
Promise<ReleaseDefinitionSummary>
getReleaseEnvironment(string, number, number, ReleaseEnvironmentExpands)
リリース環境を取得します。
function getReleaseEnvironment(project: string, releaseId: number, environmentId: number, expand?: ReleaseEnvironmentExpands): Promise<ReleaseEnvironment>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- releaseId
-
number
リリースの ID。
- environmentId
-
number
リリース環境の ID。
- expand
- ReleaseEnvironmentExpands
環境で展開する必要があるプロパティ。
戻り値
Promise<ReleaseEnvironment>
getReleaseHistory(string, number)
function getReleaseHistory(project: string, releaseId: number): Promise<ReleaseRevision[]>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- releaseId
-
number
戻り値
Promise<ReleaseRevision[]>
getReleaseProjects(string, string)
function getReleaseProjects(artifactType: string, artifactSourceId: string): Promise<ProjectReference[]>
パラメーター
- artifactType
-
string
- artifactSourceId
-
string
戻り値
Promise<ProjectReference[]>
getReleaseRevision(string, number, number)
特定のリビジョン番号のリリースを取得します。
function getReleaseRevision(project: string, releaseId: number, definitionSnapshotRevision: number): Promise<string>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- releaseId
-
number
リリースの ID。
- definitionSnapshotRevision
-
number
リビジョン番号スナップショット定義。
戻り値
Promise<string>
getReleases(string, number, number, string, string, ReleaseStatus, number, Date, Date, ReleaseQueryOrder, number, number, ReleaseExpands, string, string, string, string, boolean, string[], string[], number[], string)
リリースの一覧を取得する
function getReleases(project?: string, definitionId?: number, definitionEnvironmentId?: number, searchText?: string, createdBy?: string, statusFilter?: ReleaseStatus, environmentStatusFilter?: number, minCreatedTime?: Date, maxCreatedTime?: Date, queryOrder?: ReleaseQueryOrder, top?: number, continuationToken?: number, expand?: ReleaseExpands, artifactTypeId?: string, sourceId?: string, artifactVersionId?: string, sourceBranchFilter?: string, isDeleted?: boolean, tagFilter?: string[], propertyFilters?: string[], releaseIdFilter?: number[], path?: string): Promise<PagedList<Release>>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- definitionId
-
number
このリリース定義 ID からのリリース。
- definitionEnvironmentId
-
number
- searchText
-
string
searchText を含む名前を持つリリース。
- createdBy
-
string
このユーザーによって作成されたリリース。
- statusFilter
- ReleaseStatus
この状態のリリース。
- environmentStatusFilter
-
number
- minCreatedTime
-
Date
この後に作成されたリリース。
- maxCreatedTime
-
Date
この時点より前に作成されたリリース。
- queryOrder
- ReleaseQueryOrder
リリースの作成日の定義された順序で結果を取得します。 既定値は降順です。
- top
-
number
取得するリリースの数。 既定は 50 です。
- continuationToken
-
number
指定された継続トークンの後のリリースを取得します。
- expand
- ReleaseExpands
リリースの一覧で展開する必要がある プロパティ。
- artifactTypeId
-
string
指定された artifactTypeId を持つリリースが返されます。 値には、Build、Jenkins、GitHub、Nuget、Team Build (external)、ExternalTFSBuild、Git、TFVC、ExternalTfsXamlBuild を指定できます。
- sourceId
-
string
使用される成果物の一意識別子。 たとえば、ビルドの場合は {projectGuid}:{BuildDefinitionId}、Jenkins の場合は {JenkinsConnectionId}:{JenkinsDefinitionId}、TfsOnPrem の場合は {TfsOnPremConnectionId}:{ProjectName}:{TfsOnPremDefinitionId} になります。 サードパーティの成果物 (TeamCity、BitBucket など) の場合は、vss-extension.json https://github.com/Microsoft/vsts-rm-extensions/blob/master/Extensions内で 'uniqueSourceIdentifier' を参照できます。
- artifactVersionId
-
string
指定された artifactVersionId を持つリリースが返されます。 たとえば、Build artifactType の場合は buildId です。
- sourceBranchFilter
-
string
指定された sourceBranchFilter を含むリリースが返されます。
- isDeleted
-
boolean
論理的に削除されたリリース (true の場合) を取得します。
- tagFilter
-
string[]
タグのコンマ区切りのリスト。 これらのタグを持つリリースのみが返されます。
- propertyFilters
-
string[]
取得する拡張プロパティのコンマ区切りのリスト。 設定されている場合、返されるリリースには、指定したプロパティ ID の値が含まれます (存在する場合)。 設定されていない場合、プロパティは含まれません。 これは、プロパティが設定されているかどうかに関係なく、結果からリリースを除外しないことに注意してください。
- releaseIdFilter
-
number[]
リリース ID のコンマ区切りの一覧。 これらの ID を持つリリースのみが返されます。
- path
-
string
このフォルダー パスの下のリリースが返されます
戻り値
getReleaseSettings(string)
リリース設定を取得します
function getReleaseSettings(project: string): Promise<ReleaseSettings>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
戻り値
Promise<ReleaseSettings>
getReleaseTags(string, number)
リリースのタグを取得します
function getReleaseTags(project: string, releaseId: number): Promise<string[]>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- releaseId
-
number
戻り値
Promise<string[]>
getReleaseTaskAttachmentContent(string, number, number, number, string, string, string, string, string)
リリース タスクの添付ファイルを取得します。
function getReleaseTaskAttachmentContent(project: string, releaseId: number, environmentId: number, attemptId: number, planId: string, timelineId: string, recordId: string, type: string, name: string): Promise<ArrayBuffer>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- releaseId
-
number
リリースの ID。
- environmentId
-
number
リリース環境の ID。
- attemptId
-
number
デプロイの試行数。
- planId
-
string
デプロイ フェーズのプラン ID。
- timelineId
-
string
タスクのタイムライン ID。
- recordId
-
string
添付ファイルのレコード ID。
- type
-
string
添付ファイルの種類。
- name
-
string
添付ファイルの名前。
戻り値
Promise<ArrayBuffer>
getReleaseTaskAttachments(string, number, number, number, string, string)
リリース タスクの添付ファイルを取得します。
function getReleaseTaskAttachments(project: string, releaseId: number, environmentId: number, attemptId: number, planId: string, type: string): Promise<ReleaseTaskAttachment[]>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- releaseId
-
number
リリースの ID。
- environmentId
-
number
リリース環境の ID。
- attemptId
-
number
デプロイの試行数。
- planId
-
string
デプロイ フェーズのプラン ID。
- type
-
string
添付ファイルの種類。
戻り値
Promise<ReleaseTaskAttachment[]>
getReleaseWorkItemsRefs(string, number, number, number, string)
function getReleaseWorkItemsRefs(project: string, releaseId: number, baseReleaseId?: number, top?: number, artifactAlias?: string): Promise<ReleaseWorkItemRef[]>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- releaseId
-
number
- baseReleaseId
-
number
- top
-
number
- artifactAlias
-
string
戻り値
Promise<ReleaseWorkItemRef[]>
getSourceBranches(string, number)
function getSourceBranches(project: string, definitionId: number): Promise<string[]>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- definitionId
-
number
戻り値
Promise<string[]>
getSummaryMailSections(string, number)
function getSummaryMailSections(project: string, releaseId: number): Promise<SummaryMailSection[]>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- releaseId
-
number
戻り値
Promise<SummaryMailSection[]>
getTags(string)
function getTags(project: string): Promise<string[]>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
戻り値
Promise<string[]>
getTaskAttachmentContent(string, number, number, number, string, string, string, string)
タスクの添付ファイルを取得します。
function getTaskAttachmentContent(project: string, releaseId: number, environmentId: number, attemptId: number, timelineId: string, recordId: string, type: string, name: string): Promise<ArrayBuffer>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- releaseId
-
number
リリースの ID。
- environmentId
-
number
リリース環境の ID。
- attemptId
-
number
デプロイの試行回数。
- timelineId
-
string
タスクのタイムライン ID。
- recordId
-
string
添付ファイルのレコード ID。
- type
-
string
添付ファイルの種類。
- name
-
string
添付ファイルの名前。
戻り値
Promise<ArrayBuffer>
getTaskAttachments(string, number, number, number, string, string)
タスクの添付ファイルを取得します。
function getTaskAttachments(project: string, releaseId: number, environmentId: number, attemptId: number, timelineId: string, type: string): Promise<ReleaseTaskAttachment[]>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- releaseId
-
number
リリースの ID。
- environmentId
-
number
リリース環境の ID。
- attemptId
-
number
デプロイの試行回数。
- timelineId
-
string
タスクのタイムライン ID。
- type
-
string
添付ファイルの種類。
戻り値
Promise<ReleaseTaskAttachment[]>
getTaskLog(string, number, number, number, number, number, number)
リリースのタスク ログをプレーン テキスト ファイルとして取得します。
function getTaskLog(project: string, releaseId: number, environmentId: number, releaseDeployPhaseId: number, taskId: number, startLine?: number, endLine?: number): Promise<string>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- releaseId
-
number
リリースの ID。
- environmentId
-
number
リリース環境の ID。
- releaseDeployPhaseId
-
number
リリースデプロイフェーズ ID。
- taskId
-
number
ログの ReleaseTask ID。
- startLine
-
number
ログの開始行番号
- endLine
-
number
ログの終了行番号
戻り値
Promise<string>
getTaskLog2(string, number, number, number, string, number, number, number)
リリースのタスク ログをプレーン テキスト ファイルとして取得します。
function getTaskLog2(project: string, releaseId: number, environmentId: number, attemptId: number, timelineId: string, taskId: number, startLine?: number, endLine?: number): Promise<string>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- releaseId
-
number
リリースの ID。
- environmentId
-
number
リリース環境の ID。
- attemptId
-
number
- timelineId
-
string
- taskId
-
number
ログの ReleaseTask ID。
- startLine
-
number
ログの開始行番号
- endLine
-
number
ログの終了行番号
戻り値
Promise<string>
getTasks(string, number, number, number)
function getTasks(project: string, releaseId: number, environmentId: number, attemptId?: number): Promise<ReleaseTask[]>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- releaseId
-
number
- environmentId
-
number
- attemptId
-
number
戻り値
Promise<ReleaseTask[]>
getTasks2(string, number, number, number, string)
function getTasks2(project: string, releaseId: number, environmentId: number, attemptId: number, timelineId: string): Promise<ReleaseTask[]>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- releaseId
-
number
- environmentId
-
number
- attemptId
-
number
- timelineId
-
string
戻り値
Promise<ReleaseTask[]>
getTasksForTaskGroup(string, number, number, number)
function getTasksForTaskGroup(project: string, releaseId: number, environmentId: number, releaseDeployPhaseId: number): Promise<ReleaseTask[]>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- releaseId
-
number
- environmentId
-
number
- releaseDeployPhaseId
-
number
戻り値
Promise<ReleaseTask[]>
listDefinitionEnvironmentTemplates(string, boolean)
定義環境テンプレートの一覧を取得します
function listDefinitionEnvironmentTemplates(project: string, isDeleted?: boolean): Promise<ReleaseDefinitionEnvironmentTemplate[]>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- isDeleted
-
boolean
削除された定義環境テンプレートを取得するには、'true' を指定します。 既定値は 'false' です
戻り値
Promise<ReleaseDefinitionEnvironmentTemplate[]>
sendSummaryMail(MailMessage, string, number)
function sendSummaryMail(mailMessage: MailMessage, project: string, releaseId: number): Promise<void>
パラメーター
- mailMessage
- MailMessage
- project
-
string
プロジェクト ID またはプロジェクト名
- releaseId
-
number
戻り値
Promise<void>
undeleteRelease(string, number, string)
論理的に削除されたリリースの削除を取り消します。
function undeleteRelease(project: string, releaseId: number, comment: string): Promise<void>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- releaseId
-
number
削除を解除するリリースの ID。
- comment
-
string
削除を解除するための任意のコメント。
戻り値
Promise<void>
undeleteReleaseDefinition(ReleaseDefinitionUndeleteParameter, string, number)
リリース定義の削除を取り消します。
function undeleteReleaseDefinition(releaseDefinitionUndeleteParameter: ReleaseDefinitionUndeleteParameter, project: string, definitionId: number): Promise<ReleaseDefinition>
パラメーター
- releaseDefinitionUndeleteParameter
- ReleaseDefinitionUndeleteParameter
リリース定義の削除を取り消すオブジェクト。
- project
-
string
プロジェクト ID またはプロジェクト名
- definitionId
-
number
削除を解除するリリース定義の ID
戻り値
Promise<ReleaseDefinition>
undeleteReleaseDefinitionEnvironmentTemplate(string, string)
リリース定義環境テンプレートの削除を取り消します。
function undeleteReleaseDefinitionEnvironmentTemplate(project: string, templateId: string): Promise<ReleaseDefinitionEnvironmentTemplate>
パラメーター
- project
-
string
プロジェクト ID またはプロジェクト名
- templateId
-
string
削除を解除する定義環境テンプレートの ID
戻り値
Promise<ReleaseDefinitionEnvironmentTemplate>
updateFolder(Folder, string, string)
指定された既存のパスにある既存のフォルダーをUpdatesします。
function updateFolder(folder: Folder, project: string, path: string): Promise<Folder>
パラメーター
- folder
- Folder
フォルダーにある静的 JSON ファイルからデータを読み込みます。
- project
-
string
プロジェクト ID またはプロジェクト名
- path
-
string
更新するフォルダーのパス。
戻り値
Promise<Folder>
updateGates(GateUpdateMetadata, string, number)
デプロイのゲートをUpdatesします。
function updateGates(gateUpdateMetadata: GateUpdateMetadata, project: string, gateStepId: number): Promise<ReleaseGates>
パラメーター
- gateUpdateMetadata
- GateUpdateMetadata
リリース ゲートにパッチを適用するメタデータ。
- project
-
string
プロジェクト ID またはプロジェクト名
- gateStepId
-
number
ゲート ステップ ID。
戻り値
Promise<ReleaseGates>
updateManualIntervention(ManualInterventionUpdateMetadata, string, number, number)
手動介入を更新します。
function updateManualIntervention(manualInterventionUpdateMetadata: ManualInterventionUpdateMetadata, project: string, releaseId: number, manualInterventionId: number): Promise<ManualIntervention>
パラメーター
- manualInterventionUpdateMetadata
- ManualInterventionUpdateMetadata
手動介入を更新するためのメタデータ。
- project
-
string
プロジェクト ID またはプロジェクト名
- releaseId
-
number
リリースの ID。
- manualInterventionId
-
number
手動介入の ID。
戻り値
Promise<ManualIntervention>
updateOrgPipelineReleaseSettings(OrgPipelineReleaseSettingsUpdateParameters)
Updates組織パイプラインのリリース設定
function updateOrgPipelineReleaseSettings(newSettings: OrgPipelineReleaseSettingsUpdateParameters): Promise<OrgPipelineReleaseSettings>
パラメーター
- newSettings
- OrgPipelineReleaseSettingsUpdateParameters
戻り値
Promise<OrgPipelineReleaseSettings>
updatePipelineReleaseSettings(ProjectPipelineReleaseSettingsUpdateParameters, string)
パイプラインのリリース設定をUpdatesする
function updatePipelineReleaseSettings(newSettings: ProjectPipelineReleaseSettingsUpdateParameters, project: string): Promise<ProjectPipelineReleaseSettings>
パラメーター
- newSettings
- ProjectPipelineReleaseSettingsUpdateParameters
- project
-
string
プロジェクト ID またはプロジェクト名
戻り値
Promise<ProjectPipelineReleaseSettings>
updateRelease(Release, string, number)
完全なリリース オブジェクトを更新します。
function updateRelease(release: Release, project: string, releaseId: number): Promise<Release>
パラメーター
- release
- Release
更新用のリリース オブジェクト。
- project
-
string
プロジェクト ID またはプロジェクト名
- releaseId
-
number
更新するリリースの ID。
戻り値
Promise<Release>
updateReleaseApproval(ReleaseApproval, string, number)
承認の状態を更新する
function updateReleaseApproval(approval: ReleaseApproval, project: string, approvalId: number): Promise<ReleaseApproval>
パラメーター
- approval
- ReleaseApproval
状態、承認者、コメントを持つ ReleaseApproval オブジェクト。
- project
-
string
プロジェクト ID またはプロジェクト名
- approvalId
-
number
承認の ID。
戻り値
Promise<ReleaseApproval>
updateReleaseApprovals(ReleaseApproval[], string)
function updateReleaseApprovals(approvals: ReleaseApproval[], project: string): Promise<ReleaseApproval[]>
パラメーター
- approvals
- project
-
string
プロジェクト ID またはプロジェクト名
戻り値
Promise<ReleaseApproval[]>
updateReleaseDefinition(ReleaseDefinition, string)
リリース定義を更新します。
function updateReleaseDefinition(releaseDefinition: ReleaseDefinition, project: string): Promise<ReleaseDefinition>
パラメーター
- releaseDefinition
- ReleaseDefinition
更新するリリース定義オブジェクト。
- project
-
string
プロジェクト ID またはプロジェクト名
戻り値
Promise<ReleaseDefinition>
updateReleaseEnvironment(ReleaseEnvironmentUpdateMetadata, string, number, number)
リリース環境の状態を更新する
function updateReleaseEnvironment(environmentUpdateData: ReleaseEnvironmentUpdateMetadata, project: string, releaseId: number, environmentId: number): Promise<ReleaseEnvironment>
パラメーター
- environmentUpdateData
- ReleaseEnvironmentUpdateMetadata
環境でメタデータを更新します。
- project
-
string
プロジェクト ID またはプロジェクト名
- releaseId
-
number
リリースの ID。
- environmentId
-
number
リリース環境の ID。
戻り値
Promise<ReleaseEnvironment>
updateReleaseResource(ReleaseUpdateMetadata, string, number)
リリースのいくつかのプロパティを更新します。
function updateReleaseResource(releaseUpdateMetadata: ReleaseUpdateMetadata, project: string, releaseId: number): Promise<Release>
パラメーター
- releaseUpdateMetadata
- ReleaseUpdateMetadata
更新するリリースのプロパティ。
- project
-
string
プロジェクト ID またはプロジェクト名
- releaseId
-
number
更新するリリースの ID。
戻り値
Promise<Release>
updateReleaseSettings(ReleaseSettings, string)
リリース設定をUpdatesする
function updateReleaseSettings(releaseSettings: ReleaseSettings, project: string): Promise<ReleaseSettings>
パラメーター
- releaseSettings
- ReleaseSettings
- project
-
string
プロジェクト ID またはプロジェクト名
戻り値
Promise<ReleaseSettings>