From 45f92548f9a32f5ea3513ca7e9083ac9c5abbd9c Mon Sep 17 00:00:00 2001 From: Mel <55078580+memildin@users.noreply.github.com> Date: Wed, 7 Oct 2020 21:59:18 +0300 Subject: [PATCH 1/6] Corrected docs for Get-AzSecurityPricing Updated examples, descriptions, and output --- .../Security/help/Get-AzSecurityPricing.md | 49 ++++++++++--------- 1 file changed, 27 insertions(+), 22 deletions(-) diff --git a/src/Security/Security/help/Get-AzSecurityPricing.md b/src/Security/Security/help/Get-AzSecurityPricing.md index 8f3663b720eb..01fd52db8e1a 100644 --- a/src/Security/Security/help/Get-AzSecurityPricing.md +++ b/src/Security/Security/help/Get-AzSecurityPricing.md @@ -29,40 +29,45 @@ Get-AzSecurityPricing -ResourceId [-DefaultProfile Get-AzSecurityPricing -Id Name PricingTier --- ---- ----------- -Id--/subscriptions/fbaa2b23-e9dd-4bed-93c1-9e2a44f64bc0/providers/Microsoft.Security/pricings/VirtualMachines --- ---- ----------- -/subscriptions/fbaa2b23-e9dd-4bed-93c1-9e2a44f64bc0/providers/Microsoft.Security/pricings/SqlServers -/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/pricings/default default Standard -/subscriptions/fbaa2b23-e9dd-4bed-93c1-9e2a44f64bc0/providers/Microsoft.Security/pricings/AppServices -/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.Security/pricings/myService1 myService1 Standard -/subscriptions/fbaa2b23-e9dd-4bed-93c1-9e2a44f64bc0/providers/Microsoft.Security/pricings/StorageAccounts -/subscriptions/fbaa2b23-e9dd-4bed-93c1-9e2a44f64bc0/providers/Microsoft.Security/pricings/SqlServerVirtualMachin… -/subscriptions/fbaa2b23-e9dd-4bed-93c1-9e2a44f64bc0/providers/Microsoft.Security/pricings/KubernetesService -/subscriptions/fbaa2b23-e9dd-4bed-93c1-9e2a44f64bc0/providers/Microsoft.Security/pricings/ContainerRegistry -/subscriptions/fbaa2b23-e9dd-4bed-93c1-9e2a44f64bc0/providers/Microsoft.Security/pricings/KeyVaults +Id Name PricingTier FreeTrialRemainingTime +-- ---- ----------- ---------------------- +/subscriptions/fbaa2b23-e9dd-4bed-93c1-9e2a44f64bc0/providers/Microsoft.Security/pricings/VirtualMachines VirtualMachines Free 00:00:00 +/subscriptions/fbaa2b23-e9dd-4bed-93c1-9e2a44f64bc0/providers/Microsoft.Security/pricings/Sqlservers SqlServers Standard 00:00:00 +/subscriptions/fbaa2b23-e9dd-4bed-93c1-9e2a44f64bc0/providers/Microsoft.Security/pricings/AppServices AppServices Free 00:00:00 +/subscriptions/fbaa2b23-e9dd-4bed-93c1-9e2a44f64bc0/providers/Microsoft.Security/pricings/StorageAccounts StorageAccounts Free 00:00:00 +/subscriptions/fbaa2b23-e9dd-4bed-93c1-9e2a44f64bc0/providers/Microsoft.Security/pricings/SqlserverVirtualMachines SqlservervirtualMachines Free 00:00:00 +/subscriptions/fbaa2b23-e9dd-4bed-93c1-9e2a44f64bc0/providers/Microsoft.Security/pricings/KubernetesService KubernetesService Free 00:00:00 +/subscriptions/fbaa2b23-e9dd-4bed-93c1-9e2a44f64bc0/providers/Microsoft.Security/pricings/ContainerRegistry ContainerRegistry Free 00:00:00 +/subscriptions/fbaa2b23-e9dd-4bed-93c1-9e2a44f64bc0/providers/Microsoft.Security/pricings/KeyVaults KeyVaults Free 00:00:00 ``` -Gets all the configured pricing tiers for the subscription and the resource groups under it. +Gets all the configured pricing tiers for the subscription. + + ### Example 2 ```powershell -PS C:\> Get-AzSecurityPricing -ResourceGroupName "myService1" -Id Name PricingTier --- ---- ----------- -/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.Security/pricings/myService1 myService1 Standard +PS C:\> Get-AzSecurityPricing -ResourceId ``` -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. + +### Example 3 +```powershell +PS C:\> Get-AzSecurityPricing -Name +``` + +Gets pricing details of the named Azure Defender plan. Where name is one of the names from example 1. + + +, and Name is one of 8 above as well. + ## PARAMETERS @@ -112,7 +117,7 @@ Accept wildcard characters: False ``` ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS From 31adba11cfc0609255aaa4ef8e0cca71eefa83af Mon Sep 17 00:00:00 2001 From: Mel Date: Sun, 11 Oct 2020 18:51:56 +0300 Subject: [PATCH 2/6] Fixes following Chemi & Amit's review --- src/Security/Security/help/Get-AzSecurityPricing.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/src/Security/Security/help/Get-AzSecurityPricing.md b/src/Security/Security/help/Get-AzSecurityPricing.md index 01fd52db8e1a..a0f84825f0a1 100644 --- a/src/Security/Security/help/Get-AzSecurityPricing.md +++ b/src/Security/Security/help/Get-AzSecurityPricing.md @@ -28,7 +28,9 @@ Get-AzSecurityPricing -ResourceId [-DefaultProfile Date: Sun, 11 Oct 2020 21:24:43 +0300 Subject: [PATCH 3/6] Added Set-AzSecurityPricing --- .../Security/help/Get-AzSecurityPricing.md | 29 ++++++++++++------- .../Security/help/Set-AzSecurityPricing.md | 22 +++++++++++--- 2 files changed, 37 insertions(+), 14 deletions(-) diff --git a/src/Security/Security/help/Get-AzSecurityPricing.md b/src/Security/Security/help/Get-AzSecurityPricing.md index a0f84825f0a1..1345f2226869 100644 --- a/src/Security/Security/help/Get-AzSecurityPricing.md +++ b/src/Security/Security/help/Get-AzSecurityPricing.md @@ -8,33 +8,39 @@ schema: 2.0.0 # Get-AzSecurityPricing ## SYNOPSIS -Gets the pricing tier data for Azure Security Center for a scope. + +Gets the pricing data for the Azure Defender plans enabled in Azure Security Center for a scope. ## SYNTAX ### SubscriptionScope (Default) -``` + +```powershell Get-AzSecurityPricing [-DefaultProfile ] [] ``` ### SubscriptionLevelResource -``` + +```powershell Get-AzSecurityPricing -Name [-DefaultProfile ] [] ``` ### ResourceId -``` + +```powershell Get-AzSecurityPricing -ResourceId [-DefaultProfile ] [] ``` ## DESCRIPTION -You can enable each Azure Defender plan, per subscription, using this cmdlet. -For details about Azure Defender and the available plans, see [Introduction to Azure Defender](https://docs.microsoft.com/azure/security-center/azure-defender) +Gets the status and pricing details of the Azure Defender plan for a subscription. + +For details about Azure Defender and the available plans, see [Introduction to Azure Defender](https://docs.microsoft.com/azure/security-center/azure-defender). ## EXAMPLES ### Example 1 + ```powershell PS C:\> Get-AzSecurityPricing Id Name PricingTier FreeTrialRemainingTime @@ -54,6 +60,7 @@ Gets the status of each Azure Defender plan for the subscription. ### Example 2 + ```powershell PS C:\> Get-AzSecurityPricing -ResourceId ``` @@ -61,19 +68,18 @@ PS C:\> Get-AzSecurityPricing -ResourceId Gets pricing details of the specific ID. Where ResourceId is one of IDs from example 1. ### Example 3 + ```powershell PS C:\> Get-AzSecurityPricing -Name ``` -Gets pricing details of the named Azure Defender plan. Where name is one of the names from example 1. - - -, and Name is one of 8 above as well. +Gets pricing details of the named Azure Defender plan. Where `name` is one of the names from example 1. ## PARAMETERS ### -DefaultProfile + The credentials, account, tenant, and subscription used for communication with Azure. ```yaml @@ -89,6 +95,7 @@ Accept wildcard characters: False ``` ### -Name + Resource name. ```yaml @@ -104,6 +111,7 @@ Accept wildcard characters: False ``` ### -ResourceId + Resource ID. ```yaml @@ -119,6 +127,7 @@ Accept wildcard characters: False ``` ### CommonParameters + This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS diff --git a/src/Security/Security/help/Set-AzSecurityPricing.md b/src/Security/Security/help/Set-AzSecurityPricing.md index 42a2fd217fbc..8415692d9ede 100644 --- a/src/Security/Security/help/Set-AzSecurityPricing.md +++ b/src/Security/Security/help/Set-AzSecurityPricing.md @@ -8,28 +8,35 @@ schema: 2.0.0 # Set-AzSecurityPricing ## SYNOPSIS -Sets the pricing of Azure Security Center tier for a scope. + +Sets the pricing data for the Azure Defender plans enabled in Azure Security Center for a scope. ## SYNTAX ### SubscriptionLevelResource (Default) -``` + +```powershell Set-AzSecurityPricing -Name -PricingTier [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ### InputObject -``` + +```powershell Set-AzSecurityPricing -InputObject [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION -Sets the pricing of Azure Security Center tier for a scope. + +Enable or disable any of the Azure Defender plans for a subscription. + +For details about Azure Defender and the available plans, see [Introduction to Azure Defender](https://docs.microsoft.com/azure/security-center/azure-defender). ## EXAMPLES ### Example 1 + ```powershell PS C:\> Set-AzSecurityPricing -Name "virtualmachines" -PricingTier "Standard" ``` @@ -40,6 +47,7 @@ Sets the subscription Azure Security Center pricing tier to "Standard" ## PARAMETERS ### -DefaultProfile + The credentials, account, tenant, and subscription used for communication with Azure. ```yaml @@ -55,6 +63,7 @@ Accept wildcard characters: False ``` ### -InputObject + Input Object. ```yaml @@ -70,6 +79,7 @@ Accept wildcard characters: False ``` ### -Name + Resource name. ```yaml @@ -85,6 +95,7 @@ Accept wildcard characters: False ``` ### -PricingTier + Pricing Tier. ```yaml @@ -100,6 +111,7 @@ Accept wildcard characters: False ``` ### -Confirm + Prompts you for confirmation before running the cmdlet. ```yaml @@ -115,6 +127,7 @@ Accept wildcard characters: False ``` ### -WhatIf + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml @@ -130,6 +143,7 @@ Accept wildcard characters: False ``` ### CommonParameters + This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS From 7c26a3bd05bf7934600ec6f818cd9847fb74664d Mon Sep 17 00:00:00 2001 From: Mel Date: Sun, 18 Oct 2020 15:12:56 +0300 Subject: [PATCH 4/6] Final updates --- src/Security/Security/help/Get-AzSecurityPricing.md | 4 ++-- src/Security/Security/help/Set-AzSecurityPricing.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/src/Security/Security/help/Get-AzSecurityPricing.md b/src/Security/Security/help/Get-AzSecurityPricing.md index 1345f2226869..2f31d786f092 100644 --- a/src/Security/Security/help/Get-AzSecurityPricing.md +++ b/src/Security/Security/help/Get-AzSecurityPricing.md @@ -9,7 +9,7 @@ schema: 2.0.0 ## SYNOPSIS -Gets the pricing data for the Azure Defender plans enabled in Azure Security Center for a scope. +Gets the pricing data for the Azure Defender plans enabled in Azure Security Center for a subscription. ## SYNTAX @@ -33,7 +33,7 @@ Get-AzSecurityPricing -ResourceId [-DefaultProfile Date: Tue, 20 Oct 2020 14:55:58 +0800 Subject: [PATCH 5/6] Update Az.Security.md --- src/Security/Security/help/Az.Security.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/Security/Security/help/Az.Security.md b/src/Security/Security/help/Az.Security.md index f9ce8f601f7e..bd5b67396c3f 100644 --- a/src/Security/Security/help/Az.Security.md +++ b/src/Security/Security/help/Az.Security.md @@ -72,7 +72,7 @@ Gets security contacts that were configured on this subscription Gets the location where Azure Security Center will automatically save data for the specific subscription ### [Get-AzSecurityPricing](Get-AzSecurityPricing.md) -Gets the pricing tier data for Azure Security Center for a scope. +Gets the pricing data for the Azure Defender plans enabled in Azure Security Center for a subscription. ### [Get-AzSecurityTask](Get-AzSecurityTask.md) Gets the security tasks that Azure Security Center recommends you to do in order to strengthen your security posture. @@ -135,7 +135,7 @@ Updates automatic provisioning setting Updates a security contact for a subscription. ### [Set-AzSecurityPricing](Set-AzSecurityPricing.md) -Sets the pricing of Azure Security Center tier for a scope. +Sets the pricing data for the Azure Defender plans enabled in Azure Security Center for a subscription. ### [Set-AzSecurityWorkspaceSetting](Set-AzSecurityWorkspaceSetting.md) Updates the workspace settings for the subscription. From 1775d7bf610d3d55959defacab2096e339c04367 Mon Sep 17 00:00:00 2001 From: Mel Date: Wed, 21 Oct 2020 11:07:11 +0300 Subject: [PATCH 6/6] Final changes --- src/Security/Security/help/Get-AzSecurityPricing.md | 8 ++++---- src/Security/Security/help/Set-AzSecurityPricing.md | 6 ++++-- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/src/Security/Security/help/Get-AzSecurityPricing.md b/src/Security/Security/help/Get-AzSecurityPricing.md index 2f31d786f092..be5e9bd260ca 100644 --- a/src/Security/Security/help/Get-AzSecurityPricing.md +++ b/src/Security/Security/help/Get-AzSecurityPricing.md @@ -9,7 +9,7 @@ schema: 2.0.0 ## SYNOPSIS -Gets the pricing data for the Azure Defender plans enabled in Azure Security Center for a subscription. +Gets the Azure Defender plans for a subscription in Azure Security Center. ## SYNTAX @@ -33,7 +33,7 @@ Get-AzSecurityPricing -ResourceId [-DefaultProfile Get-AzSecurityPricing -ResourceId ``` -Gets pricing details of the specific ID. Where ResourceId is one of IDs from example 1. +Gets pricing details of the specific resource ID. Where ResourceId is one of the IDs returned by `Get-AzSecurityPricing`. ### Example 3 @@ -73,7 +73,7 @@ Gets pricing details of the specific ID. Where ResourceId is one of IDs from exa PS C:\> Get-AzSecurityPricing -Name ``` -Gets pricing details of the named Azure Defender plan. Where `name` is one of the names from example 1. +Gets pricing details of the named Azure Defender plan. Where `name` is one of the names returned by `Get-AzSecurityPricing`. ## PARAMETERS diff --git a/src/Security/Security/help/Set-AzSecurityPricing.md b/src/Security/Security/help/Set-AzSecurityPricing.md index 79590b11443b..3d9c69dcf1ad 100644 --- a/src/Security/Security/help/Set-AzSecurityPricing.md +++ b/src/Security/Security/help/Set-AzSecurityPricing.md @@ -9,7 +9,7 @@ schema: 2.0.0 ## SYNOPSIS -Sets the pricing data for the Azure Defender plans enabled in Azure Security Center for a subscription. +Enables or disables Azure Defender plans for a subscription in Azure Security Center. ## SYNTAX @@ -41,7 +41,9 @@ For details about Azure Defender and the available plans, see [Introduction to A PS C:\> Set-AzSecurityPricing -Name "virtualmachines" -PricingTier "Standard" ``` -Sets the subscription Azure Security Center pricing tier to "Standard" +Enables **Azure Defender for servers** for the subscription. + +"Standard" refers to the "On" state for an Azure Defender plan as shown in Azure Security Center's pricing and settings area of the Azure portal. ## PARAMETERS