Policy Restriction - Update

Szolgáltatás:

API Management

API-verzió:

2024-05-01

Frissíti az Api Management szolgáltatás szabályzatkorlátozási konfigurációját.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
policyRestrictionId	path	True	string minLength: 1 maxLength: 80	Szabályzatkorlátozások entitásszint után
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Az API Management szolgáltatás neve.
subscriptionId	path	True	string (uuid)	A cél-előfizetés azonosítója. Az értéknek UUID-nek kell lennie.
api-version	query	True	string minLength: 1	A művelethez használni kívánt API-verzió.

Kérelem fejléce

Name	Kötelező	Típus	Description
If-Match	True	string	Az entitás ETagje. Az ETag-nek meg kell egyeznie a GET-kérés fejlécválaszából származó aktuális entitásállapotmal, vagy * kell lennie a feltétel nélküli frissítéshez.

Kérelem törzse

Name	Típus	Description
properties.requireBase	PolicyRestrictionRequireBase	Azt jelzi, hogy az alapházirendet kötelező-e kikényszeríteni a szabályzatdokumentumhoz.
properties.scope	string	A szabályzatdokumentum elérési útja.

Válaszok

Name	Típus	Description
200 OK	PolicyRestrictionContract	Az Api Management szolgáltatás szabályzatkorlátozási konfigurációja sikeresen frissült. Fejlécek ETag: string
Other Status Codes	ErrorResponse	Hibaválasz, amely leírja, hogy miért nem sikerült a művelet.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

ApiManagementUpdatePolicyRestriction

Mintakérelem

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."
  }
}

Java

import com.azure.resourcemanager.apimanagement.models.PolicyRestrictionContract;

/**
 * Samples for PolicyRestriction Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/
     * ApiManagementUpdatePolicyRestriction.json
     */
    /**
     * Sample code: ApiManagementUpdatePolicyRestriction.
     * 
     * @param manager Entry point to ApiManagementManager.
     */
    public static void
        apiManagementUpdatePolicyRestriction(com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        PolicyRestrictionContract resource = manager.policyRestrictions()
            .getWithResponse("rg1", "apimService1", "policyRestriction1", com.azure.core.util.Context.NONE).getValue();
        resource.update().withScope("Sample Path 2 to the policy document.").withIfMatch("*").apply();
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.apimanagement import ApiManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_update_policy_restriction.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ApiManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.policy_restriction.update(
        resource_group_name="rg1",
        service_name="apimService1",
        policy_restriction_id="policyRestriction1",
        if_match="*",
        parameters={"properties": {"scope": "Sample Path 2 to the policy document."}},
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementUpdatePolicyRestriction.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armapimanagement_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e436160e64c0f8d7fb20d662be2712f71f0a7ef5/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementUpdatePolicyRestriction.json
func ExamplePolicyRestrictionClient_Update() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewPolicyRestrictionClient().Update(ctx, "rg1", "apimService1", "policyRestriction1", "*", armapimanagement.PolicyRestrictionUpdateContract{
		Properties: &armapimanagement.PolicyRestrictionContractProperties{
			Scope: to.Ptr("Sample Path 2 to the policy document."),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.PolicyRestrictionContract = armapimanagement.PolicyRestrictionContract{
	// 	Name: to.Ptr("policyRestriction1"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service/policyRestrictions"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/policyRestrictions/policyRestriction1"),
	// 	Properties: &armapimanagement.PolicyRestrictionContractProperties{
	// 		RequireBase: to.Ptr(armapimanagement.PolicyRestrictionRequireBaseTrue),
	// 		Scope: to.Ptr("Sample Path 2 to the policy document."),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Updates the policy restriction configuration of the Api Management service.
 *
 * @summary Updates the policy restriction configuration of the Api Management service.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementUpdatePolicyRestriction.json
 */
async function apiManagementUpdatePolicyRestriction() {
  const subscriptionId =
    process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const policyRestrictionId = "policyRestriction1";
  const ifMatch = "*";
  const parameters = {
    scope: "Sample Path 2 to the policy document.",
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.policyRestriction.update(
    resourceGroupName,
    serviceName,
    policyRestrictionId,
    ifMatch,
    parameters,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Mintaválasz

Állapotkód:

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

Definíciók

Name	Description
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
PolicyRestrictionContract	Szabályzatkorlátozási szerződés részletei.
PolicyRestrictionRequireBase	Azt jelzi, hogy az alapházirendet kötelező-e kikényszeríteni a szabályzatdokumentumhoz.
PolicyRestrictionUpdateContract	Szabályzatkorlátozási szerződés részletei.

ErrorAdditionalInfo

Objektum

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorDetail

Objektum

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ErrorResponse

Objektum

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

PolicyRestrictionContract

Objektum

Szabályzatkorlátozási szerződés részletei.

Name	Típus	Alapértelmezett érték	Description
id	string		Az erőforrás teljes erőforrás-azonosítója. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string		Az erőforrás neve
properties.requireBase	PolicyRestrictionRequireBase	false	Azt jelzi, hogy az alapházirendet kötelező-e kikényszeríteni a szabályzatdokumentumhoz.
properties.scope	string		A szabályzatdokumentum elérési útja.
type	string		Az erőforrás típusa. Pl. "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

PolicyRestrictionRequireBase

Enumerálás

Azt jelzi, hogy az alapházirendet kötelező-e kikényszeríteni a szabályzatdokumentumhoz.

Érték	Description
false	A szabályzatnak nem kell alapszabályzattal rendelkeznie
true	A szabályzatnak alapszabályzattal kell rendelkeznie

PolicyRestrictionUpdateContract

Objektum

Szabályzatkorlátozási szerződés részletei.

Name	Típus	Alapértelmezett érték	Description
properties.requireBase	PolicyRestrictionRequireBase	false	Azt jelzi, hogy az alapházirendet kötelező-e kikényszeríteni a szabályzatdokumentumhoz.
properties.scope	string		A szabályzatdokumentum elérési útja.