Compartir a través de

Backup-AzApiManagement

  • Referencia
Módulo:
Az.ApiManagement

Realiza una copia de seguridad de un servicio API Management.

Syntax

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

Description

El cmdlet Backup-AzApiManagement realiza una copia de seguridad de una instancia de un servicio azure API Management. Este cmdlet almacena la copia de seguridad como un blob de Azure Storage.

Ejemplos

Ejemplo 1: Copia de seguridad de un servicio API Management

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"

Ejemplo 2: Copia de seguridad mediante identidad administrada

$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

Este comando realiza una copia de seguridad de un servicio API Management en un blob de Storage mediante UserAssigned Managed Identity

Parámetros

-AccessType

Tipo de acceso que se va a usar para la cuenta de almacenamiento.

Tipo:String
Position:Named
valor predeterminado:None
Requerido:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

Las credenciales, la cuenta, el inquilino y la suscripción que se usan para la comunicación con Azure.

Tipo:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
valor predeterminado:None
Requerido:False
Accept pipeline input:False
Accept wildcard characters:False

-IdentityClientId

Identificador de cliente de la identidad administrada asignada por el usuario. Obligatorio solo si accessType está establecido en UserAssignedManagedIdentity.

Tipo:String
Position:Named
valor predeterminado:None
Requerido:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

Especifica el nombre de la implementación de API Management de la que este cmdlet realiza una copia de seguridad.

Tipo:String
Position:Named
valor predeterminado:None
Requerido:True
Accept pipeline input:True
Accept wildcard characters:False

-PassThru

Indica que este cmdlet devuelve el objeto PsApiManagement de copia de seguridad, si la operación se realiza correctamente.

Tipo:SwitchParameter
Position:Named
valor predeterminado:None
Requerido:False
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

Especifica el nombre del grupo de recursos en el que existe la implementación de API Management.

Tipo:String
Position:Named
valor predeterminado:None
Requerido:True
Accept pipeline input:True
Accept wildcard characters:False

-StorageContext

Especifica un contexto de conexión de almacenamiento.

Tipo:IStorageContext
Position:Named
valor predeterminado:None
Requerido:True
Accept pipeline input:True
Accept wildcard characters:False

-TargetBlobName

Especifica el nombre del blob para la copia de seguridad. Si el blob no existe, este cmdlet lo crea. Este cmdlet genera un valor predeterminado basado en el siguiente patrón: {Name}-{aaaa-MM-dd-HH-mm}.apimbackup

Tipo:String
Position:Named
valor predeterminado:None
Requerido:False
Accept pipeline input:False
Accept wildcard characters:False

-TargetContainerName

Especifica el nombre del contenedor del blob para la copia de seguridad. Si el contenedor no existe, este cmdlet lo crea.

Tipo:String
Position:Named
valor predeterminado:None
Requerido:True
Accept pipeline input:False
Accept wildcard characters:False

Entradas

String

IStorageContext

Salidas

PsApiManagement