你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

New-AzApiManagement

参考

模块:: Az.ApiManagement

创建API 管理部署。

语法

New-AzApiManagement
   -ResourceGroupName <String>
   -Name <String>
   -Location <String>
   -Organization <String>
   -AdminEmail <String>
   [-Sku <string>]
   [-Capacity <Int32>]
   [-VpnType <PsApiManagementVpnType>]
   [-VirtualNetwork <PsApiManagementVirtualNetwork>]
   [-Tag <System.Collections.Generic.Dictionary`2[System.String,System.String]>]
   [-AdditionalRegions <PsApiManagementRegion[]>]
   [-CustomHostnameConfiguration <PsApiManagementCustomHostNameConfiguration[]>]
   [-SystemCertificateConfiguration <PsApiManagementSystemCertificate[]>]
   [-SslSetting <PsApiManagementSslSetting>]
   [-SystemAssignedIdentity]
   [-UserAssignedIdentity <String[]>]
   [-EnableClientCertificate]
   [-Zone <String[]>]
   [-DisableGateway <Boolean>]
   [-MinimalControlPlaneApiVersion <String>]
   [-PublicNetworkAccess <String>]
   [-PublicIpAddressId <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

说明

New-AzApiManagement cmdlet 在 Azure API 管理中创建API 管理部署。

示例

示例 1：创建开发人员层API 管理服务

New-AzApiManagement -ResourceGroupName "ContosoGroup02" -Name "ContosoApi2" -Location "Central US" -Organization "Contoso" -AdminEmail "admin@contoso.com"

PublicIPAddresses                     : {104.43.240.65}
PrivateIPAddresses                    :
Id                                    : /subscriptions/a200340d-6b82-494d-9dbf-687ba6e33f9e/resourceGroups/ContosoGroup02/providers/Microsoft.ApiManagement/service/ContosoApi2
Name                                  : ContosoApi2
Location                              : Central US
Sku                                   : Developer
Capacity                              : 1
CreatedTimeUtc                        : 2/24/2020 10:34:12 PM
ProvisioningState                     : Succeeded
RuntimeUrl                            : https://contosoapi2.azure-api.net
RuntimeRegionalUrl                    : https://contosoapi2-centralus-01.regional.azure-api.net
PortalUrl                             : https://contosoapi2.portal.azure-api.net
DeveloperPortalUrl                    : https://contosoapi2.developer.azure-api.net
ManagementApiUrl                      : https://contosoapi2.management.azure-api.net
ScmUrl                                : https://contosoapi2.scm.azure-api.net
PublisherEmail                        : admin@contoso.com
OrganizationName                      : Contoso
NotificationSenderEmail               : apimgmt-noreply@mail.windowsazure.com
VirtualNetwork                        :
VpnType                               : None
PortalCustomHostnameConfiguration     :
ProxyCustomHostnameConfiguration      : {contosoapi2.azure-api.net}
ManagementCustomHostnameConfiguration :
ScmCustomHostnameConfiguration        :
DeveloperPortalHostnameConfiguration  :
SystemCertificates                    :
Tags                                  : {}
AdditionalRegions                     : {}
SslSetting                            : Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementSslSetting
Identity                              :
EnableClientCertificate               :
ResourceGroupName                     : ContosoGroup02

此命令创建开发人员层API 管理服务。该命令指定组织和管理员地址。此命令未指定 SKU 参数。因此，cmdlet 使用 Developer 的默认值。

示例 2：创建具有三个单元的标准层服务

New-AzApiManagement -ResourceGroupName "ContosoGroup02" -Name "ContosoApi" -Location "Central US" -Organization "Contoso" -AdminEmail "admin@contoso.com" -Sku Standard -Capacity 3

此命令创建具有三个单元的标准层API 管理服务。

示例 3：创建消耗层服务

New-AzApiManagement -ResourceGroupName Api-Default-North-Europe -Name consumptionskuservice -Location 'West Europe' -Sku Consumption -Organization microsoft -AdminEmail contoso@contoso.com -SystemAssignedIdentity -EnableClientCertificate

PublicIPAddresses                     :
PrivateIPAddresses                    :
Id                                    : /subscriptions/subid/resourceGroups/Api-Default-North-Europe/providers/Microsoft.ApiManagement/service/consumptionskuservice
Name                                  : consumptionskuservice
Location                              : West Europe
Sku                                   : Consumption
Capacity                              : 0
ProvisioningState                     : Succeeded
RuntimeUrl                            : https://consumptionskuservice.azure-api.net
PortalCustomHostnameConfiguration     :
ProxyCustomHostnameConfiguration      : {consumptionskuservice.azure-api.net}
ManagementCustomHostnameConfiguration :
ScmCustomHostnameConfiguration        :
DeveloperPortalHostnameConfiguration  :
SystemCertificates                    :
Tags                                  : {}
AdditionalRegions                     : {}
SslSetting                            : Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementSslSetting
Identity                              : Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementServiceIdentity
EnableClientCertificate               : True
ResourceGroupName                     : Api-Default-North-Europe

此命令创建一个消耗层API 管理服务，并在西欧启用客户端证书。

示例 4：创建API 管理服务和启用 TLS 1.0 协议

$enableTls=@{"Tls10" = "True"}
$sslSetting = New-AzApiManagementSslSetting -FrontendProtocol $enableTls -BackendProtocol $enableTls
New-AzApiManagement -ResourceGroupName Api-Default-CentralUS -Name "testtlspowershell" -Sku Standard -Location "CentralUS" -Organization "Microsoft" -AdminEmail "bar@contoso.com" -SslSetting $sslSetting

PublicIPAddresses                     : {23.99.140.18}
PrivateIPAddresses                    :
Id                                    : /subscriptions/subid/resourceGroups/Api-Default-CentralUS/providers/Microsoft.ApiManagement/service/testtlspowershell
Name                                  : testtlspowershell
Location                              : Central US
Sku                                   : Standard
Capacity                              : 1
ProvisioningState                     : Succeeded
RuntimeUrl                            : https://testtlspowershell.azure-api.net
RuntimeRegionalUrl                    : https://testtlspowershell-centralus-01.regional.azure-api.net
PortalUrl                             : https://testtlspowershell.portal.azure-api.net
ManagementApiUrl                      : https://testtlspowershell.management.azure-api.net
ScmUrl                                : https://testtlspowershell.scm.azure-api.net
PublisherEmail                        : bar@contoso.com
OrganizationName                      : Microsoft
NotificationSenderEmail               : apimgmt-noreply@mail.windowsazure.com
VirtualNetwork                        :
VpnType                               : None
PortalCustomHostnameConfiguration     :
ProxyCustomHostnameConfiguration      : {testtlspowershell.azure-api.net}
ManagementCustomHostnameConfiguration :
ScmCustomHostnameConfiguration        :
DeveloperPortalHostnameConfiguration  :
SystemCertificates                    :
Tags                                  : {}
AdditionalRegions                     : {}
SslSetting                            : Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementSslSetting
Identity                              :
EnableClientCertificate               :
ResourceGroupName                     : Api-Default-CentralUS

此命令在前端客户端上创建标准 SKU Api 管理服务并在 ApiManagement 网关与后端之间启用 TLS 1.0。

示例 5：在可用性区域中创建API 管理服务

New-AzApiManagement -ResourceGroupName "contoso-rg" -Name "apim-test-pshell-azs" -Location "Central US" -Organization "Contoso" -AdminEmail "admin@contoso.com" -Sku Premium -Capacity 3 -Zone @("1","2","3")

PublicIPAddresses                     : {52.238.252.170}
PrivateIPAddresses                    :
Id                                    : /subscriptions/aa7def4e-6bcd-4b28-b8d5-7613a618e753/resourceGroups/contoso-rg/providers/Microsoft.ApiManagement/service/apim-test-pshell-azs
Name                                  : apim-test-pshell-azs
Location                              : Central US
Sku                                   : Premium
Capacity                              : 3
CreatedTimeUtc                        : 7/30/2021 7:47:12 PM
ProvisioningState                     : Succeeded
RuntimeUrl                            : https://apim-test-pshell-azs.azure-api.net
RuntimeRegionalUrl                    : https://apim-test-pshell-azs-centralus-01.regional.azure-api.net
PortalUrl                             : https://apim-test-pshell-azs.portal.azure-api.net
DeveloperPortalUrl                    : https://apim-test-pshell-azs.developer.azure-api.net
ManagementApiUrl                      : https://apim-test-pshell-azs.management.azure-api.net
ScmUrl                                : https://apim-test-pshell-azs.scm.azure-api.net
PublisherEmail                        : admin@contoso.com
OrganizationName                      : Contoso
NotificationSenderEmail               : apimgmt-noreply@mail.windowsazure.com
VirtualNetwork                        :
VpnType                               : None
PortalCustomHostnameConfiguration     :
ProxyCustomHostnameConfiguration      : {apim-test-pshell-azs.azure-api.net}
ManagementCustomHostnameConfiguration :
ScmCustomHostnameConfiguration        :
DeveloperPortalHostnameConfiguration  :
SystemCertificates                    :
Tags                                  : {}
AdditionalRegions                     : {}
SslSetting                            : Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementSslSetting
Identity                              :
EnableClientCertificate               :
Zone                                  : {1, 2, 3}
DisableGateway                        : False
MinimalControlPlaneApiVersion         :
ResourceGroupName                     : contoso-rg

此命令在区域中创建高级 SKU API 管理服务

示例 6：使用 Stv2 在内部模式下创建虚拟网络API 管理服务

$virtualNetwork = New-AzApiManagementVirtualNetwork -SubnetResourceId "/subscriptions/4f5285a3-9fd7-40ad-91b1-d8fc3823983d/resourceGroups/contosogroup/providers/Microsoft.Network/virtualNetworks/apimvnet/subnets/ps"
$publicIpAddressId = "/subscriptions/4f5285a3-9fd7-40ad-91b1-d8fc3823983d/resourceGroups/contosogroup/providers/Microsoft.Network/publicIPAddresses/apim-external-vnet-ipv4"
New-AzApiManagement -ResourceGroupName "contosogroup" -Location "West US2" -Name "pstestinternalvnet2" -Organization "Contoso" -AdminEmail "admin@contoso.com" -VirtualNetwork $virtualNetwork -VpnType "Internal" -Sku "Premium" -PublicIpAddressId $publicIpAddressId

PublicIPAddresses                     : {20.99.249.73}
PrivateIPAddresses                    : {10.0.2.4}
Id                                    : /subscriptions/4f5285a3-9fd7-40ad-91b1-d8fc3823983d/resourceGroups/contosogroup/providers/Microsoft.ApiManagement/service/pstestinternalvnet2
Name                                  : pstestinternalvnet2
Location                              : West US 2
Sku                                   : Premium
Capacity                              : 1
CreatedTimeUtc                        : 3/24/2022 11:09:57 PM
ProvisioningState                     : Succeeded
RuntimeUrl                            : https://pstestinternalvnet2.azure-api.net
RuntimeRegionalUrl                    : https://pstestinternalvnet2-westus2-01.regional.azure-api.net
PortalUrl                             : https://pstestinternalvnet2.portal.azure-api.net
DeveloperPortalUrl                    : https://pstestinternalvnet2.developer.azure-api.net
ManagementApiUrl                      : https://pstestinternalvnet2.management.azure-api.net
ScmUrl                                : https://pstestinternalvnet2.scm.azure-api.net
PublisherEmail                        : admin@contoso.com
OrganizationName                      : Contoso
NotificationSenderEmail               : apimgmt-noreply@mail.windowsazure.com
VirtualNetwork                        : Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementVirtualNetwork
VpnType                               : Internal
PortalCustomHostnameConfiguration     :
ProxyCustomHostnameConfiguration      : {pstestinternalvnet2.azure-api.net}
ManagementCustomHostnameConfiguration :
ScmCustomHostnameConfiguration        :
DeveloperPortalHostnameConfiguration  :
SystemCertificates                    :
Tags                                  : {}
AdditionalRegions                     : {}
SslSetting                            : Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementSslSetting
Identity                              :
EnableClientCertificate               :
Zone                                  :
DisableGateway                        :
MinimalControlPlaneApiVersion         :
PublicIpAddressId                     : /subscriptions/4f5285a3-9fd7-40ad-91b1-d8fc3823983d/resourceGroups/contosogroup/providers/Microsoft.Network/publicIPAddresses/apim-external-vnet-ipv4
PlatformVersion                       : stv2
PublicNetworkAccess                   : Enabled
PrivateEndpointConnections            :
ResourceGroupName                     : contosogroup

该 cmdlet 使用 stv2 平台版本将API 管理服务部署到虚拟网络。

示例 7：为 Stv1 的外部虚拟网络创建API 管理服务

$virtualNetwork = New-AzApiManagementVirtualNetwork -SubnetResourceId "/subscriptions/a8ff56dc-3bc7-4174-b1e8-3726ab15d0e2/resourceGroups/ContosoGroup/providers/Microsoft.Network/virtualNetworks/westUsVirtualNetwork/subnets/backendSubnet"
New-AzApiManagement -ResourceGroupName "ContosoGroup" -Location "West US" -Name "ContosoApi" -Organization Contoso -AdminEmail admin@contoso.com -VirtualNetwork $virtualNetwork -VpnType "External" -Sku "Premium"

此命令在 Azure 虚拟网络子网中创建高级层API 管理服务，该服务具有面向外部的网关终结点，其主区域位于美国西部，采用 stv1 模型

参数

-AdditionalRegions

Azure API 管理的其他部署区域。

类型:	PsApiManagementRegion[]
Position:	Named
默认值:	None
必需:	False
接受管道输入:	True
接受通配符:	False

-AdminEmail

指定API 管理系统发送的所有通知的发起电子邮件地址。

类型:	String
Position:	Named
默认值:	None
必需:	True
接受管道输入:	True
接受通配符:	False

-Capacity

指定 Azure API 管理服务的 SKU 容量。默认值为 1 （1）。

类型:	Nullable<T>[Int32]
Position:	Named
默认值:	None
必需:	False
接受管道输入:	True
接受通配符:	False

-CustomHostnameConfiguration

自定义主机名配置。默认值为$null。传递$null将设置默认主机名。

类型:	PsApiManagementCustomHostNameConfiguration[]
Position:	Named
默认值:	None
必需:	False
接受管道输入:	True
接受通配符:	False

-DefaultProfile

用于与 Azure 通信的凭据、帐户、租户和订阅。

类型:	IAzureContextContainer
别名:	AzContext, AzureRmContext, AzureCredential
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-DisableGateway

标志仅用于高级 SKU ApiManagement 服务和非内部 VNET 部署。如果我们想要将网关区域从轮换中，这非常有用。这还可用于在被动模式下建立新区域，对其进行测试，然后使其在以后上线。

类型:	Nullable<T>[Boolean]
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-EnableClientCertificate

标志仅用于消耗 SKU ApiManagement 服务。这会强制在向网关的每个请求上显示客户端证书。这样，便可以在网关上的策略中对证书进行身份验证。

类型:	SwitchParameter
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-Location

指定要创建 Api 管理服务的位置。若要获取有效位置，请使用 cmdlet Get-AzResourceProvider -ProviderNamespace “Microsoft.ApiManagement” |where {$_.ResourceTypes[0]。ResourceTypeName -eq “service”} |Select-Object 位置

类型:	String
Position:	Named
默认值:	None
必需:	True
接受管道输入:	True
接受通配符:	False

-MinimalControlPlaneApiVersion

用于管理API 管理服务的最小控制平面 API 版本。

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-Name

指定API 管理部署的名称。

类型:	String
Position:	Named
默认值:	None
必需:	True
接受管道输入:	True
接受通配符:	False

-Organization

指定组织的名称。 API 管理电子邮件通知开发人员门户中使用此地址。

类型:	String
Position:	Named
默认值:	None
必需:	True
接受管道输入:	True
接受通配符:	False

-PublicIpAddressId

标准 SKU PublicIpAddress ResoureId，用于集成到 stv2 虚拟网络部署

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-PublicNetworkAccess

是否允许对此服务使用公共终结点访问。可能的值包括：“Enabled”、“Disabled”

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-ResourceGroupName

指定此 cmdlet 在其中创建API 管理部署的资源组的名称。

类型:	String
Position:	Named
默认值:	None
必需:	True
接受管道输入:	True
接受通配符:	False

-Sku

Azure API 管理服务的层。有效值为 Developer、Basic、Standard、Premium 和 Consumption。默认值为 Developer。

类型:	Nullable<T>[PsApiManagementSku]
接受的值:	Developer, Basic, Standard, Premium, Consumption
Position:	Named
默认值:	None
必需:	False
接受管道输入:	True
接受通配符:	False

-SslSetting

ApiManagement 服务的 Ssl 设置。默认值为$null

类型:	PsApiManagementSslSetting
Position:	Named
默认值:	None
必需:	False
接受管道输入:	True
接受通配符:	False

-SystemAssignedIdentity

为此服务器生成并分配 Azure Active Directory 标识，以用于 Azure KeyVault 等密钥管理服务。

类型:	SwitchParameter
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-SystemCertificateConfiguration

要安装在服务上的内部 CA 颁发的证书。默认值为$null。

类型:	PsApiManagementSystemCertificate[]
Position:	Named
默认值:	None
必需:	False
接受管道输入:	True
接受通配符:	False

-Tag

标记字典。

类型:	Dictionary<TKey,TValue>[System.String,System.String]
Position:	Named
默认值:	None
必需:	False
接受管道输入:	True
接受通配符:	False

-UserAssignedIdentity

将用户标识分配给此服务器，以用于 Azure KeyVault 等密钥管理服务。

类型:	String[]
Position:	Named
默认值:	None
必需:	False
接受管道输入:	True
接受通配符:	False

-VirtualNetwork

虚拟网络 Azure 主API 管理部署区域的配置。

类型:	PsApiManagementVirtualNetwork
Position:	Named
默认值:	None
必需:	False
接受管道输入:	True
接受通配符:	False

-VpnType

虚拟网络 ApiManagement 部署的类型。有效值为

“None”（默认值。ApiManagement 不属于任何虚拟网络“）
“外部”（ApiManagement 部署是在具有面向 Internet 的终结点的虚拟网络内设置的）
“内部”（ApiManagement 部署是在具有面向 Intranet 的终结点虚拟网络内设置的）

类型:	PsApiManagementVpnType
接受的值:	None, External, Internal
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-Zone

表示将 API 管理服务部署到的位置的可用性区域列表。

类型:	String[]
Position:	Named
默认值:	None
必需:	False
接受管道输入:	True
接受通配符:	False

输入

String

Nullable<T>[[Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementSku, Microsoft.Azure.PowerShell.Cmdlets.ApiManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]

Nullable<T>[[System.Int32, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

PsApiManagementVirtualNetwork

Dictionary<TKey,TValue>[[System.String, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e],[System.String, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

PsApiManagementRegion[]

PsApiManagementCustomHostNameConfiguration[]

PsApiManagementSystemCertificate[]

输出

PsApiManagement

通过

New-AzApiManagement

语法

说明

示例

示例 1：创建开发人员层API 管理服务

示例 2：创建具有三个单元的标准层服务

示例 3：创建消耗层服务

示例 4：创建API 管理服务和启用 TLS 1.0 协议

示例 5：在可用性区域中创建API 管理服务

示例 6：使用 Stv2 在内部模式下创建虚拟网络API 管理服务

示例 7：为 Stv1 的外部虚拟网络创建API 管理服务

参数

-AdditionalRegions

-AdminEmail

-Capacity

-CustomHostnameConfiguration

-DefaultProfile

-DisableGateway

-EnableClientCertificate

-Location

-MinimalControlPlaneApiVersion

-Name

-Organization

-PublicIpAddressId

-PublicNetworkAccess

-ResourceGroupName

-Sku

-SslSetting

-SystemAssignedIdentity

-SystemCertificateConfiguration

-Tag

-UserAssignedIdentity

-VirtualNetwork

-VpnType

-Zone

输入

输出

其他资源

通过

New-AzApiManagement

语法

说明

示例

示例 1：创建开发人员层API 管理服务

示例 2：创建具有三个单元的标准层服务

示例 3：创建消耗层服务

示例 4：创建API 管理服务和启用 TLS 1.0 协议

示例 5：在 可用性区域 中创建API 管理服务

示例 6：使用 Stv2 在内部模式下创建 虚拟网络API 管理服务

示例 7：为 Stv1 的外部虚拟网络创建API 管理服务

参数

-AdditionalRegions

-AdminEmail

-Capacity

-CustomHostnameConfiguration

-DefaultProfile

-DisableGateway

-EnableClientCertificate

-Location

-MinimalControlPlaneApiVersion

-Name

-Organization

-PublicIpAddressId

-PublicNetworkAccess

-ResourceGroupName

-Sku

-SslSetting

-SystemAssignedIdentity

-SystemCertificateConfiguration

-Tag

-UserAssignedIdentity

-VirtualNetwork

-VpnType

-Zone

输入

输出

相关链接

其他资源

示例 5：在可用性区域中创建API 管理服务

示例 6：使用 Stv2 在内部模式下创建虚拟网络API 管理服务