New-AzApiManagement
Tworzy wdrożenie usługi API Management.
Składnia
New-AzApiManagement
-ResourceGroupName <String>
-Name <String>
-Location <String>
-Organization <String>
-AdminEmail <String>
[-Sku <string>]
[-Capacity <Int32>]
[-VpnType <PsApiManagementVpnType>]
[-VirtualNetwork <PsApiManagementVirtualNetwork>]
[-Tag <System.Collections.Generic.Dictionary`2[System.String,System.String]>]
[-AdditionalRegions <PsApiManagementRegion[]>]
[-CustomHostnameConfiguration <PsApiManagementCustomHostNameConfiguration[]>]
[-SystemCertificateConfiguration <PsApiManagementSystemCertificate[]>]
[-SslSetting <PsApiManagementSslSetting>]
[-SystemAssignedIdentity]
[-UserAssignedIdentity <String[]>]
[-EnableClientCertificate]
[-Zone <String[]>]
[-DisableGateway <Boolean>]
[-MinimalControlPlaneApiVersion <String>]
[-PublicNetworkAccess <String>]
[-PublicIpAddressId <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Opis
Polecenie cmdlet New-AzApiManagement tworzy wdrożenie usługi API Management w usłudze Azure API Management.
Przykłady
Przykład 1. Tworzenie usługi API Management w warstwie dewelopera
New-AzApiManagement -ResourceGroupName "ContosoGroup02" -Name "ContosoApi2" -Location "Central US" -Organization "Contoso" -AdminEmail "admin@contoso.com"
PublicIPAddresses : {104.43.240.65}
PrivateIPAddresses :
Id : /subscriptions/a200340d-6b82-494d-9dbf-687ba6e33f9e/resourceGroups/ContosoGroup02/providers/Microsoft.ApiManagement/service/ContosoApi2
Name : ContosoApi2
Location : Central US
Sku : Developer
Capacity : 1
CreatedTimeUtc : 2/24/2020 10:34:12 PM
ProvisioningState : Succeeded
RuntimeUrl : https://contosoapi2.azure-api.net
RuntimeRegionalUrl : https://contosoapi2-centralus-01.regional.azure-api.net
PortalUrl : https://contosoapi2.portal.azure-api.net
DeveloperPortalUrl : https://contosoapi2.developer.azure-api.net
ManagementApiUrl : https://contosoapi2.management.azure-api.net
ScmUrl : https://contosoapi2.scm.azure-api.net
PublisherEmail : admin@contoso.com
OrganizationName : Contoso
NotificationSenderEmail : apimgmt-noreply@mail.windowsazure.com
VirtualNetwork :
VpnType : None
PortalCustomHostnameConfiguration :
ProxyCustomHostnameConfiguration : {contosoapi2.azure-api.net}
ManagementCustomHostnameConfiguration :
ScmCustomHostnameConfiguration :
DeveloperPortalHostnameConfiguration :
SystemCertificates :
Tags : {}
AdditionalRegions : {}
SslSetting : Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementSslSetting
Identity :
EnableClientCertificate :
ResourceGroupName : ContosoGroup02
To polecenie tworzy usługę API Management warstwy dewelopera.
Polecenie określa organizację i adres administratora.
Polecenie nie określa parametru jednostki SKU
Przykład 2. Tworzenie usługi warstwy Standardowa z trzema jednostkami
New-AzApiManagement -ResourceGroupName "ContosoGroup02" -Name "ContosoApi" -Location "Central US" -Organization "Contoso" -AdminEmail "admin@contoso.com" -Sku Standard -Capacity 3
To polecenie tworzy usługę API Management w warstwie Standardowa, która ma trzy jednostki.
Przykład 3. Tworzenie usługi warstwy Zużycie
New-AzApiManagement -ResourceGroupName Api-Default-North-Europe -Name consumptionskuservice -Location 'West Europe' -Sku Consumption -Organization microsoft -AdminEmail contoso@contoso.com -SystemAssignedIdentity -EnableClientCertificate
PublicIPAddresses :
PrivateIPAddresses :
Id : /subscriptions/subid/resourceGroups/Api-Default-North-Europe/providers/Microsoft.ApiManagement/service/consumptionskuservice
Name : consumptionskuservice
Location : West Europe
Sku : Consumption
Capacity : 0
ProvisioningState : Succeeded
RuntimeUrl : https://consumptionskuservice.azure-api.net
PortalCustomHostnameConfiguration :
ProxyCustomHostnameConfiguration : {consumptionskuservice.azure-api.net}
ManagementCustomHostnameConfiguration :
ScmCustomHostnameConfiguration :
DeveloperPortalHostnameConfiguration :
SystemCertificates :
Tags : {}
AdditionalRegions : {}
SslSetting : Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementSslSetting
Identity : Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementServiceIdentity
EnableClientCertificate : True
ResourceGroupName : Api-Default-North-Europe
To polecenie tworzy usługę API Management warstwy zużycia z włączonym certyfikatem klienta w regionie Europa Zachodnia.
Przykład 4. Tworzenie usługi API Management i włączanie protokołu TLS 1.0
$enableTls=@{"Tls10" = "True"}
$sslSetting = New-AzApiManagementSslSetting -FrontendProtocol $enableTls -BackendProtocol $enableTls
New-AzApiManagement -ResourceGroupName Api-Default-CentralUS -Name "testtlspowershell" -Sku Standard -Location "CentralUS" -Organization "Microsoft" -AdminEmail "bar@contoso.com" -SslSetting $sslSetting
PublicIPAddresses : {23.99.140.18}
PrivateIPAddresses :
Id : /subscriptions/subid/resourceGroups/Api-Default-CentralUS/providers/Microsoft.ApiManagement/service/testtlspowershell
Name : testtlspowershell
Location : Central US
Sku : Standard
Capacity : 1
ProvisioningState : Succeeded
RuntimeUrl : https://testtlspowershell.azure-api.net
RuntimeRegionalUrl : https://testtlspowershell-centralus-01.regional.azure-api.net
PortalUrl : https://testtlspowershell.portal.azure-api.net
ManagementApiUrl : https://testtlspowershell.management.azure-api.net
ScmUrl : https://testtlspowershell.scm.azure-api.net
PublisherEmail : bar@contoso.com
OrganizationName : Microsoft
NotificationSenderEmail : apimgmt-noreply@mail.windowsazure.com
VirtualNetwork :
VpnType : None
PortalCustomHostnameConfiguration :
ProxyCustomHostnameConfiguration : {testtlspowershell.azure-api.net}
ManagementCustomHostnameConfiguration :
ScmCustomHostnameConfiguration :
DeveloperPortalHostnameConfiguration :
SystemCertificates :
Tags : {}
AdditionalRegions : {}
SslSetting : Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementSslSetting
Identity :
EnableClientCertificate :
ResourceGroupName : Api-Default-CentralUS
To polecenie tworzy usługę Api Management w warstwie Standardowa i włącz protokół TLS 1.0 na kliencie frontonu do bramy ApiManagement Gateway i klienta zaplecza między bramą ApiManagement Gateway i zapleczem.
Przykład 5. Tworzenie usługi API Management w strefach dostępności
New-AzApiManagement -ResourceGroupName "contoso-rg" -Name "apim-test-pshell-azs" -Location "Central US" -Organization "Contoso" -AdminEmail "admin@contoso.com" -Sku Premium -Capacity 3 -Zone @("1","2","3")
PublicIPAddresses : {52.238.252.170}
PrivateIPAddresses :
Id : /subscriptions/aa7def4e-6bcd-4b28-b8d5-7613a618e753/resourceGroups/contoso-rg/providers/Microsoft.ApiManagement/service/apim-test-pshell-azs
Name : apim-test-pshell-azs
Location : Central US
Sku : Premium
Capacity : 3
CreatedTimeUtc : 7/30/2021 7:47:12 PM
ProvisioningState : Succeeded
RuntimeUrl : https://apim-test-pshell-azs.azure-api.net
RuntimeRegionalUrl : https://apim-test-pshell-azs-centralus-01.regional.azure-api.net
PortalUrl : https://apim-test-pshell-azs.portal.azure-api.net
DeveloperPortalUrl : https://apim-test-pshell-azs.developer.azure-api.net
ManagementApiUrl : https://apim-test-pshell-azs.management.azure-api.net
ScmUrl : https://apim-test-pshell-azs.scm.azure-api.net
PublisherEmail : admin@contoso.com
OrganizationName : Contoso
NotificationSenderEmail : apimgmt-noreply@mail.windowsazure.com
VirtualNetwork :
VpnType : None
PortalCustomHostnameConfiguration :
ProxyCustomHostnameConfiguration : {apim-test-pshell-azs.azure-api.net}
ManagementCustomHostnameConfiguration :
ScmCustomHostnameConfiguration :
DeveloperPortalHostnameConfiguration :
SystemCertificates :
Tags : {}
AdditionalRegions : {}
SslSetting : Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementSslSetting
Identity :
EnableClientCertificate :
Zone : {1, 2, 3}
DisableGateway : False
MinimalControlPlaneApiVersion :
ResourceGroupName : contoso-rg
To polecenie tworzy usługę Api Management jednostki SKU w warstwie Premium w strefach
Przykład 6. Tworzenie usługi API Management w trybie wewnętrznym w sieci wirtualnej za pomocą usługi Stv2
$virtualNetwork = New-AzApiManagementVirtualNetwork -SubnetResourceId "/subscriptions/4f5285a3-9fd7-40ad-91b1-d8fc3823983d/resourceGroups/contosogroup/providers/Microsoft.Network/virtualNetworks/apimvnet/subnets/ps"
$publicIpAddressId = "/subscriptions/4f5285a3-9fd7-40ad-91b1-d8fc3823983d/resourceGroups/contosogroup/providers/Microsoft.Network/publicIPAddresses/apim-external-vnet-ipv4"
New-AzApiManagement -ResourceGroupName "contosogroup" -Location "West US2" -Name "pstestinternalvnet2" -Organization "Contoso" -AdminEmail "admin@contoso.com" -VirtualNetwork $virtualNetwork -VpnType "Internal" -Sku "Premium" -PublicIpAddressId $publicIpAddressId
PublicIPAddresses : {20.99.249.73}
PrivateIPAddresses : {10.0.2.4}
Id : /subscriptions/4f5285a3-9fd7-40ad-91b1-d8fc3823983d/resourceGroups/contosogroup/providers/Microsoft.ApiManagement/service/pstestinternalvnet2
Name : pstestinternalvnet2
Location : West US 2
Sku : Premium
Capacity : 1
CreatedTimeUtc : 3/24/2022 11:09:57 PM
ProvisioningState : Succeeded
RuntimeUrl : https://pstestinternalvnet2.azure-api.net
RuntimeRegionalUrl : https://pstestinternalvnet2-westus2-01.regional.azure-api.net
PortalUrl : https://pstestinternalvnet2.portal.azure-api.net
DeveloperPortalUrl : https://pstestinternalvnet2.developer.azure-api.net
ManagementApiUrl : https://pstestinternalvnet2.management.azure-api.net
ScmUrl : https://pstestinternalvnet2.scm.azure-api.net
PublisherEmail : admin@contoso.com
OrganizationName : Contoso
NotificationSenderEmail : apimgmt-noreply@mail.windowsazure.com
VirtualNetwork : Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementVirtualNetwork
VpnType : Internal
PortalCustomHostnameConfiguration :
ProxyCustomHostnameConfiguration : {pstestinternalvnet2.azure-api.net}
ManagementCustomHostnameConfiguration :
ScmCustomHostnameConfiguration :
DeveloperPortalHostnameConfiguration :
SystemCertificates :
Tags : {}
AdditionalRegions : {}
SslSetting : Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementSslSetting
Identity :
EnableClientCertificate :
Zone :
DisableGateway :
MinimalControlPlaneApiVersion :
PublicIpAddressId : /subscriptions/4f5285a3-9fd7-40ad-91b1-d8fc3823983d/resourceGroups/contosogroup/providers/Microsoft.Network/publicIPAddresses/apim-external-vnet-ipv4
PlatformVersion : stv2
PublicNetworkAccess : Enabled
PrivateEndpointConnections :
ResourceGroupName : contosogroup
Polecenie cmdlet wdraża usługę API Management w sieci wirtualnej przy użyciu wersji platformy stv2.
Przykład 7. Tworzenie usługi API Management dla zewnętrznej sieci wirtualnej dla usługi Stv1
$virtualNetwork = New-AzApiManagementVirtualNetwork -SubnetResourceId "/subscriptions/a8ff56dc-3bc7-4174-b1e8-3726ab15d0e2/resourceGroups/ContosoGroup/providers/Microsoft.Network/virtualNetworks/westUsVirtualNetwork/subnets/backendSubnet"
New-AzApiManagement -ResourceGroupName "ContosoGroup" -Location "West US" -Name "ContosoApi" -Organization Contoso -AdminEmail admin@contoso.com -VirtualNetwork $virtualNetwork -VpnType "External" -Sku "Premium"
To polecenie tworzy usługę API Management w warstwie Premium w podsieci sieci wirtualnej platformy Azure z punktem końcowym bramy zewnętrznej z regionem głównym w regionie Zachodnie stany USA w modelu stv1
Parametry
-AdditionalRegions
Dodatkowe regiony wdrażania usługi Azure API Management.
Typ: | PsApiManagementRegion[] |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-AdminEmail
Określa źródłowy adres e-mail dla wszystkich powiadomień wysyłanych przez system API Management.
Typ: | String |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | True |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-Capacity
Określa pojemność jednostki SKU usługi Azure API Management. Wartość domyślna to jeden (1).
Typ: | Nullable<T>[Int32] |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-CustomHostnameConfiguration
Niestandardowe konfiguracje nazw hostów. Wartość domyślna to $null. Przekazywanie $null spowoduje ustawienie domyślnej nazwy hosta.
Typ: | PsApiManagementCustomHostNameConfiguration[] |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
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 |
-EnableClientCertificate
Flaga przeznaczona tylko do użycia dla usługi ApiManagement jednostki SKU zużycie. Wymusza to prezentowanie certyfikatu klienta dla każdego żądania do bramy. Umożliwia to również uwierzytelnianie certyfikatu w zasadach w bramie.
Typ: | SwitchParameter |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | False |
Akceptowanie symboli wieloznacznych: | False |
-Location
Określa lokalizację do utworzenia 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 |
-MinimalControlPlaneApiVersion
Minimalna wersja interfejsu API płaszczyzny sterowania umożliwiająca zarządzanie usługą API Management.
Typ: | String |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | False |
Akceptowanie symboli wieloznacznych: | False |
-Name
Określa nazwę wdrożenia usługi API Management.
Typ: | String |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | True |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-Organization
Określa nazwę organizacji. Usługa API Management używa tego adresu w portalu deweloperów w powiadomieniach e-mail.
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 |
-PublicNetworkAccess
Określa, czy dostęp do publicznego punktu końcowego jest dozwolony dla tej usługi. Możliwe wartości to: "Włączone", "Wyłączone"
Typ: | String |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | False |
Akceptowanie symboli wieloznacznych: | False |
-ResourceGroupName
Określa nazwę grupy zasobów, w której to polecenie cmdlet tworzy wdrożenie usługi API Management.
Typ: | String |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | True |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-Sku
Warstwa usługi Azure API Management. Prawidłowe wartości to Developer, Basic, Standard, Premium i Consumption. Wartość domyślna to Developer.
Typ: | Nullable<T>[PsApiManagementSku] |
Dopuszczalne wartości: | Developer, Basic, Standard, Premium, Consumption |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-SslSetting
Ustawienie ssl usługi ApiManagement. Wartość domyślna to $null
Typ: | PsApiManagementSslSetting |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-SystemAssignedIdentity
Generowanie i przypisywanie tożsamości usługi Azure Active Directory dla tego serwera do użycia z usługami zarządzania kluczami, takimi jak Azure KeyVault.
Typ: | SwitchParameter |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | False |
Akceptowanie symboli wieloznacznych: | False |
-SystemCertificateConfiguration
Certyfikaty wystawione przez wewnętrzny urząd certyfikacji do zainstalowania w usłudze. Wartość domyślna to $null.
Typ: | PsApiManagementSystemCertificate[] |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-Tag
Słownik tagów.
Typ: | Dictionary<TKey,TValue>[System.String,System.String] |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-UserAssignedIdentity
Przypisz tożsamości użytkowników do tego serwera do użycia z usługami zarządzania kluczami, takimi jak Azure KeyVault.
Typ: | String[] |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-VirtualNetwork
Konfiguracja sieci wirtualnej głównego regionu wdrażania usługi Azure API Management.
Typ: | PsApiManagementVirtualNetwork |
Position: | Named |
Domyślna wartość: | None |
Wymagane: | False |
Akceptowanie danych wejściowych potoku: | True |
Akceptowanie symboli wieloznacznych: | False |
-VpnType
Typ sieci wirtualnej wdrożenia apiManagement. Prawidłowe wartości to
- "Brak" (wartość domyślna. Usługa ApiManagement nie jest częścią żadnej sieci wirtualnej")
- "Zewnętrzne" (wdrożenie usługi ApiManagement jest konfigurowane w sieci wirtualnej z punktem końcowym dostępnym z Internetu)
- "Wewnętrzne" (wdrożenie usługi ApiManagement jest konfigurowane w sieci wirtualnej z punktem końcowym dostępnym w intranecie)
Typ: | PsApiManagementVpnType |
Dopuszczalne wartości: | None, External, Internal |
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
Nullable<T>[[Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementSku, Microsoft.Azure.PowerShell.Cmdlets.ApiManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]
Nullable<T>[[System.Int32, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]
Dictionary<TKey,TValue>[[System.String, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e],[System.String, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]
PsApiManagementCustomHostNameConfiguration[]
PsApiManagementSystemCertificate[]