Share via

New-AzureRmApiManagementApiVersionSet

  • Riferimento
Modulo:
AzureRM.ApiManagement

Crea un set di versioni dell'API.

Avviso

Il modulo AzureRM PowerShell è stato ufficialmente deprecato a partire dal 29 febbraio 2024. È consigliabile eseguire la migrazione da AzureRM al modulo Az PowerShell per garantire il supporto e gli aggiornamenti continui.

Anche se il modulo AzureRM può ancora funzionare, non è più gestito o supportato, posizionando qualsiasi uso continuo a discrezione e rischio dell'utente. Per indicazioni sulla transizione al modulo Az, vedere le risorse di migrazione.

Sintassi

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

Descrizione

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

Esempio

Esempio 1

PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
PS C:\> New-AzureRmApiManagementApiVersionSet -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.

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

-Confirm

Richiede conferma prima di eseguire il cmdlet.

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

-Context

Istanza di PsApiManagementContext. Questo parametro è obbligatorio.

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

-DefaultProfile

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

Type:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Description

Descrizione del set di versioni dell'API.

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

-HeaderName

Valore header che conterrà le informazioni sul controllo delle versioni. Se si sceglie Intestazione schema di controllo delle versioni, è necessario specificare questo valore.

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

-Name

Nome del set ApiVersion. Questo parametro è obbligatorio.

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

-QueryName

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

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

Type:PsApiManagementVersioningScheme
Accepted values:Segment, Query, Header
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

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

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

Input

PsApiManagementContext

Parametri: Context (ByValue)

String

PsApiManagementVersioningScheme

Output

PsApiManagementApiVersionSet