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-область.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-ApiRevision

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

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Context

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

Type:	PsApiManagementContext
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-DefaultProfile

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

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	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. Это необязательный параметр.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-OperationId

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

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-PassThru

passthru

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Policy

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

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-PolicyFilePath

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

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-PolicyUrl

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

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-ProductId

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

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

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

PsApiManagementContext

String

SwitchParameter

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

Boolean