Udostępnij za pośrednictwem

Api Operation Policy - Create Or Update

  • Odwołanie
Usługa:
API Management
Wersja interfejsu API:
2024-05-01

Tworzy lub aktualizuje konfigurację zasad dla poziomu operacji interfejsu API.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
apiId
 path True

string

minLength: 1
maxLength: 256
pattern: ^[^*#&+:<>?]+$

Identyfikator poprawki interfejsu API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management. Nieobsługiwana poprawka ma wartość ; rev=n jako sufiks, gdzie n jest numerem poprawki.
operationId
 path True

string

minLength: 1
maxLength: 80

Identyfikator operacji w interfejsie API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
policyId
 path True

PolicyIdName

Identyfikator zasad.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
serviceName
 path True

string

minLength: 1
maxLength: 50
pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

Nazwa usługi API Management.
subscriptionId
 path True

string (uuid)

Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.
api-version
 query True

string

minLength: 1

Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Nazwa Wymagane Typ Opis
If-Match

string

Element ETag jednostki. Nie jest to wymagane podczas tworzenia jednostki, ale wymagane podczas aktualizowania jednostki.

Treść żądania

Nazwa Wymagane Typ Opis
properties.value True

string

Zawartość zasad zgodnie z formatem.
properties.format

PolicyContentFormat

Format zasadContent.

Odpowiedzi

Nazwa Typ Opis
200 OK

PolicyContract

Konfiguracja zasad operacji interfejsu API dzierżawy została pomyślnie zaktualizowana.

Nagłówki

ETag: string
201 Created

PolicyContract

Konfiguracja zasad operacji interfejsu API została pomyślnie utworzona.

Nagłówki

ETag: string
Other Status Codes

ErrorResponse

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

ApiManagementCreateApiOperationPolicy

Przykładowe żądanie

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


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

Przykładowa odpowiedź

Kod stanu:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b57e7e8880006a040001/operations/5600b57e7e8880006a080001/policies/policy",
  "type": "Microsoft.ApiManagement/service/apis/operations/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>"
  }
}
Kod stanu:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b57e7e8880006a040001/operations/5600b57e7e8880006a080001/policies/policy",
  "type": "Microsoft.ApiManagement/service/apis/operations/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>"
  }
}

Definicje

Nazwa Opis
ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail

Szczegóły błędu.
ErrorResponse

Odpowiedź na błąd
PolicyContentFormat

Format zasadContent.
PolicyContract

Szczegóły kontraktu zasad.
PolicyIdName

Identyfikator zasad.

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa Typ Opis
info

object

Dodatkowe informacje.
type

string

Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa Typ Opis
additionalInfo

ErrorAdditionalInfo[]

Dodatkowe informacje o błędzie.
code

string

Kod błędu.
details

ErrorDetail[]

Szczegóły błędu.
message

string

Komunikat o błędzie.
target

string

Element docelowy błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa Typ Opis
error

ErrorDetail

Obiekt błędu.

PolicyContentFormat

Wyliczanie

Format zasadContent.

Wartość Opis
rawxml

Zawartość jest śródliniowa, a typ zawartości jest dokumentem zasad niekodowanych w formacie XML.
rawxml-link

Dokument zasad nie jest zakodowany w formacie XML i jest hostowany w punkcie końcowym HTTP dostępnym z usługi API Management.
xml

Zawartość jest wbudowana, a typ zawartości jest dokumentem XML.
xml-link

Dokument XML zasad jest hostowany w punkcie końcowym HTTP dostępnym z poziomu usługi API Management.

PolicyContract

Objekt

Szczegóły kontraktu zasad.

Nazwa Typ Domyślna wartość Opis
id

string

W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

Nazwa zasobu
properties.format

PolicyContentFormat

xml

Format zasadContent.
properties.value

string

Zawartość zasad zgodnie z formatem.
type

string

Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

PolicyIdName

Wyliczanie

Identyfikator zasad.

Wartość Opis
policy