Carbon Service - Query Carbon Emission Data Available Date Range

Service:

Carbon optimization

API Version:

2024-02-01-preview

API for query carbon emission data available date range

POST https://management.azure.com/providers/Microsoft.Carbon/queryCarbonEmissionDataAvailableDateRange?api-version=2024-02-01-preview

URI Parameters

Name	In	Required	Type	Description
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	CarbonEmissionDataAvailableDateRange	Azure operation completed successfully.
Other Status Codes	ErrorResponse	An unexpected error response.

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

CarbonService_QueryCarbonEmissionDataAvailableDateRange

Sample request

HTTP

POST https://management.azure.com/providers/Microsoft.Carbon/queryCarbonEmissionDataAvailableDateRange?api-version=2024-02-01-preview

Sample response

Status code:

200

{
  "startDate": "2023-01-01",
  "endDate": "2023-05-01"
}

Definitions

Name	Description
CarbonEmissionDataAvailableDateRange	Response for available date range of carbon emission data
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response

CarbonEmissionDataAvailableDateRange

Object

Response for available date range of carbon emission data

Name	Type	Description
endDate	string	End date parameter, format is yyyy-MM-dd
startDate	string	Start date parameter, format is yyyy-MM-dd

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.