IdentityProvider interface

Paket:

@azure/arm-apimanagement

Gränssnitt som representerar en IdentityProvider.

Metoder

createOrUpdate(string, string, string, IdentityProviderCreateContract, IdentityProviderCreateOrUpdateOptionalParams)	Skapar eller Uppdateringar IdentityProvider-konfigurationen.
delete(string, string, string, string, IdentityProviderDeleteOptionalParams)	Tar bort den angivna identitetsproviderkonfigurationen.
get(string, string, string, IdentityProviderGetOptionalParams)	Hämtar konfigurationsinformationen för identitetsprovidern som konfigurerats i den angivna tjänstinstansen.
getEntityTag(string, string, string, IdentityProviderGetEntityTagOptionalParams)	Hämtar entitetstillståndsversionen (Etag) för identitetprovidern som anges av dess identifierare.
listByService(string, string, IdentityProviderListByServiceOptionalParams)	Visar en samling identitetsprovider som konfigurerats i den angivna tjänstinstansen.
listSecrets(string, string, string, IdentityProviderListSecretsOptionalParams)	Hämtar klienthemlighetsinformationen för identitetsprovidern.
update(string, string, string, string, IdentityProviderUpdateParameters, IdentityProviderUpdateOptionalParams)	Uppdateringar en befintlig IdentityProvider-konfiguration.

Metodinformation

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

Skapar eller Uppdateringar IdentityProvider-konfigurationen.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

identityProviderName

string

Typidentifierare för identitetsprovider.

parameters

IdentityProviderCreateContract

Skapa parametrar.

options

IdentityProviderCreateOrUpdateOptionalParams

Alternativparametrarna.

Returer

Promise<IdentityProviderCreateOrUpdateResponse>

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

Tar bort den angivna identitetsproviderkonfigurationen.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

identityProviderName

string

Typidentifierare för identitetsprovider.

ifMatch

string

ETag för entiteten. ETag ska matcha det aktuella entitetstillståndet från huvudsvaret för GET-begäran, eller så bör det vara * för ovillkorlig uppdatering.

options

IdentityProviderDeleteOptionalParams

Alternativparametrarna.

Returer

Promise<void>

get(string, string, string, IdentityProviderGetOptionalParams)

Hämtar konfigurationsinformationen för identitetsprovidern som konfigurerats i den angivna tjänstinstansen.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

identityProviderName

string

Typidentifierare för identitetsprovider.

options

IdentityProviderGetOptionalParams

Alternativparametrarna.

Returer

Promise<IdentityProviderGetResponse>

getEntityTag(string, string, string, IdentityProviderGetEntityTagOptionalParams)

Hämtar entitetstillståndsversionen (Etag) för identitetprovidern som anges av dess identifierare.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

identityProviderName

string

Typidentifierare för identitetsprovider.

options

IdentityProviderGetEntityTagOptionalParams

Alternativparametrarna.

Returer

Promise<IdentityProviderGetEntityTagHeaders>

listByService(string, string, IdentityProviderListByServiceOptionalParams)

Visar en samling identitetsprovider som konfigurerats i den angivna tjänstinstansen.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

options

IdentityProviderListByServiceOptionalParams

Alternativparametrarna.

Returer

PagedAsyncIterableIterator<IdentityProviderContract, IdentityProviderContract[], PageSettings>

listSecrets(string, string, string, IdentityProviderListSecretsOptionalParams)

Hämtar klienthemlighetsinformationen för identitetsprovidern.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

identityProviderName

string

Typidentifierare för identitetsprovider.

options

IdentityProviderListSecretsOptionalParams

Alternativparametrarna.

Returer

Promise<IdentityProviderListSecretsResponse>

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

Uppdateringar en befintlig IdentityProvider-konfiguration.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName

string

Namnet på API Management-tjänsten.

identityProviderName

string

Typidentifierare för identitetsprovider.

ifMatch

string

ETag för entiteten. ETag ska matcha det aktuella entitetstillståndet från huvudsvaret för GET-begäran, eller så bör det vara * för ovillkorlig uppdatering.

parameters

IdentityProviderUpdateParameters

Uppdatera parametrar.

options

IdentityProviderUpdateOptionalParams

Alternativparametrarna.

Returer

Promise<IdentityProviderUpdateResponse>