AuthorizationProvider interface

Package:

@azure/arm-apimanagement

Interface representing a AuthorizationProvider.

Methods

createOrUpdate(string, string, string, AuthorizationProviderContract, AuthorizationProviderCreateOrUpdateOptionalParams)	Creates or updates authorization provider.
delete(string, string, string, string, AuthorizationProviderDeleteOptionalParams)	Deletes specific authorization provider from the API Management service instance.
get(string, string, string, AuthorizationProviderGetOptionalParams)	Gets the details of the authorization provider specified by its identifier.
listByService(string, string, AuthorizationProviderListByServiceOptionalParams)	Lists a collection of authorization providers defined within a service instance.

Method Details

createOrUpdate(string, string, string, AuthorizationProviderContract, AuthorizationProviderCreateOrUpdateOptionalParams)

Creates or updates authorization provider.

function createOrUpdate(resourceGroupName: string, serviceName: string, authorizationProviderId: string, parameters: AuthorizationProviderContract, options?: AuthorizationProviderCreateOrUpdateOptionalParams): Promise<AuthorizationProviderCreateOrUpdateResponse>

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.

parameters

AuthorizationProviderContract

Create parameters.

options

AuthorizationProviderCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<AuthorizationProviderCreateOrUpdateResponse>

delete(string, string, string, string, AuthorizationProviderDeleteOptionalParams)

Deletes specific authorization provider from the API Management service instance.

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

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

AuthorizationProviderDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, AuthorizationProviderGetOptionalParams)

Gets the details of the authorization provider specified by its identifier.

function get(resourceGroupName: string, serviceName: string, authorizationProviderId: string, options?: AuthorizationProviderGetOptionalParams): Promise<AuthorizationProviderGetResponse>

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.

options

AuthorizationProviderGetOptionalParams

The options parameters.

Returns

Promise<AuthorizationProviderGetResponse>

listByService(string, string, AuthorizationProviderListByServiceOptionalParams)

Lists a collection of authorization providers defined within a service instance.

function listByService(resourceGroupName: string, serviceName: string, options?: AuthorizationProviderListByServiceOptionalParams): PagedAsyncIterableIterator<AuthorizationProviderContract, AuthorizationProviderContract[], PageSettings>

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

options

AuthorizationProviderListByServiceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<AuthorizationProviderContract, AuthorizationProviderContract[], PageSettings>