Поделиться через

Vpn Sites - List

  • Ссылка
Служба:
Virtual WAN
Версия API:
2024-05-01

Выводит список всех vpn-сайтов в подписке.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Network/vpnSites?api-version=2024-05-01

Параметры URI

Имя В Обязательно Тип Описание
subscriptionId
 path True

string

Учетные данные подписки, которые однозначно определяют подписку Microsoft Azure. Идентификатор подписки входит в состав URI для каждого вызова службы.
api-version
 query True

string

Версия КЛИЕНТСКОго API.

Ответы

Имя Тип Описание
200 OK

ListVpnSitesResult

Запрос успешно выполнен. Возвращает сведения обо всех vpn-сайтах в подписке.
Other Status Codes

CloudError

Ответ на ошибку, описывающий причину сбоя операции.

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

azure_auth

Поток OAuth2 Azure Active Directory.

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

Области

Имя Описание
user_impersonation олицетворения учетной записи пользователя

Примеры

VpnSiteList

Образец запроса

GET https://management.azure.com/subscriptions/subid/providers/Microsoft.Network/vpnSites?api-version=2024-05-01

Пример ответа

Код состояния:
200 
{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1",
      "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
      "location": "West US",
      "name": "vpnSite1",
      "type": "Microsoft.Network/vpnSites",
      "tags": {
        "key1": "value1"
      },
      "properties": {
        "provisioningState": "Succeeded",
        "virtualWan": {
          "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1"
        },
        "deviceProperties": {
          "linkSpeedInMbps": 0
        },
        "addressSpace": {
          "addressPrefixes": [
            "10.0.0.0/16"
          ]
        },
        "isSecuritySite": false,
        "vpnSiteLinks": [
          {
            "name": "vpnSiteLink1",
            "type": "Microsoft.Network/vpnSites/vpnSiteLinks",
            "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/vpnSiteLink1",
            "etag": "W/\"00000000-0000-0000-0000-000000000000\"",
            "properties": {
              "provisioningState": "Succeeded",
              "ipAddress": "50.50.50.56",
              "linkProperties": {
                "linkSpeedInMbps": 0
              },
              "bgpProperties": {
                "bgpPeeringAddress": "192.168.0.0",
                "asn": 1234
              }
            }
          }
        ]
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/vpnSites/vpnSite2",
      "etag": "w/\\00000000-0000-0000-0000-000000000000\\",
      "location": "East US",
      "name": "vpnSite2",
      "type": "Microsoft.Network/vpnSites",
      "tags": {
        "key1": "value1"
      },
      "properties": {
        "provisioningState": "Succeeded",
        "virtualWan": {
          "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualWANs/wan1"
        },
        "deviceProperties": {
          "deviceVendor": "vendor1",
          "deviceModel": "model01",
          "linkSpeedInMbps": 200
        },
        "ipAddress": "10.1.0.0",
        "addressSpace": {
          "addressPrefixes": [
            "10.0.0.0/16"
          ]
        },
        "bgpProperties": {
          "bgpPeeringAddress": "192.168.0.0",
          "asn": 1234
        },
        "isSecuritySite": false
      }
    }
  ]
}

Определения

Имя Описание
AddressSpace

AddressSpace содержит массив диапазонов IP-адресов, которые можно использовать подсетями виртуальной сети.
BgpSettings

Сведения о параметрах BGP.
CloudError

Ответ на ошибку службы.
CloudErrorBody

Ответ на ошибку службы.
DeviceProperties

Список свойств устройства.
IpamPoolPrefixAllocation

Справочник по выделению префикса IpamPool.
IPConfigurationBgpPeeringAddress

Свойства IPConfigurationBgpPeeringAddress.
ListVpnSitesResult

Результат запроса на перечисление VPNSites. Он содержит список VpnSites и URL-адрес nextLink, чтобы получить следующий набор результатов.
O365BreakOutCategoryPolicies

Категории останова Office365.
O365PolicyProperties

Политика останова Office365.
ProvisioningState

Текущее состояние подготовки.
SubResource

Ссылка на другой подресурс.
VpnLinkBgpSettings

Сведения о параметрах BGP для ссылки.
VpnLinkProviderProperties

Список свойств поставщика ссылок.
VpnSite

Ресурс VpnSite.
VpnSiteLink

Ресурс VpnSiteLink.

AddressSpace

Object

AddressSpace содержит массив диапазонов IP-адресов, которые можно использовать подсетями виртуальной сети.

Имя Тип Описание
addressPrefixes

string[]

Список блоков адресов, зарезервированных для этой виртуальной сети в нотации CIDR.
ipamPoolPrefixAllocations

IpamPoolPrefixAllocation[]

Список пулов IPAM, выделяющих префиксы IP-адресов.

BgpSettings

Object

Сведения о параметрах BGP.

Имя Тип Описание
asn

integer

ASN докладчика BGP.
bgpPeeringAddress

string

Адрес пиринга BGP и идентификатор BGP этого докладчика BGP.
bgpPeeringAddresses

IPConfigurationBgpPeeringAddress[]

Адрес пиринга BGP с идентификатором IP-конфигурации для шлюза виртуальной сети.
peerWeight

integer

Вес, добавленный к маршрутам, извлеченным из этого докладчика BGP.

CloudError

Object

Ответ на ошибку службы.

Имя Тип Описание
error

CloudErrorBody

Текст ошибки облака.

CloudErrorBody

Object

Ответ на ошибку службы.

Имя Тип Описание
code

string

Идентификатор ошибки. Коды являются инвариантными и предназначены для программного использования.
details

CloudErrorBody[]

Список дополнительных сведений об ошибке.
message

string

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

string

Целевой объект конкретной ошибки. Например, имя свойства в ошибке.

DeviceProperties

Object

Список свойств устройства.

Имя Тип Описание
deviceModel

string

Модель устройства.
deviceVendor

string

Имя поставщика устройства.
linkSpeedInMbps

integer

Скорость связи.

IpamPoolPrefixAllocation

Object

Справочник по выделению префикса IpamPool.

Имя Тип Описание
allocatedAddressPrefixes

string[]

Список назначенных префиксов IP-адресов в IpamPool связанного ресурса.
numberOfIpAddresses

string

Количество выделенных IP-адресов.
pool.id

string

Идентификатор ресурса связанного ресурса Azure IpamPool.

IPConfigurationBgpPeeringAddress

Object

Свойства IPConfigurationBgpPeeringAddress.

Имя Тип Описание
customBgpIpAddresses

string[]

Список пользовательских адресов пиринга BGP, принадлежащих ip-конфигурации.
defaultBgpIpAddresses

string[]

Список адресов пиринга BGP по умолчанию, принадлежащих к IP-конфигурации.
ipconfigurationId

string

Идентификатор конфигурации IP-адресов, принадлежавшей шлюзу.
tunnelIpAddresses

string[]

Список общедоступных IP-адресов туннеля, принадлежащих конфигурации IP-адресов.

ListVpnSitesResult

Object

Результат запроса на перечисление VPNSites. Он содержит список VpnSites и URL-адрес nextLink, чтобы получить следующий набор результатов.

Имя Тип Описание
nextLink

string

URL-адрес для получения следующего набора результатов списка операций при наличии.
value

VpnSite[]

Список VPNSites.

O365BreakOutCategoryPolicies

Object

Категории останова Office365.

Имя Тип Описание
allow

boolean

Флаг для управления категорией разрешений.
default

boolean

Пометка для управления категорией по умолчанию.
optimize

boolean

Флаг для управления категорией оптимизации.

O365PolicyProperties

Object

Политика останова Office365.

Имя Тип Описание
breakOutCategories

O365BreakOutCategoryPolicies

Категории останова Office365.

ProvisioningState

Enumeration

Текущее состояние подготовки.

Значение Описание
Deleting
Failed
Succeeded
Updating

SubResource

Object

Ссылка на другой подресурс.

Имя Тип Описание
id

string

Идентификатор ресурса.

VpnLinkBgpSettings

Object

Сведения о параметрах BGP для ссылки.

Имя Тип Описание
asn

integer

ASN докладчика BGP.
bgpPeeringAddress

string

Адрес пиринга BGP и идентификатор BGP этого докладчика BGP.

VpnLinkProviderProperties

Object

Список свойств поставщика ссылок.

Имя Тип Описание
linkProviderName

string

Имя поставщика ссылок.
linkSpeedInMbps

integer

Скорость связи.

VpnSite

Object

Ресурс VpnSite.

Имя Тип Описание
etag

string

Уникальная строка только для чтения, которая изменяется при обновлении ресурса.
id

string

Идентификатор ресурса.
location

string

Расположение ресурса.
name

string

Имя ресурса.
properties.addressSpace

AddressSpace

Адресное пространство, содержащее массив диапазонов IP-адресов.
properties.bgpProperties

BgpSettings

Набор свойств bgp.
properties.deviceProperties

DeviceProperties

Свойства устройства.
properties.ipAddress

string

IP-адрес vpn-сайта.
properties.isSecuritySite

boolean

Флаг IsSecuritySite.
properties.o365Policy

O365PolicyProperties

Политика Office365.
properties.provisioningState

ProvisioningState

Состояние подготовки ресурса VPN-сайта.
properties.siteKey

string

Ключ vpn-сайта, который можно использовать для подключений.
properties.virtualWan

SubResource

Виртуальная глобальная сеть, к которой принадлежит vpnSite.
properties.vpnSiteLinks

VpnSiteLink[]

Список всех ссылок vpn-сайта.
tags

object

Теги ресурсов.
type

string

Тип ресурса.
Object

Ресурс VpnSiteLink.

Имя Тип Описание
etag

string

Уникальная строка только для чтения, которая изменяется при обновлении ресурса.
id

string

Идентификатор ресурса.
name

string

Имя ресурса, уникального в группе ресурсов. Это имя можно использовать для доступа к ресурсу.
properties.bgpProperties

VpnLinkBgpSettings

Набор свойств bgp.
properties.fqdn

string

Полное доменное имя vpn-сайта-link.
properties.ipAddress

string

IP-адрес для vpn-site-link.
properties.linkProperties

VpnLinkProviderProperties

Свойства поставщика ссылок.
properties.provisioningState

ProvisioningState

Состояние подготовки ресурса канала VPN-сайта.
type

string

Тип ресурса.