IdentityProvider | @azure/arm-apimanagement

Interface representing a IdentityProvider.

Hierarchy

IdentityProvider

Implemented by

IdentityProviderImpl

Index

Methods

createOrUpdate

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

- Defined in operationsInterfaces/identityProvider.ts:77
Creates or Updates the IdentityProvider configuration.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- identityProviderName: IdentityProviderType
  
  Identity Provider Type identifier.
- parameters: IdentityProviderCreateContract
  
  Create parameters.
- Optional options: IdentityProviderCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<IdentityProviderCreateOrUpdateResponse>

delete

delete(resourceGroupName: string, serviceName: string, identityProviderName: IdentityProviderType, ifMatch: string, options?: IdentityProviderDeleteOptionalParams): Promise<void>

- Defined in operationsInterfaces/identityProvider.ts:111
Deletes the specified identity provider configuration.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- identityProviderName: IdentityProviderType
  
  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.
- Optional options: IdentityProviderDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

get

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

- Defined in operationsInterfaces/identityProvider.ts:63
Gets the configuration details of the identity Provider configured in specified service instance.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- identityProviderName: IdentityProviderType
  
  Identity Provider Type identifier.
- Optional options: IdentityProviderGetOptionalParams
  
  The options parameters.
Returns Promise<IdentityProviderGetResponse>

getEntityTag

getEntityTag(resourceGroupName: string, serviceName: string, identityProviderName: IdentityProviderType, options?: IdentityProviderGetEntityTagOptionalParams): Promise<IdentityProviderGetEntityTagResponse>

- Defined in operationsInterfaces/identityProvider.ts:50
Gets the entity state (Etag) version of the identityProvider specified by its identifier.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- identityProviderName: IdentityProviderType
  
  Identity Provider Type identifier.
- Optional options: IdentityProviderGetEntityTagOptionalParams
  
  The options parameters.
Returns Promise<IdentityProviderGetEntityTagResponse>

listByService

listByService(resourceGroupName: string, serviceName: string, options?: IdentityProviderListByServiceOptionalParams): PagedAsyncIterableIterator<IdentityProviderContract>

- Defined in operationsInterfaces/identityProvider.ts:38
Lists a collection of Identity Provider configured in the specified service instance.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- Optional options: IdentityProviderListByServiceOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<IdentityProviderContract>

listSecrets

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

- Defined in operationsInterfaces/identityProvider.ts:125
Gets the client secret details of the Identity Provider.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- identityProviderName: IdentityProviderType
  
  Identity Provider Type identifier.
- Optional options: IdentityProviderListSecretsOptionalParams
  
  The options parameters.
Returns Promise<IdentityProviderListSecretsResponse>

update

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

- Defined in operationsInterfaces/identityProvider.ts:94
Updates an existing IdentityProvider configuration.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- identityProviderName: IdentityProviderType
  
  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.
- Optional options: IdentityProviderUpdateOptionalParams
  
  The options parameters.
Returns Promise<IdentityProviderUpdateResponse>

Hierarchy

Implemented by

Index

Methods

Methods

createOrUpdate

Parameters

resourceGroupName: string

serviceName: string

identityProviderName: IdentityProviderType

parameters: IdentityProviderCreateContract

Optional options: IdentityProviderCreateOrUpdateOptionalParams

Returns Promise<IdentityProviderCreateOrUpdateResponse>

delete

Parameters

resourceGroupName: string

serviceName: string

identityProviderName: IdentityProviderType

ifMatch: string

Optional options: IdentityProviderDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

serviceName: string

identityProviderName: IdentityProviderType

Optional options: IdentityProviderGetOptionalParams

Returns Promise<IdentityProviderGetResponse>

getEntityTag

Parameters

resourceGroupName: string

serviceName: string

identityProviderName: IdentityProviderType

Optional options: IdentityProviderGetEntityTagOptionalParams

Returns Promise<IdentityProviderGetEntityTagResponse>

listByService

Parameters

resourceGroupName: string

serviceName: string

Optional options: IdentityProviderListByServiceOptionalParams

Returns PagedAsyncIterableIterator<IdentityProviderContract>

listSecrets

Parameters

resourceGroupName: string

serviceName: string

identityProviderName: IdentityProviderType

Optional options: IdentityProviderListSecretsOptionalParams

Returns Promise<IdentityProviderListSecretsResponse>

update

Parameters

resourceGroupName: string

serviceName: string

identityProviderName: IdentityProviderType

ifMatch: string

parameters: IdentityProviderUpdateParameters

Optional options: IdentityProviderUpdateOptionalParams

Returns Promise<IdentityProviderUpdateResponse>