Skip to content

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

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

Merged
isra-fel merged 6 commits into from
Oct 21, 2020
Merged

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

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
45f9254
Corrected docs for Get-AzSecurityPricing
memildin Oct 7, 2020
31adba1
Fixes following Chemi & Amit's review
memildin Oct 11, 2020
c4b8759
Added Set-AzSecurityPricing
memildin Oct 11, 2020
7c26a3b
Final updates
memildin Oct 18, 2020
d87c146
Update Az.Security.md
isra-fel Oct 20, 2020
1775d7b
Final changes
memildin Oct 21, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 43 additions & 27 deletions src/Security/Security/help/Get-AzSecurityPricing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,65 +8,78 @@ 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 <IAzureContextContainer>] [<CommonParameters>]
```

### SubscriptionLevelResource
```

```powershell
Get-AzSecurityPricing -Name <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
```

### ResourceId
```

```powershell
Get-AzSecurityPricing -ResourceId <String> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
```

## DESCRIPTION
Azure Security Center pricing tier is decided per scope, with this cmdlet you can get the configured pricing tiers.
Subscription pricing tier include all the resource groups under it.
Comment thread
chshum marked this conversation as resolved.
Resource Group pricing tier will override the subscription pricing tier.
Comment thread
chshum marked this conversation as resolved.

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
-- ---- -----------
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 the status of each Azure Defender plan 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.

@chshum chshum Oct 13, 2020

Copy link
Copy Markdown

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)


### 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.

@chshum chshum Oct 13, 2020

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

same



## PARAMETERS

### -DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

```yaml
Expand All @@ -82,6 +95,7 @@ Accept wildcard characters: False
```

### -Name

Resource name.

```yaml
Expand All @@ -97,6 +111,7 @@ Accept wildcard characters: False
```

### -ResourceId

Resource ID.

```yaml
Expand All @@ -112,7 +127,8 @@ 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

Expand Down
22 changes: 18 additions & 4 deletions src/Security/Security/help/Set-AzSecurityPricing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Comment thread
memildin marked this conversation as resolved.
Outdated

## SYNTAX

### SubscriptionLevelResource (Default)
```

```powershell
Set-AzSecurityPricing -Name <String> -PricingTier <String> [-DefaultProfile <IAzureContextContainer>] [-WhatIf]
[-Confirm] [<CommonParameters>]
```

### InputObject
```

```powershell
Set-AzSecurityPricing -InputObject <PSSecurityPricing> [-DefaultProfile <IAzureContextContainer>] [-WhatIf]
[-Confirm] [<CommonParameters>]
```

## 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"
```
Expand All @@ -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
Expand All @@ -55,6 +63,7 @@ Accept wildcard characters: False
```

### -InputObject

Input Object.

```yaml
Expand All @@ -70,6 +79,7 @@ Accept wildcard characters: False
```

### -Name

Resource name.

```yaml
Expand All @@ -85,6 +95,7 @@ Accept wildcard characters: False
```

### -PricingTier

Pricing Tier.

```yaml
Expand All @@ -100,6 +111,7 @@ Accept wildcard characters: False
```

### -Confirm

Prompts you for confirmation before running the cmdlet.

```yaml
Expand All @@ -115,6 +127,7 @@ Accept wildcard characters: False
```

### -WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

```yaml
Expand All @@ -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
Expand Down