Set-AzApiManagementProduct

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

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

Синтаксис

Set-AzApiManagementProduct
   -Context <PsApiManagementContext>
   -ProductId <String>
   [-Title <String>]
   [-Description <String>]
   [-LegalTerms <String>]
   [-SubscriptionRequired <Boolean>]
   [-ApprovalRequired <Boolean>]
   [-SubscriptionsLimit <Int32>]
   [-State <PsApiManagementProductState>]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Описание

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

Примеры

Пример 1. Обновление сведений о продукте

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Set-AzApiManagementProduct -Context $apimContext -ProductId "0123456789" -Title "Starter" -Description "Starter Product" -LegalTerms "Free for all" -SubscriptionRequired $True -State "NotPublished"

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

Параметры

-ApprovalRequired

Указывает, требуется ли утверждение подписки на продукт. Значение по умолчанию — $False.

Type:Nullable<T>[Boolean]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

Запрос подтверждения перед выполнением командлета.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
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

-Description

Указывает описание продукта.

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

-LegalTerms

Указывает юридические условия использования продукта.

Type:String
Position:Named
Default value:None
Required:False
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

-ProductId

Указывает идентификатор существующего продукта.

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

-State

Указывает состояние продукта. psdx_paramvalues

  • NotPublished
  • Опубликованные
Type:Nullable<T>[PsApiManagementProductState]
Accepted values:NotPublished, Published
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-SubscriptionRequired

Указывает, требуется ли продукту подписка. Значение по умолчанию для этого параметра — $True.

Type:Nullable<T>[Boolean]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-SubscriptionsLimit

Указывает максимальное количество одновременных подписок. Значение по умолчанию для этого параметра — None.

Type:Nullable<T>[Int32]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Title

Задает заголовок продукта, который задает наборы командлетов.

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

-WhatIf

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

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

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

PsApiManagementContext

String

Nullable<T>[[System.Boolean, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

Nullable<T>[[System.Int32, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

Nullable<T>[[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementProductState, Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]

SwitchParameter

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

PsApiManagementProduct