Set-AzApiManagement
Aktualisiert einen Azure API-Verwaltungsdienst
Syntax
Default (Standard)
Set-AzApiManagement
-InputObject <PsApiManagement>
[-SystemAssignedIdentity]
[-UserAssignedIdentity <String[]>]
[-AsJob]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Beschreibung
Das Cmdlet Set-AzApiManagement aktualisiert einen Azure API Management Dienst.
Beispiele
Beispiel 1: Abrufen eines API-Verwaltungsdiensts und Skalieren auf Premium und Hinzufügen einer Region
$apim = Get-AzApiManagement -ResourceGroupName "ContosoGroup" -Name "ContosoApi"
$apim.Sku = "Premium"
$apim.Capacity = 5
$apim.AddRegion("Central US", "Premium", 3)
Set-AzApiManagement -InputObject $apim
Dieses Beispiel ruft eine API-Verwaltungsinstanz ab, skaliert sie auf fünf Premiumeinheiten und fügt dann der Premiumregion weitere drei Einheiten hinzu.
Beispiel 2: Updatebereitstellung (externes VNET)
$virtualNetwork = New-AzApiManagementVirtualNetwork -SubnetResourceId "/subscriptions/a8ff56dc-3bc7-4174-a1e8-3726ab15d0e2/resourceGroups/Api-Default-WestUS/providers/Microsoft.Network/virtualNetworks/dfVirtualNetwork/subnets/backendSubnet"
$apim = Get-AzApiManagement -ResourceGroupName "ContosoGroup" -Name "ContosoApi"
$apim.VpnType = "External"
$apim.VirtualNetwork = $virtualNetwork
Set-AzApiManagement -InputObject $apim
Mit diesem Befehl wird eine vorhandene API-Verwaltungsbereitstellung aktualisiert und mit einem externen VpnType verknüpft.
Beispiel 3: Erstellen und Initialisieren einer Instanz von PsApiManagementCustomHostNameConfiguration mithilfe eines Geheimen Schlüssels aus KeyVault-Ressource
$portal = New-AzApiManagementCustomHostnameConfiguration -Hostname "portal.contoso.com" -HostnameType Portal -KeyVaultId "https://apim-test-keyvault.vault.azure.net/secrets/api-portal-custom-ssl.pfx"
$proxy1 = New-AzApiManagementCustomHostnameConfiguration -Hostname "gatewayl.contoso.com" -HostnameType Proxy -KeyVaultId "https://apim-test-keyvault.vault.azure.net/secrets/contoso-proxy-custom-ssl.pfx"
$proxy2 = New-AzApiManagementCustomHostnameConfiguration -Hostname "gatewayl.foobar.com" -HostnameType Proxy -KeyVaultId "https://apim-test-keyvault.vault.azure.net/secrets/foobar-proxy-custom-ssl.pfx"
$proxyCustomConfig = @($proxy1,$proxy2)
$apim = Get-AzApiManagement -ResourceGroupName "ContosoGroup" -Name "ContosoApi"
$apim.PortalCustomHostnameConfiguration = $portal
$apim.ProxyCustomHostnameConfiguration = $proxyCustomConfig
Set-AzApiManagement -InputObject $apim -SystemAssignedIdentity
Beispiel 4: Aktualisieren Publisher E-Mail, NotificationSender-E-Mail und Organisationsname
$apim = Get-AzApiManagement -ResourceGroupName "api-Default-West-US" -Name "Contoso"
$apim.PublisherEmail = "foobar@contoso.com"
$apim.NotificationSenderEmail = "notification@contoso.com"
$apim.OrganizationName = "Contoso"
Set-AzApiManagement -InputObject $apim -PassThru
Beispiel 5: Hinzufügen eines verwalteten Zertifikats zu einem APIM-Dienst
$gateway=New-AzApiManagementCustomHostnameConfiguration -Hostname freecertCanary.contoso.api -HostnameType Proxy -ManagedCertificate
$customConfig= @($gateway)
$apim=Get-AzApiManagement -ResourceGroupName contosogroup -Name contosoapim
$apim.ProxyCustomHostnameConfiguration = $customConfig
Set-AzApiManagement -InputObject $apim -PassThru
PublicIPAddresses : {20.45.236.81}
PrivateIPAddresses :
Id : /subscriptions/a200340d-6b82-494d-9dbf-687ba6e33f9e/resourceGroups/Api-Default-
Central-US-EUAP/providers/Microsoft.ApiManagement/service/contosoapim
Name : contosoapim
Location : Central US EUAP
Sku : Developer
Capacity : 1
CreatedTimeUtc : 8/24/2021 10:40:21 PM
ProvisioningState : Succeeded
RuntimeUrl : https://contosoapim.azure-api.net
RuntimeRegionalUrl : https://contosoapim-centraluseuap-01.regional.azure-api.net
PortalUrl : https://contosoapim.portal.azure-api.net
DeveloperPortalUrl : https://contosoapim.developer.azure-api.net
ManagementApiUrl : https://contosoapim.management.azure-api.net
ScmUrl : https://contosoapim.scm.azure-api.net
PublisherEmail : zhonren@microsoft.com
OrganizationName : Microsoft
NotificationSenderEmail : apimgmt-noreply@mail.windowsazure.com
VirtualNetwork :
VpnType : None
PortalCustomHostnameConfiguration :
ProxyCustomHostnameConfiguration : {contosoapim.azure-api.net, freecertCanary..contoso.api}
ManagementCustomHostnameConfiguration :
ScmCustomHostnameConfiguration :
DeveloperPortalHostnameConfiguration :
SystemCertificates :
Tags : {}
AdditionalRegions : {}
SslSetting : Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementSslSetting
Identity : Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementServiceIdentity
EnableClientCertificate :
Zone :
DisableGateway : False
MinimalControlPlaneApiVersion :
PublicIpAddressId :
PlatformVersion : stv2
PublicNetworkAccess : Enabled
PrivateEndpointConnections :
ResourceGroupName : contosogroup
$apim.ProxyCustomHostnameConfiguration
CertificateInformation :
EncodedCertificate :
HostnameType : Proxy
CertificatePassword :
Hostname : contosoapim.azure-api.net
KeyVaultId :
DefaultSslBinding : False
NegotiateClientCertificate : False
IdentityClientId :
CertificateStatus :
CertificateSource : BuiltIn
CertificateInformation : Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementCertificateInformation
EncodedCertificate :
HostnameType : Proxy
CertificatePassword :
Hostname : freecertCanary.contoso.api
KeyVaultId :
DefaultSslBinding : True
NegotiateClientCertificate : False
IdentityClientId :
CertificateStatus :
CertificateSource : Managed
In diesem Beispiel wird einem API-Verwaltungsdienst ein verwaltetes Zertifikat hinzugefügt.
Parameter
-AsJob
Cmdlet im Hintergrund ausführen
Parametereigenschaften
Typ: SwitchParameter
Standardwert: None Unterstützt Platzhalter: False Nicht anzeigen: False
Parametersätze
(All)
Position: Named Obligatorisch: False Wert aus Pipeline: False Wert aus Pipeline nach dem Eigenschaftsnamen: False Wert aus verbleibenden Argumenten: False
-Confirm
Fordert Sie zur Bestätigung auf, bevor Sie das Cmdlet ausführen.
Parametereigenschaften
Typ: SwitchParameter
Standardwert: None Unterstützt Platzhalter: False Nicht anzeigen: False Aliase: Cf
Parametersätze
(All)
Position: Named Obligatorisch: False Wert aus Pipeline: False Wert aus Pipeline nach dem Eigenschaftsnamen: False Wert aus verbleibenden Argumenten: False
-DefaultProfile
Die Anmeldeinformationen, Konten, Mandanten und Abonnements, die für die Kommunikation mit Azure verwendet werden.
Parametereigenschaften
Typ: IAzureContextContainer
Standardwert: None Unterstützt Platzhalter: False Nicht anzeigen: False Aliase: AzContext, AzureRmContext, AzureCredential
Parametersätze
(All)
Position: Named Obligatorisch: False Wert aus Pipeline: False Wert aus Pipeline nach dem Eigenschaftsnamen: False Wert aus verbleibenden Argumenten: False
Die ApiManagement-Instanz.
Typ: PsApiManagement
Standardwert: None Unterstützt Platzhalter: False Nicht anzeigen: False
(All)
Position: Named Obligatorisch: True Wert aus Pipeline: True Wert aus Pipeline nach dem Eigenschaftsnamen: False Wert aus verbleibenden Argumenten: False
-PassThru
Sendet aktualisierte PsApiManagement an pipeline, wenn der Vorgang erfolgreich ist.
Parametereigenschaften
Typ: SwitchParameter
Standardwert: None Unterstützt Platzhalter: False Nicht anzeigen: False
Parametersätze
(All)
Position: Named Obligatorisch: False Wert aus Pipeline: False Wert aus Pipeline nach dem Eigenschaftsnamen: False Wert aus verbleibenden Argumenten: False
-SystemAssignedIdentity
Generieren und Zuweisen einer Azure Active Directory Identität für diesen Server für die Verwendung mit Schlüsselverwaltungsdiensten wie Azure KeyVault.
Parametereigenschaften
Typ: SwitchParameter
Standardwert: None Unterstützt Platzhalter: False Nicht anzeigen: False
Parametersätze
(All)
Position: Named Obligatorisch: False Wert aus Pipeline: False Wert aus Pipeline nach dem Eigenschaftsnamen: False Wert aus verbleibenden Argumenten: False
-UserAssignedIdentity
Weisen Sie diesem Server Benutzeridentitäten für die Verwendung mit Schlüsselverwaltungsdiensten wie Azure KeyVault zu.
Parametereigenschaften
Typ: String [ ]
Standardwert: None Unterstützt Platzhalter: False Nicht anzeigen: False
Parametersätze
(All)
Position: Named Obligatorisch: False Wert aus Pipeline: False Wert aus Pipeline nach dem Eigenschaftsnamen: True Wert aus verbleibenden Argumenten: False
-WhatIf
Zeigt, was passiert, wenn das Cmdlet ausgeführt wird. Das Cmdlet wird nicht ausgeführt.
Parametereigenschaften
Typ: SwitchParameter
Standardwert: None Unterstützt Platzhalter: False Nicht anzeigen: False Aliase: Wi
Parametersätze
(All)
Position: Named Obligatorisch: False Wert aus Pipeline: False Wert aus Pipeline nach dem Eigenschaftsnamen: False Wert aus verbleibenden Argumenten: False
CommonParameters
Dieses Cmdlet unterstützt die allgemeinen Parameter -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction und -WarningVariable. Weitere Informationen findest du unter about_CommonParameters .
Ausgaben
