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

Add-AzApiManagementRegion

  • 参考
模块:
Az.ApiManagement

将新的部署区域添加到 PsApiManagement 实例。

语法

Add-AzApiManagementRegion
   -ApiManagement <PsApiManagement>
   -Location <String>
   [-Sku <PsApiManagementSku>]
   [-Capacity <Int32>]
   [-VirtualNetwork <PsApiManagementVirtualNetwork>]
   [-Zone <String[]>]
   [-DisableGateway <Boolean>]
   [-PublicIpAddressId <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

说明

Add-AzApiManagementRegion cmdlet 将 PsApiManagementRegion 类型的新实例添加到 Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement 类型的 AdditionalRegions 集合中。 此 cmdlet 本身不会部署任何内容，而是更新 PsApiManagement 内存中的实例。 若要更新API 管理将修改后的 PsApiManagement 实例传递给 Set-AzApiManagement。

示例

示例 1：向 PsApiManagement 实例添加新部署区域

Add-AzApiManagementRegion -ApiManagement $ApiManagement -Location "East US" -Sku "Premium" -Capacity 2

此命令将两个高级 SKU 单元和名为“美国东部”的区域添加到 PsApiManagement 实例。

示例 2：将新的部署区域添加到 PsApiManagement 实例，然后更新部署

$service = Get-AzApiManagement -ResourceGroupName "Contoso" -Name "ContosoApi"
$service = Add-AzApiManagementRegion -ApiManagement $service -Location $secondarylocation -VirtualNetwork $additionalRegionVirtualNetwork
$service = Set-AzApiManagement -InputObject $service -PassThru

此命令获取 PsApiManagement 对象，为名为“美国东部”的区域添加两个高级 SKU 单元，然后更新部署。

参数

-ApiManagement

指定 此 cmdlet 将其他部署区域添加到的 PsApiManagement 实例。

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

-Capacity

指定部署区域的 SKU 容量。

Type:Nullable<T>[Int32]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

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

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

-DisableGateway

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

Type:Nullable<T>[Boolean]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Location

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

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

-PublicIpAddressId

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

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

-Sku

指定部署区域的层。 有效值为：

  • 开发人员
  • Standard
  • 高级
Type:Nullable<T>[PsApiManagementSku]
Accepted values:Developer, Standard, Premium, Basic, Consumption, Isolated
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-VirtualNetwork

指定虚拟网络配置。

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

-Zone

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

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

输入

PsApiManagement

输出

PsApiManagement

备注

  • 该 cmdlet 将更新 的 PsApiManagement 实例写入管道。