Set-AzApiManagement
Mises à jour un service Gestion des API Azure
Syntax
Set-AzApiManagement
-InputObject <PsApiManagement>
[-SystemAssignedIdentity]
[-UserAssignedIdentity <String[]>]
[-AsJob]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
L’applet de commande Set-AzApiManagement met à jour un service Azure Gestion des API.
Exemples
Exemple 1 : Obtenir un service Gestion des API et le mettre à l’échelle vers Premium et ajouter une région
$apim = Get-AzApiManagement -ResourceGroupName "ContosoGroup" -Name "ContosoApi"
$apim.Sku = "Premium"
$apim.Capacity = 5
$apim.AddRegion("Central US", "Premium", 3)
Set-AzApiManagement -InputObject $apim
Cet exemple obtient une instance Gestion des API, la met à l’échelle à cinq unités Premium, puis ajoute trois unités supplémentaires à la région Premium.
Exemple 2 : Mise à jour du déploiement (réseau virtuel externe)
$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
Cette commande met à jour un déploiement Gestion des API existant et se joint à un VpnType externe.
Exemple 3 : Créer et initialiser une instance de PsApiManagementCustomHostNameConfiguration à l’aide d’un secret à partir d’une ressource KeyVault
$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
Exemple 4 : Mettre à jour l’e-mail du serveur de publication, notificationSender email et nom de l’organisation
$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
Exemple 5 : Ajouter un certificat managé à un service APIM
$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
Cet exemple ajoute un certificat managé à un service Gestion des API.
Paramètres
-AsJob
Exécuter l’applet de commande en arrière-plan
Type: | SwitchParameter |
Position: | Named |
valeur par défaut: | None |
Obligatoire: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Confirm
Vous demande une confirmation avant d’exécuter l’applet de commande.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
valeur par défaut: | None |
Obligatoire: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DefaultProfile
Informations d’identification, compte, locataire et abonnement utilisés pour la communication avec Azure.
Type: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
valeur par défaut: | None |
Obligatoire: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
Instance ApiManagement.
Type: | PsApiManagement |
Position: | Named |
valeur par défaut: | None |
Obligatoire: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-PassThru
Envoie psApiManagement mis à jour au pipeline si l’opération réussit.
Type: | SwitchParameter |
Position: | Named |
valeur par défaut: | None |
Obligatoire: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SystemAssignedIdentity
Générez et attribuez une identité Azure Active Directory pour ce serveur à utiliser avec des services de gestion de clés comme Azure KeyVault.
Type: | SwitchParameter |
Position: | Named |
valeur par défaut: | None |
Obligatoire: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-UserAssignedIdentity
Affectez des identités utilisateur à ce serveur pour une utilisation avec des services de gestion de clés comme Azure KeyVault.
Type: | String[] |
Position: | Named |
valeur par défaut: | None |
Obligatoire: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-WhatIf
Montre ce qui se passe en cas d’exécution de l’applet de commande. L’applet de commande n’est pas exécutée.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
valeur par défaut: | None |
Obligatoire: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Entrées
Sorties
Liens associés
Commentaires
https://aka.ms/ContentUserFeedback.
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultezEnvoyer et afficher des commentaires pour