IdentityProvider interface

Пакет:

@azure/arm-apimanagement

Интерфейс, представляющий IdentityProvider.

Методы

createOrUpdate(string, string, string, IdentityProviderCreateContract, IdentityProviderCreateOrUpdateOptionalParams)	Создает или обновляет конфигурацию IdentityProvider.
delete(string, string, string, string, IdentityProviderDeleteOptionalParams)	Удаляет конфигурацию указанного поставщика удостоверений.
get(string, string, string, IdentityProviderGetOptionalParams)	Возвращает сведения о конфигурации поставщика удостоверений, настроенного в указанном экземпляре службы.
getEntityTag(string, string, string, IdentityProviderGetEntityTagOptionalParams)	Возвращает версию состояния сущности (Etag) объекта identityProvider, указанного его идентификатором.
listByService(string, string, IdentityProviderListByServiceOptionalParams)	Возвращает коллекцию поставщиков удостоверений, настроенных в указанном экземпляре службы.
listSecrets(string, string, string, IdentityProviderListSecretsOptionalParams)	Возвращает сведения о секрете клиента поставщика удостоверений.
update(string, string, string, string, IdentityProviderUpdateParameters, IdentityProviderUpdateOptionalParams)	Обновления существующую конфигурацию IdentityProvider.

Сведения о методе

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

Создает или обновляет конфигурацию IdentityProvider.

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

Параметры

resourceGroupName

string

Имя группы ресурсов. Регистр букв в имени не учитывается.

serviceName

string

Имя службы Управление API.

identityProviderName

string

Идентификатор типа поставщика удостоверений.

parameters

IdentityProviderCreateContract

Создайте параметры.

options

IdentityProviderCreateOrUpdateOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<IdentityProviderCreateOrUpdateResponse>

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

Удаляет конфигурацию указанного поставщика удостоверений.

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

Параметры

resourceGroupName

string

Имя группы ресурсов. Регистр букв в имени не учитывается.

serviceName

string

Имя службы Управление API.

identityProviderName

string

Идентификатор типа поставщика удостоверений.

ifMatch

string

ETag сущности. ETag должен соответствовать текущему состоянию сущности из ответа заголовка запроса GET или иметь значение * для безусловного обновления.

options

IdentityProviderDeleteOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<void>

get(string, string, string, IdentityProviderGetOptionalParams)

Возвращает сведения о конфигурации поставщика удостоверений, настроенного в указанном экземпляре службы.

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

Параметры

resourceGroupName

string

Имя группы ресурсов. Регистр букв в имени не учитывается.

serviceName

string

Имя службы Управление API.

identityProviderName

string

Идентификатор типа поставщика удостоверений.

options

IdentityProviderGetOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<IdentityProviderGetResponse>

getEntityTag(string, string, string, IdentityProviderGetEntityTagOptionalParams)

Возвращает версию состояния сущности (Etag) объекта identityProvider, указанного его идентификатором.

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

Параметры

resourceGroupName

string

Имя группы ресурсов. Регистр букв в имени не учитывается.

serviceName

string

Имя службы Управление API.

identityProviderName

string

Идентификатор типа поставщика удостоверений.

options

IdentityProviderGetEntityTagOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<IdentityProviderGetEntityTagHeaders>

listByService(string, string, IdentityProviderListByServiceOptionalParams)

Возвращает коллекцию поставщиков удостоверений, настроенных в указанном экземпляре службы.

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

Параметры

resourceGroupName

string

Имя группы ресурсов. Регистр букв в имени не учитывается.

serviceName

string

Имя службы Управление API.

options

IdentityProviderListByServiceOptionalParams

Параметры параметров.

Возвращаемое значение

PagedAsyncIterableIterator<IdentityProviderContract, IdentityProviderContract[], PageSettings>

listSecrets(string, string, string, IdentityProviderListSecretsOptionalParams)

Возвращает сведения о секрете клиента поставщика удостоверений.

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

Параметры

resourceGroupName

string

Имя группы ресурсов. Регистр букв в имени не учитывается.

serviceName

string

Имя службы Управление API.

identityProviderName

string

Идентификатор типа поставщика удостоверений.

options

IdentityProviderListSecretsOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<IdentityProviderListSecretsResponse>

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

Обновления существующую конфигурацию IdentityProvider.

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

Параметры

resourceGroupName

string

Имя группы ресурсов. Регистр букв в имени не учитывается.

serviceName

string

Имя службы Управление API.

identityProviderName

string

Идентификатор типа поставщика удостоверений.

ifMatch

string

ETag сущности. ETag должен соответствовать текущему состоянию сущности из ответа заголовка запроса GET или иметь значение * для безусловного обновления.

parameters

IdentityProviderUpdateParameters

Обновление параметров.

options

IdentityProviderUpdateOptionalParams

Параметры параметров.

Возвращаемое значение

Promise<IdentityProviderUpdateResponse>