Configurations - Update

Referenz

Dienst:: Policy

API-Version:: 7.1

Aktualisieren Sie eine Richtlinienkonfiguration anhand ihrer ID.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
configurationId	path	True	integer (int32)	ID der vorhandenen Richtlinienkonfiguration, die aktualisiert werden soll.
organization	path	True	string	Der Name der Azure DevOps-Organisation.
project	path	True	string	Projekt-ID oder Projektname
api-version	query	True	string	Version der zu verwendenden API. Dies sollte auf "7.1" festgelegt werden, um diese Version der API zu verwenden.

Anforderungstext

Name	Typ	Beschreibung
_links	ReferenceLinks	Die Verknüpfungen zu anderen Objekten im Zusammenhang mit diesem Objekt.
createdBy	IdentityRef	Ein Verweis auf die Identität, die die Richtlinie erstellt hat.
createdDate	string (date-time)	Das Datum und die Uhrzeit der Erstellung der Richtlinie.
id	integer (int32)	Die Richtlinienkonfigurations-ID.
isBlocking	boolean	Gibt an, ob die Richtlinie blockiert wird.
isDeleted	boolean	Gibt an, ob die Richtlinie (vorläufig) gelöscht wurde.
isEnabled	boolean	Gibt an, ob die Richtlinie aktiviert ist.
isEnterpriseManaged	boolean	Wenn diese Richtlinie festgelegt ist, ist die Berechtigung "Unternehmensrichtlinien verwalten" zum Erstellen, Bearbeiten oder Löschen erforderlich.
revision	integer (int32)	Die Richtlinienkonfigurations-Revisions-ID.
settings	JObject	Die Richtlinienkonfigurationseinstellungen.
type	PolicyTypeRef	Der Richtlinienkonfigurationstyp.
url	string	Die URL, unter der die Richtlinienkonfiguration abgerufen werden kann.

Antworten

Name	Typ	Beschreibung
200 OK	PolicyConfiguration	Erfolgreicher Vorgang

Sicherheit

oauth2

Typ: oauth2
Ablauf: accessCode
Autorisierungs-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

Bereiche

Name	Beschreibung
vso.code_write	Gewährt die Möglichkeit, Quellcode zu lesen, zu aktualisieren und zu löschen, auf Metadaten zu Commits, Änderungenets, Verzweigungen und anderen Versionssteuerungsartefakten zuzugreifen. Gewährt außerdem die Möglichkeit, Pullanforderungen und Codeüberprüfungen zu erstellen und zu verwalten und Benachrichtigungen über Versionssteuerungsereignisse über Dienst-Hooks zu erhalten.

Beispiele

Beispielanforderung

HTTP

PUT https://dev.azure.com/fabrikam/fabrikam-fiber-git/_apis/policy/configurations/17?api-version=7.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"
      }
    ]
  }
}

Beispiel für eine Antwort

Statuscode:: 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"
  }
}

Definitionen

Name	Beschreibung
IdentityRef
JObject	Stellt ein JSON-Objekt dar.
PolicyConfiguration	Die vollständige Richtlinienkonfiguration mit Einstellungen.
PolicyTypeRef	Richtlinientypreferenz.
ReferenceLinks	Die Klasse, die eine Auflistung von REST-Referenzverknüpfungslinks darstellt.

IdentityRef

Objekt

Name	Typ	Beschreibung
_links	ReferenceLinks	Dieses Feld enthält null oder interessantere Links zum Thema Diagramm. Diese Links können aufgerufen werden, um zusätzliche Beziehungen oder ausführlichere Informationen zu diesem Diagrammbetreff zu erhalten.
descriptor	string	Der Deskriptor ist die primäre Möglichkeit, auf den Diagrammbetreff zu verweisen, während das System ausgeführt wird. In diesem Feld wird dasselbe Diagrammthema sowohl in Firmen als auch in Organisationen eindeutig identifiziert.
directoryAlias	string	Veraltet – Kann abgerufen werden, indem der Graph-Benutzer abgefragt wird, auf den im "Self"-Eintrag des IdentityRef -Wörterbuchs "_links" verwiesen wird
displayName	string	Dies ist der nicht eindeutige Anzeigename des Diagrammbetreffs. Um dieses Feld zu ändern, müssen Sie den Wert im Quellanbieter ändern.
id	string
imageUrl	string	Veraltet – Verfügbar im "Avatar"-Eintrag des IdentityRef-Wörterbuchs "_links"
inactive	boolean	Veraltet – Kann abgerufen werden, indem der Graph-Mitgliedschaftsstatus abgefragt wird, auf den im Eintrag "membershipState" des GraphUser-Wörterbuchs "_links" verwiesen wird.
isAadIdentity	boolean	Veraltet – Kann vom Betrefftyp des Deskriptors abgeleitet werden (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Veraltet – Kann vom Betrefftyp des Deskriptors abgeleitet werden (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Veraltet – nicht in den meisten bereits vorhandenen Implementierungen von ToIdentityRef verwendet
uniqueName	string	Veraltet – Verwenden Sie stattdessen "Domain+PrincipalName".
url	string	Diese URL ist die vollständige Route zur Quellressource dieses Graph-Betreffs.

JObject

Objekt

Stellt ein JSON-Objekt dar.

Name	Typ	Beschreibung
item	string (JToken)
type	string (JTokenType)	Ruft den Knotentyp für dieses JToken ab.

PolicyConfiguration

Objekt

Die vollständige Richtlinienkonfiguration mit Einstellungen.

Name	Typ	Beschreibung
_links	ReferenceLinks	Die Verknüpfungen zu anderen Objekten im Zusammenhang mit diesem Objekt.
createdBy	IdentityRef	Ein Verweis auf die Identität, die die Richtlinie erstellt hat.
createdDate	string (date-time)	Das Datum und die Uhrzeit der Erstellung der Richtlinie.
id	integer (int32)	Die Richtlinienkonfigurations-ID.
isBlocking	boolean	Gibt an, ob die Richtlinie blockiert wird.
isDeleted	boolean	Gibt an, ob die Richtlinie (vorläufig) gelöscht wurde.
isEnabled	boolean	Gibt an, ob die Richtlinie aktiviert ist.
isEnterpriseManaged	boolean	Wenn diese Richtlinie festgelegt ist, ist die Berechtigung "Unternehmensrichtlinien verwalten" zum Erstellen, Bearbeiten oder Löschen erforderlich.
revision	integer (int32)	Die Richtlinienkonfigurations-Revisions-ID.
settings	JObject	Die Richtlinienkonfigurationseinstellungen.
type	PolicyTypeRef	Der Richtlinienkonfigurationstyp.
url	string	Die URL, unter der die Richtlinienkonfiguration abgerufen werden kann.

PolicyTypeRef

Objekt

Richtlinientypreferenz.

Name	Typ	Beschreibung
displayName	string	Anzeigename des Richtlinientyps.
id	string (uuid)	Die Richtlinientyp-ID.
url	string	Die URL, unter der der Richtlinientyp abgerufen werden kann.

ReferenceLinks

Objekt

Die Klasse, die eine Auflistung von REST-Referenzverknüpfungslinks darstellt.

Name	Typ	Beschreibung
links	object	Die schreibgeschützte Ansicht der Links. Da Referenzlinks schreibgeschützt sind, möchten wir sie nur als schreibgeschützt verfügbar machen.

Freigeben über

Configurations - Update

URI-Parameter

Anforderungstext

Antworten

Sicherheit

oauth2

Bereiche

Beispiele

Beispielanforderung

Beispiel für eine Antwort

Definitionen

IdentityRef

JObject

PolicyConfiguration

PolicyTypeRef

ReferenceLinks