Weather - Get Tropical Storm Search

Используйте для получения списка штормов, выпущенного национальными агентствами прогнозирования погоды.
Get Tropical Storm Search API представляет собой HTTP-запросGET, который возвращает список тропических штормов, выпущенных правительством, по годам, идентификаторам бассейна и государственным идентификаторам. Информация о тропических штормах включает в себя правительственный идентификатор, идентификатор бассейна, статус, год, название и является ли он субтропическим.

GET {endpoint}/weather/tropical/storms/json?api-version=1.1&year={year}

GET {endpoint}/weather/tropical/storms/json?api-version=1.1&year={year}&basinId={basinId}&govId={govId}

Параметры URI

Заголовок запроса

Ответы

Безопасность

AadToken

Это Microsoft Entra OAuth 2.0 потоки. В сочетании с управлением Azure ролевым доступом он может использоваться для управления доступом к Azure Maps REST API. Ролевые контроли доступа Azure используются для обозначения доступа к одной или нескольким учетной записи ресурсов или подресурсам Azure Maps. Любой пользователь, группа или принципал сервиса может получить доступ через встроенную роль или пользовательскую роль, состоящую из одного или нескольких разрешений Azure Maps REST API.\n\nДля реализации сценариев рекомендуем ознакомиться с концепциями аутентификационные концепции. В заключение, это определение безопасности предоставляет решение для моделирования приложений с помощью объектов, способных контролировать доступ к определённым API и областям видимости.\n\n#### Примечания\n* Это определение безопасности требует использование заголовка x-ms-client-id для указания, к какому Azure Maps ресурсу приложение запрашивает доступ. Её можно получить через API управления Maps.\n* \nAuthorization URL специфичен для экземпляра публичного облака Azure. Облака Sovereign имеют уникальные URL-адреса авторизации и конфигурации Microsoft Entra ID. \n* \nУправление доступом на основе ролей Azure настраивается с плоскости управления Azure через портал Azure, PowerShell, CLI, Azure SDKs или REST API.\n* \nИспользование Azure Maps Web SDK позволяет настраивать приложение на основе конфигурации для нескольких сценариев использования.\n* Для получения дополнительной информации о платформа удостоверений Майкрософт см. платформа удостоверений Майкрософт обзор.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

subscription-key

Это общий ключ, который создаётся при Создайте Azure Maps аккаунт в Azure-портале или с помощью PowerShell, CLI, Azure SDKs или REST API.\n\n С помощью этого ключа любое приложение может получить доступ ко всем REST API. Другими словами, этот ключ может использоваться как мастер-ключ на счете, на котором они выпущены.\n\n Для публично открытых приложений мы рекомендуем использовать подход confidential client applications для доступа к Azure Maps REST API, чтобы ваш ключ можно было безопасно хранить.

Тип: apiKey
В: header

SAS Token

Это токен общего доступа, созданный из операции List SAS на ресурсе Azure Maps/c0> через плоскость управления Azure через портал Azure, PowerShell, CLI, Azure SDKs или REST API.\n\n С помощью этого токена любое приложение имеет право на доступ с помощью Azure ролевые контроли доступа и тонкий контроль истечения срока действия, скорости и региона использования конкретного токена. Другими словами, SAS Token может использоваться для того, чтобы приложения могли управлять доступом более защищённо, чем общий ключ.\n\n Для публично открытых приложений мы рекомендуем настроить конкретный список разрешённых источников на ресурсе аккаунта Map , чтобы ограничить злоупотребления рендерингом и регулярно продлевать токен SAS.

Тип: apiKey
В: header

Примеры

Get Tropical Storm Search

GET {endpoint}/weather/tropical/storms/json?api-version=1.1&year=2021&basinId=AL

{
  "results": [
    {
      "name": "Ana",
      "basinId": "AL",
      "govId": 1,
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false,
      "year": "2021"
    },
    {
      "name": "Bill",
      "basinId": "AL",
      "govId": 2,
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false,
      "year": "2021"
    },
    {
      "name": "Claudette",
      "basinId": "AL",
      "govId": 3,
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false,
      "year": "2021"
    },
    {
      "name": "Danny",
      "basinId": "AL",
      "govId": 4,
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false,
      "year": "2021"
    },
    {
      "name": "Elsa",
      "basinId": "AL",
      "govId": 5,
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false,
      "year": "2021"
    },
    {
      "name": "Fred",
      "basinId": "AL",
      "govId": 6,
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false,
      "year": "2021"
    },
    {
      "name": "Grace",
      "basinId": "AL",
      "govId": 7,
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false,
      "year": "2021"
    },
    {
      "name": "Henri",
      "basinId": "AL",
      "govId": 8,
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false,
      "year": "2021"
    },
    {
      "name": "Ida",
      "basinId": "AL",
      "govId": 9,
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false,
      "year": "2021"
    },
    {
      "name": "Kate",
      "basinId": "AL",
      "govId": 10,
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false,
      "year": "2021"
    },
    {
      "name": "Julian",
      "basinId": "AL",
      "govId": 11,
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false,
      "year": "2021"
    },
    {
      "name": "Larry",
      "basinId": "AL",
      "govId": 12,
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false,
      "year": "2021"
    },
    {
      "name": "Mindy",
      "basinId": "AL",
      "govId": 13,
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false,
      "year": "2021"
    },
    {
      "name": "Nicholas",
      "basinId": "AL",
      "govId": 14,
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false,
      "year": "2021"
    },
    {
      "name": "ODETTE",
      "basinId": "AL",
      "govId": 15,
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false,
      "year": "2021"
    },
    {
      "name": "Peter",
      "basinId": "AL",
      "govId": 16,
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false,
      "year": "2021"
    },
    {
      "name": "Rose",
      "basinId": "AL",
      "govId": 17,
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false,
      "year": "2021"
    },
    {
      "name": "Sam",
      "basinId": "AL",
      "govId": 18,
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false,
      "year": "2021"
    },
    {
      "name": "Teresa",
      "basinId": "AL",
      "govId": 19,
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false,
      "year": "2021"
    },
    {
      "name": "Victor",
      "basinId": "AL",
      "govId": 20,
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false,
      "year": "2021"
    },
    {
      "name": "Wanda",
      "basinId": "AL",
      "govId": 21,
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false,
      "year": "2021"
    }
  ]
}

Get Tropical Storm Search With Three Properties

GET {endpoint}/weather/tropical/storms/json?api-version=1.1&year=2021&basinId=AL&govId=1

{
  "results": [
    {
      "name": "Ana",
      "basinId": "AL",
      "govId": 1,
      "isActive": false,
      "isRetired": false,
      "isSubtropical": false,
      "year": "2021"
    }
  ]
}

Определения

BasinId

Идентификатор бассейна для тропических штормов.

ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.

ErrorDetail

Сведения об ошибке.

ErrorResponse

Обычный ответ на ошибку для всех API Azure Resource Manager для возврата деталей ошибок при неудачных операциях. (Это также следует формату ответа об ошибках OData.).

JsonFormat

Требуемый формат ответа. Поддерживается только json формат.

StormSearchResult

Содержит список штормов, выданных правительством, соответствующих указанным критериям поиска, включая такие детали, как идентификатор бассейна шторма, удостоверение и статус.

StormSearchResultItem

Штормовое событие, выдаваемое правительством, включая идентификатор бассейна шторма (basinId), государственный идентификатор (govId) и статус. Этот объект возвращается как часть массива внутри объекта StormSearchResult .