ApiPolicy interface

Пакет:

@azure/arm-apimanagement

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

Методы

createOrUpdate(string, string, string, string, PolicyContract, ApiPolicyCreateOrUpdateOptionalParams)	Создает или обновляет конфигурацию политики для API.
delete(string, string, string, string, string, ApiPolicyDeleteOptionalParams)	Удаляет конфигурацию политики на уровне API.
get(string, string, string, string, ApiPolicyGetOptionalParams)	Получает конфигурацию политики на уровне API.
getEntityTag(string, string, string, string, ApiPolicyGetEntityTagOptionalParams)	Возвращает версию состояния сущности (Etag) политики API, указанной ее идентификатором.
listByApi(string, string, string, ApiPolicyListByApiOptionalParams)	Получает конфигурацию политики на уровне API.

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

createOrUpdate(string, string, string, string, PolicyContract, ApiPolicyCreateOrUpdateOptionalParams)

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

function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, policyId: string, parameters: PolicyContract, options?: ApiPolicyCreateOrUpdateOptionalParams): Promise<ApiPolicyCreateOrUpdateResponse>

Параметры

resourceGroupName

string

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

serviceName

string

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

apiId

string

Идентификатор редакции API. Должен быть уникальным в текущем экземпляре службы Управление API. Внешняя редакция имеет суффикс ;rev=n, где n — номер редакции.

policyId

string

Идентификатор политики.

parameters

PolicyContract

Содержимое политики для применения.

options

ApiPolicyCreateOrUpdateOptionalParams

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

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

Promise<ApiPolicyCreateOrUpdateResponse>

delete(string, string, string, string, string, ApiPolicyDeleteOptionalParams)

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

function delete(resourceGroupName: string, serviceName: string, apiId: string, policyId: string, ifMatch: string, options?: ApiPolicyDeleteOptionalParams): Promise<void>

Параметры

resourceGroupName

string

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

serviceName

string

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

apiId

string

Идентификатор редакции API. Должен быть уникальным в текущем экземпляре службы Управление API. Внешняя редакция имеет суффикс ;rev=n, где n — номер редакции.

policyId

string

Идентификатор политики.

ifMatch

string

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

options

ApiPolicyDeleteOptionalParams

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

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

Promise<void>

get(string, string, string, string, ApiPolicyGetOptionalParams)

Получает конфигурацию политики на уровне API.

function get(resourceGroupName: string, serviceName: string, apiId: string, policyId: string, options?: ApiPolicyGetOptionalParams): Promise<ApiPolicyGetResponse>

Параметры

resourceGroupName

string

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

serviceName

string

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

apiId

string

Идентификатор редакции API. Должен быть уникальным в текущем экземпляре службы Управление API. Внешняя редакция имеет суффикс ;rev=n, где n — номер редакции.

policyId

string

Идентификатор политики.

options

ApiPolicyGetOptionalParams

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

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

Promise<ApiPolicyGetResponse>

getEntityTag(string, string, string, string, ApiPolicyGetEntityTagOptionalParams)

Возвращает версию состояния сущности (Etag) политики API, указанной ее идентификатором.

function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, policyId: string, options?: ApiPolicyGetEntityTagOptionalParams): Promise<ApiPolicyGetEntityTagHeaders>

Параметры

resourceGroupName

string

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

serviceName

string

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

apiId

string

Идентификатор редакции API. Должен быть уникальным в текущем экземпляре службы Управление API. Внешняя редакция имеет суффикс ;rev=n, где n — номер редакции.

policyId

string

Идентификатор политики.

options

ApiPolicyGetEntityTagOptionalParams

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

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

Promise<ApiPolicyGetEntityTagHeaders>

listByApi(string, string, string, ApiPolicyListByApiOptionalParams)

Получает конфигурацию политики на уровне API.

function listByApi(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiPolicyListByApiOptionalParams): Promise<PolicyCollection>

Параметры

resourceGroupName

string

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

serviceName

string

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

apiId

string

Идентификатор редакции API. Должен быть уникальным в текущем экземпляре службы Управление API. Внешняя редакция имеет суффикс ;rev=n, где n — номер редакции.

options

ApiPolicyListByApiOptionalParams

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

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

Promise<PolicyCollection>