Dela via


Policy Fragment - Create Or Update

Skapar eller uppdaterar ett principfragment.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policyFragments/{id}?api-version=2022-08-01

URI-parametrar

Name I Obligatorisk Typ Description
id
path True

string

En resursidentifierare.

Reguljärt uttrycksmönster: (^[\w]+$)|(^[\w][\w\-]+[\w]$)

resourceGroupName
path True

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName
path True

string

Namnet på API Management-tjänsten.

Reguljärt uttrycksmönster: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

ID för målprenumerationen.

api-version
query True

string

Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Name Obligatorisk Typ Description
If-Match

string

ETag för entiteten. Krävs inte när du skapar en entitet, men krävs vid uppdatering av en entitet.

Begärandetext

Name Obligatorisk Typ Description
properties.value True

string

Innehållet i principfragmentet.

properties.description

string

Beskrivning av principfragment.

properties.format

PolicyFragmentContentFormat

Format för innehållet i principfragmentet.

Svar

Name Typ Description
200 OK

PolicyFragmentContract

Principfragmentet har uppdaterats.

Sidhuvuden

ETag: string

201 Created

PolicyFragmentContract

Principfragmentet skapades.

Sidhuvuden

ETag: string

202 Accepted

Begäran om att skapa eller uppdatera principfragmentet godkändes. Platsrubriken innehåller url:en där statusen för den långvariga åtgärden kan kontrolleras.

Sidhuvuden

location: string

Other Status Codes

ErrorResponse

Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

ApiManagementCreatePolicy

Exempelbegäran

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyFragments/policyFragment1?api-version=2022-08-01

{
  "properties": {
    "format": "xml",
    "description": "A policy fragment example",
    "value": "<fragment><json-to-xml apply=\"always\" consider-accept-header=\"false\" /></fragment>"
  }
}

Exempelsvar

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyFragments/policyFragment1",
  "type": "Microsoft.ApiManagement/service/policyFragments",
  "name": "policyFragment1",
  "properties": {
    "format": "xml",
    "description": "A policy fragment example",
    "value": "<json-to-xml apply=\"always\" consider-accept-header=\"false\" />"
  }
}
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyFragments/policyFragment1",
  "type": "Microsoft.ApiManagement/service/policyFragments",
  "name": "policyFragment1",
  "properties": {
    "format": "xml",
    "description": "A policy fragment example",
    "value": "<json-to-xml apply=\"always\" consider-accept-header=\"false\" />"
  }
}
location: https://management.azure.com/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyFragments/policyFragment1?api-version=2022-08-01&asyncId=5c730e343244df1b9cb56e85&asyncCode=201

Definitioner

Name Description
ErrorFieldContract

Fel Fältkontrakt.

ErrorResponse

Felsvar.

PolicyFragmentContentFormat

Format för innehållet i principfragmentet.

PolicyFragmentContract

Avtalsinformation om principfragment.

ErrorFieldContract

Fel Fältkontrakt.

Name Typ Description
code

string

Felkod på egenskapsnivå.

message

string

Mänsklig läsbar representation av fel på egenskapsnivå.

target

string

Egenskapsnamn.

ErrorResponse

Felsvar.

Name Typ Description
error.code

string

Tjänstdefinierad felkod. Den här koden fungerar som en understatus för HTTP-felkoden som anges i svaret.

error.details

ErrorFieldContract[]

Listan över ogiltiga fält som skickas i begäran, om verifieringsfel uppstår.

error.message

string

Mänsklig läsbar representation av felet.

PolicyFragmentContentFormat

Format för innehållet i principfragmentet.

Name Typ Description
rawxml

string

Innehållet är infogat och Innehållstyp är ett icke XML-kodat principdokument.

xml

string

Innehållet är infogat och innehållstypen är ett XML-dokument.

PolicyFragmentContract

Avtalsinformation om principfragment.

Name Typ Standardvärde Description
id

string

Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Namnet på resursen

properties.description

string

Beskrivning av principfragment.

properties.format

PolicyFragmentContentFormat

xml

Format för innehållet i principfragmentet.

properties.value

string

Innehållet i principfragmentet.

type

string

Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"