Cmdlets for Azure DevOps

Build 24.0.9175

ReleaseEnvironments

Retrieves a list of releases.

Table Specific Information

SELECT Query Examples


SELECT * FROM ReleaseEnvironments
SELECT * FROM ReleaseEnvironments WHERE ReleaseId = 13 AND id = 18

UPDATE Query Examples


UPDATE ReleaseEnvironments SET Status = 'inProgress' WHERE ReleaseId = 10 AND id = 12

Columns

Name Type ReadOnly References Description
Id [KEY] Integer True

Unique identifier for the release environment.

ReleaseId [KEY] Integer True

Releases.Id

Unique identifier for the release associated with this environment.

Name String True

Descriptive name of the release environment.

OwnerId String True

Identifier of the user or entity that owns the environment.

CreatedOn Datetime True

Timestamp indicating when the release environment was created.

ModifiedOn Datetime True

Timestamp indicating when the release environment was last modified.

DefinitionEnvironmentId Integer True

Identifier for the associated definition environment.

AutoLinkWorkItems Boolean True

Indicates whether work items should be automatically linked to deployments.

BadgeEnabled Boolean True

Indicates whether a badge displaying deployment status is enabled.

EmailNotificationType String True

Specifies the type of email notifications to be sent for deployments.

EmailRecipients String True

List of email recipients for deployment notifications.

EnableAccessToken Boolean True

Indicates whether an access token is enabled for the environment.

PublishDeploymentStatus Boolean True

Indicates whether deployment status should be published.

PullRequestDeploymentEnabled Boolean True

Indicates whether deployment via pull requests is enabled.

SkipArtifactsDownload Boolean True

Indicates whether artifact downloads should be skipped during deployment.

TimeoutInMinutes Integer True

Specifies the maximum allowed deployment duration in minutes.

PostApprovalAutoTrigger Boolean True

Indicates whether an approval can be skipped if the same approver approved the previous stage.

PostApprovalEnforceIdentityReval Boolean True

Specifies whether the identity of the approver must be revalidated before completing approval.

PostApprovalExecutionOrder String True

Defines the execution order for approvals.

PostApprovalCreatorCanBeApprover Boolean True

Indicates whether the user initiating a release or deployment can also be an approver.

PostApprovalRequiredApproverCount Integer True

Specifies the number of required approvals for the release to proceed. '0' means all approvals are required.

PostApprovalTimeoutInMinutes Integer True

Specifies the timeout duration for approvals in minutes. Default is 30 days, maximum is 365 days. '0' uses the default timeout.

PostDeploymentGatesSnapshotId Integer True

Identifier for the snapshot of post-deployment gates.

PreApprovalAutoTrigger Boolean True

Indicates whether an approval can be skipped if the same approver approved the previous stage.

PreApprovalEnforceIdentityReval Boolean True

Specifies whether the identity of the approver must be revalidated before completing approval.

PreApprovalExecutionOrder String True

Defines the execution order for approvals.

PreApprovalCreatorCanBeApprover Boolean True

Indicates whether the user initiating a release or deployment can also be an approver.

PreApprovalRequiredApproverCount Integer True

Specifies the number of required approvals for the release to proceed. '0' means all approvals are required.

PreApprovalTimeoutInMinutes Integer True

Specifies the timeout duration for approvals in minutes. Default is 30 days, maximum is 365 days. '0' uses the default timeout.

PreDeploymentGatesSnapshotId Integer True

Identifier for the snapshot of pre-deployment gates.

Rank Integer True

Specifies the ranking or order of this environment in the release pipeline.

ReleaseCreatedById String True

Identifier of the user who created the release.

ReleaseDefinitionId Integer True

Identifier of the release definition associated with this environment.

Status String False

Current status of the environment in the release process.

TimeToDeploy Double True

Time taken to deploy the environment.

TriggerReason String True

Specifies the reason that triggered the release.

Variables String False

Contains environment-specific variables in an aggregated format.

ProjectId String True

Unique identifier or name of the project associated with this release.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。 特に指定がない限り、擬似カラムでフィルタリングを行う場合は = 演算子のみ使用できます。

Name Type Description
Comment String

User-provided comments related to the release environment.

ScheduledDeploymentTime String

Scheduled time for the deployment to occur.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 24.0.9175