Skip to content

Commit c29e0ae

Browse files
memildinisra-fel
andauthored
Corrected docs for Get-AzSecurityPricing & Set-AzSecurityPricing (#13159)
* Corrected docs for Get-AzSecurityPricing Updated examples, descriptions, and output * Fixes following Chemi & Amit's review * Added Set-AzSecurityPricing * Final updates * Update Az.Security.md * Final changes Co-authored-by: Yeming Liu <[email protected]>
1 parent db95460 commit c29e0ae

File tree

3 files changed

+66
-34
lines changed

3 files changed

+66
-34
lines changed

src/Security/Security/help/Az.Security.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ Gets security contacts that were configured on this subscription
7272
Gets the location where Azure Security Center will automatically save data for the specific subscription
7373

7474
### [Get-AzSecurityPricing](Get-AzSecurityPricing.md)
75-
Gets the pricing tier data for Azure Security Center for a scope.
75+
Gets the pricing data for the Azure Defender plans enabled in Azure Security Center for a subscription.
7676

7777
### [Get-AzSecurityTask](Get-AzSecurityTask.md)
7878
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
135135
Updates a security contact for a subscription.
136136

137137
### [Set-AzSecurityPricing](Set-AzSecurityPricing.md)
138-
Sets the pricing of Azure Security Center tier for a scope.
138+
Sets the pricing data for the Azure Defender plans enabled in Azure Security Center for a subscription.
139139

140140
### [Set-AzSecurityWorkspaceSetting](Set-AzSecurityWorkspaceSetting.md)
141141
Updates the workspace settings for the subscription.

src/Security/Security/help/Get-AzSecurityPricing.md

Lines changed: 43 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -8,65 +8,78 @@ schema: 2.0.0
88
# Get-AzSecurityPricing
99

1010
## SYNOPSIS
11-
Gets the pricing tier data for Azure Security Center for a scope.
11+
12+
Gets the Azure Defender plans for a subscription in Azure Security Center.
1213

1314
## SYNTAX
1415

1516
### SubscriptionScope (Default)
16-
```
17+
18+
```powershell
1719
Get-AzSecurityPricing [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
1820
```
1921

2022
### SubscriptionLevelResource
21-
```
23+
24+
```powershell
2225
Get-AzSecurityPricing -Name <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
2326
```
2427

2528
### ResourceId
26-
```
29+
30+
```powershell
2731
Get-AzSecurityPricing -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
2832
```
2933

3034
## DESCRIPTION
31-
Azure Security Center pricing tier is decided per scope, with this cmdlet you can get the configured pricing tiers.
32-
Subscription pricing tier include all the resource groups under it.
33-
Resource Group pricing tier will override the subscription pricing tier.
35+
36+
You can view each Azure Defender plan, per subscription, using this cmdlet.
37+
38+
For details about Azure Defender and the available plans, see [Introduction to Azure Defender](https://docs.microsoft.com/azure/security-center/azure-defender).
3439

3540
## EXAMPLES
3641

3742
### Example 1
43+
3844
```powershell
3945
PS C:\> Get-AzSecurityPricing
40-
Id Name PricingTier
41-
-- ---- -----------
42-
Id--/subscriptions/fbaa2b23-e9dd-4bed-93c1-9e2a44f64bc0/providers/Microsoft.Security/pricings/VirtualMachines
43-
-- ---- -----------
44-
/subscriptions/fbaa2b23-e9dd-4bed-93c1-9e2a44f64bc0/providers/Microsoft.Security/pricings/SqlServers
45-
/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/providers/Microsoft.Security/pricings/default default Standard
46-
/subscriptions/fbaa2b23-e9dd-4bed-93c1-9e2a44f64bc0/providers/Microsoft.Security/pricings/AppServices
47-
/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.Security/pricings/myService1 myService1 Standard
48-
/subscriptions/fbaa2b23-e9dd-4bed-93c1-9e2a44f64bc0/providers/Microsoft.Security/pricings/StorageAccounts
49-
/subscriptions/fbaa2b23-e9dd-4bed-93c1-9e2a44f64bc0/providers/Microsoft.Security/pricings/SqlServerVirtualMachin…
50-
/subscriptions/fbaa2b23-e9dd-4bed-93c1-9e2a44f64bc0/providers/Microsoft.Security/pricings/KubernetesService
51-
/subscriptions/fbaa2b23-e9dd-4bed-93c1-9e2a44f64bc0/providers/Microsoft.Security/pricings/ContainerRegistry
52-
/subscriptions/fbaa2b23-e9dd-4bed-93c1-9e2a44f64bc0/providers/Microsoft.Security/pricings/KeyVaults
46+
Id Name PricingTier FreeTrialRemainingTime
47+
-- ---- ----------- ----------------------
48+
/subscriptions/fbaa2b23-e9dd-4bed-93c1-9e2a44f64bc0/providers/Microsoft.Security/pricings/VirtualMachines VirtualMachines Free 00:00:00
49+
/subscriptions/fbaa2b23-e9dd-4bed-93c1-9e2a44f64bc0/providers/Microsoft.Security/pricings/Sqlservers SqlServers Standard 00:00:00
50+
/subscriptions/fbaa2b23-e9dd-4bed-93c1-9e2a44f64bc0/providers/Microsoft.Security/pricings/AppServices AppServices Free 00:00:00
51+
/subscriptions/fbaa2b23-e9dd-4bed-93c1-9e2a44f64bc0/providers/Microsoft.Security/pricings/StorageAccounts StorageAccounts Free 00:00:00
52+
/subscriptions/fbaa2b23-e9dd-4bed-93c1-9e2a44f64bc0/providers/Microsoft.Security/pricings/SqlserverVirtualMachines SqlservervirtualMachines Free 00:00:00
53+
/subscriptions/fbaa2b23-e9dd-4bed-93c1-9e2a44f64bc0/providers/Microsoft.Security/pricings/KubernetesService KubernetesService Free 00:00:00
54+
/subscriptions/fbaa2b23-e9dd-4bed-93c1-9e2a44f64bc0/providers/Microsoft.Security/pricings/ContainerRegistry ContainerRegistry Free 00:00:00
55+
/subscriptions/fbaa2b23-e9dd-4bed-93c1-9e2a44f64bc0/providers/Microsoft.Security/pricings/KeyVaults KeyVaults Free 00:00:00
5356
```
5457

55-
Gets all the configured pricing tiers for the subscription and the resource groups under it.
58+
Gets the status of each Azure Defender plan for the subscription.
59+
60+
5661

5762
### Example 2
63+
5864
```powershell
59-
PS C:\> Get-AzSecurityPricing -ResourceGroupName "myService1"
60-
Id Name PricingTier
61-
-- ---- -----------
62-
/subscriptions/487bb485-b5b0-471e-9c0d-10717612f869/resourceGroups/myService1/providers/Microsoft.Security/pricings/myService1 myService1 Standard
65+
PS C:\> Get-AzSecurityPricing -ResourceId
6366
```
6467

65-
Gets the configured pricing tier for the "myService1" resource group.
68+
Gets pricing details of the specific resource ID. Where ResourceId is one of the IDs returned by `Get-AzSecurityPricing`.
69+
70+
### Example 3
71+
72+
```powershell
73+
PS C:\> Get-AzSecurityPricing -Name
74+
```
75+
76+
Gets pricing details of the named Azure Defender plan. Where `name` is one of the names returned by `Get-AzSecurityPricing`.
77+
6678

6779
## PARAMETERS
6880

6981
### -DefaultProfile
82+
7083
The credentials, account, tenant, and subscription used for communication with Azure.
7184

7285
```yaml
@@ -82,6 +95,7 @@ Accept wildcard characters: False
8295
```
8396
8497
### -Name
98+
8599
Resource name.
86100
87101
```yaml
@@ -97,6 +111,7 @@ Accept wildcard characters: False
97111
```
98112
99113
### -ResourceId
114+
100115
Resource ID.
101116
102117
```yaml
@@ -112,7 +127,8 @@ Accept wildcard characters: False
112127
```
113128
114129
### CommonParameters
115-
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).
130+
131+
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).
116132
117133
## INPUTS
118134

src/Security/Security/help/Set-AzSecurityPricing.md

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,38 +8,48 @@ schema: 2.0.0
88
# Set-AzSecurityPricing
99

1010
## SYNOPSIS
11-
Sets the pricing of Azure Security Center tier for a scope.
11+
12+
Enables or disables Azure Defender plans for a subscription in Azure Security Center.
1213

1314
## SYNTAX
1415

1516
### SubscriptionLevelResource (Default)
16-
```
17+
18+
```powershell
1719
Set-AzSecurityPricing -Name <String> -PricingTier <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf]
1820
[-Confirm] [<CommonParameters>]
1921
```
2022

2123
### InputObject
22-
```
24+
25+
```powershell
2326
Set-AzSecurityPricing -InputObject <PSSecurityPricing> [-DefaultProfile <IAzureContextContainer>] [-WhatIf]
2427
[-Confirm] [<CommonParameters>]
2528
```
2629

2730
## DESCRIPTION
28-
Sets the pricing of Azure Security Center tier for a scope.
31+
32+
Enable or disable any of the Azure Defender plans for a subscription.
33+
34+
For details about Azure Defender and the available plans, see [Introduction to Azure Defender](https://docs.microsoft.com/azure/security-center/azure-defender).
2935

3036
## EXAMPLES
3137

3238
### Example 1
39+
3340
```powershell
3441
PS C:\> Set-AzSecurityPricing -Name "virtualmachines" -PricingTier "Standard"
3542
```
3643

37-
Sets the subscription Azure Security Center pricing tier to "Standard"
44+
Enables **Azure Defender for servers** for the subscription.
45+
46+
"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.
3847

3948

4049
## PARAMETERS
4150

4251
### -DefaultProfile
52+
4353
The credentials, account, tenant, and subscription used for communication with Azure.
4454

4555
```yaml
@@ -55,6 +65,7 @@ Accept wildcard characters: False
5565
```
5666
5767
### -InputObject
68+
5869
Input Object.
5970
6071
```yaml
@@ -70,6 +81,7 @@ Accept wildcard characters: False
7081
```
7182
7283
### -Name
84+
7385
Resource name.
7486
7587
```yaml
@@ -85,6 +97,7 @@ Accept wildcard characters: False
8597
```
8698
8799
### -PricingTier
100+
88101
Pricing Tier.
89102
90103
```yaml
@@ -100,6 +113,7 @@ Accept wildcard characters: False
100113
```
101114
102115
### -Confirm
116+
103117
Prompts you for confirmation before running the cmdlet.
104118
105119
```yaml
@@ -115,6 +129,7 @@ Accept wildcard characters: False
115129
```
116130
117131
### -WhatIf
132+
118133
Shows what would happen if the cmdlet runs. The cmdlet is not run.
119134
120135
```yaml
@@ -130,6 +145,7 @@ Accept wildcard characters: False
130145
```
131146
132147
### CommonParameters
148+
133149
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).
134150
135151
## INPUTS

0 commit comments

Comments
 (0)