Check Configurations - Query
Obtenez case activée configurations pour plusieurs ressources par type et ID de ressource.
POST https://dev.azure.com/{organization}/{project}/_apis/pipelines/checks/queryconfigurations?api-version=7.1-preview.1
POST https://dev.azure.com/{organization}/{project}/_apis/pipelines/checks/queryconfigurations?$expand={$expand}&api-version=7.1-preview.1
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 |
api-version
|
query | True |
string |
Version de l’API à utiliser. Cette valeur doit être définie sur « 7.1-preview.1 » pour utiliser cette version de l’API. |
$expand
|
query |
Propriétés qui doivent être développées dans la liste des configurations case activée. |
Corps de la demande
Nom | Type | Description |
---|---|---|
body |
Resource[] |
Liste des ressources. |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
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.build | Accorde la possibilité d’accéder aux artefacts de build, y compris les résultats de build, les définitions et les demandes, et la possibilité de recevoir des notifications sur les événements de build via des hooks de service. |
Exemples
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
request-Context: appId=cid-v1:a892bfef-0287-4640-9f5e-cffc90fbcf94
access-Control-Expose-Headers: Request-Context
{
"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"
}
}
]
}
Définitions
Nom | Description |
---|---|
Check |
|
Check |
Propriétés qui doivent être développées dans la liste des configurations case activée. |
Check |
Problème (erreur, avertissement) associé à une configuration case activée. |
Check |
Type (erreur, avertissement) du problème. |
Check |
|
Identity |
|
Reference |
Classe pour représenter une collection de liens de référence REST. |
Resource |
CheckConfiguration
Nom | Type | Description |
---|---|---|
_links |
Liens de référence. |
|
createdBy |
Identité de la personne qui a configuré case activée. |
|
createdOn |
string |
Heure à laquelle case activée a été configuré. |
id |
integer |
Vérifiez l’ID de configuration. |
isDisabled |
boolean |
Est case activée désactivé. |
issue |
Problème lié à case activée configuration. |
|
modifiedBy |
Identité de la personne qui a modifié le case activée configuré. |
|
modifiedOn |
string |
Heure à laquelle case activée configuré a été modifié. |
resource |
Ressource sur laquelle case activée être configurés. |
|
timeout |
integer |
Délai d’expiration en minutes pour le case activée. |
type |
Vérifier le type de configuration |
|
url |
string |
URL à partir de laquelle vous pouvez extraire le case activée configuré. |
CheckConfigurationExpandParameter
Propriétés qui doivent être développées dans la liste des configurations case activée.
Nom | Type | Description |
---|---|---|
none |
string |
|
settings |
string |
CheckIssue
Problème (erreur, avertissement) associé à une configuration case activée.
Nom | Type | Description |
---|---|---|
description |
string |
Bref résumé du case activée : son nom et sa ressource. |
detailedMessage |
string |
Description plus détaillée du problème. |
message |
string |
Description du problème. |
type |
Type (erreur, avertissement) du problème. |
CheckIssueType
Type (erreur, avertissement) du problème.
Nom | Type | Description |
---|---|---|
error |
string |
|
warning |
string |
CheckType
Nom | Type | Description |
---|---|---|
id |
string |
Obtient ou définit case activée’ID de type. |
name |
string |
Nom du type case activée. |
IdentityRef
Nom | Type | Description |
---|---|---|
_links |
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. |
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. |
Resource
Nom | Type | Description |
---|---|---|
id |
string |
ID de la ressource. |
name |
string |
Nom de la ressource. |
type |
string |
Type de la ressource. |