次の方法で共有

Check Configurations - Query

  • リファレンス
Service:
Approvals And Checks
API Version:
7.1-preview.1

リソースの種類と ID によって、複数のリソースのチェック構成を取得します。

POST https://dev.azure.com/{organization}/{project}/_apis/pipelines/checks/queryconfigurations?api-version=7.1-preview.1
With optional parameters: 
POST https://dev.azure.com/{organization}/{project}/_apis/pipelines/checks/queryconfigurations?$expand={$expand}&api-version=7.1-preview.1

URI パラメーター

名前 / 必須 型 説明
organization
 path True

string

Azure DevOps 組織の名前です。
project
 path True

string

プロジェクト ID またはプロジェクト名
api-version
 query True

string

使う API のバージョン。 このバージョンの API を使用するには、これを '7.1-preview.1' に設定する必要があります。
$expand
 query

CheckConfigurationExpandParameter

チェック構成の一覧で展開する必要があるプロパティ。

要求本文

名前 型 説明
body

Resource[]

リソースの一覧。

応答

名前 型 説明
200 OK

CheckConfiguration[]

正常な操作

セキュリティ

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

名前 説明
vso.build ビルド結果、定義、要求など、ビルド成果物にアクセスする機能と、サービス フックを介してビルド イベントに関する通知を受信する機能を付与します。

例

Sample Request

POST https://dev.azure.com/{organization}/{project}/_apis/pipelines/checks/queryconfigurations?api-version=7.1-preview.1

[
  {
    "type": "queue",
    "id": "1",
    "name": "Default"
  },
  {
    "type": "environment",
    "id": "1",
    "name": "SampleEnv"
  }
]

Sample Response

Status code:
200 
request-Context: appId=cid-v1:a892bfef-0287-4640-9f5e-cffc90fbcf94
access-Control-Expose-Headers: Request-Context
Response Body
{
  "count": 12,
  "value": [
    {
      "createdBy": {
        "displayName": "User Name",
        "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
        "uniqueName": "uniqueName",
        "descriptor": "Descriptor"
      },
      "createdOn": "2020-11-19T11:21:11.1408948Z",
      "modifiedBy": {
        "displayName": "User Name",
        "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
        "uniqueName": "uniqueName",
        "descriptor": "Descriptor"
      },
      "modifiedOn": "2020-11-19T11:21:11.1408948Z",
      "timeout": 43200,
      "_links": {
        "self": {
          "href": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/checks/configurations/22"
        }
      },
      "id": 22,
      "type": {
        "id": "8c6f20a7-a545-4486-9777-f762fafe0d4d",
        "name": "Approval"
      },
      "url": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/checks/configurations/22",
      "resource": {
        "type": "queue",
        "id": "1",
        "name": "Default"
      }
    },
    {
      "createdBy": {
        "displayName": "User Name",
        "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
        "uniqueName": "uniqueName",
        "descriptor": "Descriptor"
      },
      "createdOn": "2020-11-19T11:21:11.312742Z",
      "modifiedBy": {
        "displayName": "User Name",
        "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
        "uniqueName": "uniqueName",
        "descriptor": "Descriptor"
      },
      "modifiedOn": "2020-11-19T11:52:52.3335458Z",
      "timeout": 43200,
      "_links": {
        "self": {
          "href": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/checks/configurations/23"
        }
      },
      "id": 23,
      "type": {
        "id": "fe1de3ee-a436-41b4-bb20-f6eb4cb879a7",
        "name": "Task Check"
      },
      "url": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/checks/configurations/23",
      "resource": {
        "type": "queue",
        "id": "1",
        "name": "Default"
      }
    },
    {
      "createdBy": {
        "displayName": "User Name",
        "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
        "uniqueName": "uniqueName",
        "descriptor": "Descriptor"
      },
      "createdOn": "2020-11-19T11:42:31.1912383Z",
      "modifiedBy": {
        "displayName": "User Name",
        "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
        "uniqueName": "uniqueName",
        "descriptor": "Descriptor"
      },
      "modifiedOn": "2020-11-19T11:42:31.1912383Z",
      "timeout": 43200,
      "_links": {
        "self": {
          "href": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/checks/configurations/24"
        }
      },
      "id": 24,
      "type": {
        "id": "8c6f20a7-a545-4486-9777-f762fafe0d4d",
        "name": "Approval"
      },
      "url": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/checks/configurations/24",
      "resource": {
        "type": "queue",
        "id": "1",
        "name": "Default"
      }
    },
    {
      "createdBy": {
        "displayName": "User Name",
        "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
        "uniqueName": "uniqueName",
        "descriptor": "Descriptor"
      },
      "createdOn": "2020-11-19T11:50:29.2550665Z",
      "modifiedBy": {
        "displayName": "User Name",
        "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
        "uniqueName": "uniqueName",
        "descriptor": "Descriptor"
      },
      "modifiedOn": "2020-11-19T12:26:25.7610862Z",
      "timeout": 43200,
      "_links": {
        "self": {
          "href": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/checks/configurations/27"
        }
      },
      "id": 27,
      "type": {
        "id": "fe1de3ee-a436-41b4-bb20-f6eb4cb879a7",
        "name": "Task Check"
      },
      "url": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/checks/configurations/27",
      "resource": {
        "type": "queue",
        "id": "1",
        "name": "Default"
      }
    },
    {
      "createdBy": {
        "displayName": "User Name",
        "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
        "uniqueName": "uniqueName",
        "descriptor": "Descriptor"
      },
      "createdOn": "2020-11-19T11:52:03.1146399Z",
      "modifiedBy": {
        "displayName": "User Name",
        "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
        "uniqueName": "uniqueName",
        "descriptor": "Descriptor"
      },
      "modifiedOn": "2020-11-19T11:52:03.1146399Z",
      "timeout": 43200,
      "_links": {
        "self": {
          "href": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/checks/configurations/28"
        }
      },
      "id": 28,
      "type": {
        "id": "8c6f20a7-a545-4486-9777-f762fafe0d4d",
        "name": "Approval"
      },
      "url": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/checks/configurations/28",
      "resource": {
        "type": "queue",
        "id": "1",
        "name": "Default"
      }
    },
    {
      "createdBy": {
        "displayName": "User Name",
        "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
        "uniqueName": "uniqueName",
        "descriptor": "Descriptor"
      },
      "createdOn": "2020-11-19T11:53:33.1149141Z",
      "modifiedBy": {
        "displayName": "User Name",
        "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
        "uniqueName": "uniqueName",
        "descriptor": "Descriptor"
      },
      "modifiedOn": "2020-11-19T11:53:33.1149141Z",
      "timeout": 43200,
      "_links": {
        "self": {
          "href": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/checks/configurations/30"
        }
      },
      "id": 30,
      "type": {
        "id": "8c6f20a7-a545-4486-9777-f762fafe0d4d",
        "name": "Approval"
      },
      "url": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/checks/configurations/30",
      "resource": {
        "type": "queue",
        "id": "1",
        "name": "Default"
      }
    },
    {
      "createdBy": {
        "displayName": "User Name",
        "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
        "uniqueName": "uniqueName",
        "descriptor": "Descriptor"
      },
      "createdOn": "2020-11-19T11:53:33.2555259Z",
      "modifiedBy": {
        "displayName": "User Name",
        "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
        "uniqueName": "uniqueName",
        "descriptor": "Descriptor"
      },
      "modifiedOn": "2020-11-19T11:53:33.2555259Z",
      "timeout": 43200,
      "_links": {
        "self": {
          "href": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/checks/configurations/31"
        }
      },
      "id": 31,
      "type": {
        "id": "fe1de3ee-a436-41b4-bb20-f6eb4cb879a7",
        "name": "Task Check"
      },
      "url": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/checks/configurations/31",
      "resource": {
        "type": "queue",
        "id": "1",
        "name": "Default"
      }
    },
    {
      "createdBy": {
        "displayName": "User Name",
        "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
        "uniqueName": "uniqueName",
        "descriptor": "Descriptor"
      },
      "createdOn": "2020-11-19T12:26:25.3548409Z",
      "modifiedBy": {
        "displayName": "User Name",
        "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
        "uniqueName": "uniqueName",
        "descriptor": "Descriptor"
      },
      "modifiedOn": "2020-11-19T12:26:25.3548409Z",
      "timeout": 43200,
      "_links": {
        "self": {
          "href": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/checks/configurations/32"
        }
      },
      "id": 32,
      "type": {
        "id": "8c6f20a7-a545-4486-9777-f762fafe0d4d",
        "name": "Approval"
      },
      "url": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/checks/configurations/32",
      "resource": {
        "type": "queue",
        "id": "1",
        "name": "Default"
      }
    },
    {
      "createdBy": {
        "displayName": "User Name",
        "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
        "uniqueName": "uniqueName",
        "descriptor": "Descriptor"
      },
      "createdOn": "2020-11-19T12:26:25.5267095Z",
      "modifiedBy": {
        "displayName": "User Name",
        "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
        "uniqueName": "uniqueName",
        "descriptor": "Descriptor"
      },
      "modifiedOn": "2020-11-19T12:26:25.5267095Z",
      "timeout": 43200,
      "_links": {
        "self": {
          "href": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/checks/configurations/33"
        }
      },
      "id": 33,
      "type": {
        "id": "fe1de3ee-a436-41b4-bb20-f6eb4cb879a7",
        "name": "Task Check"
      },
      "url": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/checks/configurations/33",
      "resource": {
        "type": "queue",
        "id": "1",
        "name": "Default"
      }
    },
    {
      "createdBy": {
        "displayName": "User Name",
        "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
        "uniqueName": "uniqueName",
        "descriptor": "Descriptor"
      },
      "createdOn": "2020-09-21T07:29:09.749198Z",
      "modifiedBy": {
        "displayName": "User Name",
        "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
        "uniqueName": "uniqueName",
        "descriptor": "Descriptor"
      },
      "modifiedOn": "2020-11-19T12:23:28.1356019Z",
      "timeout": 43200,
      "_links": {
        "self": {
          "href": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/checks/configurations/12"
        }
      },
      "id": 12,
      "type": {
        "id": "fe1de3ee-a436-41b4-bb20-f6eb4cb879a7",
        "name": "Task Check"
      },
      "url": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/checks/configurations/12",
      "resource": {
        "type": "environment",
        "id": "1",
        "name": "SampleEnv"
      }
    },
    {
      "createdBy": {
        "displayName": "User Name",
        "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
        "uniqueName": "uniqueName",
        "descriptor": "Descriptor"
      },
      "createdOn": "2020-09-30T12:46:12.6159149Z",
      "modifiedBy": {
        "displayName": "User Name",
        "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
        "uniqueName": "uniqueName",
        "descriptor": "Descriptor"
      },
      "modifiedOn": "2020-11-19T08:12:49.2665218Z",
      "timeout": 43200,
      "_links": {
        "self": {
          "href": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/checks/configurations/14"
        }
      },
      "id": 14,
      "type": {
        "id": "8c6f20a7-a545-4486-9777-f762fafe0d4d",
        "name": "Approval"
      },
      "url": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/checks/configurations/14",
      "resource": {
        "type": "environment",
        "id": "1",
        "name": "SampleEnv"
      }
    },
    {
      "createdBy": {
        "displayName": "User Name",
        "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
        "uniqueName": "uniqueName",
        "descriptor": "Descriptor"
      },
      "createdOn": "2020-11-19T10:28:46.4136508Z",
      "modifiedBy": {
        "displayName": "User Name",
        "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
        "uniqueName": "uniqueName",
        "descriptor": "Descriptor"
      },
      "modifiedOn": "2020-11-19T10:28:46.4136508Z",
      "timeout": 43200,
      "_links": {
        "self": {
          "href": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/checks/configurations/16"
        }
      },
      "id": 16,
      "type": {
        "id": "fe1de3ee-a436-41b4-bb20-f6eb4cb879a7",
        "name": "Task Check"
      },
      "url": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/checks/configurations/16",
      "resource": {
        "type": "environment",
        "id": "1",
        "name": "SampleEnv"
      }
    }
  ]
}

定義

名前 説明
CheckConfiguration
CheckConfigurationExpandParameter

チェック構成の一覧で展開する必要があるプロパティ。
CheckIssue

チェック構成に関連付けられている問題 (エラー、警告)。
CheckIssueType

問題の種類 (エラー、警告)。
CheckType
IdentityRef
ReferenceLinks

REST 参照リンクのコレクションを表す クラス。
Resource

CheckConfiguration

名前 型 説明
_links

ReferenceLinks

参照リンク。
createdBy

IdentityRef

チェックを構成したユーザーの ID。
createdOn

string

チェックが構成された時刻。
id

integer

構成 ID を確認します。
isDisabled

boolean

無効チェック。
issue

CheckIssue

チェック構成に接続されている問題。
modifiedBy

IdentityRef

構成されたチェックを変更したユーザーの ID。
modifiedOn

string

構成されたチェックが変更された時刻。
resource

Resource

チェック構成されるリソース。
timeout

integer

チェックのタイムアウト (分単位)。
type

CheckType

構成の種類を確認する
url

string

構成されたチェックをフェッチできる URL。

CheckConfigurationExpandParameter

チェック構成の一覧で展開する必要があるプロパティ。

名前 型 説明
none

string

settings

string

CheckIssue

チェック構成に関連付けられている問題 (エラー、警告)。

名前 型 説明
description

string

チェックの簡単な概要 - その名前とリソース。
detailedMessage

string

問題の詳細な説明。
message

string

問題の説明。
type

CheckIssueType

問題の種類 (エラー、警告)。

CheckIssueType

問題の種類 (エラー、警告)。

名前 型 説明
error

string

warning

string

CheckType

名前 型 説明
id

string

型 ID チェック取得または設定します。
name

string

チェック型の名前。

IdentityRef

名前 型 説明
_links

ReferenceLinks

このフィールドには、グラフの件名に関する 0 個以上の興味深いリンクが含まれています。 これらのリンクを呼び出して、このグラフの主題に関する追加のリレーションシップや詳細情報を取得できます。
descriptor

string

記述子は、システムの実行中にグラフの件名を参照する主な方法です。 このフィールドは、アカウントと組織の両方で同じグラフの件名を一意に識別します。
directoryAlias

string

非推奨 - IdentityRef "_links" ディクショナリの "self" エントリで参照されている 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 は、このグラフの件名のソース リソースへの完全なルートです。

REST 参照リンクのコレクションを表す クラス。

名前 型 説明
links

object

リンクの読み取り時ビュー。 参照リンクは読み取り専用であるため、参照リンクは読み取り専用として公開する必要があります。

Resource

名前 型 説明
id

string

リソースの ID。
name

string

リソースの名前。
type

string

リソースの種類。