< Back

Restore-AzureRmApiManagement

Tue Jan 29, 2019 9:30 pm

NAME Restore-AzureRmApiManagement



SYNOPSIS

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





SYNTAX

Restore-AzureRmApiManagement [-StorageContext] <IStorageContext> [-DefaultProfile <IAzureContextContainer>] -Name <String> [-PassThru]

-ResourceGroupName <String> -SourceBlobName <String> -SourceContainerName <String> [<CommonParameters>]





DESCRIPTION

The Restore-AzureRmApiManagement cmdlet restores an API Management Service from the specified backup residing in an Azurestorage blob.





PARAMETERS

-DefaultProfile <IAzureContextContainer>

The credentials, account, tenant, and subscription used for communication with azure.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Name <String>

Specifies the name of the API Management instance that will be restored with the backup.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-PassThru [<SwitchParameter>]

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-ResourceGroupName <String>

Specifies the name of resource group under which API Management exists.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-SourceBlobName <String>

Specifies the name of the Azure storage backup source blob.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-SourceContainerName <String>

Specifies the name of the Azure storage backup source container.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-StorageContext <IStorageContext>

Specifies the storage connection context.



Required? true

Position? 1

Default value None

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

None

This cmdlet does not accept any input.





OUTPUTS

Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement







NOTES









Example 1: Restore an API Management service



PS C:\\>New-AzureRmStorageAccount -StorageAccountName "ContosoStorage" -Location $location -ResourceGroupName "ContosoGroup02" -Type Standard_LRS

PS C:\\>$storageKey = (Get-AzureRmStorageAccountKey -ResourceGroupName "ContosoGroup02" -StorageAccountName "ContosoStorage")[0].Value

PS C:\\>$storageContext = New-AzureStorageContext -StorageAccountName "ContosoStorage" -StorageAccountKey $storageKey

PS C:\\>Restore-AzureRmApiManagement -ResourceGroupName "ContosoGroup" -Name "RestoredContosoApi" -StorageContext $StorageContext

-SourceContainerName "ContosoBackups" -SourceBlobName "ContosoBackup.apimbackup"



This command restores an API Management service from Azure storage blob.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... management

Backup-AzureRmApiManagement

Get-AzureRmApiManagement

New-AzureRmApiManagement

Remove-AzureRmApiManagement