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

Add-AzApiManagementRegion

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

语法

Default (默认值)

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 实例。

参数属性

类型:PsApiManagement
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:True
来自管道的值:True
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Capacity

指定部署区域的 SKU 容量。

参数属性

类型:

Nullable<T>[Int32]

默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-DefaultProfile

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

参数属性

类型:IAzureContextContainer
默认值:None
支持通配符:False
不显示:False
别名:AzContext, AzureRmContext, AzureCredential

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-DisableGateway

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

参数属性

类型:

Nullable<T>[Boolean]

默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Location

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

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-PublicIpAddressId

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

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Sku

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

  • 开发人员
  • 标准
  • 高级

参数属性

类型:

Nullable<T>[PsApiManagementSku]

默认值:None
接受的值:Developer, Standard, Premium, Basic, Consumption, Isolated
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-VirtualNetwork

指定虚拟网络配置。

参数属性

类型:PsApiManagementVirtualNetwork
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Zone

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

参数属性

类型:

String[]

默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False

CommonParameters

此 cmdlet 支持通用参数:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息,请参阅 about_CommonParameters

输入

PsApiManagement

输出

PsApiManagement

备注

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