Configurations - Update

Référence

Service:: Policy

API Version:: 7.1-preview.1

Mettez à jour une configuration de stratégie en fonction de son ID.

PUT https://dev.azure.com/{organization}/{project}/_apis/policy/configurations/{configurationId}?api-version=7.1-preview.1

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
configurationId	path	True	integer int32	ID de la configuration de stratégie existante à mettre à jour.
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.

Corps de la demande

Nom	Type	Description
_links	ReferenceLinks	Liens vers d’autres objets liés à cet objet.
createdBy	IdentityRef	Référence à l’identité qui a créé la stratégie.
createdDate	string	Date et heure de création de la stratégie.
id	integer	ID de configuration de stratégie.
isBlocking	boolean	Indique si la stratégie est bloquante.
isDeleted	boolean	Indique si la stratégie a été supprimée (de manière réversible).
isEnabled	boolean	Indique si la stratégie est activée.
isEnterpriseManaged	boolean	Si elle est définie, cette stratégie nécessite l’autorisation « Gérer les stratégies d’entreprise » pour créer, modifier ou supprimer.
revision	integer	ID de révision de la configuration de la stratégie.
settings	JObject	Paramètres de configuration de stratégie.
type	PolicyTypeRef	Type de configuration de stratégie.
url	string	URL où la configuration de la stratégie peut être récupérée.

Réponses

Nom	Type	Description
200 OK	PolicyConfiguration	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.code_write	Permet de lire, de mettre à jour et de supprimer le code source, d’accéder aux métadonnées relatives aux commits, aux ensembles de modifications, aux branches et à d’autres artefacts de contrôle de version. Permet également de créer et de gérer des demandes de tirage et des révisions de code, et de recevoir des notifications sur les événements de contrôle de version via des hooks de service.

Nom

Description

vso.code_write

Permet de lire, de mettre à jour et de supprimer le code source, d’accéder aux métadonnées relatives aux commits, aux ensembles de modifications, aux branches et à d’autres artefacts de contrôle de version. Permet également de créer et de gérer des demandes de tirage et des révisions de code, et de recevoir des notifications sur les événements de contrôle de version via des hooks de service.

Exemples

Sample Request

HTTP

PUT https://dev.azure.com/fabrikam/fabrikam-fiber-git/_apis/policy/configurations/17?api-version=7.1-preview.1

{
  "isEnabled": true,
  "isBlocking": true,
  "type": {
    "id": "fd2167ab-b0be-447a-8ec8-39368250530e"
  },
  "settings": {
    "requiredReviewerIds": [
      "1d1dad71-f27c-4370-810d-838ec41efd41",
      "13272ea3-92ef-46d1-b77e-608ebbf3428b"
    ],
    "filenamePatterns": [
      "*/API*.cs",
      "sql/tables/*"
    ],
    "addedFilesOnly": false,
    "scope": [
      {
        "repositoryId": null,
        "refName": "refs/heads/master",
        "matchKind": "exact"
      },
      {
        "repositoryId": null,
        "refName": "refs/heads/releases/",
        "matchKind": "prefix"
      },
      {
        "repositoryId": "49c1d4d0-be28-4f20-9e0a-4ecfafc39257",
        "refName": "refs/heads/adventureworks",
        "matchKind": "exact"
      }
    ]
  }
}

Sample Response

Status code:: 200

{
  "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"
  }
}

Définitions

Nom	Description
IdentityRef
JObject	Représente un objet JSON.
PolicyConfiguration	Configuration complète de la stratégie avec les paramètres.
PolicyTypeRef	Référence du type de stratégie.
ReferenceLinks	Classe pour représenter une collection de liens de référence REST.

IdentityRef

Nom	Type	Description
_links	ReferenceLinks	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.

JObject

Représente un objet JSON.

Nom	Type	Description
item	string
type	string	Obtient le type de nœud pour ce JToken.

PolicyConfiguration

Configuration complète de la stratégie avec les paramètres.

Nom	Type	Description
_links	ReferenceLinks	Liens vers d’autres objets liés à cet objet.
createdBy	IdentityRef	Référence à l’identité qui a créé la stratégie.
createdDate	string	Date et heure de création de la stratégie.
id	integer	ID de configuration de stratégie.
isBlocking	boolean	Indique si la stratégie est bloquante.
isDeleted	boolean	Indique si la stratégie a été supprimée (de manière réversible).
isEnabled	boolean	Indique si la stratégie est activée.
isEnterpriseManaged	boolean	Si elle est définie, cette stratégie nécessite l’autorisation « Gérer les stratégies d’entreprise » pour créer, modifier ou supprimer.
revision	integer	ID de révision de la configuration de la stratégie.
settings	JObject	Paramètres de configuration de stratégie.
type	PolicyTypeRef	Type de configuration de stratégie.
url	string	URL où la configuration de la stratégie peut être récupérée.

PolicyTypeRef

Référence du type de stratégie.

Nom	Type	Description
displayName	string	Nom d’affichage du type de stratégie.
id	string	ID de type de stratégie.
url	string	URL où le type de stratégie peut être récupéré.

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.

Partager via