Set-AzApiManagementApiVersionSet

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

Обновления набор версий API в контексте Управление API.

Синтаксис

Set-AzApiManagementApiVersionSet
   -Context <PsApiManagementContext>
   -ApiVersionSetId <String>
   [-Name <String>]
   [-Scheme <PsApiManagementVersioningScheme>]
   [-HeaderName <String>]
   [-QueryName <String>]
   [-Description <String>]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-AzApiManagementApiVersionSet
   -InputObject <PsApiManagementApiVersionSet>
   [-Name <String>]
   [-Scheme <PsApiManagementVersioningScheme>]
   [-HeaderName <String>]
   [-QueryName <String>]
   [-Description <String>]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Описание

Командлет Set-AzApiManagementApiVersionSet изменяет набор версий API azure Управление API.

Примеры

Пример 1

$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Set-AzApiManagementApiVersionSet -Context $ApiMgmtContext -ApiVersionSetId "query-verion-set" -Scheme Header -HeaderName "api-version" -Description "Azure version header string"

Эта команда обновляет существующий набор версий API с схемой Header управления версиями и параметром api-versionзаголовка.

Параметры

-ApiVersionSetId

Идентификатор нового набора версий API.

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

Описание набора версий API.

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

-HeaderName

Значение заголовка, содержащее сведения о управление версиями. Если выбрана схема управления версиями, необходимо указать это значение.

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

-InputObject

Экземпляр PsApiManagementApiVersionSet. Этот параметр является обязательным.

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

-Name

Имя набора ApiVersion. Это необязательный параметр.

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

-PassThru

Если указан экземпляр Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiVersionSet, представляющий измененный apiVersionSet, будет записан в выходные данные.

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

-QueryName

Значение запроса, содержащее сведения о управление версиями. Если выбран запрос схемы управления версиями, необходимо указать это значение.

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

-Scheme

Схема управления версиями для набора версий API. Это необязательный параметр.

Type:PsApiManagementVersioningScheme
Accepted values:Segment, Query, Header
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

PsApiManagementApiVersionSet

String

PsApiManagementVersioningScheme

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

PsApiManagementApiVersionSet