GraphQLApiResolverPolicy interface
Interface representing a GraphQLApiResolverPolicy.
Methods
| create |
Creates or updates policy configuration for the GraphQL API Resolver level. |
| delete(string, string, string, string, string, string, Graph |
Deletes the policy configuration at the GraphQL Api Resolver. |
| get(string, string, string, string, string, Graph |
Get the policy configuration at the GraphQL API Resolver level. |
| get |
Gets the entity state (Etag) version of the GraphQL API resolver policy specified by its identifier. |
| list |
Get the list of policy configuration at the GraphQL API Resolver level. |
Method Details
createOrUpdate(string, string, string, string, string, PolicyContract, GraphQLApiResolverPolicyCreateOrUpdateOptionalParams)
Creates or updates policy configuration for the GraphQL API Resolver level.
function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, resolverId: string, policyId: string, parameters: PolicyContract, options?: GraphQLApiResolverPolicyCreateOrUpdateOptionalParams): Promise<GraphQLApiResolverPolicyCreateOrUpdateResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- apiId
-
string
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
-
string
Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance.
- policyId
-
string
The identifier of the Policy.
- parameters
- PolicyContract
The policy contents to apply.
The options parameters.
Returns
delete(string, string, string, string, string, string, GraphQLApiResolverPolicyDeleteOptionalParams)
Deletes the policy configuration at the GraphQL Api Resolver.
function delete(resourceGroupName: string, serviceName: string, apiId: string, resolverId: string, policyId: string, ifMatch: string, options?: GraphQLApiResolverPolicyDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- apiId
-
string
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
-
string
Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance.
- policyId
-
string
The identifier of the Policy.
- ifMatch
-
string
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.
The options parameters.
Returns
Promise<void>
get(string, string, string, string, string, GraphQLApiResolverPolicyGetOptionalParams)
Get the policy configuration at the GraphQL API Resolver level.
function get(resourceGroupName: string, serviceName: string, apiId: string, resolverId: string, policyId: string, options?: GraphQLApiResolverPolicyGetOptionalParams): Promise<GraphQLApiResolverPolicyGetResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- apiId
-
string
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
-
string
Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance.
- policyId
-
string
The identifier of the Policy.
The options parameters.
Returns
Promise<GraphQLApiResolverPolicyGetResponse>
getEntityTag(string, string, string, string, string, GraphQLApiResolverPolicyGetEntityTagOptionalParams)
Gets the entity state (Etag) version of the GraphQL API resolver policy specified by its identifier.
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, resolverId: string, policyId: string, options?: GraphQLApiResolverPolicyGetEntityTagOptionalParams): Promise<GraphQLApiResolverPolicyGetEntityTagHeaders>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- apiId
-
string
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
-
string
Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance.
- policyId
-
string
The identifier of the Policy.
The options parameters.
Returns
listByResolver(string, string, string, string, GraphQLApiResolverPolicyListByResolverOptionalParams)
Get the list of policy configuration at the GraphQL API Resolver level.
function listByResolver(resourceGroupName: string, serviceName: string, apiId: string, resolverId: string, options?: GraphQLApiResolverPolicyListByResolverOptionalParams): PagedAsyncIterableIterator<PolicyContract, PolicyContract[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- apiId
-
string
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
-
string
Resolver identifier within a GraphQL API. Must be unique in the current API Management service instance.
The options parameters.