OpenIdConnectProvider interface

Package:

@azure/arm-apimanagement

Interface representing a OpenIdConnectProvider.

Methods

createOrUpdate(string, string, string, OpenidConnectProviderContract, OpenIdConnectProviderCreateOrUpdateOptionalParams)	Creates or updates the OpenID Connect Provider.
delete(string, string, string, string, OpenIdConnectProviderDeleteOptionalParams)	Deletes specific OpenID Connect Provider of the API Management service instance.
get(string, string, string, OpenIdConnectProviderGetOptionalParams)	Gets specific OpenID Connect Provider without secrets.
getEntityTag(string, string, string, OpenIdConnectProviderGetEntityTagOptionalParams)	Gets the entity state (Etag) version of the openIdConnectProvider specified by its identifier.
listByService(string, string, OpenIdConnectProviderListByServiceOptionalParams)	Lists of all the OpenId Connect Providers.
listSecrets(string, string, string, OpenIdConnectProviderListSecretsOptionalParams)	Gets the client secret details of the OpenID Connect Provider.
update(string, string, string, string, OpenidConnectProviderUpdateContract, OpenIdConnectProviderUpdateOptionalParams)	Updates the specific OpenID Connect Provider.

Method Details

createOrUpdate(string, string, string, OpenidConnectProviderContract, OpenIdConnectProviderCreateOrUpdateOptionalParams)

Creates or updates the OpenID Connect Provider.

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

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

opid

string

Identifier of the OpenID Connect Provider.

parameters

OpenidConnectProviderContract

Create parameters.

options

OpenIdConnectProviderCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<OpenIdConnectProviderCreateOrUpdateResponse>

delete(string, string, string, string, OpenIdConnectProviderDeleteOptionalParams)

Deletes specific OpenID Connect Provider of the API Management service instance.

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

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.

options

OpenIdConnectProviderDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, OpenIdConnectProviderGetOptionalParams)

Gets specific OpenID Connect Provider without secrets.

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

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

opid

string

Identifier of the OpenID Connect Provider.

options

OpenIdConnectProviderGetOptionalParams

The options parameters.

Returns

Promise<OpenIdConnectProviderGetResponse>

getEntityTag(string, string, string, OpenIdConnectProviderGetEntityTagOptionalParams)

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

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

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

opid

string

Identifier of the OpenID Connect Provider.

options

OpenIdConnectProviderGetEntityTagOptionalParams

The options parameters.

Returns

Promise<OpenIdConnectProviderGetEntityTagHeaders>

listByService(string, string, OpenIdConnectProviderListByServiceOptionalParams)

Lists of all the OpenId Connect Providers.

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

OpenIdConnectProviderListByServiceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<OpenidConnectProviderContract, OpenidConnectProviderContract[], PageSettings>

listSecrets(string, string, string, OpenIdConnectProviderListSecretsOptionalParams)

Gets the client secret details of the OpenID Connect Provider.

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

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

opid

string

Identifier of the OpenID Connect Provider.

options

OpenIdConnectProviderListSecretsOptionalParams

The options parameters.

Returns

Promise<OpenIdConnectProviderListSecretsResponse>

update(string, string, string, string, OpenidConnectProviderUpdateContract, OpenIdConnectProviderUpdateOptionalParams)

Updates the specific OpenID Connect Provider.

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

Parameters

resourceGroupName

string

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

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.

options

OpenIdConnectProviderUpdateOptionalParams

The options parameters.

Returns

Promise<OpenIdConnectProviderUpdateResponse>