openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 159 kB
JSON
{"openapi":"3.0.0","info":{"description":"Consumption management client provides access to consumption resources for Azure Enterprise Subscriptions.","title":"ConsumptionManagementClient","version":"2018-10-01","x-apisguru-categories":["cloud"],"x-logo":{"url":"https://assets.onestore.ms/cdnfiles/onestorerolling-1606-01000/shell/v3/images/logo/microsoft.png"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-10-01/consumption.json","version":"2.0"}],"x-preferred":true,"x-providerName":"azure.com","x-serviceName":"consumption","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/charges":{"get":{"description":"Lists the charges based on departmentId by billing period.","externalDocs":{"url":"https://docs.microsoft.com/en-us/rest/api/consumption/"},"operationId":"Charges_ListForBillingPeriodByDepartment","parameters":[{"$ref":"#/components/parameters/billingAccountIdParameter"},{"$ref":"#/components/parameters/departmentIdParameter"},{"$ref":"#/components/parameters/billingPeriodNameParameter"},{"$ref":"#/components/parameters/apiVersionParameter"},{"description":"May be used to filter charges by properties/usageEnd (Utc time), properties/usageStart (Utc time). The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:).","in":"query","name":"$filter","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK. The request has succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChargeSummary"},"examples":{"ChangesForBillingPeriodByDepartment":{"$ref":"#/components/examples/ChangesForBillingPeriodByDepartment"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["Charges"]}},"/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}/providers/Microsoft.Consumption/charges":{"get":{"description":"Lists the charges by departmentId.","externalDocs":{"url":"https://docs.microsoft.com/en-us/rest/api/consumption/"},"operationId":"Charges_ListByDepartment","parameters":[{"$ref":"#/components/parameters/billingAccountIdParameter"},{"$ref":"#/components/parameters/departmentIdParameter"},{"$ref":"#/components/parameters/apiVersionParameter"},{"description":"May be used to filter charges by properties/usageEnd (Utc time), properties/usageStart (Utc time). The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:).","in":"query","name":"$filter","required":false,"schema":{"type":"string"},"examples":{"ChargesListByDepartment":{"value":"usageStart eq '2018-04-01' AND usageEnd eq '2018-05-30'"}}}],"responses":{"200":{"description":"OK. The request has succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChargesListResult"},"examples":{"ChargesListByDepartment":{"$ref":"#/components/examples/ChargesListByDepartment"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["Charges"]}},"/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/charges":{"get":{"description":"Lists the charges based on enrollmentAccountId by billing period.","externalDocs":{"url":"https://docs.microsoft.com/en-us/rest/api/consumption/"},"operationId":"Charges_ListForBillingPeriodByEnrollmentAccount","parameters":[{"$ref":"#/components/parameters/billingAccountIdParameter"},{"$ref":"#/components/parameters/enrollmentAccountIdParameter"},{"$ref":"#/components/parameters/billingPeriodNameParameter"},{"$ref":"#/components/parameters/apiVersionParameter"},{"description":"May be used to filter charges by properties/usageEnd (Utc time), properties/usageStart (Utc time). The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:).","in":"query","name":"$filter","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK. The request has succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChargeSummary"},"examples":{"ChangesForBillingPeriodByEnrollmentAccount":{"$ref":"#/components/examples/ChangesForBillingPeriodByEnrollmentAccount"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["Charges"]}},"/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}/providers/Microsoft.Consumption/charges":{"get":{"description":"Lists the charges by enrollmentAccountId.","externalDocs":{"url":"https://docs.microsoft.com/en-us/rest/api/consumption/"},"operationId":"Charges_ListByEnrollmentAccount","parameters":[{"$ref":"#/components/parameters/billingAccountIdParameter"},{"$ref":"#/components/parameters/enrollmentAccountIdParameter"},{"$ref":"#/components/parameters/apiVersionParameter"},{"description":"May be used to filter charges by properties/usageEnd (Utc time), properties/usageStart (Utc time). The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:).","in":"query","name":"$filter","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK. The request has succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChargesListResult"},"examples":{"ChargesListForEnrollmentAccount":{"$ref":"#/components/examples/ChargesListForEnrollmentAccount"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["Charges"]}},"/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/balances":{"get":{"description":"Gets the balances for a scope by billing period and billingAccountId. Balances are available via this API only for May 1, 2014 or later.","externalDocs":{"url":"https://docs.microsoft.com/en-us/rest/api/consumption/"},"operationId":"Balances_GetForBillingPeriodByBillingAccount","parameters":[{"$ref":"#/components/parameters/apiVersionParameter"},{"$ref":"#/components/parameters/billingAccountIdParameter"},{"$ref":"#/components/parameters/billingPeriodNameParameter"}],"responses":{"200":{"description":"OK. The request has succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Balance"},"examples":{"Balances":{"$ref":"#/components/examples/Balances"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["Balances"]}},"/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/marketplaces":{"get":{"description":"Lists the marketplaces for a scope by billing period and billingAccountId. Marketplaces are available via this API only for May 1, 2014 or later.","externalDocs":{"url":"https://docs.microsoft.com/en-us/rest/api/consumption/"},"operationId":"Marketplaces_ListForBillingPeriodByBillingAccount","parameters":[{"description":"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'.","in":"query","name":"$filter","required":false,"schema":{"type":"string"}},{"description":"May be used to limit the number of results to the most recent N marketplaces.","in":"query","name":"$top","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000}},{"description":"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.","in":"query","name":"$skiptoken","required":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/apiVersionParameter"},{"$ref":"#/components/parameters/billingAccountIdParameter"},{"$ref":"#/components/parameters/billingPeriodNameParameter"}],"responses":{"200":{"description":"OK. The request has succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketplacesListResult"},"examples":{"MarketplacesListForBillingPeriod":{"$ref":"#/components/examples/MarketplacesListForBillingPeriod"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["Marketplaces"],"x-ms-odata":"#/components/schemas/Marketplace","x-ms-pageable":{"nextLinkName":"nextLink"}}},"/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/usageDetails":{"get":{"description":"Lists the usage details based on billingAccountId for a scope by billing period. Usage details are available via this API only for May 1, 2014 or later.","externalDocs":{"url":"https://docs.microsoft.com/en-us/rest/api/consumption/"},"operationId":"UsageDetails_ListForBillingPeriodByBillingAccount","parameters":[{"$ref":"#/components/parameters/billingAccountIdParameter"},{"$ref":"#/components/parameters/billingPeriodNameParameter"},{"description":"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.","in":"query","name":"$expand","required":false,"schema":{"type":"string"}},{"description":"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'. Tag filter is a key value pair string where key and value is separated by a colon (:).","in":"query","name":"$filter","required":false,"schema":{"type":"string"}},{"description":"OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart) for specified billing period","in":"query","name":"$apply","required":false,"x-ms-client-name":"Apply","x-ms-parameter-grouping":{"name":"QueryOptions"},"x-ms-parameter-location":"method","schema":{"type":"string"}},{"description":"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.","in":"query","name":"$skiptoken","required":false,"schema":{"type":"string"}},{"description":"May be used to limit the number of results to the most recent N usageDetails.","in":"query","name":"$top","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000}},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"OK. The request has succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsageDetailsListResult"},"examples":{"UsageDetailsListForBillingPeriod":{"$ref":"#/components/examples/UsageDetailsListForBillingPeriod"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["UsageDetails"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Consumption/balances":{"get":{"description":"Gets the balances for a scope by billingAccountId. Balances are available via this API only for May 1, 2014 or later.","externalDocs":{"url":"https://docs.microsoft.com/en-us/rest/api/consumption/"},"operationId":"Balances_GetByBillingAccount","parameters":[{"$ref":"#/components/parameters/apiVersionParameter"},{"$ref":"#/components/parameters/billingAccountIdParameter"}],"responses":{"200":{"description":"OK. The request has succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Balance"},"examples":{"Balances":{"$ref":"#/components/examples/Balances"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["Balances"]}},"/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Consumption/marketplaces":{"get":{"description":"Lists the marketplaces for a scope by billingAccountId and current billing period. Marketplaces are available via this API only for May 1, 2014 or later.","externalDocs":{"url":"https://docs.microsoft.com/en-us/rest/api/consumption/"},"operationId":"Marketplaces_ListByBillingAccount","parameters":[{"description":"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'.","in":"query","name":"$filter","required":false,"schema":{"type":"string"}},{"description":"May be used to limit the number of results to the most recent N marketplaces.","in":"query","name":"$top","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000}},{"description":"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.","in":"query","name":"$skiptoken","required":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/apiVersionParameter"},{"$ref":"#/components/parameters/billingAccountIdParameter"}],"responses":{"200":{"description":"OK. The request has succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketplacesListResult"},"examples":{"MarketplacesList":{"$ref":"#/components/examples/MarketplacesList"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["Marketplaces"],"x-ms-odata":"#/components/schemas/Marketplace","x-ms-pageable":{"nextLinkName":"nextLink"}}},"/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Consumption/usageDetails":{"get":{"description":"Lists the usage details by billingAccountId for a scope by current billing period. Usage details are available via this API only for May 1, 2014 or later.","externalDocs":{"url":"https://docs.microsoft.com/en-us/rest/api/consumption/"},"operationId":"UsageDetails_ListByBillingAccount","parameters":[{"$ref":"#/components/parameters/billingAccountIdParameter"},{"description":"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.","in":"query","name":"$expand","required":false,"schema":{"type":"string"}},{"description":"May be used to filter usageDetails by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName, properties/instanceId or tags. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:).","in":"query","name":"$filter","required":false,"schema":{"type":"string"}},{"description":"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.","in":"query","name":"$skiptoken","required":false,"schema":{"type":"string"}},{"description":"May be used to limit the number of results to the most recent N usageDetails.","in":"query","name":"$top","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000}},{"description":"OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart)","in":"query","name":"$apply","required":false,"x-ms-client-name":"Apply","x-ms-parameter-grouping":{"name":"QueryOptions"},"x-ms-parameter-location":"method","schema":{"type":"string"}},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"OK. The request has succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsageDetailsListResult"},"examples":{"UsageDetailsList":{"$ref":"#/components/examples/UsageDetailsList"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["UsageDetails"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/providers/Microsoft.Billing/departments/{departmentId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/marketplaces":{"get":{"description":"Lists the marketplaces for a scope by billing period and departmentId. Marketplaces are available via this API only for May 1, 2014 or later.","externalDocs":{"url":"https://docs.microsoft.com/en-us/rest/api/consumption/"},"operationId":"Marketplaces_ListForBillingPeriodByDepartment","parameters":[{"description":"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'.","in":"query","name":"$filter","required":false,"schema":{"type":"string"}},{"description":"May be used to limit the number of results to the most recent N marketplaces.","in":"query","name":"$top","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000}},{"description":"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.","in":"query","name":"$skiptoken","required":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/apiVersionParameter"},{"$ref":"#/components/parameters/departmentIdParameter"},{"$ref":"#/components/parameters/billingPeriodNameParameter"}],"responses":{"200":{"description":"OK. The request has succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketplacesListResult"},"examples":{"MarketplacesListForBillingPeriod":{"$ref":"#/components/examples/MarketplacesListForBillingPeriod"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["Marketplaces"],"x-ms-odata":"#/components/schemas/Marketplace","x-ms-pageable":{"nextLinkName":"nextLink"}}},"/providers/Microsoft.Billing/departments/{departmentId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/usageDetails":{"get":{"description":"Lists the usage details based on departmentId for a scope by billing period. Usage details are available via this API only for May 1, 2014 or later.","externalDocs":{"url":"https://docs.microsoft.com/en-us/rest/api/consumption/"},"operationId":"UsageDetails_ListForBillingPeriodByDepartment","parameters":[{"$ref":"#/components/parameters/departmentIdParameter"},{"$ref":"#/components/parameters/billingPeriodNameParameter"},{"description":"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.","in":"query","name":"$expand","required":false,"schema":{"type":"string"}},{"description":"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'. Tag filter is a key value pair string where key and value is separated by a colon (:).","in":"query","name":"$filter","required":false,"schema":{"type":"string"}},{"description":"OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart) for specified billing period","in":"query","name":"$apply","required":false,"x-ms-client-name":"Apply","x-ms-parameter-grouping":{"name":"QueryOptions"},"x-ms-parameter-location":"method","schema":{"type":"string"}},{"description":"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.","in":"query","name":"$skiptoken","required":false,"schema":{"type":"string"}},{"description":"May be used to limit the number of results to the most recent N usageDetails.","in":"query","name":"$top","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000}},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"OK. The request has succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsageDetailsListResult"},"examples":{"UsageDetailsListForBillingPeriod":{"$ref":"#/components/examples/UsageDetailsListForBillingPeriod"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["UsageDetails"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/providers/Microsoft.Billing/departments/{departmentId}/providers/Microsoft.Consumption/marketplaces":{"get":{"description":"Lists the marketplaces for a scope by departmentId and current billing period. Marketplaces are available via this API only for May 1, 2014 or later.","externalDocs":{"url":"https://docs.microsoft.com/en-us/rest/api/consumption/"},"operationId":"Marketplaces_ListByDepartment","parameters":[{"description":"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'.","in":"query","name":"$filter","required":false,"schema":{"type":"string"}},{"description":"May be used to limit the number of results to the most recent N marketplaces.","in":"query","name":"$top","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000}},{"description":"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.","in":"query","name":"$skiptoken","required":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/apiVersionParameter"},{"$ref":"#/components/parameters/departmentIdParameter"}],"responses":{"200":{"description":"OK. The request has succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketplacesListResult"},"examples":{"MarketplacesList":{"$ref":"#/components/examples/MarketplacesList"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["Marketplaces"],"x-ms-odata":"#/components/schemas/Marketplace","x-ms-pageable":{"nextLinkName":"nextLink"}}},"/providers/Microsoft.Billing/departments/{departmentId}/providers/Microsoft.Consumption/usageDetails":{"get":{"description":"Lists the usage details by departmentId for a scope by current billing period. Usage details are available via this API only for May 1, 2014 or later.","externalDocs":{"url":"https://docs.microsoft.com/en-us/rest/api/consumption/"},"operationId":"UsageDetails_ListByDepartment","parameters":[{"$ref":"#/components/parameters/departmentIdParameter"},{"description":"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.","in":"query","name":"$expand","required":false,"schema":{"type":"string"}},{"description":"May be used to filter usageDetails by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName, properties/instanceId or tags. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:).","in":"query","name":"$filter","required":false,"schema":{"type":"string"}},{"description":"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.","in":"query","name":"$skiptoken","required":false,"schema":{"type":"string"}},{"description":"May be used to limit the number of results to the most recent N usageDetails.","in":"query","name":"$top","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000}},{"description":"OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart)","in":"query","name":"$apply","required":false,"x-ms-client-name":"Apply","x-ms-parameter-grouping":{"name":"QueryOptions"},"x-ms-parameter-location":"method","schema":{"type":"string"}},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"OK. The request has succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsageDetailsListResult"},"examples":{"UsageDetailsList":{"$ref":"#/components/examples/UsageDetailsList"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["UsageDetails"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/providers/Microsoft.Billing/enrollmentAccounts/{enrollmentAccountId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/marketplaces":{"get":{"description":"Lists the marketplaces for a scope by billing period and enrollmentAccountId. Marketplaces are available via this API only for May 1, 2014 or later.","externalDocs":{"url":"https://docs.microsoft.com/en-us/rest/api/consumption/"},"operationId":"Marketplaces_ListForBillingPeriodByEnrollmentAccount","parameters":[{"description":"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'.","in":"query","name":"$filter","required":false,"schema":{"type":"string"}},{"description":"May be used to limit the number of results to the most recent N marketplaces.","in":"query","name":"$top","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000}},{"description":"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.","in":"query","name":"$skiptoken","required":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/apiVersionParameter"},{"$ref":"#/components/parameters/enrollmentAccountIdParameter"},{"$ref":"#/components/parameters/billingPeriodNameParameter"}],"responses":{"200":{"description":"OK. The request has succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketplacesListResult"},"examples":{"MarketplacesListForBillingPeriod":{"$ref":"#/components/examples/MarketplacesListForBillingPeriod"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["Marketplaces"],"x-ms-odata":"#/components/schemas/Marketplace","x-ms-pageable":{"nextLinkName":"nextLink"}}},"/providers/Microsoft.Billing/enrollmentAccounts/{enrollmentAccountId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/usageDetails":{"get":{"description":"Lists the usage details based on enrollmentAccountId for a scope by billing period. Usage details are available via this API only for May 1, 2014 or later.","externalDocs":{"url":"https://docs.microsoft.com/en-us/rest/api/consumption/"},"operationId":"UsageDetails_ListForBillingPeriodByEnrollmentAccount","parameters":[{"$ref":"#/components/parameters/enrollmentAccountIdParameter"},{"$ref":"#/components/parameters/billingPeriodNameParameter"},{"description":"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.","in":"query","name":"$expand","required":false,"schema":{"type":"string"}},{"description":"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'. Tag filter is a key value pair string where key and value is separated by a colon (:).","in":"query","name":"$filter","required":false,"schema":{"type":"string"}},{"description":"OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart) for specified billing period","in":"query","name":"$apply","required":false,"x-ms-client-name":"Apply","x-ms-parameter-grouping":{"name":"QueryOptions"},"x-ms-parameter-location":"method","schema":{"type":"string"}},{"description":"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.","in":"query","name":"$skiptoken","required":false,"schema":{"type":"string"}},{"description":"May be used to limit the number of results to the most recent N usageDetails.","in":"query","name":"$top","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000}},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"OK. The request has succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsageDetailsListResult"},"examples":{"UsageDetailsListForBillingPeriod":{"$ref":"#/components/examples/UsageDetailsListForBillingPeriod"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["UsageDetails"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/providers/Microsoft.Billing/enrollmentAccounts/{enrollmentAccountId}/providers/Microsoft.Consumption/marketplaces":{"get":{"description":"Lists the marketplaces for a scope by enrollmentAccountId and current billing period. Marketplaces are available via this API only for May 1, 2014 or later.","externalDocs":{"url":"https://docs.microsoft.com/en-us/rest/api/consumption/"},"operationId":"Marketplaces_ListByEnrollmentAccount","parameters":[{"description":"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'.","in":"query","name":"$filter","required":false,"schema":{"type":"string"}},{"description":"May be used to limit the number of results to the most recent N marketplaces.","in":"query","name":"$top","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000}},{"description":"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.","in":"query","name":"$skiptoken","required":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/apiVersionParameter"},{"$ref":"#/components/parameters/enrollmentAccountIdParameter"}],"responses":{"200":{"description":"OK. The request has succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketplacesListResult"},"examples":{"MarketplacesList":{"$ref":"#/components/examples/MarketplacesList"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["Marketplaces"],"x-ms-odata":"#/components/schemas/Marketplace","x-ms-pageable":{"nextLinkName":"nextLink"}}},"/providers/Microsoft.Billing/enrollmentAccounts/{enrollmentAccountId}/providers/Microsoft.Consumption/usageDetails":{"get":{"description":"Lists the usage details by enrollmentAccountId for a scope by current billing period. Usage details are available via this API only for May 1, 2014 or later.","externalDocs":{"url":"https://docs.microsoft.com/en-us/rest/api/consumption/"},"operationId":"UsageDetails_ListByEnrollmentAccount","parameters":[{"$ref":"#/components/parameters/enrollmentAccountIdParameter"},{"description":"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.","in":"query","name":"$expand","required":false,"schema":{"type":"string"}},{"description":"May be used to filter usageDetails by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName, properties/instanceId or tags. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:).","in":"query","name":"$filter","required":false,"schema":{"type":"string"}},{"description":"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.","in":"query","name":"$skiptoken","required":false,"schema":{"type":"string"}},{"description":"May be used to limit the number of results to the most recent N usageDetails.","in":"query","name":"$top","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000}},{"description":"OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart)","in":"query","name":"$apply","required":false,"x-ms-client-name":"Apply","x-ms-parameter-grouping":{"name":"QueryOptions"},"x-ms-parameter-location":"method","schema":{"type":"string"}},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"OK. The request has succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsageDetailsListResult"},"examples":{"UsageDetailsList":{"$ref":"#/components/examples/UsageDetailsList"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["UsageDetails"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/providers/Microsoft.Capacity/reservationorders/{reservationOrderId}/providers/Microsoft.Consumption/reservationDetails":{"get":{"description":"Lists the reservations details for provided date range.","externalDocs":{"url":"https://docs.microsoft.com/en-us/rest/api/consumption/"},"operationId":"ReservationsDetails_ListByReservationOrder","parameters":[{"$ref":"#/components/parameters/reservationOrderIdParameter"},{"description":"Filter reservation details by date range. The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge' ","in":"query","name":"$filter","required":true,"schema":{"type":"string"},"examples":{"ReservationDetails":{"value":"properties/usageDate ge '2017-10-01' AND properties/usageDate le '2017-12-05'"}}},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"OK. The request has succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReservationDetailsListResult"},"examples":{"ReservationDetails":{"$ref":"#/components/examples/ReservationDetails"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["ReservedInstances"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/providers/Microsoft.Capacity/reservationorders/{reservationOrderId}/providers/Microsoft.Consumption/reservationSummaries":{"get":{"description":"Lists the reservations summaries for daily or monthly grain.","externalDocs":{"url":"https://docs.microsoft.com/en-us/rest/api/consumption/"},"operationId":"ReservationsSummaries_ListByReservationOrder","parameters":[{"$ref":"#/components/parameters/reservationOrderIdParameter"},{"$ref":"#/components/parameters/grainParameter"},{"description":"Required only for daily grain. The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge'","in":"query","name":"$filter","required":false,"schema":{"type":"string"},"examples":{"ReservationSummariesDaily":{"value":"properties/usageDate ge '2017-10-01' AND properties/usageDate le '2017-11-20'"}}},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"OK. The request has succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReservationSummariesListResult"},"examples":{"ReservationSummariesDaily":{"$ref":"#/components/examples/ReservationSummariesDaily"},"ReservationSummariesMonthly":{"$ref":"#/components/examples/ReservationSummariesMonthly"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["ReservedInstances"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/providers/Microsoft.Capacity/reservationorders/{reservationOrderId}/reservations/{reservationId}/providers/Microsoft.Consumption/reservationDetails":{"get":{"description":"Lists the reservations details for provided date range.","externalDocs":{"url":"https://docs.microsoft.com/en-us/rest/api/consumption/"},"operationId":"ReservationsDetails_ListByReservationOrderAndReservation","parameters":[{"$ref":"#/components/parameters/reservationOrderIdParameter"},{"$ref":"#/components/parameters/reservationIdParameter"},{"description":"Filter reservation details by date range. The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge' ","in":"query","name":"$filter","required":true,"schema":{"type":"string"},"examples":{"ReservationDetailsWithReservationId":{"value":"properties/usageDate ge '2017-10-01' AND properties/usageDate le '2017-12-05'"}}},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"OK. The request has succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReservationDetailsListResult"},"examples":{"ReservationDetailsWithReservationId":{"$ref":"#/components/examples/ReservationDetailsWithReservationId"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["ReservedInstances"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/providers/Microsoft.Capacity/reservationorders/{reservationOrderId}/reservations/{reservationId}/providers/Microsoft.Consumption/reservationSummaries":{"get":{"description":"Lists the reservations summaries for daily or monthly grain.","externalDocs":{"url":"https://docs.microsoft.com/en-us/rest/api/consumption/"},"operationId":"ReservationsSummaries_ListByReservationOrderAndReservation","parameters":[{"$ref":"#/components/parameters/reservationOrderIdParameter"},{"$ref":"#/components/parameters/reservationIdParameter"},{"$ref":"#/components/parameters/grainParameter"},{"description":"Required only for daily grain. The properties/UsageDate for start date and end date. The filter supports 'le' and 'ge'","in":"query","name":"$filter","required":false,"schema":{"type":"string"},"examples":{"ReservationSummariesDailyWithReservationId":{"value":"properties/usageDate ge '2017-10-01' AND properties/usageDate le '2017-11-20'"}}},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"OK. The request has succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReservationSummariesListResult"},"examples":{"ReservationSummariesDailyWithReservationId":{"$ref":"#/components/examples/ReservationSummariesDailyWithReservationId"},"ReservationSummariesMonthlyWithReservationId":{"$ref":"#/components/examples/ReservationSummariesMonthlyWithReservationId"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["ReservedInstances"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/providers/Microsoft.Consumption/operations":{"get":{"description":"Lists all of the available consumption REST API operations.","operationId":"Operations_List","parameters":[{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"OK. The request has succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationListResult"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["Operations"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/providers/Microsoft.CostManagement/billingAccounts/{billingAccountId}/providers/Microsoft.Consumption/tags":{"get":{"description":"Get all available tag keys for a billing account.","externalDocs":{"url":"https://docs.microsoft.com/en-us/rest/api/consumption/"},"operationId":"Tags_Get","parameters":[{"$ref":"#/components/parameters/apiVersionParameter"},{"$ref":"#/components/parameters/billingAccountIdParameter"}],"responses":{"200":{"description":"OK. The request has succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagsResult"},"examples":{"Tags_Get":{"$ref":"#/components/examples/Tags_Get"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["Tags"]}},"/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/Microsoft.Consumption/aggregatedcost":{"get":{"description":"Provides the aggregate cost of a management group and all child management groups by specified billing period","externalDocs":{"url":"https://docs.microsoft.com/en-us/rest/api/consumption/"},"operationId":"AggregatedCost_GetForBillingPeriodByManagementGroup","parameters":[{"$ref":"#/components/parameters/managementGroupIdParameter"},{"$ref":"#/components/parameters/billingPeriodNameParameter"},{"$ref":"#/components/parameters/apiVersionParameter"}],"responses":{"200":{"description":"OK. The request has succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManagementGroupAggregatedCostResult"},"examples":{"AggregatedCostListForBillingPeriodByManagementGroup":{"$ref":"#/components/examples/AggregatedCostListForBillingPeriodByManagementGroup"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["AggregatedCost"]}},"/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/marketplaces":{"get":{"description":"Lists the marketplace records for all subscriptions belonging to a management group scope by specified billing period. Marketplaces are available via this API only for May 1, 2014 or later.","externalDocs":{"url":"https://docs.microsoft.com/en-us/rest/api/consumption/"},"operationId":"Marketplaces_ListForBillingPeriodByManagementGroup","parameters":[{"description":"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'.","in":"query","name":"$filter","required":false,"schema":{"type":"string"}},{"description":"May be used to limit the number of results to the most recent N marketplaces.","in":"query","name":"$top","required":false,"schema":{"type":"integer","minimum":1,"maximum":1000}},{"description":"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.","in":"query","name":"$skiptoken","required":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/apiVersionParameter"},{"$ref":"#/components/parameters/managementGroupIdParameter"},{"$ref":"#/components/parameters/billingPeriodNameParameter"}],"responses":{"200":{"description":"OK. The request has succeeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketplacesListResult"},"examples":{"MarketplacesListForBillingPeriod":{"$ref":"#/components/examples/MarketplacesListForBillingPeriod"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["Marketplaces"],"x-ms-odata":"#/components/schemas/Marketplace","x-ms-pageable":{"nextLinkName":"nextLink"}}},"/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/usageDetails":{"get":{"description":"Lists the usage detail records for all subscriptions belonging to a management group scope by specified billing period. Usage details are available via this API only for May 1, 2014 or later.","externalDocs":{"url":"https://docs.microsoft.com/en-us/rest/api/consumption/"},"operationId":"UsageDetails_ListForBillingPeriodByManagementGroup","parameters":[{"$ref":"#/components/parameters/managementGroupIdParameter"},{"$ref":"#/components/parameters/billingPeriodNameParameter"},{"description":"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.","in":"query","name":"$expand","required":false,"schema":{"type":"string"}},{"description":"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'. Tag filter is a key value pair string where key and value is separated by a colon (:).","in":"query","name":"$filter","required":false,"schema":{"type":"string"}},{"description":"OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart) for specified