Add-AzApiManagementRegion
將新的部署區域新增至 PsApiManagement 實例。
語法
Add-AzApiManagementRegion
-ApiManagement <PsApiManagement>
-Location <String>
[-Sku <PsApiManagementSku>]
[-Capacity <Int32>]
[-VirtualNetwork <PsApiManagementVirtualNetwork>]
[-Zone <String[]>]
[-DisableGateway <Boolean>]
[-PublicIpAddressId <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
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 |
Position: | Named |
預設值: | None |
必要: | True |
接受管線輸入: | True |
接受萬用字元: | False |
-Capacity
指定部署區域的 SKU 容量。
類型: | Nullable<T>[Int32] |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | 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 |
-Location
指定 Api 管理服務所支援區域之間的新部署區域位置。 若要取得有效的位置,請使用 Cmdlet Get-AzResourceProvider -ProviderNamespace “Microsoft.ApiManagement” |其中 {$_.ResourceTypes[0]。ResourceTypeName -eq “service”} |Select-Object Locations
類型: | String |
Position: | Named |
預設值: | None |
必要: | True |
接受管線輸入: | False |
接受萬用字元: | False |
-PublicIpAddressId
標準 SKU PublicIpAddress ResoureId 以整合至 stv2 虛擬網絡 部署
類型: | String |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
-Sku
指定部署區域的層級。 有效值為:
- 開發人員
- 標準
- Premium
類型: | Nullable<T>[PsApiManagementSku] |
接受的值: | Developer, Standard, Premium, Basic, Consumption, Isolated |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
-VirtualNetwork
指定虛擬網路組態。
類型: | PsApiManagementVirtualNetwork |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
-Zone
可用性區域清單,表示 API 管理服務部署至何處。
類型: | String[] |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | True |
接受萬用字元: | False |
輸入
輸出
備註
- Cmdlet 會將更新 的 PsApiManagement 實例寫入管線。