GraphQLApiResolverPolicies Interface

public interface GraphQLApiResolverPolicies

Resource collection API of GraphQLApiResolverPolicies.

Method Summary

Modifier and Type Method and Description
abstract 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.

abstract Response<PolicyContract> createOrUpdateWithResponse(String resourceGroupName, String serviceName, String apiId, String resolverId, PolicyIdName policyId, PolicyContractInner parameters, String ifMatch, Context context)

Creates or updates policy configuration for the GraphQL API Resolver level.

abstract void delete(String resourceGroupName, String serviceName, String apiId, String resolverId, PolicyIdName policyId, String ifMatch)

Deletes the policy configuration at the GraphQL Api Resolver.

abstract Response<Void> deleteWithResponse(String resourceGroupName, String serviceName, String apiId, String resolverId, PolicyIdName policyId, String ifMatch, Context context)

Deletes the policy configuration at the GraphQL Api Resolver.

abstract PolicyContract get(String resourceGroupName, String serviceName, String apiId, String resolverId, PolicyIdName policyId)

Get the policy configuration at the GraphQL API Resolver level.

abstract 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.

abstract GraphQLApiResolverPoliciesGetEntityTagResponse getEntityTagWithResponse(String resourceGroupName, String serviceName, String apiId, String resolverId, PolicyIdName policyId, Context context)

Gets the entity state (Etag) version of the GraphQL API resolver policy specified by its identifier.

abstract Response<PolicyContract> getWithResponse(String resourceGroupName, String serviceName, String apiId, String resolverId, PolicyIdName policyId, PolicyExportFormat format, Context context)

Get the policy configuration at the GraphQL API Resolver level.

abstract PagedIterable<PolicyContract> listByResolver(String resourceGroupName, String serviceName, String apiId, String resolverId)

Get the list of policy configuration at the GraphQL API Resolver level.

abstract PagedIterable<PolicyContract> listByResolver(String resourceGroupName, String serviceName, String apiId, String resolverId, Context context)

Get the list of policy configuration at the GraphQL API Resolver level.

Method Details

createOrUpdate

public abstract 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.

createOrUpdateWithResponse

public abstract Response createOrUpdateWithResponse(String resourceGroupName, String serviceName, String apiId, String resolverId, PolicyIdName policyId, PolicyContractInner parameters, String ifMatch, 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.

delete

public abstract 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.

deleteWithResponse

public abstract Response deleteWithResponse(String resourceGroupName, String serviceName, String apiId, String resolverId, PolicyIdName policyId, String ifMatch, 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:

get

public abstract 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.

getEntityTag

public abstract 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.

getEntityTagWithResponse

public abstract GraphQLApiResolverPoliciesGetEntityTagResponse getEntityTagWithResponse(String resourceGroupName, String serviceName, String apiId, String resolverId, PolicyIdName policyId, 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.

getWithResponse

public abstract Response getWithResponse(String resourceGroupName, String serviceName, String apiId, String resolverId, PolicyIdName policyId, PolicyExportFormat format, 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.

listByResolver

public abstract PagedIterable 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<T>.

listByResolver

public abstract PagedIterable listByResolver(String resourceGroupName, String serviceName, String apiId, String resolverId, 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<T>.

Applies to