Condividi tramite

New-AzApiManagementApiVersionSet

  • Riferimento
Modulo:
Az.ApiManagement

Crea un set di versioni dell'API.

Sintassi

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

Descrizione

Il cmdlet New-AzApiManagementApiVersionSet crea un'entità set di versioni API nel contesto di Azure Gestione API.

Esempio

Esempio 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

Questo comando crea un set di versioni dell'API che prevede lo schema Query di controllo delle versioni e il parametro api-versionquery .

Parametri

-ApiVersionSetId

Identificatore per il nuovo set di versioni dell'API. Il parametro è facoltativo. Se non specificato, verrà generato un identificatore.

Tipo:String
Position:Named
valore predefinito:None
Necessario:False
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

Richiede conferma prima di eseguire il cmdlet.

Tipo:SwitchParameter
Aliases:cf
Position:Named
valore predefinito:None
Necessario:False
Accept pipeline input:False
Accept wildcard characters:False

-Context

Istanza di PsApiManagementContext. Questo parametro è obbligatorio.

Tipo:PsApiManagementContext
Position:Named
valore predefinito:None
Necessario:True
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

Le credenziali, l’account, il tenant e la sottoscrizione usati per comunicare con Azure.

Tipo:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
valore predefinito:None
Necessario:False
Accept pipeline input:False
Accept wildcard characters:False

-Description

Descrizione del set di versioni dell'API.

Tipo:String
Position:Named
valore predefinito:None
Necessario:False
Accept pipeline input:True
Accept wildcard characters:False

-HeaderName

Valore header che conterrà le informazioni sul controllo delle versioni. Se si seleziona l'intestazione dello schema di controllo delle versioni, è necessario specificare questo valore.

Tipo:String
Position:Named
valore predefinito:None
Necessario:False
Accept pipeline input:True
Accept wildcard characters:False

-Name

Nome del set ApiVersion. Questo parametro è obbligatorio.

Tipo:String
Position:Named
valore predefinito:None
Necessario:True
Accept pipeline input:True
Accept wildcard characters:False

-QueryName

Valore query che conterrà le informazioni sul controllo delle versioni. Se si seleziona Query schema di controllo delle versioni, è necessario specificare questo valore.

Tipo:String
Position:Named
valore predefinito:None
Necessario:False
Accept pipeline input:True
Accept wildcard characters:False

-Scheme

Schema di controllo delle versioni da selezionare per il set di versioni api. Questo parametro è obbligatorio.

Tipo:PsApiManagementVersioningScheme
valori accettati:Segment, Query, Header
Position:Named
valore predefinito:None
Necessario:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Mostra gli effetti dell'esecuzione del cmdlet. Il cmdlet non viene eseguito.

Tipo:SwitchParameter
Aliases:wi
Position:Named
valore predefinito:None
Necessario:False
Accept pipeline input:False
Accept wildcard characters:False

Input

PsApiManagementContext

String

PsApiManagementVersioningScheme

Output

PsApiManagementApiVersionSet