Interface ApiPolicies
-
public interface ApiPolicies
Resource collection API of ApiPolicies.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description PolicyContract
createOrUpdate(String resourceGroupName, String serviceName, String apiId, PolicyIdName policyId, PolicyContractInner parameters)
Creates or updates policy configuration for the API.com.azure.core.http.rest.Response<PolicyContract>
createOrUpdateWithResponse(String resourceGroupName, String serviceName, String apiId, PolicyIdName policyId, PolicyContractInner parameters, String ifMatch, com.azure.core.util.Context context)
Creates or updates policy configuration for the API.void
delete(String resourceGroupName, String serviceName, String apiId, PolicyIdName policyId, String ifMatch)
Deletes the policy configuration at the Api.com.azure.core.http.rest.Response<Void>
deleteWithResponse(String resourceGroupName, String serviceName, String apiId, PolicyIdName policyId, String ifMatch, com.azure.core.util.Context context)
Deletes the policy configuration at the Api.PolicyContract
get(String resourceGroupName, String serviceName, String apiId, PolicyIdName policyId)
Get the policy configuration at the API level.void
getEntityTag(String resourceGroupName, String serviceName, String apiId, PolicyIdName policyId)
Gets the entity state (Etag) version of the API policy specified by its identifier.ApiPoliciesGetEntityTagResponse
getEntityTagWithResponse(String resourceGroupName, String serviceName, String apiId, PolicyIdName policyId, com.azure.core.util.Context context)
Gets the entity state (Etag) version of the API policy specified by its identifier.com.azure.core.http.rest.Response<PolicyContract>
getWithResponse(String resourceGroupName, String serviceName, String apiId, PolicyIdName policyId, PolicyExportFormat format, com.azure.core.util.Context context)
Get the policy configuration at the API level.PolicyCollection
listByApi(String resourceGroupName, String serviceName, String apiId)
Get the policy configuration at the API level.com.azure.core.http.rest.Response<PolicyCollection>
listByApiWithResponse(String resourceGroupName, String serviceName, String apiId, com.azure.core.util.Context context)
Get the policy configuration at the API level.
-
-
-
Method Detail
-
listByApi
PolicyCollection listByApi(String resourceGroupName, String serviceName, String apiId)
Get the policy configuration at the API 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.- Returns:
- the policy configuration at the API 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.
-
listByApiWithResponse
com.azure.core.http.rest.Response<PolicyCollection> listByApiWithResponse(String resourceGroupName, String serviceName, String apiId, com.azure.core.util.Context context)
Get the policy configuration at the API 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.context
- The context to associate with this operation.- Returns:
- the policy configuration at the API 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, PolicyIdName policyId)
Gets the entity state (Etag) version of the API 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.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
ApiPoliciesGetEntityTagResponse getEntityTagWithResponse(String resourceGroupName, String serviceName, String apiId, PolicyIdName policyId, com.azure.core.util.Context context)
Gets the entity state (Etag) version of the API 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.policyId
- The identifier of the Policy.context
- The context to associate with this operation.- Returns:
- the entity state (Etag) version of the API 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, PolicyIdName policyId)
Get the policy configuration at the API 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.policyId
- The identifier of the Policy.- Returns:
- the policy configuration at the API 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, PolicyIdName policyId, PolicyExportFormat format, com.azure.core.util.Context context)
Get the policy configuration at the API 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.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 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.
-
createOrUpdate
PolicyContract createOrUpdate(String resourceGroupName, String serviceName, String apiId, PolicyIdName policyId, PolicyContractInner parameters)
Creates or updates policy configuration for the API.- 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.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.
-
createOrUpdateWithResponse
com.azure.core.http.rest.Response<PolicyContract> createOrUpdateWithResponse(String resourceGroupName, String serviceName, String apiId, PolicyIdName policyId, PolicyContractInner parameters, String ifMatch, com.azure.core.util.Context context)
Creates or updates policy configuration for the API.- 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.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.
-
delete
void delete(String resourceGroupName, String serviceName, String apiId, PolicyIdName policyId, String ifMatch)
Deletes the policy configuration at the Api.- 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.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, PolicyIdName policyId, String ifMatch, com.azure.core.util.Context context)
Deletes the policy configuration at the Api.- 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.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.
-
-