Skip to content

OSA Restore in RecoveryServices.Backup #5310

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jan 22, 2018
Merged

Conversation

dragonfly91
Copy link

@dragonfly91 dragonfly91 commented Jan 19, 2018

Adding UseOriginalStorageAccountForDiskRestore parameter to Restore cmdlet.

Description


This checklist is used to make sure that common guidelines for a pull request are followed. You can find a more complete discussion of PowerShell cmdlet best practices here.

General Guidelines

  • Title of the pull request is clear and informative.
  • There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.
  • The pull request does not introduce breaking changes (unless a major version change occurs in the assembly and module).

Testing Guidelines

  • Pull request includes test coverage for the included changes.
  • PowerShell scripts used in tests should do any necessary setup as part of the test or suite setup, and should not use hard-coded values for locations or existing resources.

Cmdlet Signature Guidelines

  • New cmdlets that make changes or have side effects should implement ShouldProcess and have SupportShouldProcess=true specified in the cmdlet attribute. You can find more information on ShouldProcess here.
  • Cmdlet specifies OutputType attribute if any output is produced - if the cmdlet produces no output, it should implement a PassThru parameter.

Cmdlet Parameter Guidelines

  • Parameter types should not expose types from the management library - complex parameter types should be defined in the module.
  • Complex parameter types are discouraged - a parameter type should be simple types as often as possible. If complex types are used, they should be shallow and easily creatable from a constructor or another cmdlet.
  • Cmdlet parameter sets should be mutually exclusive - each parameter set must have at least one mandatory parameter not in other parameter sets.

@maddieclayton
Copy link
Contributor

@dragonfly91 The parameter name is currently very long, I think that -UseOriginalStorageAccount would work as well without losing clarity for the user. Also, can you update the changelog with this change?

@@ -213,6 +213,13 @@ function Test-AzureVMFullRestore

Set-AzureRmRecoveryServicesVaultContext -Vault $vault;

Assert-ThrowsContains { Restore-AzureRmRecoveryServicesBackupItem `
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add a positive test for this parameter?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This feature is not enabled by default, so setting up the test artefacts for the positive case is quite difficult. Will take this up at a later time when the feature is enabled by default.

/// <summary>
/// Use this switch if the disks from the recovery point are to be restored to their original storage accounts
/// </summary>
[Parameter(Mandatory = false, Position = 3,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No position is necessary for SwitchParameters

Copy link
Member

@markcowl markcowl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dragonfly91 It is OK to defer the test as long as you file a test debt issue for this, assign it to yourself, and put it into the next milestone (2018-02-09). Meanwhile, please fix the mismatch between help and cmdlet

@@ -15,8 +15,8 @@ Restores the data and configuration for a Backup item to a recovery point.

```
Restore-AzureRmRecoveryServicesBackupItem [-RecoveryPoint] <RecoveryPointBase> [-StorageAccountName] <String>
[-StorageAccountResourceGroupName] <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
[<CommonParameters>]
[-StorageAccountResourceGroupName] <String> [-UseOriginalStorageAccountForDiskRestore]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The parameter name in help does not match the test parameter. This needs to be corrected before we can release

@cormacpayne
Copy link
Member

@dragonfly91
Copy link
Author

dragonfly91 commented Jan 22, 2018

Hi @markcowl, filed the following issue for the positive test case: #5331

@dragonfly91
Copy link
Author

dragonfly91 commented Jan 22, 2018

Hi, I've addressed all the comments. Is it possible for this PR to be part of the current Jan release?

@cormacpayne cormacpayne dismissed stale reviews from maddieclayton and markcowl January 22, 2018 19:31

Approved offline

@cormacpayne cormacpayne merged commit 8cfd729 into Azure:preview Jan 22, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants