Dimensions - By External Cloud Provider Type

Reference

Service:: Cost Management

API Version:: 2023-11-01

Lists the dimensions by the external cloud provider type.

GET https://management.azure.com/providers/Microsoft.CostManagement/{externalCloudProviderType}/{externalCloudProviderId}/dimensions?api-version=2023-11-01

With optional parameters:

GET https://management.azure.com/providers/Microsoft.CostManagement/{externalCloudProviderType}/{externalCloudProviderId}/dimensions?api-version=2023-11-01&$filter={$filter}&$expand={$expand}&$skiptoken={$skiptoken}&$top={$top}

URI Parameters

Name	In	Required	Type	Description
externalCloudProviderId	path	True	string	This can be '{externalSubscriptionId}' for linked account or '{externalBillingAccountId}' for consolidated account used with dimension/query operations.
externalCloudProviderType	path	True	externalCloudProviderType	The external cloud provider type associated with dimension/query operations. This includes 'externalSubscriptions' for linked account and 'externalBillingAccounts' for consolidated account.
api-version	query	True	string	The API version to use for this operation.
$expand	query		string	May be used to expand the properties/data within a dimension category. By default, data is not included when listing dimensions.
$filter	query		string	May be used to filter dimensions by properties/category, properties/usageStart, properties/usageEnd. Supported operators are 'eq','lt', 'gt', 'le', 'ge'.
$skiptoken	query		string	Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.
$top	query		integer int32	May be used to limit the number of results to the most recent N dimension data.

Responses

Name	Type	Description
200 OK	DimensionsListResult	OK. The request has succeeded.
Other Status Codes	ErrorResponse	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

ExternalBillingAccountDimensionList

ExternalSubscriptionDimensionList

ExternalBillingAccountDimensionList

Sample Request

HTTP

GET https://management.azure.com/providers/Microsoft.CostManagement/externalBillingAccounts/100/dimensions?api-version=2023-11-01

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "providers/Microsoft.CostManagement/externalBillingAccounts/100/dimensions_ResourceType_2019-12-01_2019-12-31",
      "name": "dimensions_ResourceType_2019-12-01_2019-12-31",
      "type": "microsoft.consumption/dimensions",
      "properties": {
        "data": [
          "thoroetrg01",
          "default-notificationhubs-westus",
          "jedikeyvaultrg",
          "contosocodeflow8d4a",
          "noobaa"
        ],
        "total": 0,
        "category": "ResourceType",
        "description": "Resource type",
        "usageStart": "2019-12-01T00:00:00Z",
        "usageEnd": "2019-12-31T00:00:00Z",
        "filterEnabled": true,
        "groupingEnabled": true
      }
    },
    {
      "id": "providers/Microsoft.CostManagement/externalBillingAccounts/100/dimensions_ResourceId_2019-12-01_2019-12-31",
      "name": "dimensions_ResourceId_2019-12-01_2019-12-31",
      "type": "microsoft.consumption/dimensions",
      "properties": {
        "data": [
          "thoroetrg01",
          "default-notificationhubs-westus",
          "jedikeyvaultrg",
          "contosocodeflow8d4a",
          "noobaa"
        ],
        "total": 0,
        "category": "ResourceId",
        "description": "Resource ID",
        "usageStart": "2019-12-01T00:00:00Z",
        "usageEnd": "2019-12-31T00:00:00Z",
        "filterEnabled": true,
        "groupingEnabled": true
      }
    }
  ]
}

ExternalSubscriptionDimensionList

Sample Request

HTTP

GET https://management.azure.com/providers/Microsoft.CostManagement/externalSubscriptions/100/dimensions?api-version=2023-11-01

Sample Response

Status code:: 200

{
  "value": [
    {
      "id": "providers/Microsoft.CostManagement/externalSubscriptions/123/dimensions_ResourceType_2019-12-01_2019-12-31",
      "name": "dimensions_ResourceType_2019-12-01_2019-12-31",
      "type": "microsoft.consumption/dimensions",
      "properties": {
        "data": [
          "thoroetrg01",
          "default-notificationhubs-westus",
          "jedikeyvaultrg",
          "contosocodeflow8d4a",
          "noobaa"
        ],
        "total": 0,
        "category": "ResourceType",
        "description": "Resource type",
        "usageStart": "2019-12-01T00:00:00Z",
        "usageEnd": "2019-12-31T00:00:00Z",
        "filterEnabled": true,
        "groupingEnabled": true
      }
    },
    {
      "id": "providers/Microsoft.CostManagement/externalSubscriptions/123/dimensions_ResourceId_2019-12-01_2019-12-31",
      "name": "dimensions_ResourceId_2019-12-01_2019-12-31",
      "type": "microsoft.consumption/dimensions",
      "properties": {
        "data": [
          "thoroetrg01",
          "default-notificationhubs-westus",
          "jedikeyvaultrg",
          "contosocodeflow8d4a",
          "noobaa"
        ],
        "total": 0,
        "category": "ResourceId",
        "description": "Resource ID",
        "usageStart": "2019-12-01T00:00:00Z",
        "usageEnd": "2019-12-31T00:00:00Z",
        "filterEnabled": true,
        "groupingEnabled": true
      }
    }
  ]
}

Definitions

Name	Description
Dimension	List of Dimension.
DimensionsListResult	Result of listing dimensions. It contains a list of available dimensions.
ErrorDetails	The details of the error.
ErrorResponse	Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message. Some Error responses: 429 TooManyRequests - Request is throttled. Retry after waiting for the time specified in the "x-ms-ratelimit-microsoft.consumption-retry-after" header. 503 ServiceUnavailable - Service is temporarily unavailable. Retry after waiting for the time specified in the "Retry-After" header.
externalCloudProviderType	The external cloud provider type associated with dimension/query operations. This includes 'externalSubscriptions' for linked account and 'externalBillingAccounts' for consolidated account.

Dimension

List of Dimension.

Name	Type	Description
eTag	string	ETag of the resource.
id	string	Resource Id.
location	string	Location of the resource.
name	string	Resource name.
properties.category	string	Dimension category.
properties.data	string[]	Dimension data.
properties.description	string	Dimension description.
properties.filterEnabled	boolean	Filter enabled.
properties.groupingEnabled	boolean	Grouping enabled.
properties.nextLink	string	The link (url) to the next page of results.
properties.total	integer	Total number of data for the dimension.
properties.usageEnd	string	Usage end.
properties.usageStart	string	Usage start.
sku	string	SKU of the resource.
tags	object	Resource tags.
type	string	Resource type.

DimensionsListResult

Result of listing dimensions. It contains a list of available dimensions.

Name	Type	Description
value	Dimension[]	The list of dimensions.

ErrorDetails

The details of the error.

Name	Type	Description
code	string	Error code.
message	string	Error message indicating why the operation failed.

ErrorResponse

Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.

Some Error responses:

429 TooManyRequests - Request is throttled. Retry after waiting for the time specified in the "x-ms-ratelimit-microsoft.consumption-retry-after" header.
503 ServiceUnavailable - Service is temporarily unavailable. Retry after waiting for the time specified in the "Retry-After" header.

Name	Type	Description
error	ErrorDetails	The details of the error.

externalCloudProviderType

The external cloud provider type associated with dimension/query operations. This includes 'externalSubscriptions' for linked account and 'externalBillingAccounts' for consolidated account.

Name	Type	Description
externalBillingAccounts	string
externalSubscriptions	string

Dimensions - By External Cloud Provider Type

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

ExternalBillingAccountDimensionList

Sample Request

Sample Response

ExternalSubscriptionDimensionList

Sample Request

Sample Response

Definitions

Dimension

DimensionsListResult

ErrorDetails

ErrorResponse

externalCloudProviderType

Additional resources