Check Configurations - Add

Riferimento

Service:: Approvals And Checks

API Version:: 7.1-preview.1

Aggiungere una configurazione di controllo

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
organization	path	True	string	Nome dell'organizzazione di Azure DevOps.
project	path	True	string	ID progetto o nome progetto
api-version	query	True	string	Versione dell'API da usare. Questa opzione deve essere impostata su '7.1-preview.1' per usare questa versione dell'API.

Corpo della richiesta

Nome	Tipo	Descrizione
_links	ReferenceLinks	Collegamenti di riferimento.
createdBy	IdentityRef	Identità della persona che ha configurato il controllo.
createdOn	string	Ora in cui è stato configurato il controllo.
id	integer	Controllare l'ID di configurazione.
isDisabled	boolean	È disabilitato.
issue	CheckIssue	Problema connesso a controllare la configurazione.
modifiedBy	IdentityRef	Identità della persona che ha modificato il controllo configurato.
modifiedOn	string	Ora in cui è stato modificato il controllo configurato.
resource	Resource	Risorsa in cui controllare la configurazione.
timeout	integer	Timeout in minuti per il controllo.
type	CheckType	Controllare il tipo di configurazione
url	string	URL da cui è possibile recuperare il controllo configurato.

Risposte

Nome	Tipo	Descrizione
200 OK	CheckConfiguration	operazione riuscita

Sicurezza

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

Nome	Descrizione
vso.build_execute	Concede la possibilità di accedere agli artefatti di compilazione, inclusi i risultati della compilazione, le definizioni e le richieste e la possibilità di accodare una compilazione, aggiornare le proprietà di compilazione e la possibilità di ricevere notifiche sugli eventi di compilazione tramite hook del servizio.
vso.pipelineresources_manage	Concede la possibilità di gestire una risorsa protetta o una richiesta di una pipeline di usare una risorsa protetta: pool di agenti, pool di agenti, coda, repository, file protetti, connessione al servizio e gruppo di variabili

Esempio

Approval

Task Check

Approval

Sample Request

HTTP

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

{
  "settings": {
    "approvers": [
      {
        "displayName": null,
        "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1"
      }
    ],
    "executionOrder": "anyOrder",
    "minRequiredApprovers": 0,
    "instructions": "Instructions",
    "blockedApprovers": []
  },
  "timeout": 43200,
  "type": {
    "id": "8c6f20a7-a545-4486-9777-f762fafe0d4d",
    "name": "Approval"
  },
  "resource": {
    "type": "queue",
    "id": "1",
    "name": "Default"
  }
}

Sample Response

Status code:: 200

request-Context: appId=cid-v1:a892bfef-0287-4640-9f5e-cffc90fbcf94
access-Control-Expose-Headers: Request-Context

Response Body

{
  "settings": {
    "approvers": [
      {
        "displayName": null,
        "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1"
      }
    ],
    "executionOrder": "anyOrder",
    "minRequiredApprovers": 0,
    "instructions": "Instructions",
    "blockedApprovers": []
  },
  "createdBy": {
    "displayName": "User Name",
    "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
    "uniqueName": "uniqueName",
    "descriptor": "Descriptor"
  },
  "createdOn": "2020-11-19T10:50:46.0110496Z",
  "modifiedBy": {
    "displayName": "User Name",
    "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
    "uniqueName": "uniqueName",
    "descriptor": "Descriptor"
  },
  "modifiedOn": "2020-11-19T10:50:46.0110496Z",
  "timeout": 43200,
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/checks/configurations/19"
    }
  },
  "id": 19,
  "type": {
    "id": "8c6f20a7-a545-4486-9777-f762fafe0d4d",
    "name": "Approval"
  },
  "url": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/checks/configurations/19",
  "resource": {
    "type": "queue",
    "id": "1",
    "name": "Default"
  }
}

Task Check

Sample Request

HTTP

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

{
  "settings": {
    "displayName": "Business Hours",
    "definitionRef": {
      "id": "445fde2f-6c39-441c-807f-8a59ff2e075f",
      "name": "evaluateBusinessHours",
      "version": "0.0.1"
    },
    "inputs": {
      "businessDays": "Monday,Tuesday,Wednesday,Thursday,Friday",
      "timeZone": "UTC",
      "startTime": "04:00",
      "endTime": "11:00"
    },
    "retryInterval": 5
  },
  "timeout": 43200,
  "type": {
    "id": "fe1de3ee-a436-41b4-bb20-f6eb4cb879a7",
    "name": "Task Check"
  },
  "resource": {
    "type": "queue",
    "id": "1",
    "name": "Default"
  }
}

Sample Response

Status code:: 200

request-Context: appId=cid-v1:a892bfef-0287-4640-9f5e-cffc90fbcf94
access-Control-Expose-Headers: Request-Context

Response Body

{
  "settings": {
    "displayName": "Business Hours",
    "definitionRef": {
      "id": "445fde2f-6c39-441c-807f-8a59ff2e075f",
      "name": "evaluateBusinessHours",
      "version": "0.0.1"
    },
    "inputs": {
      "businessDays": "Monday,Tuesday,Wednesday,Thursday,Friday",
      "timeZone": "UTC",
      "startTime": "04:00",
      "endTime": "11:00"
    },
    "retryInterval": 5
  },
  "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:21:11.312742Z",
  "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"
  }
}

Definizioni

Nome	Descrizione
CheckConfiguration
CheckIssue	Problema (errore, avviso) associato a una configurazione di controllo.
CheckIssueType	Tipo (errore, avviso) del problema.
CheckType
IdentityRef
ReferenceLinks	Classe da rappresentare una raccolta di collegamenti di riferimento REST.
Resource

CheckConfiguration

Nome	Tipo	Descrizione
_links	ReferenceLinks	Collegamenti di riferimento.
createdBy	IdentityRef	Identità della persona che ha configurato il controllo.
createdOn	string	Ora in cui è stato configurato il controllo.
id	integer	Controllare l'ID di configurazione.
isDisabled	boolean	È disabilitato.
issue	CheckIssue	Problema connesso a controllare la configurazione.
modifiedBy	IdentityRef	Identità della persona che ha modificato il controllo configurato.
modifiedOn	string	Ora in cui è stato modificato il controllo configurato.
resource	Resource	Risorsa in cui controllare la configurazione.
timeout	integer	Timeout in minuti per il controllo.
type	CheckType	Controllare il tipo di configurazione
url	string	URL da cui è possibile recuperare il controllo configurato.

CheckIssue

Problema (errore, avviso) associato a una configurazione di controllo.

Nome	Tipo	Descrizione
description	string	Breve riepilogo del controllo : nome e risorsa.
detailedMessage	string	Descrizione più dettagliata del problema.
message	string	Descrizione del problema.
type	CheckIssueType	Tipo (errore, avviso) del problema.

CheckIssueType

Tipo (errore, avviso) del problema.

Nome	Tipo	Descrizione
error	string
warning	string

CheckType

Nome	Tipo	Descrizione
id	string	Ottiene o imposta l'ID del tipo di controllo.
name	string	Nome del tipo di controllo.

IdentityRef

Nome	Tipo	Descrizione
_links	ReferenceLinks	Questo campo contiene zero o più collegamenti interessanti sull'oggetto grafico. Questi collegamenti possono essere richiamati per ottenere relazioni aggiuntive o informazioni più dettagliate su questo argomento grafico.
descriptor	string	Il descrittore è il modo principale per fare riferimento all'oggetto del grafico durante l'esecuzione del sistema. Questo campo identificherà in modo univoco lo stesso soggetto grafo in account e organizzazioni.
directoryAlias	string	Deprecato: può essere recuperato eseguendo query sull'utente Graph a cui si fa riferimento nella voce "self" del dizionario IdentityRef "_links"
displayName	string	Si tratta del nome visualizzato non univoco dell'oggetto grafico. Per modificare questo campo, è necessario modificarlo nel provider di origine.
id	string
imageUrl	string	Deprecato - Disponibile nella voce "avatar" del dizionario IdentityRef "_links"
inactive	boolean	Deprecato: può essere recuperato eseguendo una query sullo stato di appartenenza Graph a cui fa riferimento nella voce "membershipState" del dizionario GraphUser "_links"
isAadIdentity	boolean	Deprecato: può essere dedotto dal tipo di soggetto del descrittore (Descrittore.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Deprecato: può essere dedotto dal tipo di soggetto del descrittore (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Deprecato : non in uso nella maggior parte delle implementazioni preesistenti di ToIdentityRef
uniqueName	string	Deprecato: usare invece Domain+PrincipalName
url	string	Questo URL è la route completa alla risorsa di origine di questo oggetto grafico.

ReferenceLinks

Classe da rappresentare una raccolta di collegamenti di riferimento REST.

Nome	Tipo	Descrizione
links	object	Visualizzazione di lettura dei collegamenti. Poiché i collegamenti di riferimento sono in sola lettura, si vuole esporre solo i collegamenti di riferimento come sola lettura.

Resource

Nome	Tipo	Descrizione
id	string	ID della risorsa.
name	string	Nome della risorsa.
type	string	Tipo di risorsa.

Condividi tramite

Check Configurations - Add

Parametri dell'URI

Corpo della richiesta

Risposte

Sicurezza

oauth2

Scopes

Esempio

Approval

Sample Request

Sample Response

Task Check

Sample Request

Sample Response

Definizioni

CheckConfiguration

CheckIssue

CheckIssueType

CheckType

IdentityRef

ReferenceLinks

Resource

Risorse aggiuntive