Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Backup-AzureApiManagement

Backup-AzureApiManagement

microsoft.azure.commands.apimanagement.dll

Synopsis

Backs up API Management Service and places the backup to the specified Azure storage blob.

Syntax

Backup-AzureApiManagement [-ResourceGroupName] [-Name] [-StorageContext] [-TargetContainerName] [-TargetBlobName] [-PassThru] [-Profile] [<CommonParameters>]

Detailed Description

Backup-AzureApiManagement cmdlet makes a backup copy of an API Management Service and places the backup to the specified Azure storage blob.

Parameters

-ResourceGroupName <String>

Name of resource group under which API Management exists.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-Name <String>

Name of API Management.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-StorageContext <AzureStorageContext>

The storage connection context.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-TargetContainerName <String>

Name of target Azure Storage blob. If the blob does not exist it will be created.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-TargetBlobName <String>

Name of target Azure Storage blob. If the blob does not exist it will be created. The default value will be generated based on the following pattern: {Name}-{yyyy-MM-dd-HH-mm}.apimbackup

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-PassThru <SwitchParameter>

Sends backed up PsApiManagement to pipeline if operation succeeds.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Profile <AzureProfile>

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type


Return Type


Notes

Examples

-------------------------- Example 1 --------------------------

Backup API Management service to Azure storage blob.

PS C:\> Backup-AzureApiManagement –ResourceGroupName ContosoGroup –Name ContosoApi -StorageContext $storageContext -TargetContainerName ContosoBackups –TargetBlobName ContosoBackup.apimbackup