Microsoft Azure Weather API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Weather API
schemes:
- https
tags:
- name: Weather
paths:
  /weather:
    get:
      tags:
      - Weather
      description: Returns a paginated list of weather data.
      operationId: microsoftAzureWeatherList
      produces:
      - application/json
      parameters:
      - in: query
        name: partyId
        description: Party ID.
        required: true
        type: string
      - in: query
        name: boundaryId
        description: Boundary ID.
        required: true
        type: string
      - in: query
        name: extensionId
        description: ID of the weather extension.
        required: true
        type: string
        pattern: ^[a-zA-Z]{3,50}[.][a-zA-Z]{3,100}$
      - in: query
        name: weatherDataType
        description: Type of weather data (forecast/historical).
        required: true
        type: string
        maxLength: 50
        minLength: 0
      - in: query
        name: granularity
        description: Granularity of weather data (daily/hourly).
        required: true
        type: string
        maxLength: 50
        minLength: 0
      - in: query
        name: startDateTime
        description: 'Weather data start UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ.'
        type: string
        format: date-time
      - in: query
        name: endDateTime
        description: 'Weather data end UTC date-time (inclusive), sample format: yyyy-MM-ddTHH:mm:ssZ.'
        type: string
        format: date-time
      - in: query
        name: maxPageSize
        description: "Maximum number of items needed (inclusive).\r\nMinimum = 10, Maximum = 1000, Default value = 50."
        type: integer
        format: int32
        default: 50
        maximum: 1000
        minimum: 10
      - in: query
        name: skipToken
        description: Skip token for getting next set of results.
        type: string
      - in: query
        name: api-version
        description: The requested API version
        required: true
        type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/WeatherDataListResponse'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              x-ms-client-name: ErrorCode
          x-ms-error-response: true
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        Weather_List:
          $ref: ./examples/Weather_List.json
      summary: Microsoft Azure Get Weather
  /weather/delete-data/{jobId}:
    get:
      tags:
      - Weather
      description: Get weather data delete job.
      operationId: microsoftAzureWeatherGetdatadeletejobdetails
      produces:
      - application/json
      parameters:
      - in: path
        name: jobId
        description: Id of the job.
        required: true
        type: string
      - in: query
        name: api-version
        description: The requested API version
        required: true
        type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/WeatherDataDeleteJob'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              x-ms-client-name: ErrorCode
          x-ms-error-response: true
      x-ms-examples:
        Weather_GetDataDeleteJobDetails:
          $ref: ./examples/Weather_GetDataDeleteJobDetails.json
      summary: Microsoft Azure Get Weather Delete Data Jobid
    put:
      tags:
      - Weather
      description: Create a weather data delete job.
      operationId: microsoftAzureWeatherCreatedatadeletejob
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: path
        name: jobId
        description: Job Id supplied by end user.
        required: true
        type: string
      - in: query
        name: api-version
        description: The requested API version
        required: true
        type: string
      - in: body
        name: job
        description: Job parameters supplied by user.
        required: true
        schema:
          $ref: '#/definitions/WeatherDataDeleteJob'
      responses:
        '202':
          description: Accepted
          schema:
            $ref: '#/definitions/WeatherDataDeleteJob'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              x-ms-client-name: ErrorCode
          x-ms-error-response: true
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-examples:
        Weather_CreateDataDeleteJob:
          $ref: ./examples/Weather_CreateDataDeleteJob.json
      summary: Microsoft Azure Put Weather Delete Data Jobid
  /weather/ingest-data/{jobId}:
    get:
      tags:
      - Weather
      description: Get weather ingestion job.
      operationId: microsoftAzureWeatherGetdataingestionjobdetails
      produces:
      - application/json
      parameters:
      - in: path
        name: jobId
        description: Id of the job.
        required: true
        type: string
      - in: query
        name: api-version
        description: The requested API version
        required: true
        type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/WeatherDataIngestionJob'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              x-ms-client-name: ErrorCode
          x-ms-error-response: true
      x-ms-examples:
        Weather_GetDataIngestionJobDetails:
          $ref: ./examples/Weather_GetDataIngestionJobDetails.json
      summary: Microsoft Azure Get Weather Ingest Data Jobid
    put:
      tags:
      - Weather
      description: Create a weather data ingestion job.
      operationId: microsoftAzureWeatherCreatedataingestionjob
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: path
        name: jobId
        description: Job id supplied by user.
        required: true
        type: string
      - in: query
        name: api-version
        description: The requested API version
        required: true
        type: string
      - in: body
        name: job
        description: Job parameters supplied by user.
        required: true
        schema:
          $ref: '#/definitions/WeatherDataIngestionJob'
      responses:
        '202':
          description: Accepted
          schema:
            $ref: '#/definitions/WeatherDataIngestionJob'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              x-ms-client-name: ErrorCode
          x-ms-error-response: true
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-examples:
        Weather_CreateDataIngestionJob:
          $ref: ./examples/Weather_CreateDataIngestionJob.json
      summary: Microsoft Azure Put Weather Ingest Data Jobid
  /weather/forecast/hourly/{format}:
    get:
      description: '**Get Hourly Forecast**<br><br>**Applies to**: S0 and S1 pricing tiers.<br><br><br>Request detailed weather forecast by the hour for the next 1, 12, 24 (1 day), 72 (3 days), 120 (5 days), and 240 hours (10 days) for the given the given coordinate location.  The API returns details such as temperature, humidity, wind, precipitation, and ultraviolet (UV) index.<br><br>In S0 you can request hourly forecast for the next 1, 12, 24 hours (1 day), and 72 hours (3 days). In S1 you can also request hourly forecast for the next 120 (5 days) and 240 hours (10 days).'
      operationId: microsoftAzureWeatherGethourlyforecast
      x-ms-examples:
        HourlyForecast:
          $ref: ./examples/GetHourlyForecast.json
      parameters:
      - $ref: '#/parameters/ClientId'
      - $ref: '#/parameters/SubscriptionKey'
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/JsonFormat'
      - name: query
        description: Coordinates of the location for which hourly forecast information is requested. The applicable query is specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
        in: query
        type: string
        required: true
      - $ref: '#/parameters/WeatherUnit'
      - name: duration
        description: "Time frame of the returned weather forecast. By default, the forecast data for next hour will be returned. Available values are\n  * `1` - Return forecast data for the next hour. Default value.\n  * `12` - Return hourly forecast for next 12 hours.\n  * `24` - Return hourly forecast for next 24 hours.\n  * `72` - Return hourly forecast for next 72 hours (3 days).\n  * `120` - Return hourly forecast for next 120 hours (5 days). Only available in S1 SKU. \n  * `240` - Return hourly forecast for next 240 hours (10 days). Only available in S1 SKU."
        default: 1
        in: query
        type: integer
      - $ref: '#/parameters/WeatherLanguage'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/HourlyForecastResponse'
        '400':
          $ref: '#/responses/400'
        '401':
          $ref: '#/responses/401'
        '403':
          $ref: '#/responses/403'
        '404':
          $ref: '#/responses/404'
        '500':
          $ref: '#/responses/500'
      summary: Microsoft Azure Get Weather Forecast Hourly Format
      tags:
      - Weather
  /weather/forecast/minute/{format}:
    get:
      description: '**Get Minute Forecast**<br>  <br>  <br>**Applies to**: S1 pricing tier.<br><br><br>Get Minute Forecast service returns minute-by-minute forecasts for a given location for the next 120 minutes.  Users can request weather forecasts in the interval of 1, 5 and 15 minutes.  The response will include details such as the type of precipitation (including rain, snow, or a mixture of both), start time, and precipitation intensity value (dBZ).'
      operationId: microsoftAzureWeatherGetminuteforecast
      x-ms-examples:
        MinuteForecast:
          $ref: ./examples/GetMinuteForecast.json
      parameters:
      - $ref: '#/parameters/ClientId'
      - $ref: '#/parameters/SubscriptionKey'
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/JsonFormat'
      - name: query
        description: Coordinates of the location for which minute forecast information is requested. The applicable query is specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
        in: query
        type: string
        required: true
      - name: interval
        description: "Specifies time interval in minutes for the returned weather forecast. Supported values are\n  * `1` -  Retrieve forecast for 1-minute intervals. Returned by default.\n  * `5` - Retrieve forecasts for 5-minute intervals.\n  * `15` - Retrieve forecasts for 15-minute intervals."
        default: 1
        in: query
        type: integer
      - $ref: '#/parameters/WeatherLanguage'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/MinuteForecastResponse'
        '400':
          $ref: '#/responses/400'
        '401':
          $ref: '#/responses/401'
        '403':
          $ref: '#/responses/403'
        '404':
          $ref: '#/responses/404'
        '500':
          $ref: '#/responses/500'
      summary: Microsoft Azure Get Weather Forecast Minute Format
      tags:
      - Weather
  /weather/forecast/quarterDay/{format}:
    get:
      description: '**Get Quarter-Day Forecast**<br>  <br>  <br>**Applies to**: S0 and S1 pricing tiers.<br><br><br>Service returns detailed weather forecast by quarter-day for the next 1, 5, 10, or 15 days for a given location. Response data is presented by quarters of the day - morning, afternoon, evening, and overnight. Details such as temperature, humidity, wind, precipitation, and UV index are returned.'
      operationId: microsoftAzureWeatherGetquarterdayforecast
      x-ms-examples:
        QuarterDayForecast:
          $ref: ./examples/GetQuarterDayForecast.json
      parameters:
      - $ref: '#/parameters/ClientId'
      - $ref: '#/parameters/SubscriptionKey'
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/JsonFormat'
      - name: query
        description: Coordinates of the location for which quarter-day forecast information is requested. The applicable query is specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
        in: query
        type: string
        required: true
      - $ref: '#/parameters/WeatherUnit'
      - name: duration
        description: "Specifies for how many days the quester-day forecast responses are returned. Supported values are:\n  * `1` - Return forecast data for the next day. Returned by default.\n  * `5` - Return forecast data for the next 5 days.\n  * `10` - Return forecast data for next 10 days.\n  * `15` - Return forecast data for the next 15 days."
        default: 1
        in: query
        type: integer
      - $ref: '#/parameters/WeatherLanguage'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/QuarterDayForecastResponse'
        '400':
          $ref: '#/responses/400'
        '401':
          $ref: '#/responses/401'
        '403':
          $ref: '#/responses/403'
        '404':
          $ref: '#/responses/404'
        '500':
          $ref: '#/responses/500'
      summary: Microsoft Azure Get Weather Forecast Quarterday Format
      tags:
      - Weather
  /weather/currentConditions/{format}:
    get:
      description: '**Get Current Conditions**<br>  <br>  <br>**Applies to**: S0 and S1 pricing tiers.<br><br><br>Get Current Conditions service returns detailed current weather conditions such as precipitation, temperature and wind for a given coordinate location. Also, observations from the past 6 or 24 hours for a particular location can be retrieved. The basic information returned with the response include details such as observation date and time, brief description of the weather conditions, weather icon, precipitation indicator flags, and temperature. Additional details such as RealFeel™ Temperature and UV index are also returned.'
      operationId: microsoftAzureWeatherGetcurrentconditions
      x-ms-examples:
        CurrentConditions:
          $ref: ./examples/GetCurrentConditions.json
      parameters:
      - $ref: '#/parameters/ClientId'
      - $ref: '#/parameters/SubscriptionKey'
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/JsonFormat'
      - name: query
        description: Coordinates of the location for which current conditions information is requested. The applicable query is specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
        in: query
        type: string
        required: true
      - $ref: '#/parameters/WeatherUnit'
      - name: details
        description: "Return full details for the current conditions. Available values are\n  * `true` - Returns full details. By default all details are returned.\n  * `false` - Returns a truncated version of the current condition data, which includes observation date time, weather phrase, icon code, precipitation indicator flag, and temperature."
        default: 'true'
        in: query
        type: string
      - name: duration
        description: "Time frame of the returned weather conditions. By default, the most current weather conditions will be returned. Default value is 0. Supported values are:\n   * `0` - Return the most current weather conditions.\n   * `6` - Return weather conditions from past 6 hours.\n   * `24` - Return weather conditions from past 24 hours."
        default: 0
        in: query
        type: integer
      - $ref: '#/parameters/WeatherLanguage'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/CurrentConditionsResponse'
        '400':
          $ref: '#/responses/400'
        '401':
          $ref: '#/responses/401'
        '403':
          $ref: '#/responses/403'
        '404':
          $ref: '#/responses/404'
        '500':
          $ref: '#/responses/500'
      summary: Microsoft Azure Get Weather Currentconditions Format
      tags:
      - Weather
  /weather/forecast/daily/{format}:
    get:
      description: '**Get Daily Forecast**<br>  <br>  <br>**Applies to**: S0 and S1 pricing tiers.<br><br><br>The service returns detailed weather forecast such as temperature and wind by day for the next 1, 5, 10, 15, 25, or 45 days for a given coordinate location.  The response include details such as temperature, wind, precipitation, air quality, and UV index.<br><br>In S0 you can request daily forecast for the next 1, 5, 10, and 15 days. In S1 you can also request daily forecast for the next 25 days, and 45 days.'
      operationId: microsoftAzureWeatherGetdailyforecast
      x-ms-examples:
        DailyForecast:
          $ref: ./examples/GetDailyForecast.json
      parameters:
      - $ref: '#/parameters/ClientId'
      - $ref: '#/parameters/SubscriptionKey'
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/JsonFormat'
      - name: query
        description: Coordinates of the location for which current conditions information is requested. The applicable query is specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
        in: query
        type: string
        required: true
      - $ref: '#/parameters/WeatherUnit'
      - name: duration
        description: "Specifies for how many days the daily forecast responses are returned. Available values are\n  * `1` - Return forecast data for the next day. Returned by default.\n  * `5` - Return forecast data for the next 5 days.\n  * `10` - Return forecast data for the next 10 days.\n  * `25` - Return forecast data for the next 25 days. Only available in S1 SKU.\n  * `45` - Return forecast data for the next 45 days. Only available in S1 SKU."
        default: 1
        in: query
        type: integer
      - $ref: '#/parameters/WeatherLanguage'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/DailyForecastResponse'
        '400':
          $ref: '#/responses/400'
        '401':
          $ref: '#/responses/401'
        '403':
          $ref: '#/responses/403'
        '404':
          $ref: '#/responses/404'
        '500':
          $ref: '#/responses/500'
      summary: Microsoft Azure Get Weather Forecast Daily Format
      tags:
      - Weather
  /weather/route/{format}:
    get:
      description: '**Get Weather along route**<br>   <br>   <br> **Applies to**: S1 pricing tier.<br><br> Weather along a route API returns hyper local (one kilometer or less), up-to-the-minute weather nowcasts, weather hazard assessments, and notifications along a route described as a sequence of waypoints. <br> This includes a list of weather hazards affecting the waypoint or route, and the aggregated hazard index for each waypoint might be used to paint each portion of a route according to how safe it is for the driver. When submitting the waypoints, it is recommended to stay within, or close to, the distance that can be traveled within 120-mins or shortly after. Data is updated every five minutes. <br> <br> The service supplements Azure Maps [Route Service](https://docs.microsoft.com/rest/api/maps/route) that allows you to first request a route between an origin and a destination and use that as an input for Weather Along Route endpoint.<br> <br> In addition, the service supports scenarios to generate weather notifications for waypoints that experience an increase in intensity of a weather hazard. For example, if the vehicle is expected to begin experiencing heavy rain as it reaches a waypoint, a weather notification for heavy rain will be generated for that waypoint allowing the end product to display a heavy rain notification before the driver reaches that waypoint. <br> The trigger for when to display the notification for a waypoint could be based, for example, on a [geofence](https://docs.microsoft.com/azure/azure-maps/tutorial-iot-hub-maps), or selectable distance to the waypoint.<br><br> The API covers all regions of the planet except latitudes above Greenland and Antarctica.'
      operationId: microsoftAzureWeatherGetweatheralongroute
      x-ms-examples:
        WeatherAlongRoute:
          $ref: ./examples/GetWeatherAlongRoute.json
      parameters:
      - $ref: '#/parameters/ClientId'
      - $ref: '#/parameters/SubscriptionKey'
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/JsonFormat'
      - name: query
        description: "Coordinates through which the route is calculated, separated by colon (:) and entered in chronological order. A minimum of two waypoints is required. A single API call may contain up to 60 waypoints. \nA waypoint indicates location, ETA, and optional heading: latitude,longitude,ETA,heading, where\n  * `Latitude` - Latitude coordinate in decimal degrees.\n  * `Longitude` - Longitude coordinate in decimal degrees.\n  * `ETA (estimated time of arrival)` - The number of minutes from the present time that it will take for the vehicle to reach the waypoint. Allowed range is from 0.0 to 120.0 minutes.\n  * `Heading` - An optional value indicating the vehicle heading as it passes the waypoint. Expressed in clockwise degrees relative to true north. This is issued to calculate sun glare as a driving hazard. Allowed range is from 0.0 to 360.0 degrees. If not provided, a heading will automatically be derived based on the position of neighboring waypoints.\n\nIt is recommended to stay within, or close to, the distance that can be traveled within 120-mins or shortly after. This way a more accurate assessment can be provided for the trip and prevent isolated events not being captured between waypoints.  Information can and should be updated along the route (especially for trips greater than 2 hours) to continuously pull new waypoints moving forward, but also to ensure that forecast information for content such as precipitation type and intensity is accurate as storms develop and dissipate over time."
        in: query
        type: string
        required: true
      - $ref: '#/parameters/WeatherLanguage'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/WeatherAlongRouteResponse'
        '400':
          $ref: '#/responses/400'
        '401':
          $ref: '#/responses/401'
        '403':
          $ref: '#/responses/403'
        '404':
          $ref: '#/responses/404'
        '500':
          $ref: '#/responses/500'
      summary: Microsoft Azure Get Weather Route Format
      tags:
      - Weather
  /weather/severe/alerts/{format}:
    get:
      description: '**Get Severe Weather Alerts**<br><br>**Applies to**: S0 and S1 pricing tiers.<br><br>Severe weather phenomenon can significantly impact our everyday life and business operations. For example, severe weather conditions such as tropical storms, high winds or flooding can close roads and force logistics companies to reroute their fleet causing delays in reaching destinations and breaking the cold chain of refrigerated food products.  Azure Maps Severe Weather Alerts API returns the severe weather alerts that are available worldwide from both official Government Meteorological Agencies and leading global to regional weather alert providers. The service can return details such as alert type, category, level and detailed description about the active severe alerts for the requested location, like hurricanes, thunderstorms, lightning, heat waves or forest fires.'
      operationId: microsoftAzureWeatherGetsevereweatheralerts
      x-ms-examples:
        SevereWeatherAlert:
          $ref: ./examples/GetSevereWeatherAlerts.json
      parameters:
      - $ref: '#/parameters/ClientId'
      - $ref: '#/parameters/SubscriptionKey'
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/JsonFormat'
      - name: query
        description: Coordinates of the location for which severe weather alerts are requested. The applicable query is specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
        in: query
        type: string
        required: true
      - $ref: '#/parameters/WeatherLanguage'
      - name: details
        description: "Return full details for the severe weather alerts. Available values are\n  * `true` - Returns full details. By default all details are returned.\n  * `false` - Returns a truncated version of the alerts data, which excludes the area-specific full description of alert details (`alertDetails`)."
        default: 'true'
        in: query
        type: string
      responses:
        '200':
          description: OK,
          schema:
            $ref: '#/definitions/SevereWeatherAlertsResponse'
        '400':
          $ref: '#/responses/400'
        '401':
          $ref: '#/responses/401'
        '403':
          $ref: '#/responses/403'
        '404':
          $ref: '#/responses/404'
        '500':
          $ref: '#/responses/500'
      summary: Microsoft Azure Get Weather Severe Alerts Format
      tags:
      - Weather
  /weather/indices/daily/{format}:
    get:
      description: '**Get Daily Indices**<br><br>**Applies to**: S0 and S1 pricing tiers.<br><br>There may be times when you want to know if the weather conditions are optimal for a specific activity, for example, for outdoor construction, indoor activities, running or farming including soil moisture information.  Azure Maps Indices API returns index values that will guide end users to plan future activities. For example, a health mobile application can notify users that today is good weather for running or for other outdoors activities like for playing golf, and retail stores can optimize their digital marketing campaigns based on predicted index values. The service returns in daily indices values for current and next 5, 10 and 15 days starting from current day.'
      operationId: microsoftAzureWeatherGetdailyindices
      x-ms-examples:
        DailyIndices:
          $ref: ./examples/GetDailyIndices.json
      parameters:
      - $ref: '#/parameters/ClientId'
      - $ref: '#/parameters/SubscriptionKey'
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/JsonFormat'
      - name: query
        description: Coordinates of the location for which daily indices are requested. The applicable query is specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
        in: query
        type: string
        required: true
      - $ref: '#/parameters/WeatherLanguage'
      - name: duration
        description: "Specifies for how many days the daily indices are returned. By default, the indices data for the current day will be returned. When requesting future indices data, the current day is included in the response as day 1. Available values are\n  * `1` - Return daily index data for the current day. Default value.\n  * `5` - Return 5 days of daily index data starting from the current day.\n  * `10` - Return 10 days of daily index data starting from the current day.\n  * `15` - Return 15 days of daily index data starting from the current day."
        default: 1
        in: query
        type: integer
      - name: indexId
        description: Numeric index identifier that can be used for restricting returned results to the corresponding index type. Cannot be paired with `indexGroupId`. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details and to see the supported indices.
        in: query
        type: integer
      - name: indexGroupId
        description: Numeric index group identifier that can be used for restricting returned results to the corresponding subset of indices (index group). Cannot be paired with `indexId`. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details and to see the supported index groups.
        in: query
        type: integer
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/DailyIndicesResponse'
        '400':
          $ref: '#/responses/400'
        '401':
          $ref: '#/responses/401'
        '403':
          $ref: '#/responses/403'
        '404':
          $ref: '#/responses/404'
        '500':
          $ref: '#/responses/500'
      summary: Microsoft Azure Get Weather Indices Daily Format
      tags:
      - Weather
definitions:
  PressureTendency:
    type: object
    properties:
      localizedDescription:
        type: string
        description: Description of the pressure tendency in specified language
      code:
        type: string
        description: Pressure tendency code regardless of language. One of F=Falling, S=Steady, R=Rising.
  WindSpeed:
    type: object
    description: Speed of wind in specified unit.
    properties:
      value:
        type: number
        format: float
        description: Rounded value of the speed.
      unit:
        type: string
        description: Type of unit for the speed value.
      unitType:
        type: integer
        format: int32
        description: Numeric ID value associated with the type of unit being displayed. Can be used for unit translation. Please refer to [Weather Service Concepts](https://aka.ms/AzureMapsWeatherConcepts) for details.
  Notification:
    type: object
    properties:
      type:
        type: string
        description: A type of notification generated to warn drivers of the onset of a hazard, or increase in intensity of a hazard.
      hazardIndex:
        $ref: '#/definitions/HazardIndex'
      hazardCode:
        type: string
        description: 'A unique identifier (non-displayable) for each type of hazard: LightRain, ModerateRain, HeavyRain, LightMix, ModerateMix, HeavyMix, LightSnow, ModerateSnow, HeavySnow, LightIce, ModerateIce, HeavyIce, Hail, LargeHail, SunGlare, SunGlareHigh, Lightning, SevereLightning, WindModerate, WindHigh, WindExtreme, FloodWarning, FlashFloodWarning, TornadoWarning, TsunamiWarning, SevereThunderstormWarning.'
      shortPhrase:
        type: string
        description: A displayable short phrase describing the forecasted conditions and precipitation intensity/type.
  WeatherDataListResponse:
    description: Paged response contains list of requested objects and a URL link to get the next set of results.
    required:
    - value
    type: object
    properties:
      value:
        description: List of requested objects.
        type: array
        items:
          $ref: '#/definitions/WeatherData'
      skipToken:
        description: Token used in retrieving the next page. If null, there are no additional pages.
        type: string
      nextLink:
        description: Continuation link (absolute URI) to the next page of results in the list.
        type: string
  HazardDetail:
    type: object
    properties:
      hazardIndex:
        $ref: '#/definitions/HazardIndex'
      hazardCode:
        type: string
        description: 'A unique identifier (non-displayable) for each type of hazard: LightRain, ModerateRain, HeavyRain, LightMix, ModerateMix, HeavyMix, LightSnow, ModerateSnow, HeavySnow, LightIce, ModerateIce, HeavyIce, Hail, LargeHail, SunGlare, SunGlareHigh, Lightning, SevereLightning, WindModerate, WindHigh, WindExtreme, FloodWarning, FlashFloodWarning, TornadoWarning, TsunamiWarning, SevereThunderstormWarning.'
      shortPhrase:
        type: string
        description: A displayable short phrase describing the forecasted conditions and precipitation intensity/type.
  Location:
    description:

# --- truncated at 32 KB (91 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoft-azure-weather-api-openapi.yml