azure.mgmt.consumption.operations module¶
-
class
azure.mgmt.consumption.operations.
UsageDetailsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
UsageDetailsOperations operations.
Parameters: - client – Client for service requests.
- config – Configuration of service client.
- serializer – An object model serializer.
- deserializer – An object model deserializer.
Variables: api_version – Version of the API to be used with the client request. The current version is 2018-01-31. Constant value: “2018-01-31”.
-
list
(expand=None, filter=None, skiptoken=None, top=None, custom_headers=None, raw=False, **operation_config)[source]¶ Lists the usage details for a scope by billing period. Usage details are available via this API only for May 1, 2014 or later.
Parameters: - expand (str) – May be used to expand the properties/additionalProperties or properties/meterDetails within a list of usage details. By default, these fields are not included when listing usage details.
- filter (str) – May be used to filter usageDetails by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName or properties/instanceId. The filter supports ‘eq’, ‘lt’, ‘gt’, ‘le’, ‘ge’, and ‘and’. It does not currently support ‘ne’, ‘or’, or ‘not’.
- skiptoken (str) – 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) – May be used to limit the number of results to the most recent N usageDetails.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of UsageDetail
Return type: Raises:
-
list_by_billing_period
(billing_period_name, expand=None, filter=None, skiptoken=None, top=None, custom_headers=None, raw=False, **operation_config)[source]¶ Lists the usage details for a scope by billing period. Usage details are available via this API only for May 1, 2014 or later.
Parameters: - billing_period_name (str) – Billing Period Name.
- expand (str) – May be used to expand the properties/additionalProperties or properties/meterDetails within a list of usage details. By default, these fields are not included when listing usage details.
- filter (str) – May be used to filter usageDetails by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName or properties/instanceId. The filter supports ‘eq’, ‘lt’, ‘gt’, ‘le’, ‘ge’, and ‘and’. It does not currently support ‘ne’, ‘or’, or ‘not’.
- skiptoken (str) – 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) – May be used to limit the number of results to the most recent N usageDetails.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of UsageDetail
Return type: Raises:
-
models
= <module 'azure.mgmt.consumption.models' from '/usr/lib/python3.7/site-packages/azure/mgmt/consumption/models/__init__.py'>¶
-
class
azure.mgmt.consumption.operations.
MarketplacesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
MarketplacesOperations operations.
Parameters: - client – Client for service requests.
- config – Configuration of service client.
- serializer – An object model serializer.
- deserializer – An object model deserializer.
Variables: api_version – Version of the API to be used with the client request. The current version is 2018-01-31. Constant value: “2018-01-31”.
-
list
(filter=None, top=None, skiptoken=None, custom_headers=None, raw=False, **operation_config)[source]¶ Lists the marketplaces for a scope by subscriptionId. Marketplaces are available via this API only for May 1, 2014 or later.
Parameters: - filter (str) – May be used to filter marketplaces by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName or properties/instanceId. The filter supports ‘eq’, ‘lt’, ‘gt’, ‘le’, ‘ge’, and ‘and’. It does not currently support ‘ne’, ‘or’, or ‘not’.
- top (int) – May be used to limit the number of results to the most recent N marketplaces.
- skiptoken (str) – 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.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of Marketplace
Return type: Raises:
-
list_by_billing_period
(billing_period_name, filter=None, top=None, skiptoken=None, custom_headers=None, raw=False, **operation_config)[source]¶ Lists the marketplaces for a scope by billing period and subscripotionId. Marketplaces are available via this API only for May 1, 2014 or later.
Parameters: - billing_period_name (str) – Billing Period Name.
- filter (str) – May be used to filter marketplaces by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName or properties/instanceId. The filter supports ‘eq’, ‘lt’, ‘gt’, ‘le’, ‘ge’, and ‘and’. It does not currently support ‘ne’, ‘or’, or ‘not’.
- top (int) – May be used to limit the number of results to the most recent N marketplaces.
- skiptoken (str) – 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.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of Marketplace
Return type: Raises:
-
models
= <module 'azure.mgmt.consumption.models' from '/usr/lib/python3.7/site-packages/azure/mgmt/consumption/models/__init__.py'>¶
-
class
azure.mgmt.consumption.operations.
ReservationsSummariesOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ReservationsSummariesOperations operations.
Parameters: - client – Client for service requests.
- config – Configuration of service client.
- serializer – An object model serializer.
- deserializer – An object model deserializer.
Variables: api_version – Version of the API to be used with the client request. The current version is 2018-01-31. Constant value: “2018-01-31”.
-
list_by_reservation_order
(reservation_order_id, grain, filter=None, custom_headers=None, raw=False, **operation_config)[source]¶ Lists the reservations summaries for daily or monthly grain.
Parameters: - reservation_order_id (str) – Order Id of the reservation
- grain (str or Datagrain) – Can be daily or monthly. Possible values include: ‘DailyGrain’, ‘MonthlyGrain’
- filter (str) – Required only for daily grain. The properties/UsageDate for start date and end date. The filter supports ‘le’ and ‘ge’
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of ReservationSummaries
Return type: Raises:
-
list_by_reservation_order_and_reservation
(reservation_order_id, reservation_id, grain, filter=None, custom_headers=None, raw=False, **operation_config)[source]¶ Lists the reservations summaries for daily or monthly grain.
Parameters: - reservation_order_id (str) – Order Id of the reservation
- reservation_id (str) – Id of the reservation
- grain (str or Datagrain) – Can be daily or monthly. Possible values include: ‘DailyGrain’, ‘MonthlyGrain’
- filter (str) – Required only for daily grain. The properties/UsageDate for start date and end date. The filter supports ‘le’ and ‘ge’
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of ReservationSummaries
Return type: Raises:
-
models
= <module 'azure.mgmt.consumption.models' from '/usr/lib/python3.7/site-packages/azure/mgmt/consumption/models/__init__.py'>¶
-
class
azure.mgmt.consumption.operations.
ReservationsDetailsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ReservationsDetailsOperations operations.
Parameters: - client – Client for service requests.
- config – Configuration of service client.
- serializer – An object model serializer.
- deserializer – An object model deserializer.
Variables: api_version – Version of the API to be used with the client request. The current version is 2018-01-31. Constant value: “2018-01-31”.
-
list_by_reservation_order
(reservation_order_id, filter, custom_headers=None, raw=False, **operation_config)[source]¶ Lists the reservations details for provided date range.
Parameters: - reservation_order_id (str) – Order Id of the reservation
- filter (str) – Filter reservation details by date range. The properties/UsageDate for start date and end date. The filter supports ‘le’ and ‘ge’
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of ReservationDetails
Return type: Raises:
-
list_by_reservation_order_and_reservation
(reservation_order_id, reservation_id, filter, custom_headers=None, raw=False, **operation_config)[source]¶ Lists the reservations details for provided date range.
Parameters: - reservation_order_id (str) – Order Id of the reservation
- reservation_id (str) – Id of the reservation
- filter (str) – Filter reservation details by date range. The properties/UsageDate for start date and end date. The filter supports ‘le’ and ‘ge’
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of ReservationDetails
Return type: Raises:
-
models
= <module 'azure.mgmt.consumption.models' from '/usr/lib/python3.7/site-packages/azure/mgmt/consumption/models/__init__.py'>¶
-
class
azure.mgmt.consumption.operations.
BudgetsOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
BudgetsOperations operations.
Parameters: - client – Client for service requests.
- config – Configuration of service client.
- serializer – An object model serializer.
- deserializer – An object model deserializer.
Variables: api_version – Version of the API to be used with the client request. The current version is 2018-01-31. Constant value: “2018-01-31”.
-
create_or_update
(budget_name, parameters, custom_headers=None, raw=False, **operation_config)[source]¶ The operation to create or update a budget. Update operation requires latest eTag to be set in the request mandatorily. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag.
Parameters: - budget_name (str) – Budget Name.
- parameters (Budget) – Parameters supplied to the Create Budget operation.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: Budget or ClientRawResponse if raw=true
Return type: Budget or ClientRawResponse
Raises:
-
create_or_update_by_resource_group_name
(resource_group_name, budget_name, parameters, custom_headers=None, raw=False, **operation_config)[source]¶ The operation to create or update a budget. Update operation requires latest eTag to be set in the request mandatorily. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag.
Parameters: - resource_group_name (str) – Azure Resource Group Name.
- budget_name (str) – Budget Name.
- parameters (Budget) – Parameters supplied to the Create Budget operation.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: Budget or ClientRawResponse if raw=true
Return type: Budget or ClientRawResponse
Raises:
-
delete
(budget_name, custom_headers=None, raw=False, **operation_config)[source]¶ The operation to delete a budget.
Parameters: - budget_name (str) – Budget Name.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises:
-
delete_by_resource_group_name
(resource_group_name, budget_name, custom_headers=None, raw=False, **operation_config)[source]¶ The operation to delete a budget.
Parameters: - resource_group_name (str) – Azure Resource Group Name.
- budget_name (str) – Budget Name.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: None or ClientRawResponse if raw=true
Return type: None or ClientRawResponse
Raises:
-
get
(budget_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the budget for a subscription by budget name.
Parameters: - budget_name (str) – Budget Name.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: Budget or ClientRawResponse if raw=true
Return type: Budget or ClientRawResponse
Raises:
-
get_by_resource_group_name
(resource_group_name, budget_name, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the budget for a resource group under a subscription by budget name.
Parameters: - resource_group_name (str) – Azure Resource Group Name.
- budget_name (str) – Budget Name.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: Budget or ClientRawResponse if raw=true
Return type: Budget or ClientRawResponse
Raises:
-
list
(custom_headers=None, raw=False, **operation_config)[source]¶ Lists all budgets for a subscription.
Parameters: - custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of Budget
Return type: Raises:
-
list_by_resource_group_name
(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]¶ Lists all budgets for a resource group under a subscription.
Parameters: - resource_group_name (str) – Azure Resource Group Name.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of Budget
Return type: Raises:
-
models
= <module 'azure.mgmt.consumption.models' from '/usr/lib/python3.7/site-packages/azure/mgmt/consumption/models/__init__.py'>¶
-
class
azure.mgmt.consumption.operations.
Operations
(client, config, serializer, deserializer)[source]¶ Bases:
object
Operations operations.
Parameters: - client – Client for service requests.
- config – Configuration of service client.
- serializer – An object model serializer.
- deserializer – An object model deserializer.
Variables: api_version – Version of the API to be used with the client request. The current version is 2018-01-31. Constant value: “2018-01-31”.
-
list
(custom_headers=None, raw=False, **operation_config)[source]¶ Lists all of the available consumption REST API operations.
Parameters: - custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: An iterator like instance of Operation
Return type: Raises:
-
models
= <module 'azure.mgmt.consumption.models' from '/usr/lib/python3.7/site-packages/azure/mgmt/consumption/models/__init__.py'>¶
-
class
azure.mgmt.consumption.operations.
PriceSheetOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
PriceSheetOperations operations.
Parameters: - client – Client for service requests.
- config – Configuration of service client.
- serializer – An object model serializer.
- deserializer – An object model deserializer.
Variables: api_version – Version of the API to be used with the client request. The current version is 2018-01-31. Constant value: “2018-01-31”.
-
get
(expand=None, skiptoken=None, top=None, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the price sheet for a scope by subscriptionId. Price sheet is available via this API only for May 1, 2014 or later.
Parameters: - expand (str) – May be used to expand the properties/meterDetails within a price sheet. By default, these fields are not included when returning price sheet.
- skiptoken (str) – 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) – May be used to limit the number of results to the top N results.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: PriceSheetResult or ClientRawResponse if raw=true
Return type: PriceSheetResult or ClientRawResponse
Raises:
-
get_by_billing_period
(billing_period_name, expand=None, skiptoken=None, top=None, custom_headers=None, raw=False, **operation_config)[source]¶ Get the price sheet for a scope by subscriptionId and billing period. Price sheet is available via this API only for May 1, 2014 or later.
Parameters: - billing_period_name (str) – Billing Period Name.
- expand (str) – May be used to expand the properties/meterDetails within a price sheet. By default, these fields are not included when returning price sheet.
- skiptoken (str) – 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) – May be used to limit the number of results to the top N results.
- custom_headers (dict) – headers that will be added to the request
- raw (bool) – returns the direct response alongside the deserialized response
- operation_config – Operation configuration overrides.
Returns: PriceSheetResult or ClientRawResponse if raw=true
Return type: PriceSheetResult or ClientRawResponse
Raises:
-
models
= <module 'azure.mgmt.consumption.models' from '/usr/lib/python3.7/site-packages/azure/mgmt/consumption/models/__init__.py'>¶