AuthorizationAccessPolicies Interface

Package:

com.azure.resourcemanager.apimanagement.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-apimanagement:1.0.0-beta.4

public interface AuthorizationAccessPolicies

Resource collection API of AuthorizationAccessPolicies.

Method Summary

Modifier and Type	Method and Description
abstract Blank	define(String name) Begins definition for a new AuthorizationAccessPolicyContract resource.
abstract void	delete(String resourceGroupName, String serviceName, String authorizationProviderId, String authorizationId, String authorizationAccessPolicyId, String ifMatch) Deletes specific access policy from the Authorization.
abstract void	deleteById(String id) Deletes specific access policy from the Authorization.
abstract Response<Void>	deleteByIdWithResponse(String id, String ifMatch, Context context) Deletes specific access policy from the Authorization.
abstract Response<Void>	deleteWithResponse(String resourceGroupName, String serviceName, String authorizationProviderId, String authorizationId, String authorizationAccessPolicyId, String ifMatch, Context context) Deletes specific access policy from the Authorization.
abstract AuthorizationAccessPolicyContract	get(String resourceGroupName, String serviceName, String authorizationProviderId, String authorizationId, String authorizationAccessPolicyId) Gets the details of the authorization access policy specified by its identifier.
abstract AuthorizationAccessPolicyContract	getById(String id) Gets the details of the authorization access policy specified by its identifier.
abstract Response<AuthorizationAccessPolicyContract>	getByIdWithResponse(String id, Context context) Gets the details of the authorization access policy specified by its identifier.
abstract Response<AuthorizationAccessPolicyContract>	getWithResponse(String resourceGroupName, String serviceName, String authorizationProviderId, String authorizationId, String authorizationAccessPolicyId, Context context) Gets the details of the authorization access policy specified by its identifier.
abstract PagedIterable<AuthorizationAccessPolicyContract>	listByAuthorization(String resourceGroupName, String serviceName, String authorizationProviderId, String authorizationId) Lists a collection of authorization access policy defined within a authorization.
abstract PagedIterable<AuthorizationAccessPolicyContract>	listByAuthorization(String resourceGroupName, String serviceName, String authorizationProviderId, String authorizationId, String filter, Integer top, Integer skip, Context context) Lists a collection of authorization access policy defined within a authorization.

Method Details

define

public abstract AuthorizationAccessPolicyContract.DefinitionStages.Blank define(String name)

Begins definition for a new AuthorizationAccessPolicyContract resource.

Parameters:

name - resource name.

Returns:

the first stage of the new AuthorizationAccessPolicyContract definition.

delete

public abstract void delete(String resourceGroupName, String serviceName, String authorizationProviderId, String authorizationId, String authorizationAccessPolicyId, String ifMatch)

Deletes specific access policy from the Authorization.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

serviceName - The name of the API Management service.

authorizationProviderId - Identifier of the authorization provider.

authorizationId - Identifier of the authorization.

authorizationAccessPolicyId - Identifier of the authorization access 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.

deleteById

public abstract void deleteById(String id)

Deletes specific access policy from the Authorization.

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract Response deleteByIdWithResponse(String id, String ifMatch, Context context)

Deletes specific access policy from the Authorization.

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

deleteWithResponse

public abstract Response deleteWithResponse(String resourceGroupName, String serviceName, String authorizationProviderId, String authorizationId, String authorizationAccessPolicyId, String ifMatch, Context context)

Deletes specific access policy from the Authorization.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

serviceName - The name of the API Management service.

authorizationProviderId - Identifier of the authorization provider.

authorizationId - Identifier of the authorization.

authorizationAccessPolicyId - Identifier of the authorization access 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<T>.

get

public abstract AuthorizationAccessPolicyContract get(String resourceGroupName, String serviceName, String authorizationProviderId, String authorizationId, String authorizationAccessPolicyId)

Gets the details of the authorization access 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.

authorizationProviderId - Identifier of the authorization provider.

authorizationId - Identifier of the authorization.

authorizationAccessPolicyId - Identifier of the authorization access policy.

Returns:

the details of the authorization access policy specified by its identifier.

getById

public abstract AuthorizationAccessPolicyContract getById(String id)

Gets the details of the authorization access policy specified by its identifier.

Parameters:

id - the resource ID.

Returns:

the details of the authorization access policy specified by its identifier.

getByIdWithResponse

public abstract Response getByIdWithResponse(String id, Context context)

Gets the details of the authorization access policy specified by its identifier.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

Returns:

the details of the authorization access policy specified by its identifier.

getWithResponse

public abstract Response getWithResponse(String resourceGroupName, String serviceName, String authorizationProviderId, String authorizationId, String authorizationAccessPolicyId, Context context)

Gets the details of the authorization access 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.

authorizationProviderId - Identifier of the authorization provider.

authorizationId - Identifier of the authorization.

authorizationAccessPolicyId - Identifier of the authorization access policy.

context - The context to associate with this operation.

Returns:

the details of the authorization access policy specified by its identifier.

listByAuthorization

public abstract PagedIterable listByAuthorization(String resourceGroupName, String serviceName, String authorizationProviderId, String authorizationId)

Lists a collection of authorization access policy defined within a authorization.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

serviceName - The name of the API Management service.

authorizationProviderId - Identifier of the authorization provider.

authorizationId - Identifier of the authorization.

Returns:

paged Authorization Access Policy list representation as paginated response with PagedIterable<T>.

listByAuthorization

public abstract PagedIterable listByAuthorization(String resourceGroupName, String serviceName, String authorizationProviderId, String authorizationId, String filter, Integer top, Integer skip, Context context)

Lists a collection of authorization access policy defined within a authorization.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.

serviceName - The name of the API Management service.

authorizationProviderId - Identifier of the authorization provider.

authorizationId - Identifier of the authorization.

filter - | Field | Usage | Supported operators | Supported functions |</br>|-------------|-------------|-------------|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>.

top - Number of records to return.

skip - Number of records to skip.

context - The context to associate with this operation.

Returns:

paged Authorization Access Policy list representation as paginated response with PagedIterable<T>.