Interface ApiOperationPolicies
-
public interface ApiOperationPolicies
Resource collection API of ApiOperationPolicies.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description PolicyContract.DefinitionStages.Blank
define(PolicyIdName name)
Begins definition for a new PolicyContract resource.void
delete(String resourceGroupName, String serviceName, String apiId, String operationId, PolicyIdName policyId, String ifMatch)
Deletes the policy configuration at the Api Operation.void
deleteById(String id)
Deletes the policy configuration at the Api Operation.com.azure.core.http.rest.Response<Void>
deleteByIdWithResponse(String id, String ifMatch, com.azure.core.util.Context context)
Deletes the policy configuration at the Api Operation.com.azure.core.http.rest.Response<Void>
deleteWithResponse(String resourceGroupName, String serviceName, String apiId, String operationId, PolicyIdName policyId, String ifMatch, com.azure.core.util.Context context)
Deletes the policy configuration at the Api Operation.PolicyContract
get(String resourceGroupName, String serviceName, String apiId, String operationId, PolicyIdName policyId)
Get the policy configuration at the API Operation level.PolicyContract
getById(String id)
Get the policy configuration at the API Operation level.com.azure.core.http.rest.Response<PolicyContract>
getByIdWithResponse(String id, PolicyExportFormat format, com.azure.core.util.Context context)
Get the policy configuration at the API Operation level.void
getEntityTag(String resourceGroupName, String serviceName, String apiId, String operationId, PolicyIdName policyId)
Gets the entity state (Etag) version of the API operation policy specified by its identifier.ApiOperationPoliciesGetEntityTagResponse
getEntityTagWithResponse(String resourceGroupName, String serviceName, String apiId, String operationId, PolicyIdName policyId, com.azure.core.util.Context context)
Gets the entity state (Etag) version of the API operation policy specified by its identifier.com.azure.core.http.rest.Response<PolicyContract>
getWithResponse(String resourceGroupName, String serviceName, String apiId, String operationId, PolicyIdName policyId, PolicyExportFormat format, com.azure.core.util.Context context)
Get the policy configuration at the API Operation level.PolicyCollection
listByOperation(String resourceGroupName, String serviceName, String apiId, String operationId)
Get the list of policy configuration at the API Operation level.com.azure.core.http.rest.Response<PolicyCollection>
listByOperationWithResponse(String resourceGroupName, String serviceName, String apiId, String operationId, com.azure.core.util.Context context)
Get the list of policy configuration at the API Operation level.
-
-
-
Method Detail
-
listByOperation
PolicyCollection listByOperation(String resourceGroupName, String serviceName, String apiId, String operationId)
Get the list of policy configuration at the API Operation level.- Parameters:
resourceGroupName
- The name of the resource group.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.operationId
- Operation identifier within an API. Must be unique in the current API Management service instance.- Returns:
- the list of policy configuration at the API Operation 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.
-
listByOperationWithResponse
com.azure.core.http.rest.Response<PolicyCollection> listByOperationWithResponse(String resourceGroupName, String serviceName, String apiId, String operationId, com.azure.core.util.Context context)
Get the list of policy configuration at the API Operation level.- Parameters:
resourceGroupName
- The name of the resource group.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.operationId
- Operation identifier within an 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 API Operation level along with
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.
-
getEntityTag
void getEntityTag(String resourceGroupName, String serviceName, String apiId, String operationId, PolicyIdName policyId)
Gets the entity state (Etag) version of the API operation policy specified by its identifier.- Parameters:
resourceGroupName
- The name of the resource group.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.operationId
- Operation identifier within an 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.
-
getEntityTagWithResponse
ApiOperationPoliciesGetEntityTagResponse getEntityTagWithResponse(String resourceGroupName, String serviceName, String apiId, String operationId, PolicyIdName policyId, com.azure.core.util.Context context)
Gets the entity state (Etag) version of the API operation policy specified by its identifier.- Parameters:
resourceGroupName
- The name of the resource group.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.operationId
- Operation identifier within an 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 API operation 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.
-
get
PolicyContract get(String resourceGroupName, String serviceName, String apiId, String operationId, PolicyIdName policyId)
Get the policy configuration at the API Operation level.- Parameters:
resourceGroupName
- The name of the resource group.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.operationId
- Operation identifier within an API. Must be unique in the current API Management service instance.policyId
- The identifier of the Policy.- Returns:
- the policy configuration at the API Operation 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.
-
getWithResponse
com.azure.core.http.rest.Response<PolicyContract> getWithResponse(String resourceGroupName, String serviceName, String apiId, String operationId, PolicyIdName policyId, PolicyExportFormat format, com.azure.core.util.Context context)
Get the policy configuration at the API Operation level.- Parameters:
resourceGroupName
- The name of the resource group.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.operationId
- Operation identifier within an 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 API Operation 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.
-
delete
void delete(String resourceGroupName, String serviceName, String apiId, String operationId, PolicyIdName policyId, String ifMatch)
Deletes the policy configuration at the Api Operation.- Parameters:
resourceGroupName
- The name of the resource group.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.operationId
- Operation identifier within an 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.
-
deleteWithResponse
com.azure.core.http.rest.Response<Void> deleteWithResponse(String resourceGroupName, String serviceName, String apiId, String operationId, PolicyIdName policyId, String ifMatch, com.azure.core.util.Context context)
Deletes the policy configuration at the Api Operation.- Parameters:
resourceGroupName
- The name of the resource group.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.operationId
- Operation identifier within an 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.
-
getById
PolicyContract getById(String id)
Get the policy configuration at the API Operation level.- Parameters:
id
- the resource ID.- Returns:
- the policy configuration at the API Operation 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.
-
getByIdWithResponse
com.azure.core.http.rest.Response<PolicyContract> getByIdWithResponse(String id, PolicyExportFormat format, com.azure.core.util.Context context)
Get the policy configuration at the API Operation level.- Parameters:
id
- the resource ID.format
- Policy Export Format.context
- The context to associate with this operation.- Returns:
- the policy configuration at the API Operation 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.
-
deleteById
void deleteById(String id)
Deletes the policy configuration at the Api Operation.- Parameters:
id
- the resource ID.- 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.
-
deleteByIdWithResponse
com.azure.core.http.rest.Response<Void> deleteByIdWithResponse(String id, String ifMatch, com.azure.core.util.Context context)
Deletes the policy configuration at the Api Operation.- Parameters:
id
- the resource ID.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.
-
define
PolicyContract.DefinitionStages.Blank define(PolicyIdName name)
Begins definition for a new PolicyContract resource.- Parameters:
name
- resource name.- Returns:
- the first stage of the new PolicyContract definition.
-
-