Pricings - Update

Updates a provided Microsoft Defender for Cloud pricing configuration in the subscription.

PUT https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Security/pricings/{pricingName}?api-version=2023-01-01

URI Parameters

Name In Required Type Description
pricingName
path True

string

name of the pricing configuration

subscriptionId
path True

string

Azure subscription ID

Regex pattern: ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$

api-version
query True

string

API version for the operation

Request Body

Name Required Type Description
properties.pricingTier True

pricingTier

The pricing tier value. Microsoft Defender for Cloud is provided in two pricing tiers: free and standard. The standard tier offers advanced security capabilities, while the free tier offers basic security features.

properties.extensions

Extension[]

Optional. List of extensions offered under a plan.

properties.subPlan

string

The sub-plan selected for a Standard pricing configuration, when more than one sub-plan is available. Each sub-plan enables a set of security features. When not specified, full plan is applied.

Responses

Name Type Description
200 OK

Pricing

OK

Other Status Codes

CloudError

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

Update pricing on subscription
Update pricing on subscription - partial success

Update pricing on subscription

Sample Request

PUT https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/pricings/CloudPosture?api-version=2023-01-01

{
  "properties": {
    "pricingTier": "Standard"
  }
}

Sample Response

{
  "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/pricings/CloudPosture",
  "name": "CloudPosture",
  "type": "Microsoft.Security/pricings",
  "properties": {
    "pricingTier": "Standard",
    "freeTrialRemainingTime": "PT0S",
    "enablementTime": "2023-03-01T12:42:42.1921106Z",
    "extensions": [
      {
        "name": "AgentlessVmScanning",
        "isEnabled": "True",
        "operationStatus": {
          "code": "Succeeded",
          "message": ""
        }
      },
      {
        "name": "AgentlessDiscoveryForKubernetes",
        "isEnabled": "True",
        "operationStatus": {
          "code": "Succeeded",
          "message": ""
        }
      },
      {
        "name": "SensitiveDataDiscovery",
        "isEnabled": "True",
        "operationStatus": {
          "code": "Succeeded",
          "message": ""
        }
      },
      {
        "name": "ContainerRegistriesVulnerabilityAssessments",
        "isEnabled": "True",
        "operationStatus": {
          "code": "Succeeded",
          "message": ""
        }
      }
    ]
  }
}

Update pricing on subscription - partial success

Sample Request

PUT https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/pricings/CloudPosture?api-version=2023-01-01

{
  "properties": {
    "pricingTier": "Standard"
  }
}

Sample Response

{
  "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/pricings/CloudPosture",
  "name": "CloudPosture",
  "type": "Microsoft.Security/pricings",
  "properties": {
    "pricingTier": "Standard",
    "freeTrialRemainingTime": "PT0S",
    "enablementTime": "2023-03-01T12:42:42.1921106Z",
    "extensions": [
      {
        "name": "AgentlessVmScanning",
        "isEnabled": "True",
        "operationStatus": {
          "code": "Succeeded",
          "message": ""
        }
      },
      {
        "name": "AgentlessDiscoveryForKubernetes",
        "isEnabled": "True",
        "operationStatus": {
          "code": "Succeeded",
          "message": ""
        }
      },
      {
        "name": "SensitiveDataDiscovery",
        "isEnabled": "True",
        "operationStatus": {
          "code": "Succeeded",
          "message": ""
        }
      },
      {
        "name": "ContainerRegistriesVulnerabilityAssessments",
        "isEnabled": "True",
        "operationStatus": {
          "code": "Failed",
          "message": "Extension enablemment failed due to missing permissions."
        }
      }
    ]
  }
}

Definitions

Name Description
CloudError

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

CloudErrorBody

The error detail.

code

The operation status code.

ErrorAdditionalInfo

The resource management error additional info.

Extension

A plan's extension properties

isEnabled

Indicates whether the extension is enabled.

OperationStatus

A status describing the success/failure of the extension's enablement/disablement operation.

Pricing

Microsoft Defender for Cloud is provided in two pricing tiers: free and standard. The standard tier offers advanced security capabilities, while the free tier offers basic security features.

pricingTier

The pricing tier value. Microsoft Defender for Cloud is provided in two pricing tiers: free and standard. The standard tier offers advanced security capabilities, while the free tier offers basic security features.

CloudError

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

Name Type Description
error.additionalInfo

ErrorAdditionalInfo[]

The error additional info.

error.code

string

The error code.

error.details

CloudErrorBody[]

The error details.

error.message

string

The error message.

error.target

string

The error target.

CloudErrorBody

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.

code

string

The error code.

details

CloudErrorBody[]

The error details.

message

string

The error message.

target

string

The error target.

code

The operation status code.

Name Type Description
Failed

string

Extension was not created/updated successfully. See operation status message for more details.

Succeeded

string

Extension was created/updated successfully.

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.

type

string

The additional info type.

Extension

A plan's extension properties

Name Type Description
additionalExtensionProperties

Property values associated with the extension.

isEnabled

isEnabled

Indicates whether the extension is enabled.

name

string

The extension name. Supported values are:

AgentlessDiscoveryForKubernetes - API-based discovery of information about Kubernetes cluster architecture, workload objects, and setup. Required for Kubernetes inventory, identity and network exposure detection, attack path analysis and risk hunting as part of the cloud security explorer. Available for CloudPosture plan.

OnUploadMalwareScanning - Limits the GB to be scanned per month for each storage account within the subscription. Once this limit reached on a given storage account, Blobs won't be scanned during current calendar month. Available for StorageAccounts plan.

SensitiveDataDiscovery - Sensitive data discovery identifies Blob storage container with sensitive data such as credentials, credit cards, and more, to help prioritize and investigate security events. Available for StorageAccounts and CloudPosture plans.

ContainerRegistriesVulnerabilityAssessments - Provides vulnerability management for images stored in your container registries. Available for CloudPosture and Containers plans.

operationStatus

OperationStatus

Optional. A status describing the success/failure of the extension's enablement/disablement operation.

isEnabled

Indicates whether the extension is enabled.

Name Type Description
False

string

Indicates the extension is disabled

True

string

Indicates the extension is enabled

OperationStatus

A status describing the success/failure of the extension's enablement/disablement operation.

Name Type Description
code

code

The operation status code.

message

string

Additional information regarding the success/failure of the operation.

Pricing

Microsoft Defender for Cloud is provided in two pricing tiers: free and standard. The standard tier offers advanced security capabilities, while the free tier offers basic security features.

Name Type Description
id

string

Resource Id

name

string

Resource name

properties.deprecated

boolean

Optional. True if the plan is deprecated. If there are replacing plans they will appear in replacedBy property

properties.enablementTime

string

Optional. If pricingTier is Standard then this property holds the date of the last time the pricingTier was set to Standard, when available (e.g 2023-03-01T12:42:42.1921106Z).

properties.extensions

Extension[]

Optional. List of extensions offered under a plan.

properties.freeTrialRemainingTime

string

The duration left for the subscriptions free trial period - in ISO 8601 format (e.g. P3Y6M4DT12H30M5S).

properties.pricingTier

pricingTier

The pricing tier value. Microsoft Defender for Cloud is provided in two pricing tiers: free and standard. The standard tier offers advanced security capabilities, while the free tier offers basic security features.

properties.replacedBy

string[]

Optional. List of plans that replace this plan. This property exists only if this plan is deprecated.

properties.subPlan

string

The sub-plan selected for a Standard pricing configuration, when more than one sub-plan is available. Each sub-plan enables a set of security features. When not specified, full plan is applied.

type

string

Resource type

pricingTier

The pricing tier value. Microsoft Defender for Cloud is provided in two pricing tiers: free and standard. The standard tier offers advanced security capabilities, while the free tier offers basic security features.

Name Type Description
Free

string

Get free Microsoft Defender for Cloud experience with basic security features

Standard

string

Get the standard Microsoft Defender for Cloud experience with advanced security features