Skip to content

Add Enable-AdlStoreKeyVault cmdlet and help #4023

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 6 commits into from
Jun 1, 2017

Conversation

begoldsm
Copy link
Contributor

@begoldsm begoldsm commented May 24, 2017

Description

There was a missing cmdlet to enable the keyvault for an ADLS account.
This cmdlet has been added, as well as a simple test for it and an
update to our help.


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.

There was a missing cmdlet to enable the keyvault for an ADLS account.
This cmdlet has been added, as well as a simple test for it and an
update to our help.
@begoldsm
Copy link
Contributor Author

@markcowl any concerns with this PR? I want to make sure it makes it in for the next release.

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.

Two minor comments. Kicking off on demand as these will not impact it.

{
[Parameter(ValueFromPipelineByPropertyName = true, Position = 0, Mandatory = true,
HelpMessage = "The Data Lake Store account to enable the Key Vault for")]
[ValidateNotNullOrEmpty]
Copy link
Member

Choose a reason for hiding this comment

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

Alias("Name")]

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is a break from the pattern that we have been using for other ADLA and ADLS commands. Is it expected that we should include a "Name" alias as well now? I am ok with adding it here right now, just want to make sure that I know it should be added to the other cmdlets in the future as well.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@markcowl just spoke with PM. We would rather hold off on this to make sure it makes sense for all of our cmdlets that have an Account/AccountName parameter, since we want to ensure a consistent parameter naming across all the ADL cmdlets for users. Given this, are you ok with accepting this PR without the Alias change?

Copy link
Member

Choose a reason for hiding this comment

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

@begoldsm This is just about piping scenarios. If the intention is to allow piping from generic cmdlets, then this needs to be 'Name' to allow piping by PropertyName. Otherwise, not sure why you would have piping ByPropertyName for the 'resourcegroupname' parameter

@@ -82,6 +82,7 @@ CmdletsToExport = 'Get-AzureRmDataLakeStoreTrustedIdProvider',
'Set-AzureRmDataLakeStoreFirewallRule',
'Add-AzureRmDataLakeStoreFirewallRule',
'Add-AzureRmDataLakeStoreItemContent',
'Enable-AzureRmDataLakeStoreKeyVault',
Copy link
Member

Choose a reason for hiding this comment

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

indentation

@markcowl
Copy link
Member

Fix tabbing.
@markcowl
Copy link
Member

@begoldsm
Copy link
Contributor Author

@markcowl I addressed your feedback and added the "name" alias. Now that we have an issue opened against this can we get this merged to ensure that it makes it in for the next release?

@markcowl
Copy link
Member

@begoldsm You will need to fix the following static analysis issue from the on-demand run:

"Enable-AzureRmDataLakeStoreKeyVault Does not support ShouldProcess but the cmdlet verb Enable indicates that it should.

So you will either need to support ShouldProcess or add an exception if you are sure this cmdlet makes no permanent changes.

@begoldsm
Copy link
Contributor Author

@begoldsm
Copy link
Contributor Author

@markcowl new NEW on demand run here (and it passed!): http://azuresdkci.cloudapp.net/view/1-AzurePowerShell/job/powershell-demand/1631/

@cormacpayne cormacpayne dismissed markcowl’s stale review June 1, 2017 16:59

Approved offline

@cormacpayne cormacpayne merged commit cc9a484 into Azure:preview Jun 1, 2017
azure-sdk referenced this pull request in azure-sdk/azure-powershell Apr 27, 2022
[Hub Generated] Publish private branch 'dev-orbital-Microsoft.Orbital-2021-04-04-preview' (Azure#18551)

* New Swagger Spec File

* New Swagger Example Spec File

* New Readme Config File

* New Azure AZ Readme Config File

* New Azure CLI Readme Config File

* New Go Language Readme Config File

* New Python Language Readme Config File

* New Typescript Language Readme Config File

* New C# Language Readme Config File

* Orbital sdk 2021 04 04 preview (#5253)

* New Readme Config File

* New Go Language Readme Config File

* New Typescript Language Readme Config File

* New Python Language Readme Config File

* New C# Language Readme Config File

* New Ruby Language Readme Config File

* New Swagger Spec File

* New Swagger Example Spec File

* Added orbital.json file

* Passed linting using AutoRest for 2020-09-01 Azure Orbital Private Privew

* Updated Operation object under Azure Orbital 2020-09-01 preview.

* Updated Operation object under Azure Orbital 2020-09-01 preview.

* Updated Satellites object for Azure Orbital 2020-09-01 preview

* Updated examples for Azure Orbital Private Preview 2020-09-01

* Updated examples for Azure Orbital Private Preview 2020-09-01

* Updated examples for Azure Orbital Private Preview 2020-09-01

* Addressed feedback from ARMChangesRequested

* Updated the GetAvailableContacts api to add long running operation

* Updated the api version

* Updated the objects based on discussion with PM.

* list available ground station made a POST request (#2521)

* list available ground station made a POST request

* Swagger LintDiff fix

Co-authored-by: Devanshu Singh <[email protected]>

* swagger specs for version-20210404-preview

* removed cross version references. Copied over unchanged examples from the previous API version 2021-09-01-preview

* removed availableGroundStations API

* New Readme Config File

New Go Language Readme Config File

New Typescript Language Readme Config File

New Python Language Readme Config File

New C# Language Readme Config File

New Ruby Language Readme Config File

New Swagger Spec File

New Swagger Example Spec File

Added orbital.json file

Passed linting using AutoRest for 2020-09-01 Azure Orbital Private Privew

Updated Operation object under Azure Orbital 2020-09-01 preview.

Updated Operation object under Azure Orbital 2020-09-01 preview.

Updated Satellites object for Azure Orbital 2020-09-01 preview

Updated examples for Azure Orbital Private Preview 2020-09-01

Updated examples for Azure Orbital Private Preview 2020-09-01

Updated examples for Azure Orbital Private Preview 2020-09-01

Addressed feedback from ARMChangesRequested

Updated the GetAvailableContacts api to add long running operation

Updated the api version

Updated the objects based on discussion with PM.

list available ground station made a POST request (#2521)

* list available ground station made a POST request

* Swagger LintDiff fix

Co-authored-by: Devanshu Singh <[email protected]>

* validation check changes. Avocado, SpellCheck and prettier

* validation checks changes

* Modify readme.md for sdk generation

* added system data

* sdk pre namer validation changes

* lintdiff warning changes

* add comms scenario swagger (#3794)

* add comms scenario swagger

* remove unused example

* fix some validation errors

* fix style issues

* update spec based on feedback

* add updated example files

* fix CI errors

* change endpoints/connections list APIs to posts from gets

* connections lists from endpoints return resource IDs rather than full
objects.

* update examples files for endpoints connections list APIs

* fix operationIds and add descriptions

* fix more op ids and add descriptions for real

* fix typos, add constraints, and remove kbps/gbps from bandwidth (#4023)

* Updates to Resource Types (Modifications and Renames) (#4294)

* update orbital.json

* update examples

* prettier fix

* unfix old api version

* fix ci issues

* make more fields immutable

* update provisioning states

* swagger specs for Available groundstation APIs, version 2021-preview (#4920)

* swagger specs for Available groundstation APIs, version 2021-preview

* npm prettier check

* added type object

* removed capability and global comms info from responses

* prettier fix

* changed AP id response

* changes to schema to follow ARM format, resource id update

* Spelling check fix

* Ground Station spell check

* added groundstation to custom words

* Revert "added groundstation to custom words"

This reverts commit 0d7e18217de98836dcb8ba991685e15436004836.

* Revert "Ground Station spell check"

This reverts commit ef85b3b26f9ddf81dc1f50a9b677f9d8f115c4cf.

* Revert "Spelling check fix"

This reverts commit 6bd95c6e013889b6d488703846bbe87bbbb9c494.

* word addition

* type in response

* type definition in swagger

* readonly add

Co-authored-by: Akanksha Bhattacharyya <[email protected]>

* removed comms APIs

* readme updated

* fixed Swagger Avocado errors

* swagger lintDiff fix 1

* swagger lintDiff fix 2

* swagger lintDiff fix 3

Co-authored-by: Sunny Patel <[email protected]>
Co-authored-by: Sunny Patel <[email protected]>
Co-authored-by: Arthur Ning <[email protected]>
Co-authored-by: Devanshu Singh <[email protected]>
Co-authored-by: Zhenglai Zhang <[email protected]>
Co-authored-by: Jim Harris <[email protected]>
Co-authored-by: Akanksha Bhattacharyya <[email protected]>
Co-authored-by: Akanksha Bhattacharyya <[email protected]>

* operation IDs updated (#5461)

Co-authored-by: Devanshu Singh <[email protected]>

* Dev orbital microsoft.orbital 2021 04 04 preview (#5491)

* operation IDs updated

* updated OperationListResult definition

* review points implemented

Co-authored-by: Devanshu Singh <[email protected]>

* Azure Orbital - Review points implemented (#5507)

* operation IDs updated

* updated OperationListResult definition

* review points implemented

* referencing CloudError, ApiVersionParameter, ResourceGroupNameParameter, SubscriptionIdParameter from common-types

* reverting cloudError refs

* prettify json

* reorder some parameters

Co-authored-by: Devanshu Singh <[email protected]>
Co-authored-by: ArcturusZhang <[email protected]>

* Removed Empty allOf (#5510)

* operation IDs updated

* updated OperationListResult definition

* review points implemented

* referencing CloudError, ApiVersionParameter, ResourceGroupNameParameter, SubscriptionIdParameter from common-types

* reverting cloudError refs

* prettify json

* removed empty allOf

* validation checks

Co-authored-by: Devanshu Singh <[email protected]>

* readme.go.md fixed (#5512)

* operation IDs updated

* updated OperationListResult definition

* review points implemented

* referencing CloudError, ApiVersionParameter, ResourceGroupNameParameter, SubscriptionIdParameter from common-types

* reverting cloudError refs

* prettify json

* removed empty allOf

* validation checks

* readme.go.md fixed

Co-authored-by: Devanshu Singh <[email protected]>

* Remove last empty allOf (#5513)

* operation IDs updated

* updated OperationListResult definition

* review points implemented

* referencing CloudError, ApiVersionParameter, ResourceGroupNameParameter, SubscriptionIdParameter from common-types

* reverting cloudError refs

* prettify json

* removed empty allOf

* validation checks

* readme.go.md fixed

* remove one last empty allOf

Co-authored-by: Devanshu Singh <[email protected]>

* stable API version 2022-03-01

* valid json

* lint diff fix

* lint diff fix 2

* avocado fix

* lint diff warninga 1

* lint diff warnings 2

* prettier fix

* readme.me updated 2022-03-01

* Update readme.python.md

Co-authored-by: Sunny Patel <[email protected]>
Co-authored-by: Sunny Patel <[email protected]>
Co-authored-by: Arthur Ning <[email protected]>
Co-authored-by: Devanshu Singh <[email protected]>
Co-authored-by: Zhenglai Zhang <[email protected]>
Co-authored-by: Jim Harris <[email protected]>
Co-authored-by: Akanksha Bhattacharyya <[email protected]>
Co-authored-by: Akanksha Bhattacharyya <[email protected]>
Co-authored-by: ArcturusZhang <[email protected]>
Co-authored-by: Yuchao Yan <[email protected]>
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