Policy interface
Интерфейс, представляющий политику.
Методы
create |
Создает или обновляет конфигурацию глобальной политики службы управления API. |
delete(string, string, string, string, Policy |
Удаляет конфигурацию глобальной политики службы управления API. |
get(string, string, string, Policy |
Получение определения глобальной политики службы управления API. |
get |
Возвращает версию состояния сущности (Etag) определения глобальной политики в службе управления API. |
list |
Перечисляет все определения глобальных политик службы управления API. |
Сведения о методе
createOrUpdate(string, string, string, PolicyContract, PolicyCreateOrUpdateOptionalParams)
Создает или обновляет конфигурацию глобальной политики службы управления API.
function createOrUpdate(resourceGroupName: string, serviceName: string, policyId: string, parameters: PolicyContract, options?: PolicyCreateOrUpdateOptionalParams): Promise<PolicyCreateOrUpdateResponse>
Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- policyId
-
string
Идентификатор политики.
- parameters
- PolicyContract
Содержимое политики для применения.
Параметры параметров.
Возвращаемое значение
Promise<PolicyCreateOrUpdateResponse>
delete(string, string, string, string, PolicyDeleteOptionalParams)
Удаляет конфигурацию глобальной политики службы управления API.
function delete(resourceGroupName: string, serviceName: string, policyId: string, ifMatch: string, options?: PolicyDeleteOptionalParams): Promise<void>
Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- policyId
-
string
Идентификатор политики.
- ifMatch
-
string
ETag сущности. ETag должен соответствовать текущему состоянию сущности из ответа заголовка запроса GET или иметь значение * для безусловного обновления.
- options
- PolicyDeleteOptionalParams
Параметры параметров.
Возвращаемое значение
Promise<void>
get(string, string, string, PolicyGetOptionalParams)
Получение определения глобальной политики службы управления API.
function get(resourceGroupName: string, serviceName: string, policyId: string, options?: PolicyGetOptionalParams): Promise<PolicyGetResponse>
Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- policyId
-
string
Идентификатор политики.
- options
- PolicyGetOptionalParams
Параметры параметров.
Возвращаемое значение
Promise<PolicyGetResponse>
getEntityTag(string, string, string, PolicyGetEntityTagOptionalParams)
Возвращает версию состояния сущности (Etag) определения глобальной политики в службе управления API.
function getEntityTag(resourceGroupName: string, serviceName: string, policyId: string, options?: PolicyGetEntityTagOptionalParams): Promise<PolicyGetEntityTagHeaders>
Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
- policyId
-
string
Идентификатор политики.
- options
- PolicyGetEntityTagOptionalParams
Параметры параметров.
Возвращаемое значение
Promise<PolicyGetEntityTagHeaders>
listByService(string, string, PolicyListByServiceOptionalParams)
Перечисляет все определения глобальных политик службы управления API.
function listByService(resourceGroupName: string, serviceName: string, options?: PolicyListByServiceOptionalParams): Promise<PolicyCollection>
Параметры
- resourceGroupName
-
string
Имя группы ресурсов. Регистр букв в имени не учитывается.
- serviceName
-
string
Имя службы Управление API.
Параметры параметров.
Возвращаемое значение
Promise<PolicyCollection>