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

Merged

isra-fel merged 6 commits intomasterfrom

memildin-patch-4

Oct 21, 2020

Contributor

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


          Corrected docs for Get-AzSecurityPricing

45f9254

Updated examples, descriptions, and output

azuresdkci added the needs-review label

memildin closed this

memildin reopened this

Contributor Author

memildin commented Oct 8, 2020

#sign-off

memildin closed this

memildin reopened this

memildin closed this

memildin reopened this

memildin requested a review from taklei

October 8, 2020 19:30

Contributor Author

memildin commented Oct 8, 2020

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

chshum reviewed

View reviewed changes

src/Security/Security/help/Get-AzSecurityPricing.md Show resolved Hide resolved

isra-fel self-assigned this

Member

isra-fel commented Oct 9, 2020

/azp run azure-powershell - powershell-core

Contributor

azure-pipelines bot commented Oct 9, 2020

Azure Pipelines successfully started running 1 pipeline(s).

isra-fel added needs-revision and removed needs-review labels

isra-fel assigned memildin

isra-fel added the Doc - Reference label

amitbiton1988 reviewed

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.

amitbiton1988 Oct 10, 2020

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?

Contributor Author

memildin Oct 11, 2020

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


          Fixes following Chemi & Amit's review

31adba1

amitbiton1988 previously approved these changes

View reviewed changes

chshum suggested changes

View reviewed changes

src/Security/Security/help/Get-AzSecurityPricing.md Show resolved Hide resolved

src/Security/Security/help/Get-AzSecurityPricing.md Show resolved Hide resolved


          Added Set-AzSecurityPricing

c4b8759

memildin dismissed amitbiton1988’s stale review via

c4b8759

October 11, 2020 18:24

memildin changed the title ~~Corrected docs for Get-AzSecurityPricing~~ Corrected docs for Get-AzSecurityPricing & Set-AzSecurityPricing

chshum reviewed

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.

chshum Oct 13, 2020

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 reviewed

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.

chshum Oct 13, 2020

same

chshum reviewed

View reviewed changes

src/Security/Security/help/Set-AzSecurityPricing.md Outdated Show resolved Hide resolved

src/Security/Security/help/Get-AzSecurityPricing.md Show resolved Hide resolved


          Final updates

7c26a3b

Contributor Author

memildin commented Oct 18, 2020

#sign-off

memildin commented

View reviewed changes

Contributor Author

memildin left a comment

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

isra-fel previously approved these changes

View reviewed changes

Member

isra-fel left a comment

LGTM


          Update Az.Security.md

d87c146

isra-fel dismissed their stale review via

d87c146

October 20, 2020 06:56

isra-fel previously approved these changes

View reviewed changes

Member

isra-fel left a comment

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

isra-fel added needs-review and removed needs-revision labels

isra-fel assigned chshum

Contributor

msJinLei commented Oct 21, 2020

/azp run

Contributor

azure-pipelines bot commented Oct 21, 2020

Azure Pipelines successfully started running 3 pipeline(s).


          Final changes

1775d7b

memildin dismissed isra-fel’s stale review via

1775d7b

October 21, 2020 08:07

chshum approved these changes

View reviewed changes

chshum closed this

chshum reopened this

Contributor Author

memildin commented Oct 21, 2020

#sign-off

isra-fel merged commit c29e0ae into master

Contributor Author

memildin commented Oct 28, 2020

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

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

Labels

Doc - Reference needs-review