AuthorizationProvider interface

Пакет:

@azure/arm-apimanagement

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

Методы

createOrUpdate(string, string, string, AuthorizationProviderContract, AuthorizationProviderCreateOrUpdateOptionalParams)	Создает или обновляет поставщик авторизации.
delete(string, string, string, string, AuthorizationProviderDeleteOptionalParams)	Удаляет конкретный поставщик авторизации из экземпляра службы Управление API.
get(string, string, string, AuthorizationProviderGetOptionalParams)	Возвращает сведения о поставщике авторизации, заданном его идентификатором.
listByService(string, string, AuthorizationProviderListByServiceOptionalParams)	Перечисляет коллекцию поставщиков авторизации, определенных в экземпляре службы.

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

createOrUpdate(string, string, string, AuthorizationProviderContract, AuthorizationProviderCreateOrUpdateOptionalParams)

Создает или обновляет поставщик авторизации.

function createOrUpdate(resourceGroupName: string, serviceName: string, authorizationProviderId: string, parameters: AuthorizationProviderContract, options?: AuthorizationProviderCreateOrUpdateOptionalParams): Promise<AuthorizationProviderCreateOrUpdateResponse>

Параметры

resourceGroupName

string

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

serviceName

string

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

authorizationProviderId

string

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

parameters

AuthorizationProviderContract

Создание параметров.

options

AuthorizationProviderCreateOrUpdateOptionalParams

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

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

Promise<AuthorizationProviderCreateOrUpdateResponse>

delete(string, string, string, string, AuthorizationProviderDeleteOptionalParams)

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

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

Параметры

resourceGroupName

string

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

serviceName

string

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

authorizationProviderId

string

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

ifMatch

string

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

options

AuthorizationProviderDeleteOptionalParams

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

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

Promise<void>

get(string, string, string, AuthorizationProviderGetOptionalParams)

Возвращает сведения о поставщике авторизации, заданном его идентификатором.

function get(resourceGroupName: string, serviceName: string, authorizationProviderId: string, options?: AuthorizationProviderGetOptionalParams): Promise<AuthorizationProviderGetResponse>

Параметры

resourceGroupName

string

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

serviceName

string

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

authorizationProviderId

string

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

options

AuthorizationProviderGetOptionalParams

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

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

Promise<AuthorizationProviderGetResponse>

listByService(string, string, AuthorizationProviderListByServiceOptionalParams)

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

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

Параметры

resourceGroupName

string

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

serviceName

string

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

options

AuthorizationProviderListByServiceOptionalParams

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

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

PagedAsyncIterableIterator<AuthorizationProviderContract, AuthorizationProviderContract[], PageSettings>