Partager via

Backup-AzApiManagement

  • Référence
Module:
Az.ApiManagement

Sauvegarde un service Gestion des API.

Syntax

Backup-AzApiManagement
      -ResourceGroupName <String>
      -Name <String>
      -StorageContext <IStorageContext>
      -TargetContainerName <String>
      [-TargetBlobName <String>]
      [-AccessType <String>]
      [-IdentityClientId <String>]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [<CommonParameters>]

Description

L’applet de commande Backup-AzApiManagement sauvegarde une instance d’un service Azure Gestion des API. Cette applet de commande stocke la sauvegarde en tant qu’objet blob Stockage Azure.

Exemples

Exemple 1 : Sauvegarder un service Gestion des API

New-AzStorageAccount -StorageAccountName "ContosoStorage" -Location $location -ResourceGroupName "ContosoGroup02" -Type Standard_LRS
$storageKey = (Get-AzStorageAccountKey -ResourceGroupName "ContosoGroup02" -StorageAccountName "ContosoStorage")[0].Value
$storageContext = New-AzStorageContext -StorageAccountName "ContosoStorage" -StorageAccountKey $storageKey
Backup-AzApiManagement -ResourceGroupName "ContosoGroup02" -Name "ContosoApi" -StorageContext $StorageContext -TargetContainerName "contosobackups" -TargetBlobName "contosobackups.apimbackup"

Exemple 2 : Sauvegarder à l’aide de l’identité managée

$storageContext=New-AzStorageContext -StorageAccountName apimbackupmsi
$resourceGroupName="contosogroup2";
$apiManagementName="contosoapi";
$containerName="apimbackupcontainer";
$backupName="test-sdk-backup-1";
$msiClientId="a6270d0c-7d86-478b-8cbe-dc9047ba54f7"
Backup-AzApiManagement -ResourceGroupName $resourceGroupName -Name $apiManagementName -StorageContext $storageContext -TargetContainerName $containerName -TargetBlobName $backupName -AccessType "UserAssignedManagedIdentity" -IdentityClientId $msiClientId -PassThru

PublicIPAddresses                     : {52.143.79.150}
PrivateIPAddresses                    :
Id                                    : /subscriptions/4f5285a3-9fd7-40ad-91b1-d8fc3823983d/resourceGroups/contosogroup2/providers/Microsoft.ApiManagement/service/contosoapi
Name                                  : contosoapi
Location                              : West US 2
Sku                                   : Premium
Capacity                              : 1
CreatedTimeUtc                        : 10/13/2021 5:49:32 PM
ProvisioningState                     : Succeeded
RuntimeUrl                            : https://contosoapi.azure-api.net
RuntimeRegionalUrl                    : https://contosoapi-westus2-01.regional.azure-api.net
PortalUrl                             : https://contosoapi.portal.azure-api.net
DeveloperPortalUrl                    : https://contosoapi.developer.azure-api.net
ManagementApiUrl                      : https://contosoapi.management.azure-api.net
ScmUrl                                : https://contosoapi.scm.azure-api.net
PublisherEmail                        : foobar@microsoft.com
OrganizationName                      : fsdfsdfs
NotificationSenderEmail               : apimgmt-noreply@mail.windowsazure.com
VirtualNetwork                        :
VpnType                               : None
PortalCustomHostnameConfiguration     :
ProxyCustomHostnameConfiguration      : {contosoapi.azure-api.net}
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                     : contosogroup2

Cette commande sauvegarde un service Gestion des API dans un objet blob Stockage à l’aide de l’identité managée UserAssigned

Paramètres

-AccessType

Type d’accès à utiliser pour le compte de stockage.

Type:String
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

-IdentityClientId

ID client de l’identité managée affectée par l’utilisateur. Obligatoire uniquement si accessType est défini sur UserAssignedManagedIdentity.

Type:String
Position:Named
valeur par défaut:None
Obligatoire:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

Spécifie le nom du déploiement Gestion des API sauvegardé par cette applet de commande.

Type:String
Position:Named
valeur par défaut:None
Obligatoire:True
Accept pipeline input:True
Accept wildcard characters:False

-PassThru

Indique que cette applet de commande retourne l’objet PsApiManagement sauvegardé, 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

-ResourceGroupName

Spécifie le nom du groupe de ressources sous lequel le déploiement Gestion des API existe.

Type:String
Position:Named
valeur par défaut:None
Obligatoire:True
Accept pipeline input:True
Accept wildcard characters:False

-StorageContext

Spécifie un contexte de connexion de stockage.

Type:IStorageContext
Position:Named
valeur par défaut:None
Obligatoire:True
Accept pipeline input:True
Accept wildcard characters:False

-TargetBlobName

Spécifie le nom de l’objet blob pour la sauvegarde. Si l’objet blob n’existe pas, cette applet de commande la crée. Cette applet de commande génère une valeur par défaut basée sur le modèle suivant : {Name}-{aaaa-MM-dd-HH-mm}.apimbackup

Type:String
Position:Named
valeur par défaut:None
Obligatoire:False
Accept pipeline input:False
Accept wildcard characters:False

-TargetContainerName

Spécifie le nom du conteneur de l’objet blob pour la sauvegarde. Si le conteneur n’existe pas, cette applet de commande la crée.

Type:String
Position:Named
valeur par défaut:None
Obligatoire:True
Accept pipeline input:False
Accept wildcard characters:False

Entrées

String

IStorageContext

Sorties

PsApiManagement