Azure API Reference

This section provides the API reference documentation for Azure cost export endpoints, auto-generated from docstrings.

Interactive Documentation

Swagger UI

• URL: /docs
• Features: Request/response testing, parameter exploration

ReDoc

• URL: /redoc
• Features: Sidebar navigation, endpoint discovery

Azure Endpoints Reference

Export Azure cost data using POST request with JSON body.

Request Body Parameters: - start_date (str, optional): Start date in YYYY-MM-DD format - end_date (str, optional): End date in YYYY-MM-DD format - granularity (str, optional): Time granularity - "Monthly" or "Daily" (default: "Monthly") - group_by (str, optional): Group by dimension - "subscription", "ServiceName", or "ResourceGroupName" (default: "subscription")

Assumes Azure credentials are already configured in the environment.

Source code in api/main.py

@app.post("/azure/cost/export")
async def export_azure_costs_post(request: Request):
    """
    Export Azure cost data using POST request with JSON body.

    Request Body Parameters:
    - start_date (str, optional): Start date in YYYY-MM-DD format
    - end_date (str, optional): End date in YYYY-MM-DD format
    - granularity (str, optional): Time granularity - "Monthly" or "Daily" (default: "Monthly")
    - group_by (str, optional): Group by dimension - "subscription", "ServiceName", or "ResourceGroupName" (default: "subscription")

    Assumes Azure credentials are already configured in the environment.
    """
    # Check if Azure module is available
    if not AZURE_AVAILABLE:
        return JSONResponse(
            {
                "error": True,
                "message": "Azure functionality not available. Please install Azure SDK: "
                "pip install azure-identity azure-mgmt-costmanagement azure-mgmt-resource",
            },
            status_code=503,
        )
    try:
        # Parse JSON body if present
        try:
            body = await request.json()
        except Exception:
            body = {}

        # Extract parameters with defaults
        start_date = body.get("start_date")
        end_date = body.get("end_date")
        granularity = body.get("granularity", "Monthly")
        group_by = body.get("group_by", "subscription")

        # Set default dates if not provided (Azure format: YYYY,MM,DD)
        if not start_date:
            default_start = (datetime.now() - timedelta(days=90)).strftime("%Y,%m,%d")
            start_date = default_start
        else:
            # Convert from YYYY-MM-DD to YYYY,MM,DD format for Azure
            start_date = start_date.replace("-", ",")

        if not end_date:
            default_end = datetime.now().strftime("%Y,%m,%d")
            end_date = default_end
        else:
            # Convert from YYYY-MM-DD to YYYY,MM,DD format for Azure
            end_date = end_date.replace("-", ",")

        print(f"Fetching Azure cost data from {start_date} to {end_date}")
        print(f"Granularity: {granularity}, Group by: {group_by}")

        # Fetch subscriptions first (required because eraXplor_azure doesn't handle None)
        subscriptions_list_detailed = list_subs()
        if not subscriptions_list_detailed:
            return JSONResponse(
                {"error": True, "message": "No Azure subscriptions found or accessible"},
                status_code=404,
            )

        # Call eraXplor Azure cost_export function
        cost_data = azure_cost_export(
            group_by=group_by,
            subscriptions_list_detailed=subscriptions_list_detailed,
            start_date=start_date,
            end_date=end_date,
            granularity=granularity,
        )

        # Handle case where Azure function returns None
        if cost_data is None:
            cost_data = []
            print("No cost data returned from Azure function")

        print(f"Retrieved {len(cost_data)} cost records")

        response_data = {
            "success": True,
            "message": "Azure cost data exported successfully",
            "total_records": len(cost_data),
            "cost_data": cost_data,
            "request_parameters": {
                "start_date": start_date.replace(",", "-"),  # Convert back for response
                "end_date": end_date.replace(",", "-"),  # Convert back for response
                "granularity": granularity,
                "group_by": group_by,
            },
        }

        return response_data

    except Exception as e:
        print(f"Error exporting Azure costs: {str(e)}")
        return JSONResponse(
            {"error": True, "message": f"Error exporting Azure costs: {str(e)}"},
            status_code=500,
        )

Export Azure cost data using GET request with query parameters.

Query Parameters: - start_date (str, optional): Start date in YYYY-MM-DD format - end_date (str, optional): End date in YYYY-MM-DD format - granularity (str, optional): Time granularity - "Monthly" or "Daily" (default: "Monthly") - group_by (str, optional): Group by dimension - "subscription", "ServiceName", or "ResourceGroupName" (default: "subscription")

Assumes Azure credentials are already configured in the environment.

Source code in api/main.py

@app.get("/azure/cost/export")
async def export_azure_costs_get(
    start_date: str = None,
    end_date: str = None,
    granularity: str = "Monthly",
    group_by: str = "subscription",
):
    """
    Export Azure cost data using GET request with query parameters.

    Query Parameters:
    - start_date (str, optional): Start date in YYYY-MM-DD format
    - end_date (str, optional): End date in YYYY-MM-DD format
    - granularity (str, optional): Time granularity - "Monthly" or "Daily" (default: "Monthly")
    - group_by (str, optional): Group by dimension - "subscription", "ServiceName", or "ResourceGroupName" (default: "subscription")

    Assumes Azure credentials are already configured in the environment.
    """
    # Check if Azure module is available
    if not AZURE_AVAILABLE:
        return JSONResponse(
            {
                "error": True,
                "message": "Azure functionality not available. Please install Azure SDK: "
                "pip install azure-identity azure-mgmt-costmanagement azure-mgmt-resource",
            },
            status_code=503,
        )
    try:
        # Set default dates if not provided (Azure format: YYYY,MM,DD)
        if not start_date:
            default_start = (datetime.now() - timedelta(days=90)).strftime("%Y,%m,%d")
            start_date = default_start
        else:
            # Convert from YYYY-MM-DD to YYYY,MM,DD format for Azure
            start_date = start_date.replace("-", ",")

        if not end_date:
            default_end = datetime.now().strftime("%Y,%m,%d")
            end_date = default_end
        else:
            # Convert from YYYY-MM-DD to YYYY,MM,DD format for Azure
            end_date = end_date.replace("-", ",")

        print(f"Fetching Azure cost data from {start_date} to {end_date}")
        print(f"Granularity: {granularity}, Group by: {group_by}")

        # Fetch subscriptions first (required because eraXplor_azure doesn't handle None)
        subscriptions_list_detailed = list_subs()
        if not subscriptions_list_detailed:
            return JSONResponse(
                {"error": True, "message": "No Azure subscriptions found or accessible"},
                status_code=404,
            )

        # Call eraXplor Azure cost_export function
        cost_data = azure_cost_export(
            group_by=group_by,
            subscriptions_list_detailed=subscriptions_list_detailed,
            start_date=start_date,
            end_date=end_date,
            granularity=granularity,
        )

        # Handle case where Azure function returns None
        if cost_data is None:
            cost_data = []
            print("No cost data returned from Azure function")

        print(f"Retrieved {len(cost_data)} cost records")

        response_data = {
            "success": True,
            "message": "Azure cost data exported successfully",
            "total_records": len(cost_data),
            "cost_data": cost_data,
            "request_parameters": {
                "start_date": start_date.replace(",", "-"),  # Convert back for response
                "end_date": end_date.replace(",", "-"),  # Convert back for response
                "granularity": granularity,
                "group_by": group_by,
            },
        }

        return response_data

    except Exception as e:  # Pylint: disable=broad-except
        print(f"Error exporting Azure costs: {str(e)}")
        return JSONResponse(
            {"error": True, "message": f"Error exporting Azure costs: {str(e)}"},
            status_code=500,
        )

Authentication

• Azure CLI authentication (az login)
• Azure subscription access
• Cost Management API permissions

Rate Limiting

Azure Cost Management has its own quotas - no built-in limiting.