Share via

IdentityProvider interface

  • Reference
Package:
@azure/arm-apimanagement

Interface representing a IdentityProvider.

Methods

createOrUpdate(string, string, string, IdentityProviderCreateContract, IdentityProviderCreateOrUpdateOptionalParams)

Creates or Updates the IdentityProvider configuration.
delete(string, string, string, string, IdentityProviderDeleteOptionalParams)

Deletes the specified identity provider configuration.
get(string, string, string, IdentityProviderGetOptionalParams)

Gets the configuration details of the identity Provider configured in specified service instance.
getEntityTag(string, string, string, IdentityProviderGetEntityTagOptionalParams)

Gets the entity state (Etag) version of the identityProvider specified by its identifier.
listByService(string, string, IdentityProviderListByServiceOptionalParams)

Lists a collection of Identity Provider configured in the specified service instance.
listSecrets(string, string, string, IdentityProviderListSecretsOptionalParams)

Gets the client secret details of the Identity Provider.
update(string, string, string, string, IdentityProviderUpdateParameters, IdentityProviderUpdateOptionalParams)

Updates an existing IdentityProvider configuration.

Method Details

createOrUpdate(string, string, string, IdentityProviderCreateContract, IdentityProviderCreateOrUpdateOptionalParams)

Creates or Updates the IdentityProvider configuration.

function createOrUpdate(resourceGroupName: string, serviceName: string, identityProviderName: string, parameters: IdentityProviderCreateContract, options?: IdentityProviderCreateOrUpdateOptionalParams): Promise<IdentityProviderCreateOrUpdateResponse>

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

identityProviderName

string

Identity Provider Type identifier.

parameters
IdentityProviderCreateContract

Create parameters.

options
IdentityProviderCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<IdentityProviderCreateOrUpdateResponse>

delete(string, string, string, string, IdentityProviderDeleteOptionalParams)

Deletes the specified identity provider configuration.

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

identityProviderName

string

Identity Provider Type identifier.

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
IdentityProviderDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, IdentityProviderGetOptionalParams)

Gets the configuration details of the identity Provider configured in specified service instance.

function get(resourceGroupName: string, serviceName: string, identityProviderName: string, options?: IdentityProviderGetOptionalParams): Promise<IdentityProviderGetResponse>

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

identityProviderName

string

Identity Provider Type identifier.

options
IdentityProviderGetOptionalParams

The options parameters.

Returns

Promise<IdentityProviderGetResponse>

getEntityTag(string, string, string, IdentityProviderGetEntityTagOptionalParams)

Gets the entity state (Etag) version of the identityProvider specified by its identifier.

function getEntityTag(resourceGroupName: string, serviceName: string, identityProviderName: string, options?: IdentityProviderGetEntityTagOptionalParams): Promise<IdentityProviderGetEntityTagHeaders>

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

identityProviderName

string

Identity Provider Type identifier.

options
IdentityProviderGetEntityTagOptionalParams

The options parameters.

Returns

Promise<IdentityProviderGetEntityTagHeaders>

listByService(string, string, IdentityProviderListByServiceOptionalParams)

Lists a collection of Identity Provider configured in the specified service instance.

function listByService(resourceGroupName: string, serviceName: string, options?: IdentityProviderListByServiceOptionalParams): PagedAsyncIterableIterator<IdentityProviderContract, IdentityProviderContract[], 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
IdentityProviderListByServiceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<IdentityProviderContract, IdentityProviderContract[], PageSettings>

listSecrets(string, string, string, IdentityProviderListSecretsOptionalParams)

Gets the client secret details of the Identity Provider.

function listSecrets(resourceGroupName: string, serviceName: string, identityProviderName: string, options?: IdentityProviderListSecretsOptionalParams): Promise<IdentityProviderListSecretsResponse>

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

identityProviderName

string

Identity Provider Type identifier.

options
IdentityProviderListSecretsOptionalParams

The options parameters.

Returns

Promise<IdentityProviderListSecretsResponse>

update(string, string, string, string, IdentityProviderUpdateParameters, IdentityProviderUpdateOptionalParams)

Updates an existing IdentityProvider configuration.

function update(resourceGroupName: string, serviceName: string, identityProviderName: string, ifMatch: string, parameters: IdentityProviderUpdateParameters, options?: IdentityProviderUpdateOptionalParams): Promise<IdentityProviderUpdateResponse>

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

identityProviderName

string

Identity Provider Type identifier.

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.

parameters
IdentityProviderUpdateParameters

Update parameters.

options
IdentityProviderUpdateOptionalParams

The options parameters.

Returns

Promise<IdentityProviderUpdateResponse>