New-AzureRmApiManagement
Crea una distribuzione Gestione 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-AzureRmApiManagement
-ResourceGroupName <String>
-Name <String>
-Location <String>
-Organization <String>
-AdminEmail <String>
[-Sku <PsApiManagementSku>]
[-Capacity <Int32>]
[-VpnType <PsApiManagementVpnType>]
[-VirtualNetwork <PsApiManagementVirtualNetwork>]
[-Tag <System.Collections.Generic.Dictionary`2[System.String,System.String]>]
[-AdditionalRegions <PsApiManagementRegion[]>]
[-CustomHostnameConfiguration <PsApiManagementCustomHostNameConfiguration[]>]
[-SystemCertificateConfiguration <PsApiManagementSystemCertificate[]>]
[-AssignIdentity]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Descrizione
Il cmdlet New-AzureRmApiManagement crea una distribuzione Gestione API in Azure Gestione API.
Esempio
Esempio 1: Creare un servizio di Gestione API livello sviluppatore
PS C:\>New-AzureRmApiManagement -ResourceGroupName "ContosoGroup02" -Name "ContosoApi" -Location "Central US" -Organization "Contoso" -AdminEmail "admin@contoso.com"Questo comando crea un servizio di Gestione API livello sviluppatore. Il comando specifica l'organizzazione e l'indirizzo dell'amministratore. Il comando non specifica il parametro SKU . Di conseguenza, il cmdlet usa il valore predefinito developer.
Esempio 2: Creare un servizio di livello Standard con tre unità
PS C:\>New-AzureRmApiManagement -ResourceGroupName "ContosoGroup02 -Name "ContosoApi" -Location "Central US" -Organization "Contoso" -AdminEmail "admin@contoso.com" -Sku Standard -Capacity 3Questo comando crea un servizio di livello Standard Gestione API con tre unità.
Esempio 3: Creare un servizio Gestione API per una rete virtuale esterna
PS C:\> $virtualNetwork = New-AzureRmApiManagementVirtualNetwork -Location "West US" -SubnetResourceId "/subscriptions/a8ff56dc-3bc7-4174-b1e8-3726ab15d0e2/resourceGroups/ContosoGroup/providers/Microsoft.Network/virtualNetworks/westUsVirtualNetwork/subnets/backendSubnet"
PS C:\> New-AzureRmApiManagement -ResourceGroupName "ContosoGroup" -Location "West US" -Name "ContosoApi" -Organization Contoso -AdminEmail admin@contoso.com -VirtualNetwork $virtualNetwork -VpnType "External" -Sku "Premium"Questo comando crea un servizio di Gestione API di livello Premium in una subnet di rete virtuale di Azure con un endpoint gateway esterno con un'area master negli Stati Uniti occidentali.
Esempio 4: Creare un servizio di Gestione API per una rete virtuale interna
PS C:\> $virtualNetwork = New-AzureRmApiManagementVirtualNetwork -Location "West US" -SubnetResourceId "/subscriptions/a8ff56dc-3bc7-4174-b1e8-3726ab15d0e2/resourceGroups/ContosoGroup/providers/Microsoft.Network/virtualNetworks/westUsVirtualNetwork/subnets/backendSubnet"
PS C:\> New-AzureRmApiManagement -ResourceGroupName "ContosoGroup" -Location "West US" -Name "ContosoApi" -Organization "Contoso" -AdminEmail "admin@contoso.com" -VirtualNetwork $virtualNetwork -VpnType "Internal" -Sku "Premium"Questo comando crea un servizio di Gestione API di livello Premium in una subnet di rete virtuale di Azure con un endpoint gateway interno con un'area master negli Stati Uniti occidentali.
Parametri
-AdditionalRegions
Aree di distribuzione aggiuntive di Azure Gestione API.
| Type: | PsApiManagementRegion[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-AdminEmail
Specifica l'indirizzo di posta elettronica di origine per tutte le notifiche inviate dal sistema Gestione API.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-AssignIdentity
Generare e assegnare un'identità Microsoft Entra per questo server da usare con i servizi di gestione delle chiavi come Azure KeyVault.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Capacity
Specifica la capacità sku del servizio azure Gestione API. Il valore predefinito è uno (1).
| Type: | Nullable<T>[Int32] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-CustomHostnameConfiguration
Configurazioni personalizzate dei nomi host. Il valore predefinito è $null. Passando $null verrà impostato il nome host predefinito.
| Type: | PsApiManagementCustomHostNameConfiguration[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-DefaultProfile
Credenziali, account, tenant e sottoscrizione usati per la comunicazione con Azure.
| Type: | IAzureContextContainer |
| Aliases: | AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Location
Specifica il percorso in cui creare il servizio Gestione API. Per ottenere percorsi validi, usare il cmdlet Get-AzureRmResourceProvider -ProviderNamespace "Microsoft.ApiManagement" | dove {$_. ResourceTypes[0]. ResourceTypeName -eq "service"} | Posizioni dell'oggetto Select
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
Specifica un nome per la distribuzione Gestione API.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Organization
Specifica il nome di un'organizzazione. Gestione API usa questo indirizzo nel portale per sviluppatori nelle notifiche tramite posta elettronica.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ResourceGroupName
Specifica il nome del gruppo di risorse in cui questo cmdlet crea una distribuzione Gestione API.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Sku
Specifica il livello del servizio Gestione API. I valori validi sono:
- Sviluppatore
- Standard
- Premium Il valore predefinito è Developer.
| Type: | Nullable<T>[PsApiManagementSku] |
| Accepted values: | Developer, Basic, Standard, Premium |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SystemCertificateConfiguration
Certificati rilasciati dalla CA interna da installare nel servizio. Il valore predefinito è $null.
| Type: | PsApiManagementSystemCertificate[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Tag
Dizionario tag.
| Type: | Dictionary<TKey,TValue>[System.String,System.String] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-VirtualNetwork
Rete virtuale Configurazione dell'area di distribuzione master di Azure Gestione API.
| Type: | PsApiManagementVirtualNetwork |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-VpnType
Rete virtuale Tipo di distribuzione ApiManagement. I valori validi sono
- "Nessuno" (valore predefinito. ApiManagement non fa parte di alcun Rete virtuale")
- "Esterno" (La distribuzione ApiManagement è configurata all'interno di un Rete virtuale con un endpoint con connessione Internet)
- "Interno" (la distribuzione ApiManagement viene configurata all'interno di un Rete virtuale con un endpoint con connessione Intranet)
| Type: | PsApiManagementVpnType |
| Accepted values: | None, External, Internal |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Input
Nullable<T>[[Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementSku, Microsoft.Azure.Commands.ApiManagement, Version=6.1.2.0, Culture=neutral, PublicKeyToken=null]]
Nullable<T>[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]
Dictionary<TKey,TValue>[[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089],[System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]
PsApiManagementCustomHostNameConfiguration[]
PsApiManagementSystemCertificate[]