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

Get-AzApiManagementPolicy

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

Возвращает указанную политику области.

Синтаксис

Get-AzApiManagementPolicy
   -Context <PsApiManagementContext>
   [-Format <String>]
   [-SaveAs <String>]
   [-Force]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Get-AzApiManagementPolicy
   -Context <PsApiManagementContext>
   [-Format <String>]
   [-SaveAs <String>]
   -ProductId <String>
   [-Force]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Get-AzApiManagementPolicy
   -Context <PsApiManagementContext>
   [-Format <String>]
   [-SaveAs <String>]
   -ApiId <String>
   [-ApiRevision <String>]
   [-Force]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Get-AzApiManagementPolicy
   -Context <PsApiManagementContext>
   [-Format <String>]
   [-SaveAs <String>]
   -ApiId <String>
   [-ApiRevision <String>]
   -OperationId <String>
   [-Force]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Описание

Командлет get-AzApiManagementPolicy получает указанную политику области.

Примеры

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

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

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

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

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

Эта команда получает политику области продукта

Пример 3. Получение политики области API

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

Эта команда получает политику области API.

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

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

Эта команда получает политику области операций.

Пример 5. Получение политики области клиента в формате RawXml

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Get-AzApiManagementPolicy -Context $apimContext -Format rawxml

<policies>
        <inbound>
                <set-header name="correlationid" exists-action="skip">
                        <value>@{
                var guidBinary = new byte[16];
                Array.Copy(Guid.NewGuid().ToByteArray(), 0, guidBinary, 0, 10);
                long time = DateTime.Now.Ticks;
                byte[] bytes = new byte[6];
                unchecked
                {
                       bytes[5] = (byte)(time >> 40);
                       bytes[4] = (byte)(time >> 32);
                       bytes[3] = (byte)(time >> 24);
                       bytes[2] = (byte)(time >> 16);
                       bytes[1] = (byte)(time >> 8);
                       bytes[0] = (byte)(time);
                }
                Array.Copy(bytes, 0, guidBinary, 10, 6);
                return new Guid(guidBinary).ToString();
            }
            </value>
                </set-header>
        </inbound>
        <backend>
                <forward-request />
        </backend>
        <outbound />
        <on-error />
</policies>

Эта команда получает политику области клиента в формате, отличном от XML.

Параметры

-ApiId

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

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

-ApiRevision

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

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

-Confirm

Запрашивает подтверждение перед запуском командлета.

Тип:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки: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

-Force

ps_force

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

-Format

Задает формат политики управления API. Значение по умолчанию для этого параметра — xml.

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

-OperationId

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

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

-ProductId

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

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

-SaveAs

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

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

-WhatIf

Показывает, что произойдет, если командлет выполняется. Командлет не выполняется.

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

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

PsApiManagementContext

String

SwitchParameter

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

String