Update-AzApiManagementRegion
Aktualizuje istniejący region wdrażania w wystąpieniu PsApiManagement.
Składnia
Update-AzApiManagementRegion
-ApiManagement <PsApiManagement>
-Location <String>
-Sku <string>
-Capacity <Int32>
[-VirtualNetwork <PsApiManagementVirtualNetwork>]
[-Zone <String[]>]
[-DisableGateway <Boolean>]
[-PublicIpAddressId <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Opis
Polecenie cmdlet Update-AzApiManagementRegion aktualizuje istniejące wystąpienie typu Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementRegion w kolekcji AdditionalRegions obiektów określonego typu Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement. To polecenie cmdlet nie wdraża żadnych elementów, ale aktualizuje wystąpienie PsApiManagement w pamięci. Aby zaktualizować wdrożenie usługi API Management, użyj zmodyfikowanego polecenia cmdlet PsApiManagementInstance Set-AzApiManagement.
Przykłady
Przykład 1. Zwiększenie pojemności dodatkowego regionu w wystąpieniu 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
To polecenie pobiera usługę SKU PREMIUM usługi API Management, która ma regiony w południowo-środkowych stanach USA i północno-środkowych stanach USA. Następnie zwiększa pojemność regionu Północno-środkowe stany USA do 2 przy użyciu Set-AzApiManagement. Następne polecenie cmdlet Set-AzApiManagement stosuje zmianę konfiguracji w usłudze Api Management.
Przykład 2
Aktualizuje istniejący region wdrażania w wystąpieniu PsApiManagement. (automatycznie wygenerowane)
Update-AzApiManagementRegion -ApiManagement <PsApiManagement> -Capacity 2 -Location 'North Central US' -Sku Developer -VirtualNetwork <PsApiManagementVirtualNetwork>
Parametry
-ApiManagement
Określa wystąpienie PsApiManagement w celu zaktualizowania istniejącego regionu wdrożenia.
Typ: | PsApiManagement |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | True |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-Capacity
Określa nową wartość pojemności jednostki SKU dla regionu wdrożenia.
Typ: | Int32 |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | True |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-DefaultProfile
Poświadczenia, konto, dzierżawa i subskrypcja używane do komunikacji z platformą Azure.
Typ: | IAzureContextContainer |
Aliasy: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | False |
Akceptowanie symboli wieloznacznych: | False |
-DisableGateway
Flaga przeznaczona tylko do użycia w przypadku wdrożeń usługi ApiManagement jednostki SKU w warstwie Premium i innych niż wewnętrzne wdrożenia sieci wirtualnej. Jest to przydatne w przypadku, gdy chcemy wycofać region bramy z rotacji. Można to również użyć do wstrzymania nowego regionu w trybie pasywnym, przetestowania go, a następnie przełączenie go na żywo później.
Typ: | Nullable<T>[Boolean] |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | False |
Akceptowanie symboli wieloznacznych: | False |
-Location
Określa lokalizację regionu wdrożenia do zaktualizowania. Określa lokalizację nowego regionu wdrożenia w obsługiwanym regionie dla usługi Api Management. Aby uzyskać prawidłowe lokalizacje, użyj polecenia cmdlet Get-AzResourceProvider -ProviderNamespace "Microsoft.ApiManagement" | gdzie {$_. ResourceTypes[0]. ResourceTypeName -eq "service"} | lokalizacje Select-Object
Typ: | String |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | True |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-PublicIpAddressId
Standardowa jednostka SKU PublicIpAddress ResoureId do integracji z wdrożeniami sieci wirtualnej stv2
Typ: | String |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | False |
Akceptowanie symboli wieloznacznych: | False |
-Sku
Określa nową wartość warstwy dla regionu wdrożenia. Prawidłowe wartości to:
- Wywoływacz
- Norma
- Premia
Typ: | PsApiManagementSku |
Dopuszczalne wartości: | Developer, Standard, Premium, Basic, Consumption, Isolated |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | True |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-VirtualNetwork
Określa konfigurację sieci wirtualnej dla regionu wdrażania. Przekazywanie $null spowoduje usunięcie konfiguracji sieci wirtualnej dla regionu.
Typ: | PsApiManagementVirtualNetwork |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-Zone
Lista stref dostępności oznaczających miejsce wdrożenia usługi API Management.
Typ: | String[] |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |