Configurations - Get
Ottenere una configurazione dei criteri in base al relativo ID.
GET https://dev.azure.com/{organization}/{project}/_apis/policy/configurations/{configurationId}?api-version=7.1
Parametri dell'URI
| Nome | In | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
configuration
|
path | True |
integer (int32) |
ID della configurazione dei criteri |
|
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. Deve essere impostato su '7.1' per usare questa versione dell'API. |
Risposte
| Nome | Tipo | Descrizione |
|---|---|---|
| 200 OK |
operazione riuscita |
Sicurezza
oauth2
Tipo:
oauth2
Flow:
accessCode
URL di autorizzazione:
https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL token:
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
Ambiti
| Nome | Descrizione |
|---|---|
| vso.code | Concede la possibilità di leggere il codice sorgente e i metadati relativi a commit, insiemi di modifiche, rami e altri artefatti del controllo della versione. Concede inoltre la possibilità di cercare il codice e ricevere notifiche sugli eventi di controllo della versione tramite hook del servizio. |
Esempio
Esempio di richiesta
GET https://dev.azure.com/fabrikam/fabrikam-fiber-git/_apis/policy/configurations/17?api-version=7.1
Risposta di esempio
{
"createdBy": {
"id": "d6245f20-2af8-44f4-9451-8107cb2767db",
"displayName": "Normal Paulk",
"uniqueName": "fabrikamfiber16@hotmail.com",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d6245f20-2af8-44f4-9451-8107cb2767db",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d6245f20-2af8-44f4-9451-8107cb2767db"
},
"createdDate": "2015-02-23T12:51:06.85754Z",
"isEnabled": true,
"isBlocking": true,
"isDeleted": false,
"settings": {
"requiredReviewerIds": [
"1d1dad71-f27c-4370-810d-838ec41efd41",
"13272ea3-92ef-46d1-b77e-608ebbf3428b"
],
"filenamePatterns": [
"*/API*.cs",
"sql/tables/*"
],
"addedFilesOnly": false,
"message": null,
"scope": [
{
"refName": "refs/heads/master",
"matchKind": "Exact",
"repositoryId": null
},
{
"refName": "refs/heads/releases/",
"matchKind": "Prefix",
"repositoryId": null
},
{
"refName": "refs/heads/adventureworks",
"matchKind": "Exact",
"repositoryId": "49c1d4d0-be28-4f20-9e0a-4ecfafc39257"
}
]
},
"_links": {
"self": {
"href": "https://dev.azure.com/fabrikam/_apis/policy/configurations/17"
},
"type": {
"href": "https://dev.azure.com/fabrikam/1be3fc5b-c58c-4173-8fd7-6647d11eccd1/_apis/policy/types/fd2167ab-b0be-447a-8ec8-39368250530e"
}
},
"revision": 2,
"id": 17,
"url": "https://dev.azure.com/fabrikam/_apis/policy/configurations/17",
"type": {
"id": "fd2167ab-b0be-447a-8ec8-39368250530e",
"url": "https://dev.azure.com/fabrikam/1be3fc5b-c58c-4173-8fd7-6647d11eccd1/_apis/policy/types/fd2167ab-b0be-447a-8ec8-39368250530e",
"displayName": "Required reviewers"
}
}
Definizioni
| Nome | Descrizione |
|---|---|
|
Identity |
|
| JObject |
Rappresenta un oggetto JSON. |
|
Policy |
Configurazione completa dei criteri con le impostazioni. |
|
Policy |
Informazioni di riferimento sul tipo di criteri. |
|
Reference |
Classe per rappresentare una raccolta di collegamenti di riferimento REST. |
IdentityRef
| Nome | Tipo | Descrizione |
|---|---|---|
| _links |
Questo campo contiene zero o più collegamenti interessanti sull'oggetto grafico. Questi collegamenti possono essere richiamati per ottenere relazioni aggiuntive o informazioni più dettagliate sull'oggetto grafico. |
|
| descriptor |
string |
Il descrittore è il modo principale per fare riferimento all'oggetto del grafo mentre il sistema è in esecuzione. Questo campo identificherà in modo univoco lo stesso soggetto del grafico in account e organizzazioni. |
| directoryAlias |
string |
Deprecato: può essere recuperato eseguendo una 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 del grafico. Per modificare questo campo, è necessario modificarne il valore 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 si fa riferimento nella voce "membershipState" del dizionario "_links" GraphUser |
| isAadIdentity |
boolean |
Deprecato: può essere dedotto dal tipo di soggetto del descrittore (Descriptor.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. |
JObject
Rappresenta un oggetto JSON.
| Nome | Tipo | Descrizione |
|---|---|---|
| item |
string (JToken) |
|
| type |
string (JTokenType) |
Ottiene il tipo di nodo per questo JToken. |
PolicyConfiguration
Configurazione completa dei criteri con le impostazioni.
| Nome | Tipo | Descrizione |
|---|---|---|
| _links |
Collegamenti ad altri oggetti correlati a questo oggetto. |
|
| createdBy |
Riferimento all'identità che ha creato i criteri. |
|
| createdDate |
string (date-time) |
Data e ora di creazione del criterio. |
| id |
integer (int32) |
ID di configurazione dei criteri. |
| isBlocking |
boolean |
Indica se il criterio è bloccato. |
| isDeleted |
boolean |
Indica se il criterio è stato eliminato (leggero). |
| isEnabled |
boolean |
Indica se il criterio è abilitato. |
| isEnterpriseManaged |
boolean |
Se impostato, questo criterio richiede l'autorizzazione "Gestisci criteri aziendali" per creare, modificare o eliminare. |
| revision |
integer (int32) |
ID revisione della configurazione dei criteri. |
| settings |
Impostazioni di configurazione dei criteri. |
|
| type |
Tipo di configurazione dei criteri. |
|
| url |
string |
URL in cui è possibile recuperare la configurazione dei criteri. |
PolicyTypeRef
Informazioni di riferimento sul tipo di criteri.
| Nome | Tipo | Descrizione |
|---|---|---|
| displayName |
string |
Nome visualizzato del tipo di criterio. |
| id |
string (uuid) |
ID del tipo di criterio. |
| url |
string |
URL in cui è possibile recuperare il tipo di criteri. |
ReferenceLinks
Classe per rappresentare una raccolta di collegamenti di riferimento REST.
| Nome | Tipo | Descrizione |
|---|---|---|
| links |
object |
Visualizzazione di sola lettura dei collegamenti. Poiché i collegamenti di riferimento sono di sola lettura, è consigliabile esporli solo come di sola lettura. |