IdentityProvider interface

Balíček:

@azure/arm-apimanagement

Rozhraní představující IdentityProvider.

Metody

createOrUpdate(string, string, string, IdentityProviderCreateContract, IdentityProviderCreateOrUpdateOptionalParams)	Vytvoří nebo Aktualizace konfiguraci IdentityProvider.
delete(string, string, string, string, IdentityProviderDeleteOptionalParams)	Odstraní konfiguraci zadaného zprostředkovatele identity.
get(string, string, string, IdentityProviderGetOptionalParams)	Získá podrobnosti konfigurace zprostředkovatele identity nakonfigurované v zadané instanci služby.
getEntityTag(string, string, string, IdentityProviderGetEntityTagOptionalParams)	Získá stav entity (Etag) verze identityProvider určený jeho identifikátor.
listByService(string, string, IdentityProviderListByServiceOptionalParams)	Vypíše kolekci zprostředkovatele identity nakonfigurovanou v zadané instanci služby.
listSecrets(string, string, string, IdentityProviderListSecretsOptionalParams)	Získá podrobnosti tajného klíče klienta zprostředkovatele identity.
update(string, string, string, string, IdentityProviderUpdateParameters, IdentityProviderUpdateOptionalParams)	Aktualizace existující konfiguraci IdentityProvider.

Podrobnosti metody

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

Vytvoří nebo Aktualizace konfiguraci IdentityProvider.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

serviceName

string

Název služby Gestione API.

identityProviderName

string

Identifikátor typu zprostředkovatele identity.

parameters

IdentityProviderCreateContract

Vytvořte parametry.

options

IdentityProviderCreateOrUpdateOptionalParams

Parametry možností.

Návraty

Promise<IdentityProviderCreateOrUpdateResponse>

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

Odstraní konfiguraci zadaného zprostředkovatele identity.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

serviceName

string

Název služby Gestione API.

identityProviderName

string

Identifikátor typu zprostředkovatele identity.

ifMatch

string

Značka ETag entity. Značka ETag by měla odpovídat aktuálnímu stavu entity z odpovědi hlavičky požadavku GET nebo by měla být * pro nepodmíněnou aktualizaci.

options

IdentityProviderDeleteOptionalParams

Parametry možností.

Návraty

Promise<void>

get(string, string, string, IdentityProviderGetOptionalParams)

Získá podrobnosti konfigurace zprostředkovatele identity nakonfigurované v zadané instanci služby.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

serviceName

string

Název služby Gestione API.

identityProviderName

string

Identifikátor typu zprostředkovatele identity.

options

IdentityProviderGetOptionalParams

Parametry možností.

Návraty

Promise<IdentityProviderGetResponse>

getEntityTag(string, string, string, IdentityProviderGetEntityTagOptionalParams)

Získá stav entity (Etag) verze identityProvider určený jeho identifikátor.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

serviceName

string

Název služby Gestione API.

identityProviderName

string

Identifikátor typu zprostředkovatele identity.

options

IdentityProviderGetEntityTagOptionalParams

Parametry možností.

Návraty

Promise<IdentityProviderGetEntityTagHeaders>

listByService(string, string, IdentityProviderListByServiceOptionalParams)

Vypíše kolekci zprostředkovatele identity nakonfigurovanou v zadané instanci služby.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

serviceName

string

Název služby Gestione API.

options

IdentityProviderListByServiceOptionalParams

Parametry možností.

Návraty

PagedAsyncIterableIterator<IdentityProviderContract, IdentityProviderContract[], PageSettings>

listSecrets(string, string, string, IdentityProviderListSecretsOptionalParams)

Získá podrobnosti tajného klíče klienta zprostředkovatele identity.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

serviceName

string

Název služby Gestione API.

identityProviderName

string

Identifikátor typu zprostředkovatele identity.

options

IdentityProviderListSecretsOptionalParams

Parametry možností.

Návraty

Promise<IdentityProviderListSecretsResponse>

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

Aktualizace existující konfiguraci IdentityProvider.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

serviceName

string

Název služby Gestione API.

identityProviderName

string

Identifikátor typu zprostředkovatele identity.

ifMatch

string

Značka ETag entity. Značka ETag by měla odpovídat aktuálnímu stavu entity z odpovědi hlavičky požadavku GET nebo by měla být * pro nepodmíněnou aktualizaci.

parameters

IdentityProviderUpdateParameters

Aktualizujte parametry.

options

IdentityProviderUpdateOptionalParams

Parametry možností.

Návraty

Promise<IdentityProviderUpdateResponse>