你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Pricings - List
Lists Microsoft Defender与给定的可选$filter匹配的 scopeId 的云定价配置。 有效范围为:订阅 ID 或特定资源 ID, (支持的资源为:“VirtualMachines、VMSS 和 ARC 计算机”) 。 有效$filter为:“name in ({planName1},{planName2},...) ”。 如果未提供$filter,则将返回未筛选的列表。 如果提供了“$filter=name in (planName1,planName2) ”,则返回的列表仅包括为“planName1”和“planName2”设置的定价。
GET https://management.azure.com/{scopeId}/providers/Microsoft.Security/pricings?api-version=2024-01-01
GET https://management.azure.com/{scopeId}/providers/Microsoft.Security/pricings?api-version=2024-01-01&$filter={$filter}
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
scope
|
path | True |
string |
定价的范围 ID。 有效作用域为:订阅 (格式:“subscriptions/{subscriptionId}”) ,或特定资源 (格式:“subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}) - 支持的资源 (VirtualMachines) |
api-version
|
query | True |
string |
操作的 API 版本 |
$filter
|
query |
string |
OData 筛选器。 可选。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
确定 |
|
Other Status Codes |
描述操作失败原因的错误响应。 |
安全性
azure_auth
Azure Active Directory OAuth2 流
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
名称 | 说明 |
---|---|
user_impersonation | 模拟用户帐户 |
示例
Get pricings on resource |
Get pricings on subscription |
Get pricings on subscription with plans filter |
Get pricings on resource
Sample Request
GET https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/DEMO/providers/Microsoft.Compute/virtualMachines/VM-1/providers/Microsoft.Security/pricings?api-version=2024-01-01
Sample Response
{
"value": [
{
"id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/DEMO/providers/Microsoft.Compute/virtualMachines/VM-1/providers/Microsoft.Security/pricings/VirtualMachines",
"name": "VirtualMachines",
"type": "Microsoft.Security/pricings",
"properties": {
"pricingTier": "Standard",
"subPlan": "P2",
"freeTrialRemainingTime": "PT0S",
"enablementTime": "2023-03-01T12:42:42.1921106Z",
"inherited": "True",
"inheritedFrom": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23",
"extensions": [
{
"name": "AgentlessVmScanning",
"isEnabled": "True",
"additionalExtensionProperties": {
"ExclusionTags": "[{\"Key\":\"TestKey1\",\"Value\":\"TestValue1\"},{\"Key\":\"TestKey2\",\"Value\":\"TestValue2\"}]"
}
},
{
"name": "MdeDesignatedSubscription",
"isEnabled": "True"
}
]
}
},
{
"id": "/subscriptions/d34fd44c-ebfa-4a9c-bceb-9eeafe72ac15/resourceGroups/DEMO/providers/Microsoft.Compute/virtualMachines/VM-1/providers/Microsoft.Security/pricings/CloudPosture",
"name": "CloudPosture",
"type": "Microsoft.Security/pricings",
"properties": {
"pricingTier": "Free",
"inherited": "False",
"inheritedFrom": null
}
}
]
}
Get pricings on subscription
Sample Request
GET https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/pricings?api-version=2024-01-01
Sample Response
{
"value": [
{
"id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/pricings/VirtualMachines",
"name": "VirtualMachines",
"type": "Microsoft.Security/pricings",
"properties": {
"pricingTier": "Standard",
"subPlan": "P2",
"freeTrialRemainingTime": "PT0S",
"enablementTime": "2023-03-01T12:42:42.1921106Z",
"enforce": "False",
"resourcesCoverageStatus": "PartiallyCovered",
"extensions": [
{
"name": "AgentlessVmScanning",
"isEnabled": "True",
"additionalExtensionProperties": {
"ExclusionTags": "[{\"Key\":\"TestKey1\",\"Value\":\"TestValue1\"},{\"Key\":\"TestKey2\",\"Value\":\"TestValue2\"}]"
}
},
{
"name": "MdeDesignatedSubscription",
"isEnabled": "True"
}
]
}
},
{
"id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/pricings/SqlServers",
"name": "SqlServers",
"type": "Microsoft.Security/pricings",
"properties": {
"pricingTier": "Standard",
"freeTrialRemainingTime": "PT0S",
"enablementTime": "2023-03-01T12:42:42.1921106Z",
"enforce": "False",
"resourcesCoverageStatus": "FullyCovered"
}
},
{
"id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/pricings/AppServices",
"name": "AppServices",
"type": "Microsoft.Security/pricings",
"properties": {
"pricingTier": "Free",
"freeTrialRemainingTime": "PT0S",
"enforce": "False",
"resourcesCoverageStatus": "NotCovered"
}
},
{
"id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/pricings/StorageAccounts",
"name": "StorageAccounts",
"type": "Microsoft.Security/pricings",
"properties": {
"pricingTier": "Standard",
"subPlan": "DefenderForStorageV2",
"freeTrialRemainingTime": "PT0S",
"enablementTime": "2023-03-01T12:42:42.1921106Z",
"enforce": "False",
"resourcesCoverageStatus": "FullyCovered",
"extensions": [
{
"name": "OnUploadMalwareScanning",
"isEnabled": "True",
"additionalExtensionProperties": {
"capGBPerMonthPerStorageAccount": 10
}
},
{
"name": "SensitiveDataDiscovery",
"isEnabled": "True"
}
]
}
},
{
"id": "/subscriptions/d34fd44c-ebfa-4a9c-bceb-9eeafe72ac15/providers/Microsoft.Security/pricings/SqlServerVirtualMachines",
"name": "SqlServerVirtualMachines",
"type": "Microsoft.Security/pricings",
"properties": {
"pricingTier": "Standard",
"freeTrialRemainingTime": "PT0S",
"enablementTime": "2023-03-01T12:42:42.1921106Z",
"enforce": "False",
"resourcesCoverageStatus": "FullyCovered"
}
},
{
"id": "/subscriptions/d34fd44c-ebfa-4a9c-bceb-9eeafe72ac15/providers/Microsoft.Security/pricings/KubernetesService",
"name": "KubernetesService",
"type": "Microsoft.Security/pricings",
"properties": {
"pricingTier": "Free",
"freeTrialRemainingTime": "PT0S",
"enforce": "False",
"resourcesCoverageStatus": "NotCovered",
"deprecated": true,
"replacedBy": [
"Containers"
]
}
},
{
"id": "/subscriptions/d34fd44c-ebfa-4a9c-bceb-9eeafe72ac15/providers/Microsoft.Security/pricings/ContainerRegistry",
"name": "ContainerRegistry",
"type": "Microsoft.Security/pricings",
"properties": {
"pricingTier": "Free",
"freeTrialRemainingTime": "PT0S",
"enforce": "False",
"resourcesCoverageStatus": "NotCovered",
"deprecated": true,
"replacedBy": [
"Containers"
]
}
},
{
"id": "/subscriptions/d34fd44c-ebfa-4a9c-bceb-9eeafe72ac15/providers/Microsoft.Security/pricings/KeyVaults",
"name": "KeyVaults",
"type": "Microsoft.Security/pricings",
"properties": {
"pricingTier": "Standard",
"subPlan": "PerKeyVault",
"freeTrialRemainingTime": "PT0S",
"enablementTime": "2023-03-01T12:42:42.1921106Z",
"enforce": "False",
"resourcesCoverageStatus": "FullyCovered"
}
},
{
"id": "/subscriptions/d34fd44c-ebfa-4a9c-bceb-9eeafe72ac15/providers/Microsoft.Security/pricings/Dns",
"name": "Dns",
"type": "Microsoft.Security/pricings",
"properties": {
"pricingTier": "Standard",
"freeTrialRemainingTime": "PT0S",
"enablementTime": "2023-03-01T12:42:42.1921106Z",
"deprecated": true,
"replacedBy": [
"VirtualMachines"
],
"enforce": "False",
"resourcesCoverageStatus": "FullyCovered"
}
},
{
"id": "/subscriptions/d34fd44c-ebfa-4a9c-bceb-9eeafe72ac15/providers/Microsoft.Security/pricings/Arm",
"name": "Arm",
"type": "Microsoft.Security/pricings",
"properties": {
"pricingTier": "Standard",
"subPlan": "PerSubscription",
"freeTrialRemainingTime": "PT0S",
"enablementTime": "2023-03-01T12:42:42.1921106Z",
"enforce": "False",
"resourcesCoverageStatus": "FullyCovered"
}
},
{
"id": "/subscriptions/d34fd44c-ebfa-4a9c-bceb-9eeafe72ac15/providers/Microsoft.Security/pricings/OpenSourceRelationalDatabases",
"name": "OpenSourceRelationalDatabases",
"type": "Microsoft.Security/pricings",
"properties": {
"pricingTier": "Standard",
"freeTrialRemainingTime": "PT0S",
"enforce": "False",
"resourcesCoverageStatus": "FullyCovered"
}
},
{
"id": "/subscriptions/d34fd44c-ebfa-4a9c-bceb-9eeafe72ac15/providers/Microsoft.Security/pricings/Containers",
"name": "Containers",
"type": "Microsoft.Security/pricings",
"properties": {
"pricingTier": "Standard",
"freeTrialRemainingTime": "PT0S",
"enablementTime": "2023-03-01T12:42:42.1921106Z",
"enforce": "False",
"resourcesCoverageStatus": "FullyCovered",
"extensions": [
{
"name": "ContainerRegistriesVulnerabilityAssessments",
"isEnabled": "True"
}
]
}
},
{
"id": "/subscriptions/d34fd44c-ebfa-4a9c-bceb-9eeafe72ac15/providers/Microsoft.Security/pricings/CloudPosture",
"name": "CloudPosture",
"type": "Microsoft.Security/pricings",
"properties": {
"pricingTier": "Standard",
"freeTrialRemainingTime": "PT0S",
"enablementTime": "2023-03-01T12:42:42.1921106Z",
"enforce": "False",
"resourcesCoverageStatus": "FullyCovered",
"extensions": [
{
"name": "AgentlessVmScanning",
"isEnabled": "True",
"additionalExtensionProperties": {
"ExclusionTags": "[]"
}
},
{
"name": "AgentlessDiscoveryForKubernetes",
"isEnabled": "True"
},
{
"name": "SensitiveDataDiscovery",
"isEnabled": "True"
},
{
"name": "ContainerRegistriesVulnerabilityAssessments",
"isEnabled": "True"
},
{
"name": "EntraPermissionsManagement",
"isEnabled": "True"
}
]
}
},
{
"id": "subscriptions/d34fd44c-ebfa-4a9c-bceb-9eeafe72ac15/providers/Microsoft.Security/pricings/Api",
"name": "Api",
"type": "Microsoft.Security/pricings",
"properties": {
"pricingTier": "Standard",
"subPlan": "P1",
"freeTrialRemainingTime": "PT0S"
}
}
]
}
Get pricings on subscription with plans filter
Sample Request
GET https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/pricings?api-version=2024-01-01
Sample Response
{
"value": [
{
"id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/pricings/VirtualMachines",
"name": "VirtualMachines",
"type": "Microsoft.Security/pricings",
"properties": {
"pricingTier": "Standard",
"subPlan": "P2",
"freeTrialRemainingTime": "PT0S",
"enablementTime": "2023-03-01T12:42:42.1921106Z",
"enforce": "False",
"resourcesCoverageStatus": "PartiallyCovered",
"extensions": [
{
"name": "AgentlessVmScanning",
"isEnabled": "True",
"additionalExtensionProperties": {
"ExclusionTags": "[{\"Key\":\"TestKey1\",\"Value\":\"TestValue1\"},{\"Key\":\"TestKey2\",\"Value\":\"TestValue2\"}]"
}
},
{
"name": "MdeDesignatedSubscription",
"isEnabled": "True"
}
]
}
},
{
"id": "/subscriptions/d34fd44c-ebfa-4a9c-bceb-9eeafe72ac15/providers/Microsoft.Security/pricings/KeyVaults",
"name": "KeyVaults",
"type": "Microsoft.Security/pricings",
"properties": {
"pricingTier": "Standard",
"subPlan": "PerKeyVault",
"freeTrialRemainingTime": "PT0S",
"enablementTime": "2023-03-01T12:42:42.1921106Z",
"enforce": "False",
"resourcesCoverageStatus": "FullyCovered"
}
}
]
}
定义
名称 | 说明 |
---|---|
Cloud |
对所有 Azure 资源管理器 API 的常见错误响应,可返回失败操作的错误详细信息。 (这也遵循 OData 错误响应格式.) 。 |
Cloud |
错误详细信息。 |
code |
操作状态代码。 |
enforce |
如果设置为“False”,则允许此范围的后代覆盖在此范围上设置的定价配置, (允许设置 inherited=“False”) 。 如果设置为“True”,则会阻止重写,并强制对此范围的所有后代进行此定价配置。 此字段仅适用于订阅级定价。 |
Error |
资源管理错误附加信息。 |
Extension |
计划的扩展属性 |
inherited |
“inherited” = “True” 表示当前范围从其父级继承其定价配置。 提供继承配置的父范围的 ID 显示在“inheritedFrom”字段中。 另一方面,“inherited” = “False” 表示当前范围显式设置了自己的定价配置,并且不会从其父级继承。 此字段是只读的,仅适用于资源级定价。 |
is |
指示是否启用扩展。 |
Operation |
描述扩展的启用/禁用操作成功/失败的状态。 |
Pricing |
Microsoft Defender for Cloud 分为两个定价层:免费和标准。 标准层提供高级安全功能,而免费层提供基本安全功能。 |
Pricing |
定价配置响应列表。 |
pricing |
指示是否在所选范围内启用 Defender 计划。 Microsoft Defender for Cloud 分为两个定价层:免费和标准。 标准层提供高级安全功能,而免费层提供基本安全功能。 |
resources |
此字段仅适用于订阅级别,并反映订阅下资源的覆盖状态。 请注意:“pricingTier”字段反映订阅的计划状态。 但是,由于计划状态也可以在资源级别定义,因此订阅的计划状态和资源状态之间可能存在不一致。 此字段有助于指示资源的覆盖状态。 |
CloudError
对所有 Azure 资源管理器 API 的常见错误响应,可返回失败操作的错误详细信息。 (这也遵循 OData 错误响应格式.) 。
名称 | 类型 | 说明 |
---|---|---|
error.additionalInfo |
错误附加信息。 |
|
error.code |
string |
错误代码。 |
error.details |
错误详细信息。 |
|
error.message |
string |
错误消息。 |
error.target |
string |
错误目标。 |
CloudErrorBody
错误详细信息。
名称 | 类型 | 说明 |
---|---|---|
additionalInfo |
错误附加信息。 |
|
code |
string |
错误代码。 |
details |
错误详细信息。 |
|
message |
string |
错误消息。 |
target |
string |
错误目标。 |
code
操作状态代码。
名称 | 类型 | 说明 |
---|---|---|
Failed |
string |
扩展未成功创建/更新。 有关更多详细信息,请参阅操作状态消息。 |
Succeeded |
string |
已成功创建/更新扩展。 |
enforce
如果设置为“False”,则允许此范围的后代覆盖在此范围上设置的定价配置, (允许设置 inherited=“False”) 。 如果设置为“True”,则会阻止重写,并强制对此范围的所有后代进行此定价配置。 此字段仅适用于订阅级定价。
名称 | 类型 | 说明 |
---|---|---|
False |
string |
允许此范围的后代覆盖在此范围上设置的定价配置, (允许设置 inherited=“False”) |
True |
string |
阻止替代,并将当前范围的定价配置强制用于所有后代 |
ErrorAdditionalInfo
资源管理错误附加信息。
名称 | 类型 | 说明 |
---|---|---|
info |
object |
其他信息。 |
type |
string |
其他信息类型。 |
Extension
计划的扩展属性
名称 | 类型 | 说明 |
---|---|---|
additionalExtensionProperties |
与扩展关联的属性值。 |
|
isEnabled |
指示是否启用扩展。 |
|
name |
string |
扩展插件名称。 支持的值是: |
operationStatus |
可选。 描述扩展的启用/禁用操作成功/失败的状态。 |
inherited
“inherited” = “True” 表示当前范围从其父级继承其定价配置。 提供继承配置的父范围的 ID 显示在“inheritedFrom”字段中。 另一方面,“inherited” = “False” 表示当前范围显式设置了自己的定价配置,并且不会从其父级继承。 此字段是只读的,仅适用于资源级定价。
名称 | 类型 | 说明 |
---|---|---|
False |
string |
指示当前范围设置其自己的定价配置,并且不会从其父级继承它 |
True |
string |
指示当前范围正在从其父级继承其定价配置 |
isEnabled
指示是否启用扩展。
名称 | 类型 | 说明 |
---|---|---|
False |
string |
指示扩展已禁用 |
True |
string |
指示扩展已启用 |
OperationStatus
描述扩展的启用/禁用操作成功/失败的状态。
名称 | 类型 | 说明 |
---|---|---|
code |
操作状态代码。 |
|
message |
string |
有关操作成功/失败的其他信息。 |
Pricing
Microsoft Defender for Cloud 分为两个定价层:免费和标准。 标准层提供高级安全功能,而免费层提供基本安全功能。
名称 | 类型 | 说明 |
---|---|---|
id |
string |
资源 ID |
name |
string |
资源名称 |
properties.deprecated |
boolean |
可选。 如果计划已弃用,则其值为 True。 如果有替换计划,它们将显示在 属性中 |
properties.enablementTime |
string |
可选。 如果 |
properties.enforce |
如果设置为“False”,则允许此范围的后代覆盖在此范围上设置的定价配置, (允许设置 inherited=“False”) 。 如果设置为“True”,则会阻止重写,并强制对此范围的所有后代进行此定价配置。 此字段仅适用于订阅级定价。 |
|
properties.extensions |
可选。 计划下提供的扩展列表。 |
|
properties.freeTrialRemainingTime |
string |
订阅免费试用版剩余的持续时间 - ISO 8601 格式 (例如P3Y6M4DT12H30M5S) 。 |
properties.inherited |
“inherited” = “True” 表示当前范围从其父级继承其定价配置。 提供继承配置的父范围的 ID 显示在“inheritedFrom”字段中。 另一方面,“inherited” = “False” 表示当前范围显式设置了自己的定价配置,并且不会从其父级继承。 此字段是只读的,仅适用于资源级定价。 |
|
properties.inheritedFrom |
string |
继承自的范围的 ID。 如果未继承,则为“Null”。 此字段仅适用于资源级定价。 |
properties.pricingTier |
指示是否在所选范围内启用 Defender 计划。 Microsoft Defender for Cloud 分为两个定价层:免费和标准。 标准层提供高级安全功能,而免费层提供基本安全功能。 |
|
properties.replacedBy |
string[] |
可选。 替换此计划的计划列表。 仅当此计划已弃用时,此属性才存在。 |
properties.resourcesCoverageStatus |
此字段仅适用于订阅级别,并反映订阅下资源的覆盖状态。 请注意:“pricingTier”字段反映订阅的计划状态。 但是,由于计划状态也可以在资源级别定义,因此订阅的计划状态和资源状态之间可能存在不一致。 此字段有助于指示资源的覆盖状态。 |
|
properties.subPlan |
string |
当有多个子计划可用时,为标准定价配置选择的子计划。 每个子计划都支持一组安全功能。 如果未指定,则应用完整计划。 对于 VirtualMachines 计划,可用的子计划为“P1”&“P2”,其中仅支持资源级别的“P1”子计划。 |
type |
string |
资源类型 |
PricingList
定价配置响应列表。
名称 | 类型 | 说明 |
---|---|---|
value |
Pricing[] |
定价配置列表 |
pricingTier
指示是否在所选范围内启用 Defender 计划。 Microsoft Defender for Cloud 分为两个定价层:免费和标准。 标准层提供高级安全功能,而免费层提供基本安全功能。
名称 | 类型 | 说明 |
---|---|---|
Free |
string |
使用基本安全功能获取免费的 Microsoft Defender for Cloud 体验 |
Standard |
string |
使用高级安全功能获取标准Microsoft Defender for Cloud 体验 |
resourcesCoverageStatus
此字段仅适用于订阅级别,并反映订阅下资源的覆盖状态。 请注意:“pricingTier”字段反映订阅的计划状态。 但是,由于计划状态也可以在资源级别定义,因此订阅的计划状态和资源状态之间可能存在不一致。 此字段有助于指示资源的覆盖状态。
名称 | 类型 | 说明 |
---|---|---|
FullyCovered |
string |
此值指示与订阅关联的所有资源都已启用 Defender 计划。 |
NotCovered |
string |
此值指示已为订阅下的所有资源禁用 Defender 计划。 Defender 计划不保护任何资源。 |
PartiallyCovered |
string |
此值指示订阅下的某些资源已启用 Defender 计划,而其他资源则禁用了 Defender 计划。 资源之间的覆盖率状态是混合的。 |