Graph QL Api Resolver Policy - Get

Service:

API Management

Version d'API:

2024-05-01

Obtenez la configuration de la stratégie au niveau du programme de résolution de l’API GraphQL.

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

Avec des paramètres facultatifs:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/resolvers/{resolverId}/policies/policy?format={format}&api-version=2024-05-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
apiId	path	True	string minLength: 1 maxLength: 256 pattern: ^[^*#&+:<>?]+$	Identificateur de révision d’API. Doit être unique dans l’instance actuelle du service Gestion des API. La révision non actuelle a ; rev=n en tant que suffixe où n est le numéro de révision.
policyId	path	True	PolicyIdName	Identificateur de la stratégie.
resolverId	path	True	string minLength: 1 maxLength: 80	Identificateur du programme de résolution dans une API GraphQL. Doit être unique dans l’instance actuelle du service Gestion des API.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nom du service Gestion des API.
subscriptionId	path	True	string (uuid)	ID de l’abonnement cible. La valeur doit être un UUID.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.
format	query		PolicyExportFormat	Format d’exportation de stratégie.

Réponses

Nom	Type	Description
200 OK	PolicyContract	Informations de stratégie de résolution d’API GraphQL. En-têtes ETag: string
Other Status Codes	ErrorResponse	Réponse d’erreur décrivant pourquoi le programme de résolution a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

ApiManagementGetGraphQLApiResolverPolicy

Exemple de requête

HTTP

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

Java

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

/**
 * Samples for GraphQLApiResolverPolicy Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/
     * ApiManagementGetGraphQLApiResolverPolicy.json
     */
    /**
     * Sample code: ApiManagementGetGraphQLApiResolverPolicy.
     * 
     * @param manager Entry point to ApiManagementManager.
     */
    public static void
        apiManagementGetGraphQLApiResolverPolicy(com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager.graphQLApiResolverPolicies().getWithResponse("rg1", "apimService1", "5600b539c53f5b0062040001",
            "5600b53ac53f5b0062080006", PolicyIdName.POLICY, null, com.azure.core.util.Context.NONE);
    }
}

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_get_graph_ql_api_resolver_policy.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.graph_ql_api_resolver_policy.get(
        resource_group_name="rg1",
        service_name="apimService1",
        api_id="5600b539c53f5b0062040001",
        resolver_id="5600b53ac53f5b0062080006",
        policy_id="policy",
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementGetGraphQLApiResolverPolicy.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/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/ApiManagementGetGraphQLApiResolverPolicy.json
func ExampleGraphQLAPIResolverPolicyClient_Get() {
	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.NewGraphQLAPIResolverPolicyClient().Get(ctx, "rg1", "apimService1", "5600b539c53f5b0062040001", "5600b53ac53f5b0062080006", armapimanagement.PolicyIDNamePolicy, &armapimanagement.GraphQLAPIResolverPolicyClientGetOptions{Format: 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.PolicyContract = armapimanagement.PolicyContract{
	// 	Name: to.Ptr("policy"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service/apis/resolvers/policies"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b539c53f5b0062040001/resolvers/5600b53ac53f5b0062080006/policies/policy"),
	// 	Properties: &armapimanagement.PolicyContractProperties{
	// 		Value: to.Ptr("<http-data-source>\r\n  <http-request>\r\n   <set-method>GET</set-method>\r\n<set-backend-service base-url=\"https://some.service.com\" />\r\n<set-url>/api/users</set-url>\r\n</http-request>\r\n</http-data-source>"),
	// 	},
	// }
}

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 Get the policy configuration at the GraphQL API Resolver level.
 *
 * @summary Get the policy configuration at the GraphQL API Resolver level.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementGetGraphQLApiResolverPolicy.json
 */
async function apiManagementGetGraphQlApiResolverPolicy() {
  const subscriptionId =
    process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const apiId = "5600b539c53f5b0062040001";
  const resolverId = "5600b53ac53f5b0062080006";
  const policyId = "policy";
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.graphQLApiResolverPolicy.get(
    resourceGroupName,
    serviceName,
    apiId,
    resolverId,
    policyId,
  );
  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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ApiManagement.Models;
using Azure.ResourceManager.ApiManagement;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementGetGraphQLApiResolverPolicy.json
// this example is just showing the usage of "GraphQLApiResolverPolicy_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ServiceApiResolverPolicyResource created on azure
// for more information of creating ServiceApiResolverPolicyResource, please refer to the document of ServiceApiResolverPolicyResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
string apiId = "5600b539c53f5b0062040001";
string resolverId = "5600b53ac53f5b0062080006";
PolicyName policyId = PolicyName.Policy;
ResourceIdentifier serviceApiResolverPolicyResourceId = ServiceApiResolverPolicyResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName, apiId, resolverId, policyId);
ServiceApiResolverPolicyResource serviceApiResolverPolicy = client.GetServiceApiResolverPolicyResource(serviceApiResolverPolicyResourceId);

// invoke the operation
ServiceApiResolverPolicyResource result = await serviceApiResolverPolicy.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
PolicyContractData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

Exemple de réponse

Code d’état:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5600b539c53f5b0062040001/resolvers/5600b53ac53f5b0062080006/policies/policy",
  "type": "Microsoft.ApiManagement/service/apis/resolvers/policies",
  "name": "policy",
  "properties": {
    "value": "<http-data-source>\r\n  <http-request>\r\n   <set-method>GET</set-method>\r\n<set-backend-service base-url=\"https://some.service.com\" />\r\n<set-url>/api/users</set-url>\r\n</http-request>\r\n</http-data-source>"
  }
}

Définitions

Nom	Description
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
PolicyContentFormat	Format de policyContent.
PolicyContract	Détails du contrat de stratégie.
PolicyExportFormat	Format d’exportation de stratégie.
PolicyIdName	Identificateur de la stratégie.

ErrorAdditionalInfo

Object

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Object

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Object

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

PolicyContentFormat

Énumération

Format de policyContent.

Valeur	Description
rawxml	Le contenu est inline et le type de contenu est un document de stratégie encodé non XML.
rawxml-link	Le document de stratégie n’est pas encodé XML et est hébergé sur un point de terminaison HTTP accessible à partir du service Gestion des API.
xml	Le contenu est inline et le type de contenu est un document XML.
xml-link	Le document XML de stratégie est hébergé sur un point de terminaison HTTP accessible à partir du service Gestion des API.

PolicyContract

Object

Détails du contrat de stratégie.

Nom	Type	Valeur par défaut	Description
id	string		ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string		Nom de la ressource
properties.format	PolicyContentFormat	xml	Format de policyContent.
properties.value	string		Contenu de la stratégie tel que défini par le format.
type	string		Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

PolicyExportFormat

Énumération

Format d’exportation de stratégie.

Valeur	Description
rawxml	Le contenu est inline et le type de contenu est un document de stratégie encodé non XML.
xml	Le contenu est inline et le type de contenu est un document XML.

PolicyIdName

Énumération

Identificateur de la stratégie.

Valeur	Description
policy