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
 

Restore-AzureApiManagement

Restore-AzureApiManagement

microsoft.azure.commands.apimanagement.dll

Synopsis

Restores an API Management Service from the specified Azure storage blob.

Syntax

Restore-AzureApiManagement [-ResourceGroupName] [-Name] [-StorageContext] [-SourceContainerName] [-SourceBlobName] [-PassThru] [-Profile] [<CommonParameters>]

Detailed Description

Restore-AzureApiManagement cmdlet restores an API Management Service from the specified backup residing in an 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

1

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-SourceContainerName <String>

Name of Azure Storage backup source container.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-SourceBlobName <String>

Name of Azure Storage backup source blob.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-PassThru <SwitchParameter>

Sends restored 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 --------------------------

Restore API Management service from Azure storage blob.

PS C:\> Restore-AzureApiManagement –ResourceGroupName ContosoGroup –Name RestoredContosoApi -StorageContext $storageContext -SourceContainerName ContosoBackups –SourceBlobName ContosoBackup.apimbackup