ApiOperationPolicy interface
Интерфейс, представляющий ApiOperationPolicy.
Методы
| create |
Создает или обновляет конфигурацию политики для уровня операций API. |
| delete(string, string, string, string, string, string, Api |
Удаляет конфигурацию политики на уровне операций API. |
| get(string, string, string, string, string, Api |
Получите конфигурацию политики на уровне операции API. |
| get |
Возвращает версию состояния сущности (Etag) политики операций API, указанной ее идентификатором. |
| list |
Получает список конфигураций политики на уровне операций API. |
Сведения о методе
createOrUpdate(string, string, string, string, string, PolicyContract, ApiOperationPolicyCreateOrUpdateOptionalParams)
Создает или обновляет конфигурацию политики для уровня операций API.
function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, policyId: string, parameters: PolicyContract, options?: ApiOperationPolicyCreateOrUpdateOptionalParams): Promise<ApiOperationPolicyCreateOrUpdateResponse>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- apiId
-
string
Идентификатор редакции API. Должен быть уникальным в текущем экземпляре службы Управление API. Внешняя редакция имеет суффикс ;rev=n, где n — номер редакции.
- operationId
-
string
Идентификатор операции в API. Должен быть уникальным в текущем экземпляре службы Управление API.
- policyId
-
string
Идентификатор политики.
- parameters
- PolicyContract
Содержимое политики для применения.
Параметры параметров.
Возвращаемое значение
delete(string, string, string, string, string, string, ApiOperationPolicyDeleteOptionalParams)
Удаляет конфигурацию политики на уровне операций API.
function delete(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, policyId: string, ifMatch: string, options?: ApiOperationPolicyDeleteOptionalParams): Promise<void>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- apiId
-
string
Идентификатор редакции API. Должен быть уникальным в текущем экземпляре службы Управление API. Внешняя редакция имеет суффикс ;rev=n, где n — номер редакции.
- operationId
-
string
Идентификатор операции в API. Должен быть уникальным в текущем экземпляре службы Управление API.
- policyId
-
string
Идентификатор политики.
- ifMatch
-
string
ETag сущности. ETag должен соответствовать текущему состоянию сущности из ответа заголовка запроса GET или иметь значение * для безусловного обновления.
Параметры параметров.
Возвращаемое значение
Promise<void>
get(string, string, string, string, string, ApiOperationPolicyGetOptionalParams)
Получите конфигурацию политики на уровне операции API.
function get(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, policyId: string, options?: ApiOperationPolicyGetOptionalParams): Promise<ApiOperationPolicyGetResponse>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- apiId
-
string
Идентификатор редакции API. Должен быть уникальным в текущем экземпляре службы Управление API. Внешняя редакция имеет суффикс ;rev=n, где n — номер редакции.
- operationId
-
string
Идентификатор операции в API. Должен быть уникальным в текущем экземпляре службы Управление API.
- policyId
-
string
Идентификатор политики.
Параметры параметров.
Возвращаемое значение
Promise<ApiOperationPolicyGetResponse>
getEntityTag(string, string, string, string, string, ApiOperationPolicyGetEntityTagOptionalParams)
Возвращает версию состояния сущности (Etag) политики операций API, указанной ее идентификатором.
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, policyId: string, options?: ApiOperationPolicyGetEntityTagOptionalParams): Promise<ApiOperationPolicyGetEntityTagHeaders>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- apiId
-
string
Идентификатор редакции API. Должен быть уникальным в текущем экземпляре службы Управление API. Внешняя редакция имеет суффикс ;rev=n, где n — номер редакции.
- operationId
-
string
Идентификатор операции в API. Должен быть уникальным в текущем экземпляре службы Управление API.
- policyId
-
string
Идентификатор политики.
Параметры параметров.
Возвращаемое значение
listByOperation(string, string, string, string, ApiOperationPolicyListByOperationOptionalParams)
Получает список конфигураций политики на уровне операций API.
function listByOperation(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, options?: ApiOperationPolicyListByOperationOptionalParams): Promise<PolicyCollection>Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- apiId
-
string
Идентификатор редакции API. Должен быть уникальным в текущем экземпляре службы Управление API. Внешняя редакция имеет суффикс ;rev=n, где n — номер редакции.
- operationId
-
string
Идентификатор операции в API. Должен быть уникальным в текущем экземпляре службы Управление API.
Параметры параметров.
Возвращаемое значение
Promise<PolicyCollection>