Microsoft.Impact (preview:2024-05-01)

2025/02/18 • 1 updated methods

ImpactCategories_ListBySubscription (updated)
Description :  List ImpactCategory resources by subscription
Reference :  Link ¶

⚶ Changes

{
  "#id": "ImpactCategories_ListBySubscription",
  "$parameters": [
    {
      "#name": "resourceType",
      "Required": {
        "new": true,
        "old": false
      }
    }
  ]
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Impact/impactCategories
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
categoryName:
{
Description: Filter by category name ,
Required: False ,
}
string ,
resourceType:
{
Description: Filter by resource type ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The ImpactCategory items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: Resource provisioning state. ,
Enum:
{
Succeeded: Provisioning Succeeded ,
Failed: Provisioning Failed ,
Canceled: Provisioning Canceled ,
}
,
Required: False ,
}
enum ,
categoryId:
{
Description: Unique ID of the category ,
Required: True ,
}
string ,
parentCategoryId:
{
Description: Unique ID of the parent category ,
Required: False ,
}
string ,
description:
{
Description: Description of the category ,
Required: False ,
}
string ,
requiredImpactProperties:
{
Description: The workloadImpact properties which are required when reporting with the impact category ,
Required: False ,
}
[
{
name:
{
Description: Name of the property ,
Required: True ,
}
string ,
allowedValues:
{
Description: Allowed values values for the property ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}