Поделиться через

Set-AzApiManagementPolicy

  • Ссылка
Модуль:
Az.ApiManagement

Задает указанную политику области для управления API.

Синтаксис

Set-AzApiManagementPolicy
   -Context <PsApiManagementContext>
   [-Format <String>]
   [-Policy <String>]
   [-PolicyFilePath <String>]
   [-PolicyUrl <String>]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Set-AzApiManagementPolicy
   -Context <PsApiManagementContext>
   [-Format <String>]
   -ProductId <String>
   [-Policy <String>]
   [-PolicyFilePath <String>]
   [-PolicyUrl <String>]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Set-AzApiManagementPolicy
   -Context <PsApiManagementContext>
   [-Format <String>]
   -ApiId <String>
   [-ApiRevision <String>]
   [-Policy <String>]
   [-PolicyFilePath <String>]
   [-PolicyUrl <String>]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Set-AzApiManagementPolicy
   -Context <PsApiManagementContext>
   [-Format <String>]
   -ApiId <String>
   [-ApiRevision <String>]
   -OperationId <String>
   [-Policy <String>]
   [-PolicyFilePath <String>]
   [-PolicyUrl <String>]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Описание

Командлет Set-AzApiManagementPolicy задает указанную политику области для управления API.

Примеры

Пример 1. Настройка политики уровня клиента

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Set-AzApiManagementPolicy -Context $apimContext -PolicyFilePath "C:\contoso\policies\tenantpolicy.xml"

Эта команда задает политику уровня клиента из файла с именем tenantpolicy.xml.

Пример 2. Настройка политики области продукта

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Set-AzApiManagementPolicy -Context $apimContext -ProductId "0123456789" -Policy $PolicyString

Эта команда задает политику области продукта для управления API.

Пример 3. Настройка политики области API

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Set-AzApiManagementPolicy -Context $apimContext -ApiId "9876543210" -Policy $PolicyString

Эта команда задает политику области API для управления API.

Пример 4. Настройка политики области операций

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Set-AzApiManagementPolicy -Context $apimContext -ApiId "9876543210" -OperationId "777" -Policy $PolicyString

Эта команда задает политику области операций для управления API.

Параметры

-ApiId

Указывает идентификатор существующего API. Если указать этот параметр, командлет задает политику области API.

Тип:String
Position:Named
Default value:None
Обязательно:True
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-ApiRevision

Идентификатор редакции API. Этот параметр является необязательным. Если это не указано, политика будет обновлена в текущей активной редакции API.

Тип:String
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-Context

Указывает экземпляр PsApiManagementContext.

Тип:PsApiManagementContext
Position:Named
Default value:None
Обязательно:True
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-DefaultProfile

Учетные данные, учетная запись, клиент и подписка, используемые для обмена данными с Azure.

Тип:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-Format

Задает формат политики. При использовании application/vnd.ms-azure-apim.policy+xmlвыражения, содержащиеся в политике, должны быть экранированы XML-файлом. При использовании application/vnd.ms-azure-apim.policy.raw+xmlне, необходимых для использования политики с экранированием XML. Значение по умолчанию — application/vnd.ms-azure-apim.policy+xml. Этот параметр является необязательным.

Тип:String
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-OperationId

Указывает идентификатор существующей операции. Если задан apiId, политика области операций будет задана. Эти параметры необходимы.

Тип:String
Position:Named
Default value:None
Обязательно:True
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-PassThru

passthru

Тип:SwitchParameter
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-Policy

Указывает документ политики в виде строки. Этот параметр требуется, еслиPolicyFilePath не указан.

Тип:String
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-PolicyFilePath

Указывает путь к файлу документа политики. Этот параметр требуется, если параметр политики не указан.

Тип:String
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-PolicyUrl

URL-адрес, в котором размещен документ политики. Этот параметр требуется, если -Policy или -PolicyFilePath не указан.

Тип:String
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-ProductId

Указывает идентификатор существующего продукта. Если этот параметр указан, командлет задает политику области продукта.

Тип:String
Position:Named
Default value:None
Обязательно:True
Принять входные данные конвейера:True
Принять подстановочные знаки:False

Входные данные

PsApiManagementContext

String

SwitchParameter

Выходные данные

Boolean