Update-AzApiManagementRegion
更新 PsApiManagement 實例中的現有部署區域。
語法
Update-AzApiManagementRegion
-ApiManagement <PsApiManagement>
-Location <String>
-Sku <string>
-Capacity <Int32>
[-VirtualNetwork <PsApiManagementVirtualNetwork>]
[-Zone <String[]>]
[-DisableGateway <Boolean>]
[-PublicIpAddressId <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
Update-AzApiManagementRegion Cmdlet 會在所提供類型為 Microsoft.Azure.Commands.Models.PsApiManagement.PsApiManagement 之其他Regions 物件的集合中,更新類型為 Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement 的現有實例。 此 Cmdlet 不會部署任何專案,但會更新記憶體中的 PsApiManagement 實例。 若要更新部署 API 管理 請使用已修改的 PsApiManagementInstance 至 Set-AzApiManagement Cmdlet。
範例
範例 1:增加 PsApiManagement 實例中其他區域的容量
$apimService = Get-AzApiManagement -ResourceGroupName $resourceGroupName -Name $apiManagementName
$apimService = Update-AzApiManagementRegion -ApiManagement $apimService -Location "North Central US" -Capacity 2 -Sku Premium
$apimService = Set-AzApiManagement -InputObject $apimService -PassThru
此命令會取得 API 管理 進階 SKU 服務,其區域位於美國中南部和美國中北部。 然後,它會使用 Set-AzApiManagement 將美國中北部區域的容量增加到 2。 下一個 Cmdlet Set-AzApiManagement 會將設定變更套用至 Api 管理服務。
範例 2
更新 PsApiManagement 實例中的現有部署區域。 ( 自動產生 )
Update-AzApiManagementRegion -ApiManagement <PsApiManagement> -Capacity 2 -Location 'North Central US' -Sku Developer -VirtualNetwork <PsApiManagementVirtualNetwork>
參數
-ApiManagement
指定要 更新中現有部署區域的 PsApiManagement 實例。
類型: | PsApiManagement |
Position: | Named |
預設值: | None |
必要: | True |
接受管線輸入: | True |
接受萬用字元: | False |
-Capacity
指定部署區域的新 SKU 容量值。
類型: | Int32 |
Position: | Named |
預設值: | None |
必要: | True |
接受管線輸入: | 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 |
-Location
指定要更新之部署區域的位置。 指定 Api 管理服務所支援區域之間的新部署區域位置。 若要取得有效的位置,請使用 Cmdlet Get-AzResourceProvider -ProviderNamespace “Microsoft.ApiManagement” |其中 {$_.ResourceTypes[0]。ResourceTypeName -eq “service”} |Select-Object Locations
類型: | String |
Position: | Named |
預設值: | None |
必要: | True |
接受管線輸入: | True |
接受萬用字元: | False |
-PublicIpAddressId
標準 SKU PublicIpAddress ResoureId 以整合至 stv2 虛擬網絡 部署
類型: | String |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | False |
接受萬用字元: | False |
-Sku
指定部署區域的新層值。 有效值為:
- 開發人員
- 標準
- Premium
類型: | PsApiManagementSku |
接受的值: | Developer, Standard, Premium, Basic, Consumption, Isolated |
Position: | Named |
預設值: | None |
必要: | True |
接受管線輸入: | True |
接受萬用字元: | False |
-VirtualNetwork
指定部署區域的虛擬網路組態。 傳遞$null將會移除區域的虛擬網路組態。
類型: | PsApiManagementVirtualNetwork |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | True |
接受萬用字元: | False |
-Zone
可用性區域清單,表示 API 管理服務部署至何處。
類型: | String[] |
Position: | Named |
預設值: | None |
必要: | False |
接受管線輸入: | True |
接受萬用字元: | False |