Package com.azure.resourcemanager.apimanagement.models

Interface GraphQLApiResolverPolicies

public interface GraphQLApiResolverPolicies
Resource collection API of GraphQLApiResolverPolicies.

  • Method Details

    • listByResolver

      com.azure.core.http.rest.PagedIterable<PolicyContract> listByResolver(String resourceGroupName, String serviceName, String apiId, String resolverId)
      Get the list of policy configuration at the GraphQL API Resolver level.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      apiId - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
      resolverId - Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance.
      Returns:
      the list of policy configuration at the GraphQL API Resolver level as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listByResolver

      com.azure.core.http.rest.PagedIterable<PolicyContract> listByResolver(String resourceGroupName, String serviceName, String apiId, String resolverId, com.azure.core.util.Context context)
      Get the list of policy configuration at the GraphQL API Resolver level.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      apiId - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
      resolverId - Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance.
      context - The context to associate with this operation.
      Returns:
      the list of policy configuration at the GraphQL API Resolver level as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getEntityTagWithResponse

      GraphQLApiResolverPoliciesGetEntityTagResponse getEntityTagWithResponse(String resourceGroupName, String serviceName, String apiId, String resolverId, PolicyIdName policyId, com.azure.core.util.Context context)
      Gets the entity state (Etag) version of the GraphQL API resolver policy specified by its identifier.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      apiId - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
      resolverId - Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance.
      policyId - The identifier of the Policy.
      context - The context to associate with this operation.
      Returns:
      the entity state (Etag) version of the GraphQL API resolver policy specified by its identifier.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getEntityTag

      void getEntityTag(String resourceGroupName, String serviceName, String apiId, String resolverId, PolicyIdName policyId)
      Gets the entity state (Etag) version of the GraphQL API resolver policy specified by its identifier.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      apiId - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
      resolverId - Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance.
      policyId - The identifier of the Policy.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getWithResponse

      com.azure.core.http.rest.Response<PolicyContract> getWithResponse(String resourceGroupName, String serviceName, String apiId, String resolverId, PolicyIdName policyId, PolicyExportFormat format, com.azure.core.util.Context context)
      Get the policy configuration at the GraphQL API Resolver level.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      apiId - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
      resolverId - Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance.
      policyId - The identifier of the Policy.
      format - Policy Export Format.
      context - The context to associate with this operation.
      Returns:
      the policy configuration at the GraphQL API Resolver level.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • get

      PolicyContract get(String resourceGroupName, String serviceName, String apiId, String resolverId, PolicyIdName policyId)
      Get the policy configuration at the GraphQL API Resolver level.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      apiId - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
      resolverId - Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance.
      policyId - The identifier of the Policy.
      Returns:
      the policy configuration at the GraphQL API Resolver level.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • createOrUpdateWithResponse

      com.azure.core.http.rest.Response<PolicyContract> createOrUpdateWithResponse(String resourceGroupName, String serviceName, String apiId, String resolverId, PolicyIdName policyId, PolicyContractInner parameters, String ifMatch, com.azure.core.util.Context context)
      Creates or updates policy configuration for the GraphQL API Resolver level.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      apiId - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
      resolverId - Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance.
      policyId - The identifier of the Policy.
      parameters - The policy contents to apply.
      ifMatch - ETag of the Entity. Not required when creating an entity, but required when updating an entity.
      context - The context to associate with this operation.
      Returns:
      policy Contract details.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • createOrUpdate

      PolicyContract createOrUpdate(String resourceGroupName, String serviceName, String apiId, String resolverId, PolicyIdName policyId, PolicyContractInner parameters)
      Creates or updates policy configuration for the GraphQL API Resolver level.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      apiId - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
      resolverId - Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance.
      policyId - The identifier of the Policy.
      parameters - The policy contents to apply.
      Returns:
      policy Contract details.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deleteWithResponse

      com.azure.core.http.rest.Response<Void> deleteWithResponse(String resourceGroupName, String serviceName, String apiId, String resolverId, PolicyIdName policyId, String ifMatch, com.azure.core.util.Context context)
      Deletes the policy configuration at the GraphQL Api Resolver.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      apiId - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
      resolverId - Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance.
      policyId - The identifier of the Policy.
      ifMatch - ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
      context - The context to associate with this operation.
      Returns:
      the Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • delete

      void delete(String resourceGroupName, String serviceName, String apiId, String resolverId, PolicyIdName policyId, String ifMatch)
      Deletes the policy configuration at the GraphQL Api Resolver.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      serviceName - The name of the API Management service.
      apiId - API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
      resolverId - Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance.
      policyId - The identifier of the Policy.
      ifMatch - ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.