Add-AzApiManagementRegion
Dodaje nowe regiony wdrażania do wystąpienia psApiManagement.
Składnia
Add-AzApiManagementRegion
-ApiManagement <PsApiManagement>
-Location <String>
[-Sku <PsApiManagementSku>]
[-Capacity <Int32>]
[-VirtualNetwork <PsApiManagementVirtualNetwork>]
[-Zone <String[]>]
[-DisableGateway <Boolean>]
[-PublicIpAddressId <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Opis
Polecenie cmdlet Add-AzApiManagementRegion dodaje nowe wystąpienie typu PsApiManagementRegion do kolekcji AdditionalRegions podanego wystąpienia typu Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement. To polecenie cmdlet nie wdraża niczego samodzielnie, ale aktualizuje wystąpienie PsApiManagement w pamięci. Aby zaktualizować wdrożenie usługi API Management, należy przekazać zmodyfikowane wystąpienie PsApiManagement do polecenia Set-AzApiManagement.
Przykłady
Przykład 1. Dodawanie nowych regionów wdrażania do wystąpienia psApiManagement
Add-AzApiManagementRegion -ApiManagement $ApiManagement -Location "East US" -Sku "Premium" -Capacity 2
To polecenie dodaje dwie jednostki SKU w warstwie Premium i region o nazwie Wschodnie stany USA do wystąpienia PsApiManagement.
Przykład 2. Dodawanie nowych regionów wdrażania do wystąpienia psApiManagement, a następnie aktualizowanie wdrożenia
$service = Get-AzApiManagement -ResourceGroupName "Contoso" -Name "ContosoApi"
$service = Add-AzApiManagementRegion -ApiManagement $service -Location $secondarylocation -VirtualNetwork $additionalRegionVirtualNetwork
$service = Set-AzApiManagement -InputObject $service -PassThru
To polecenie pobiera obiekt PsApiManagement, dodaje dwie jednostki SKU w warstwie Premium dla regionu o nazwie Wschodnie stany USA, a następnie aktualizuje wdrożenie.
Parametry
-ApiManagement
Określa wystąpienie PsApiManagement, do którego to polecenie cmdlet dodaje dodatkowe regiony wdrażania.
Typ: | PsApiManagement |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | True |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-Capacity
Określa pojemność jednostki SKU regionu wdrażania.
Typ: | Nullable<T>[Int32] |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | False |
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. Domyślne zachowanie polega na tym, aby region był żywy natychmiast.
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ę 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: | False |
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 warstwę regionu wdrożenia. Prawidłowe wartości to:
- Wywoływacz
- Norma
- Premia
Typ: | Nullable<T>[PsApiManagementSku] |
Dopuszczalne wartości: | Developer, Standard, Premium, Basic, Consumption, Isolated |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | False |
Akceptowanie symboli wieloznacznych: | False |
-VirtualNetwork
Określa konfigurację sieci wirtualnej.
Typ: | PsApiManagementVirtualNetwork |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | False |
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 |
Dane wejściowe
Dane wyjściowe
Uwagi
- Polecenie cmdlet zapisuje zaktualizowane wystąpienie PsApiManagement do potoku.