Policy Restriction - Update

Service:: API Management

API-versie:: 2024-05-01

Hiermee werkt u de beleidsbeperkingsconfiguratie van de Api Management-service bij.

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

URI-parameters

Name	In	Vereist	Type	Description
policyRestrictionId	path	True	string minLength: 1 maxLength: 80	Beleidsbeperkingen na een entiteitsniveau
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	De naam van de API Management-service.
subscriptionId	path	True	string (uuid)	De id van het doelabonnement. De waarde moet een UUID zijn.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagkoptekst

Name	Vereist	Type	Description
If-Match	True	string	ETag van de entiteit. ETag moet overeenkomen met de huidige entiteitsstatus van het headerantwoord van de GET-aanvraag of moet * zijn voor een onvoorwaardelijke update.

Aanvraagbody

Name	Type	Description
properties.requireBase	PolicyRestrictionRequireBase	Geeft aan of basisbeleid moet worden afgedwongen voor het beleidsdocument.
properties.scope	string	Pad naar het beleidsdocument.

Antwoorden

Name	Type	Description
200 OK	PolicyRestrictionContract	De configuratie van beleidsbeperking van de Api Management-service is bijgewerkt. Kopteksten ETag: string
Other Status Codes	ErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Name

Type

Description

200 OK

PolicyRestrictionContract

De configuratie van beleidsbeperking van de Api Management-service is bijgewerkt.

Kopteksten

ETag: string

Other Status Codes

ErrorResponse

Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

OAuth2-stroom voor Azure Active Directory.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

ApiManagementUpdatePolicyRestriction

Voorbeeldaanvraag

HTTP

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


{
  "properties": {
    "scope": "Sample Path 2 to the policy document."
  }
}

Voorbeeldrespons

Statuscode:: 200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyRestrictions/policyRestriction1",
  "type": "Microsoft.ApiManagement/service/policyRestrictions",
  "name": "policyRestriction1",
  "properties": {
    "scope": "Sample Path 2 to the policy document.",
    "requireBase": "true"
  }
}

Definities

Name	Description
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
PolicyRestrictionContract	Contractgegevens voor beleidsbeperking.
PolicyRestrictionRequireBase	Geeft aan of basisbeleid moet worden afgedwongen voor het beleidsdocument.
PolicyRestrictionUpdateContract	Contractgegevens voor beleidsbeperking.

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

PolicyRestrictionContract

Object

Contractgegevens voor beleidsbeperking.

Name	Type	Default value	Description
id	string		Volledig gekwalificeerde resource-id voor de resource. Vb.: - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string		De naam van de resource
properties.requireBase	PolicyRestrictionRequireBase	false	Geeft aan of basisbeleid moet worden afgedwongen voor het beleidsdocument.
properties.scope	string		Pad naar het beleidsdocument.
type	string		Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

PolicyRestrictionRequireBase

Inventarisatie

Geeft aan of basisbeleid moet worden afgedwongen voor het beleidsdocument.

Waarde	Description
true	Het beleid is vereist om basisbeleid te hebben
false	Het beleid hoeft geen basisbeleid te hebben

PolicyRestrictionUpdateContract

Object

Contractgegevens voor beleidsbeperking.

Name	Type	Default value	Description
properties.requireBase	PolicyRestrictionRequireBase	false	Geeft aan of basisbeleid moet worden afgedwongen voor het beleidsdocument.
properties.scope	string		Pad naar het beleidsdocument.