New-AzureRmApiManagement
API Management デプロイを作成します。
警告
AzureRM PowerShell モジュールは、2024 年 2 月 29 日の時点で正式に非推奨になりました。 引き続きサポートを受け、更新を受け取れるようにするために、AzureRM から Az PowerShell モジュールに移行することをお勧めします。
AzureRM モジュールは引き続き機能する可能性がありますが、メインが維持またはサポートされなくなり、ユーザーの判断とリスクで引き続き使用できます。 Az モジュールへの移行に関するガイダンスについては、移行リソースを参照してください。
構文
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>] 説明
New-AzureRmApiManagement コマンドレットは、Azure API Management に API Management デプロイを作成します。
例
例 1: 開発者層 API Management サービスを作成する
PS C:\>New-AzureRmApiManagement -ResourceGroupName "ContosoGroup02" -Name "ContosoApi" -Location "Central US" -Organization "Contoso" -AdminEmail "admin@contoso.com"このコマンドは、Developer レベルの API Management サービスを作成します。 このコマンドは、組織と管理者アドレスを指定します。 このコマンドでは、SKU パラメーターは指定されません。 そのため、コマンドレットは Developer の既定値を使用します。
例 2: 3 つのユニットを含む Standard レベルのサービスを作成する
PS C:\>New-AzureRmApiManagement -ResourceGroupName "ContosoGroup02 -Name "ContosoApi" -Location "Central US" -Organization "Contoso" -AdminEmail "admin@contoso.com" -Sku Standard -Capacity 3このコマンドは、3 つのユニットを持つ Standard レベルの API Management サービスを作成します。
例 3: 外部仮想ネットワークの API Management サービスを作成する
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"このコマンドは、米国西部のマスター リージョンを持つ外部向けゲートウェイ エンドポイントを持つ Azure 仮想ネットワーク サブネットに、プレミアム層 API Management サービスを作成します。
例 4: 内部仮想ネットワーク用の API Management サービスを作成する
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"このコマンドは、米国西部のマスター リージョンを持つ内部向けのゲートウェイ エンドポイントを持つ Azure 仮想ネットワーク サブネットに、プレミアム層 API Management サービスを作成します。
パラメーター
-AdditionalRegions
Azure API Management の追加のデプロイ リージョン。
| Type: | PsApiManagementRegion[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-AdminEmail
API Management システムが送信するすべての通知の送信元電子メール アドレスを指定します。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-AssignIdentity
Azure KeyVault などのキー管理サービスで使用するために、このサーバーの Microsoft Entra ID を生成して割り当てます。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Capacity
Azure API Management サービスの SKU 容量を指定します。 既定値は 1 です。
| Type: | Nullable<T>[Int32] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-CustomHostnameConfiguration
カスタム ホスト名の構成。 既定値は $null です。 $nullを渡すと、既定のホスト名が設定されます。
| Type: | PsApiManagementCustomHostNameConfiguration[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。
| Type: | IAzureContextContainer |
| Aliases: | AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Location
Api Management サービスを作成する場所を指定します。 有効な場所を取得するには、コマンドレット Get-AzureRmResourceProvider -ProviderNamespace "Microsoft.ApiManagement" |where {$_.ResourceTypes[0]。ResourceTypeName -eq "service"} |Select-Object Locations
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
API Management デプロイの名前を指定します。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Organization
組織の名前を指定します。 API Management は、電子メール通知で開発者ポータルでこのアドレスを使用します。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ResourceGroupName
このコマンドレットで API Management デプロイを作成するリソース グループの名前を指定します。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Sku
API Management サービスのレベルを指定します。 有効な値は次の通りです。
- Developer
- Standard
- プレミアム 既定値は 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
内部 CA によって発行され、サービスにインストールされる証明書。 既定値は $null です。
| Type: | PsApiManagementSystemCertificate[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-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
マスター Azure API Management デプロイ リージョンの仮想ネットワーク構成。
| Type: | PsApiManagementVirtualNetwork |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-VpnType
ApiManagement デプロイの仮想ネットワークの種類。 有効な値は次のとおりです。
- "None" (既定値。ApiManagement は仮想ネットワークの一部ではありません")
- "外部" (ApiManagement のデプロイは、インターネットに接続するエンドポイントを持つ仮想ネットワーク内で設定されます)
- "内部" (ApiManagement のデプロイは、イントラネットに接続するエンドポイントを持つ仮想ネットワーク内に設定されます)
| Type: | PsApiManagementVpnType |
| Accepted values: | None, External, Internal |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
入力
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[]