Partilhar via

New-AzApiManagementApiVersionSet

  • Referência
Módulo:
Az.ApiManagement

Cria um conjunto de versões da API.

Syntax

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

Description

O cmdlet New-AzApiManagementApiVersionSet cria uma entidade do conjunto de Versão da API no contexto de Gerenciamento de API do Azure.

Exemplos

Exemplo 1

$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
New-AzApiManagementApiVersionSet -Context $ApiMgmtContext  -Name "newversion" -Scheme Header -HeaderName "x-ms-version" -Description "version by xmsversion"

ApiVersionSetId   : ea9a87cd-a699-4a75-bf7d-909846b91268
Description       : version by xmsversion
VersionQueryName  :
VersionHeaderName : x-ms-version
DisplayName       : newversion
VersioningScheme  : Header
Id                : /subscriptions/subid/resourceGroups/Api-Default-WestUS/providers/Microsoft.ApiManagement/service/contoso/api-version-sets/ea9a87cd-a699-4a75-bf7d-909846b91268
ResourceGroupName : Api-Default-WestUS
ServiceName       : contoso

Este comando cria um conjunto de versões da API qual esquema Query de controle de versão e parâmetro api-versionQuery .

Parâmetros

-ApiVersionSetId

Identificador do novo conjunto de versões da API. Este parâmetro é opcional. Se não for especificado, será gerado um identificador.

Tipo:String
Position:Named
valor predefinido:None
Necessário:False
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

Solicita a sua confirmação antes de executar o cmdlet.

Tipo:SwitchParameter
Aliases:cf
Position:Named
valor predefinido:None
Necessário:False
Accept pipeline input:False
Accept wildcard characters:False

-Context

Instância de PsApiManagementContext. Este parâmetro é obrigatório.

Tipo:PsApiManagementContext
Position:Named
valor predefinido:None
Necessário:True
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

As credenciais, a conta, o locatário e a assinatura usados para comunicação com o Azure.

Tipo:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
valor predefinido:None
Necessário:False
Accept pipeline input:False
Accept wildcard characters:False

-Description

Descrição do conjunto de versões da api.

Tipo:String
Position:Named
valor predefinido:None
Necessário:False
Accept pipeline input:True
Accept wildcard characters:False

-HeaderName

O valor Header que conterá as informações de controle de versão. Se o versionamento Scheme HEADER for escolhido, esse valor deverá ser especificado.

Tipo:String
Position:Named
valor predefinido:None
Necessário:False
Accept pipeline input:True
Accept wildcard characters:False

-Name

O nome do conjunto ApiVersion. Este parâmetro é obrigatório.

Tipo:String
Position:Named
valor predefinido:None
Necessário:True
Accept pipeline input:True
Accept wildcard characters:False

-QueryName

O valor Query que conterá as informações de controle de versão. Se a Consulta de Esquema de Controle de Versão for escolhida, esse valor deverá ser especificado.

Tipo:String
Position:Named
valor predefinido:None
Necessário:False
Accept pipeline input:True
Accept wildcard characters:False

-Scheme

Esquema de versionamento a ser selecionado para o conjunto de versionamento de api. Este parâmetro é obrigatório.

Tipo:PsApiManagementVersioningScheme
valores aceites:Segment, Query, Header
Position:Named
valor predefinido:None
Necessário:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Apresenta o que aconteceria mediante a execução do cmdlet. O cmdlet não é executado.

Tipo:SwitchParameter
Aliases:wi
Position:Named
valor predefinido:None
Necessário:False
Accept pipeline input:False
Accept wildcard characters:False

Entradas

PsApiManagementContext

String

PsApiManagementVersioningScheme

Saídas

PsApiManagementApiVersionSet