Policy - Create Or Update

Dienst:

API Management

API-Version:

2024-05-01

Erstellt oder aktualisiert die globale Richtlinienkonfiguration des API-Verwaltungsdiensts.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policies/policy?api-version=2024-05-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
policyId	path	True	PolicyIdName	Der Bezeichner der Richtlinie.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Der Name des API-Verwaltungsdiensts.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
If-Match		string	ETag der Entität. Beim Erstellen einer Entität nicht erforderlich, aber beim Aktualisieren einer Entität erforderlich.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
properties.value	True	string	Inhalt der Richtlinie gemäß definition des Formats.
properties.format		PolicyContentFormat	Format der policyContent.

Antworten

Name	Typ	Beschreibung
200 OK	PolicyContract	Die globale Richtlinienkonfiguration des API-Verwaltungsdiensts wurde erfolgreich aktualisiert. Header ETag: string
201 Created	PolicyContract	Die globale Richtlinienkonfiguration wurde erfolgreich erstellt. Header ETag: string
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

ApiManagementCreatePolicy

Beispielanforderung

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policies/policy?api-version=2024-05-01

{
  "properties": {
    "format": "xml",
    "value": "<policies>\r\n  <inbound />\r\n  <backend>\r\n    <forward-request />\r\n  </backend>\r\n  <outbound />\r\n</policies>"
  }
}

Beispiel für eine Antwort

Statuscode:

201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policies/policy",
  "type": "Microsoft.ApiManagement/service/policies",
  "name": "policy",
  "properties": {
    "value": "<policies>\r\n  <inbound />\r\n  <backend>\r\n    <forward-request />\r\n  </backend>\r\n  <outbound />\r\n</policies>"
  }
}

Statuscode:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policies/policy",
  "type": "Microsoft.ApiManagement/service/policies",
  "name": "policy",
  "properties": {
    "value": "<policies>\r\n  <inbound />\r\n  <backend>\r\n    <forward-request />\r\n  </backend>\r\n  <outbound />\r\n</policies>"
  }
}

Definitionen

Name	Beschreibung
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
PolicyContentFormat	Format der policyContent.
PolicyContract	Details des Richtlinienvertrags.
PolicyIdName	Der Bezeichner der Richtlinie.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

PolicyContentFormat

Enumeration

Format der policyContent.

Wert	Beschreibung
rawxml	Der Inhalt ist inline und der Inhaltstyp ist ein nicht XML-codiertes Richtliniendokument.
rawxml-link	Das Richtliniendokument ist nicht XML-codiert und wird auf einem HTTP-Endpunkt gehostet, auf den über den API-Verwaltungsdienst zugegriffen werden kann.
xml	Der Inhalt ist inline und der Inhaltstyp ist ein XML-Dokument.
xml-link	Das XML-Dokument der Richtlinie wird auf einem HTTP-Endpunkt gehostet, auf den über den API-Verwaltungsdienst zugegriffen werden kann.

PolicyContract

Objekt

Details des Richtlinienvertrags.

Name	Typ	Standardwert	Beschreibung
id	string		Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string		Der Name der Ressource
properties.format	PolicyContentFormat	xml	Format der policyContent.
properties.value	string		Inhalt der Richtlinie gemäß definition des Formats.
type	string		Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

PolicyIdName

Enumeration

Der Bezeichner der Richtlinie.

Wert	Beschreibung
policy