DimensionsOperations Class

DimensionsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance

builtins.object

DimensionsOperations

Constructor

DimensionsOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

Methods

by_external_cloud_provider_type	Lists the dimensions by the external cloud provider type.
list	Lists the dimensions by the defined scope.

by_external_cloud_provider_type

Lists the dimensions by the external cloud provider type.

by_external_cloud_provider_type(external_cloud_provider_type: Union[str, _models.ExternalCloudProviderType], external_cloud_provider_id: str, filter: Optional[str] = None, expand: Optional[str] = None, skiptoken: Optional[str] = None, top: Optional[int] = None, **kwargs: Any) -> Iterable[_models.DimensionsListResult]

Parameters

external_cloud_provider_type

str or ExternalCloudProviderType

Required

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

external_cloud_provider_id

str

Required

This can be '{externalSubscriptionId}' for linked account or '{externalBillingAccountId}' for consolidated account used with dimension/query operations.

filter

str

default value: None

May be used to filter dimensions by properties/category, properties/usageStart, properties/usageEnd. Supported operators are 'eq','lt', 'gt', 'le', 'ge'.

expand

str

default value: None

May be used to expand the properties/data within a dimension category. By default, data is not included when listing dimensions.

skiptoken

str

default value: None

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

int

default value: None

May be used to limit the number of results to the most recent N dimension data.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either DimensionsListResult or the result of cls(response)

Return type

ItemPaged[DimensionsListResult]

Exceptions

HttpResponseError

list

Lists the dimensions by the defined scope.

list(scope: str, filter: Optional[str] = None, expand: Optional[str] = None, skiptoken: Optional[str] = None, top: Optional[int] = None, **kwargs: Any) -> Iterable[_models.DimensionsListResult]

Parameters

scope

str

Required

The scope associated with dimension operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners.

filter

str

default value: None

May be used to filter dimensions by properties/category, properties/usageStart, properties/usageEnd. Supported operators are 'eq','lt', 'gt', 'le', 'ge'.

expand

str

default value: None

May be used to expand the properties/data within a dimension category. By default, data is not included when listing dimensions.

skiptoken

str

default value: None

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

int

default value: None

May be used to limit the number of results to the most recent N dimension data.

cls

callable

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either DimensionsListResult or the result of cls(response)

Return type

ItemPaged[<xref:azure.mgmt.costmanagement.models.DimensionsListResultor None>]

Exceptions

HttpResponseError

Attributes

models

models = <module 'azure.mgmt.costmanagement.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\costmanagement\\models\\__init__.py'>