Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Corrected docs for Get-AzSecurityPricing & Set-AzSecurityPricing #13159

Merged
merged 6 commits into from
Oct 21, 2020
Merged

Corrected docs for Get-AzSecurityPricing & Set-AzSecurityPricing #13159

merged 6 commits into from
Oct 21, 2020

Conversation

memildin
Copy link
Contributor

@memildin memildin commented Oct 7, 2020

Updated examples, descriptions, and output

Description

Updated examples, descriptions, and output. This is a Docs-only change: the API was updated months ago.

Checklist

  • I have read the Submitting Changes section of CONTRIBUTING.md
  • The title of the PR is clear and informative
  • The appropriate ChangeLog.md file(s) has been updated:
    • For any service, the ChangeLog.md file can be found at src/{{SERVICE}}/{{SERVICE}}/ChangeLog.md
    • A snippet outlining the change(s) made in the PR should be written under the ## Upcoming Release header -- no new version header should be added
  • The PR does not introduce breaking changes
  • If applicable, the changes made in the PR have proper test coverage
  • For public API changes to cmdlets:
    • a cmdlet design review was approved for the changes in this repository (Microsoft internal only)
    • the markdown help files have been regenerated using the commands listed here

@memildin
Corrected docs for Get-AzSecurityPricing
45f9254 
Updated examples, descriptions, and output
@memildin memildin closed this Oct 8, 2020
@memildin memildin reopened this Oct 8, 2020
@memildin
Copy link
Contributor Author

memildin commented Oct 8, 2020

#sign-off

@memildin memildin closed this Oct 8, 2020
@memildin memildin reopened this Oct 8, 2020
@memildin memildin closed this Oct 8, 2020
@memildin memildin reopened this Oct 8, 2020
@memildin memildin requested a review from taklei October 8, 2020 19:30
@memildin
Copy link
Contributor Author

memildin commented Oct 8, 2020

@taklei please can you help me get the checks to complete?

@isra-fel isra-fel self-assigned this Oct 9, 2020
@isra-fel
Copy link
Member

isra-fel commented Oct 9, 2020

/azp run azure-powershell - powershell-core

@azure-pipelines
Copy link
Contributor

Azure Pipelines successfully started running 1 pipeline(s).

amitbiton1988
amitbiton1988 reviewed Oct 10, 2020
View reviewed changes
src/Security/Security/help/Get-AzSecurityPricing.md Outdated
```

Gets all the configured pricing tiers for the subscription and the resource groups under it.
Gets all the configured pricing tiers for the subscription.
Copy link

Choose a reason for hiding this comment

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

We might need to correlate between the terms here to Azure Defender terminology. @memildin , Does this legitimate to add a link here to our documentation for more information about our Azure Defender plans and bundles?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@amitbiton1988, I can certainly try.
Again, there are no "bundles" anymore.

amitbiton1988
amitbiton1988 previously approved these changes Oct 11, 2020
View reviewed changes
@memildin memildin changed the title Corrected docs for Get-AzSecurityPricing Corrected docs for Get-AzSecurityPricing & Set-AzSecurityPricing Oct 11, 2020
chshum
chshum reviewed Oct 13, 2020
View reviewed changes
src/Security/Security/help/Get-AzSecurityPricing.md Outdated
```

Gets the configured pricing tier for the "myService1" resource group.
Gets pricing details of the specific ID. Where ResourceId is one of IDs from example 1.
Copy link

Choose a reason for hiding this comment

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

should be "where resourceId is one of the Azure defender plans resource id returned in "Get-AzSecurityPricing" (since the example will be out of date once we add a new bundle)

chshum
chshum reviewed Oct 13, 2020
View reviewed changes
src/Security/Security/help/Get-AzSecurityPricing.md Outdated
PS C:\> Get-AzSecurityPricing -Name
```

Gets pricing details of the named Azure Defender plan. Where `name` is one of the names from example 1.
Copy link

Choose a reason for hiding this comment

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

same

@memildin
Copy link
Contributor Author

#sign-off

memildin
memildin commented Oct 18, 2020
View reviewed changes
Copy link
Contributor Author

@memildin memildin left a comment

Choose a reason for hiding this comment

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

Thanks, @chshum.
I've handled these changes in the latest commit.

isra-fel
isra-fel previously approved these changes Oct 20, 2020
View reviewed changes
Copy link
Member

@isra-fel isra-fel left a comment

Choose a reason for hiding this comment

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

LGTM

isra-fel
isra-fel previously approved these changes Oct 20, 2020
View reviewed changes
Copy link
Member

@isra-fel isra-fel left a comment

Choose a reason for hiding this comment

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

Whenever you update the SYNOPSIS of a cmdlet you would like to update the catalog file help/Az.***.md as well. (I've done that)

Pending you final approval @chshum

@msJinLei
Copy link
Contributor

/azp run

@azure-pipelines
Copy link
Contributor

Azure Pipelines successfully started running 3 pipeline(s).

@chshum chshum closed this Oct 21, 2020
@chshum chshum reopened this Oct 21, 2020
@memildin
Copy link
Contributor Author

#sign-off

@isra-fel isra-fel merged commit c29e0ae into master Oct 21, 2020
@memildin
Copy link
Contributor Author

@isra-fel do you know when this will be published?

@isra-fel isra-fel deleted the memildin-patch-4 branch May 26, 2021 00:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@chshum chshum chshum approved these changes

@amitbiton1988 amitbiton1988 amitbiton1988 left review comments

@isra-fel isra-fel isra-fel left review comments

@taklei taklei Awaiting requested review from taklei

Assignees

@isra-fel isra-fel

@chshum chshum

@memildin memildin

Labels
Doc - Reference needs-review
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@memildin @isra-fel @msJinLei @chshum @amitbiton1988 @azuresdkci