AuthorizationAccessPolicy interface

Package:

@azure/arm-apimanagement

Interface representing a AuthorizationAccessPolicy.

Methods

createOrUpdate(string, string, string, string, string, AuthorizationAccessPolicyContract, AuthorizationAccessPolicyCreateOrUpdateOptionalParams)	Creates or updates Authorization Access Policy.
delete(string, string, string, string, string, string, AuthorizationAccessPolicyDeleteOptionalParams)	Deletes specific access policy from the Authorization.
get(string, string, string, string, string, AuthorizationAccessPolicyGetOptionalParams)	Gets the details of the authorization access policy specified by its identifier.
listByAuthorization(string, string, string, string, AuthorizationAccessPolicyListByAuthorizationOptionalParams)	Lists a collection of authorization access policy defined within a authorization.

Method Details

createOrUpdate(string, string, string, string, string, AuthorizationAccessPolicyContract, AuthorizationAccessPolicyCreateOrUpdateOptionalParams)

Creates or updates Authorization Access Policy.

function createOrUpdate(resourceGroupName: string, serviceName: string, authorizationProviderId: string, authorizationId: string, authorizationAccessPolicyId: string, parameters: AuthorizationAccessPolicyContract, options?: AuthorizationAccessPolicyCreateOrUpdateOptionalParams): Promise<AuthorizationAccessPolicyCreateOrUpdateResponse>

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

authorizationProviderId

string

Identifier of the authorization provider.

authorizationId

string

Identifier of the authorization.

authorizationAccessPolicyId

string

Identifier of the authorization access policy.

parameters

AuthorizationAccessPolicyContract

Create parameters.

options

AuthorizationAccessPolicyCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<AuthorizationAccessPolicyCreateOrUpdateResponse>

delete(string, string, string, string, string, string, AuthorizationAccessPolicyDeleteOptionalParams)

Deletes specific access policy from the Authorization.

function delete(resourceGroupName: string, serviceName: string, authorizationProviderId: string, authorizationId: string, authorizationAccessPolicyId: string, ifMatch: string, options?: AuthorizationAccessPolicyDeleteOptionalParams): 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.

authorizationProviderId

string

Identifier of the authorization provider.

authorizationId

string

Identifier of the authorization.

authorizationAccessPolicyId

string

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

options

AuthorizationAccessPolicyDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, string, string, AuthorizationAccessPolicyGetOptionalParams)

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

function get(resourceGroupName: string, serviceName: string, authorizationProviderId: string, authorizationId: string, authorizationAccessPolicyId: string, options?: AuthorizationAccessPolicyGetOptionalParams): Promise<AuthorizationAccessPolicyGetResponse>

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

authorizationProviderId

string

Identifier of the authorization provider.

authorizationId

string

Identifier of the authorization.

authorizationAccessPolicyId

string

Identifier of the authorization access policy.

options

AuthorizationAccessPolicyGetOptionalParams

The options parameters.

Returns

Promise<AuthorizationAccessPolicyGetResponse>

listByAuthorization(string, string, string, string, AuthorizationAccessPolicyListByAuthorizationOptionalParams)

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

function listByAuthorization(resourceGroupName: string, serviceName: string, authorizationProviderId: string, authorizationId: string, options?: AuthorizationAccessPolicyListByAuthorizationOptionalParams): PagedAsyncIterableIterator<AuthorizationAccessPolicyContract, AuthorizationAccessPolicyContract[], PageSettings>

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

authorizationProviderId

string

Identifier of the authorization provider.

authorizationId

string

Identifier of the authorization.

options

AuthorizationAccessPolicyListByAuthorizationOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<AuthorizationAccessPolicyContract, AuthorizationAccessPolicyContract[], PageSettings>