OpenIdConnectProviderImpl | @azure/arm-apimanagement

Class containing OpenIdConnectProvider operations.

Hierarchy

OpenIdConnectProviderImpl

Implements

OpenIdConnectProvider

Index

Constructors

constructor

Methods

Constructors

constructor

new OpenIdConnectProviderImpl(client: ApiManagementClientContext): OpenIdConnectProviderImpl

- Defined in operations/openIdConnectProvider.ts:38
Initialize a new instance of the class OpenIdConnectProvider class.

Parameters
- client: ApiManagementClientContext
  
  Reference to the service client
Returns OpenIdConnectProviderImpl

Methods

createOrUpdate

createOrUpdate(resourceGroupName: string, serviceName: string, opid: string, parameters: OpenidConnectProviderContract, options?: OpenIdConnectProviderCreateOrUpdateOptionalParams): Promise<OpenIdConnectProviderCreateOrUpdateResponse>

Implementation of OpenIdConnectProvider.createOrUpdate
- Defined in operations/openIdConnectProvider.ts:182
Creates or updates the OpenID Connect Provider.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- opid: string
  
  Identifier of the OpenID Connect Provider.
- parameters: OpenidConnectProviderContract
  
  Create parameters.
- Optional options: OpenIdConnectProviderCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<OpenIdConnectProviderCreateOrUpdateResponse>

delete

delete(resourceGroupName: string, serviceName: string, opid: string, ifMatch: string, options?: OpenIdConnectProviderDeleteOptionalParams): Promise<void>

Implementation of OpenIdConnectProvider.delete
- Defined in operations/openIdConnectProvider.ts:228
Deletes specific OpenID Connect Provider of the API Management service instance.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- opid: string
  
  Identifier of the OpenID Connect 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.
- Optional options: OpenIdConnectProviderDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

get

get(resourceGroupName: string, serviceName: string, opid: string, options?: OpenIdConnectProviderGetOptionalParams): Promise<OpenIdConnectProviderGetResponse>

Implementation of OpenIdConnectProvider.get
- Defined in operations/openIdConnectProvider.ts:162
Gets specific OpenID Connect Provider without secrets.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- opid: string
  
  Identifier of the OpenID Connect Provider.
- Optional options: OpenIdConnectProviderGetOptionalParams
  
  The options parameters.
Returns Promise<OpenIdConnectProviderGetResponse>

getEntityTag

getEntityTag(resourceGroupName: string, serviceName: string, opid: string, options?: OpenIdConnectProviderGetEntityTagOptionalParams): Promise<OpenIdConnectProviderGetEntityTagResponse>

Implementation of OpenIdConnectProvider.getEntityTag
- Defined in operations/openIdConnectProvider.ts:143
Gets the entity state (Etag) version of the openIdConnectProvider specified by its identifier.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- opid: string
  
  Identifier of the OpenID Connect Provider.
- Optional options: OpenIdConnectProviderGetEntityTagOptionalParams
  
  The options parameters.
Returns Promise<OpenIdConnectProviderGetEntityTagResponse>

listByService

listByService(resourceGroupName: string, serviceName: string, options?: OpenIdConnectProviderListByServiceOptionalParams): PagedAsyncIterableIterator<OpenidConnectProviderContract>

Implementation of OpenIdConnectProvider.listByService
- Defined in operations/openIdConnectProvider.ts:54
Lists of all the OpenId Connect Providers.

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

listSecrets

listSecrets(resourceGroupName: string, serviceName: string, opid: string, options?: OpenIdConnectProviderListSecretsOptionalParams): Promise<OpenIdConnectProviderListSecretsResponse>

Implementation of OpenIdConnectProvider.listSecrets
- Defined in operations/openIdConnectProvider.ts:248
Gets the client secret details of the OpenID Connect Provider.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- opid: string
  
  Identifier of the OpenID Connect Provider.
- Optional options: OpenIdConnectProviderListSecretsOptionalParams
  
  The options parameters.
Returns Promise<OpenIdConnectProviderListSecretsResponse>

update

update(resourceGroupName: string, serviceName: string, opid: string, ifMatch: string, parameters: OpenidConnectProviderUpdateContract, options?: OpenIdConnectProviderUpdateOptionalParams): Promise<OpenIdConnectProviderUpdateResponse>

Implementation of OpenIdConnectProvider.update
- Defined in operations/openIdConnectProvider.ts:205
Updates the specific OpenID Connect Provider.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- opid: string
  
  Identifier of the OpenID Connect 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.
- parameters: OpenidConnectProviderUpdateContract
  
  Update parameters.
- Optional options: OpenIdConnectProviderUpdateOptionalParams
  
  The options parameters.
Returns Promise<OpenIdConnectProviderUpdateResponse>

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: ApiManagementClientContext

Returns OpenIdConnectProviderImpl

Methods

createOrUpdate

Parameters

resourceGroupName: string

serviceName: string

opid: string

parameters: OpenidConnectProviderContract

Optional options: OpenIdConnectProviderCreateOrUpdateOptionalParams

Returns Promise<OpenIdConnectProviderCreateOrUpdateResponse>

delete

Parameters

resourceGroupName: string

serviceName: string

opid: string

ifMatch: string

Optional options: OpenIdConnectProviderDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

serviceName: string

opid: string

Optional options: OpenIdConnectProviderGetOptionalParams

Returns Promise<OpenIdConnectProviderGetResponse>

getEntityTag

Parameters

resourceGroupName: string

serviceName: string

opid: string

Optional options: OpenIdConnectProviderGetEntityTagOptionalParams

Returns Promise<OpenIdConnectProviderGetEntityTagResponse>

listByService

Parameters

resourceGroupName: string

serviceName: string

Optional options: OpenIdConnectProviderListByServiceOptionalParams

Returns PagedAsyncIterableIterator<OpenidConnectProviderContract>

listSecrets

Parameters

resourceGroupName: string

serviceName: string

opid: string

Optional options: OpenIdConnectProviderListSecretsOptionalParams

Returns Promise<OpenIdConnectProviderListSecretsResponse>

update

Parameters

resourceGroupName: string

serviceName: string

opid: string

ifMatch: string

parameters: OpenidConnectProviderUpdateContract

Optional options: OpenIdConnectProviderUpdateOptionalParams

Returns Promise<OpenIdConnectProviderUpdateResponse>