New-AzApiManagement

Reference

Modul:: Az.ApiManagement

Vytvoří nasazení služby API Management.

Syntax

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>]

Description

Rutina New-AzApiManagement vytvoří nasazení služby API Management ve službě Azure API Management.

Příklady

Příklad 1: Vytvoření služby API Management úrovně pro vývojáře

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

Tento příkaz vytvoří službu API Management vrstvy pro vývojáře. Příkaz určuje organizaci a adresu správce. Příkaz nezadá parametr skladové položky . Proto rutina používá výchozí hodnotu Developer.

Příklad 2: Vytvoření služby úrovně Standard, která má tři jednotky

New-AzApiManagement -ResourceGroupName "ContosoGroup02" -Name "ContosoApi" -Location "Central US" -Organization "Contoso" -AdminEmail "admin@contoso.com" -Sku Standard -Capacity 3

Tento příkaz vytvoří službu API Management úrovně Standard, která má tři jednotky.

Příklad 3: Vytvoření služby úrovně Consumption

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

Tento příkaz vytvoří službu API Management úrovně consumption s povoleným klientským certifikátem v západní Evropě.

Příklad 4: Vytvoření služby API Management a povolení protokolu 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

Tento příkaz vytvoří službu Api Management úrovně Standard a povolí ve front-endovém klientovi tls 1.0 bránu ApiManagement a back-endového klienta mezi bránou ApiManagement a back-endem.

Příklad 5: Vytvoření služby API Management v Zóny dostupnosti

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

Tento příkaz vytvoří službu Api Management úrovně Premium v zónách.

Příklad 6: Vytvoření služby API Management v interním režimu do virtuální sítě pomocí 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

Rutina nasadí službu API Management do služby Virtual Network pomocí verze platformy stv2.

Příklad 7: Vytvoření služby API Management pro externí virtuální síť pro 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"

Tento příkaz vytvoří službu API Management na úrovni Premium v podsíti virtuální sítě Azure s koncovým bodem externí brány s hlavní oblastí v oblasti USA – západ v modelu stv1.

Parametry

-AdditionalRegions

Další oblasti nasazení služby Azure API Management

Type:	PsApiManagementRegion[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-AdminEmail

Určuje původní e-mailovou adresu pro všechna oznámení, která systém API Management odesílá.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Capacity

Určuje kapacitu skladové položky služby Azure API Management. Výchozí hodnota je jedna (1).

Type:	Nullable<T>[Int32]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-CustomHostnameConfiguration

Konfigurace vlastních názvů hostitelů Výchozí hodnota je $null. Předání $null nastaví výchozí název hostitele.

Type:	PsApiManagementCustomHostNameConfiguration[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-DefaultProfile

Přihlašovací údaje, účet, tenant a předplatné používané ke komunikaci s Azure.

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DisableGateway

Příznak určený pouze pro nasazení apimanagement služby ApiManagement úrovně Premium a neinterních virtuálních sítí. To je užitečné v případě, že chceme oblast brány převést mimo obměnu. Můžete ho také použít k vytvoření nové oblasti v pasivním režimu, otestování a pozdějšímu nastavení.

Type:	Nullable<T>[Boolean]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-EnableClientCertificate

Příznak má být použit pouze pro službu ApiManagement consumption. To vynucuje, aby se klientský certifikát zobrazoval na každém požadavku bráně. To také umožňuje ověřit certifikát v zásadách brány.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Location

Určuje umístění pro vytvoření služby Api Management. K získání platných umístění použijte rutinu Get-AzResourceProvider -ProviderNamespace Microsoft.ApiManagement | where {$_. ResourceTypes[0]. ResourceTypeName -eq "service"} | Výběr umístění objektů

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-MinimalControlPlaneApiVersion

Minimální verze APIS řídicí roviny, která umožňuje správu služby API Management.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

Určuje název nasazení služby API Management.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Organization

Určuje název organizace. Služba API Management používá tuto adresu na portálu pro vývojáře v e-mailových oznámeních.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-PublicIpAddressId

Standard SKU PublicIpAddress ResoureId pro integraci do nasazení virtuální sítě stv2

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PublicNetworkAccess

Bez ohledu na to, jestli je pro tuto službu povolený přístup k veřejnému koncovému bodu. Mezi možné hodnoty patří: Enabled(Povoleno), Disabled (Zakázáno).

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceGroupName

Určuje název skupiny prostředků, pod kterou tato rutina vytvoří nasazení služby API Management.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Sku

Úroveň služby Azure API Management. Platné hodnoty jsou Developer, Basic, Standard, Premium a Consumption. Výchozí hodnota je Developer.

Type:	Nullable<T>[PsApiManagementSku]
Accepted values:	Developer, Basic, Standard, Premium, Consumption
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-SslSetting

Nastavení ssl služby ApiManagement. Výchozí hodnota je $null

Type:	PsApiManagementSslSetting
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-SystemAssignedIdentity

Vygenerujte a přiřaďte identitu Azure Active Directory pro tento server pro použití se službami pro správu klíčů, jako je Azure KeyVault.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SystemCertificateConfiguration

Certifikáty vydané interní certifikační autoritou, které mají být nainstalovány ve službě. Výchozí hodnota je $null.

Type:	PsApiManagementSystemCertificate[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Tag

Slovník značek

Type:	Dictionary<TKey,TValue>[System.String,System.String]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-UserAssignedIdentity

Přiřaďte k tomuto serveru identity uživatelů pro použití se službami pro správu klíčů, jako je Azure KeyVault.

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-VirtualNetwork

Konfigurace virtuální sítě hlavní oblasti nasazení služby Azure API Management

Type:	PsApiManagementVirtualNetwork
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-VpnType

Typ virtuální sítě nasazení ApiManagement. Platné hodnoty jsou

"None" (výchozí hodnota. ApiManagement není součástí žádné virtuální sítě.
"Externí" (Nasazení apiManagement je nastavené uvnitř virtuální sítě s internetovým koncovým bodem)
Interní (Nasazení služby ApiManagement je nastaveno uvnitř virtuální sítě s intranetovým koncovým bodem)

Type:	PsApiManagementVpnType
Accepted values:	None, External, Internal
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Zone

Seznam zón dostupnosti označující, kam je služba API Management nasazená.

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

Vstupy

String

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]]

PsApiManagementVirtualNetwork

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]]

PsApiManagementRegion[]

PsApiManagementCustomHostNameConfiguration[]

PsApiManagementSystemCertificate[]

Výstupy

PsApiManagement

New-AzApiManagement

Syntax

Description

Příklady

Příklad 1: Vytvoření služby API Management úrovně pro vývojáře

Příklad 2: Vytvoření služby úrovně Standard, která má tři jednotky

Příklad 3: Vytvoření služby úrovně Consumption

Příklad 4: Vytvoření služby API Management a povolení protokolu TLS 1.0

Příklad 5: Vytvoření služby API Management v Zóny dostupnosti

Příklad 6: Vytvoření služby API Management v interním režimu do virtuální sítě pomocí Stv2

Příklad 7: Vytvoření služby API Management pro externí virtuální síť pro Stv1

Parametry

-AdditionalRegions

-AdminEmail

-Capacity

-CustomHostnameConfiguration

-DefaultProfile

-DisableGateway

-EnableClientCertificate

-Location

-MinimalControlPlaneApiVersion

-Name

-Organization

-PublicIpAddressId

-PublicNetworkAccess

-ResourceGroupName

-Sku

-SslSetting

-SystemAssignedIdentity

-SystemCertificateConfiguration

-Tag

-UserAssignedIdentity

-VirtualNetwork

-VpnType

-Zone

Vstupy

Výstupy

Váš názor

Další materiály

New-AzApiManagement

Syntax

Description

Příklady

Příklad 1: Vytvoření služby API Management úrovně pro vývojáře

Příklad 2: Vytvoření služby úrovně Standard, která má tři jednotky

Příklad 3: Vytvoření služby úrovně Consumption

Příklad 4: Vytvoření služby API Management a povolení protokolu TLS 1.0

Příklad 5: Vytvoření služby API Management v Zóny dostupnosti

Příklad 6: Vytvoření služby API Management v interním režimu do virtuální sítě pomocí Stv2

Příklad 7: Vytvoření služby API Management pro externí virtuální síť pro Stv1

Parametry

-AdditionalRegions

-AdminEmail

-Capacity

-CustomHostnameConfiguration

-DefaultProfile

-DisableGateway

-EnableClientCertificate

-Location

-MinimalControlPlaneApiVersion

-Name

-Organization

-PublicIpAddressId

-PublicNetworkAccess

-ResourceGroupName

-Sku

-SslSetting

-SystemAssignedIdentity

-SystemCertificateConfiguration

-Tag

-UserAssignedIdentity

-VirtualNetwork

-VpnType

-Zone

Vstupy

Výstupy

Související odkazy

Váš názor

Další materiály