az network vpn-site

Note

Эта ссылка является частью расширения virtual-wan для Azure CLI (версия 2.55.0 или более поздней). Расширение будет автоматически устанавливаться при первом запуске команды az network vpn-site. Подробнее о расширениях.

Управление конфигурациями сайтов VPN.

Команды

Имя Описание Тип Состояние
az network vpn-site create

Создайте конфигурацию VPN-сайта.

 Extension GA
az network vpn-site delete

Удаление конфигурации VPN-сайта.

 Extension GA
az network vpn-site download

Укажите URL-адрес SAS для скачивания конфигурации для VPN-сайта.

 Extension GA
az network vpn-site link

Управление ссылкой VPN-сайта.

 Extension GA
az network vpn-site link add

Добавьте ссылку VPN-сайта в конфигурацию VPN-сайта.

 Extension GA
az network vpn-site link list

Вывод списка ссылок НА VPN-сайт в конфигурации VPN-сайта.

 Extension GA
az network vpn-site link remove

Удалите ссылку VPN-сайта из конфигурации VPN-сайта.

 Extension GA
az network vpn-site list

Вывод списка конфигураций VPN-сайта.

 Extension GA
az network vpn-site show

Получите сведения о конфигурации VPN-сайта.

 Extension GA
az network vpn-site update

Обновление параметров конфигурации VPN-сайта.

 Extension GA

az network vpn-site create

Создайте конфигурацию VPN-сайта.

az network vpn-site create --ip-address
                           --name
                           --resource-group
                           [--acquire-policy-token]
                           [--address-prefixes]
                           [--asn]
                           [--bgp-peering-address]
                           [--change-reference]
                           [--device-model]
                           [--device-vendor]
                           [--link-speed]
                           [--location]
                           [--no-wait]
                           [--peer-weight]
                           [--security-site {false, true}]
                           [--site-key]
                           [--tags]
                           [--virtual-wan]
                           [--with-link {false, true}]

Обязательные параметры

--ip-address

IP-адрес VPN-сайта.

--name -n

Имя конфигурации VPN-сайта.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

Необязательные параметры

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

--acquire-policy-token

Автоматическое получение маркера Политика Azure для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--address-prefixes

Разделенный пробелами список префиксов адресов CIDR.

--asn

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

Свойство Значение
Группа параметров: BGP Peering Arguments
--bgp-peering-address

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

Свойство Значение
Группа параметров: BGP Peering Arguments
--change-reference

Связанный идентификатор ссылки на изменение для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--device-model

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

Свойство Значение
Группа параметров: Device Property Arguments
--device-vendor

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

Свойство Значение
Группа параметров: Device Property Arguments
--link-speed

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

Свойство Значение
Группа параметров: Device Property Arguments
--location -l

Location. Значения из az account list-locations. Расположение по умолчанию можно настроить с помощью az configure --defaults location=<location>.

--no-wait

Не ожидать завершения длительной операции.

Свойство Значение
Значение по умолчанию: False
--peer-weight

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

Свойство Значение
Группа параметров: BGP Peering Arguments
--security-site

Связан ли VPN-сайт с безопасностью.

Свойство Значение
Допустимые значения: false, true
--site-key

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

--tags

Теги, разделенные пробелами: key[=value] [key[=value] ...]. Используйте "" для очистки существующих тегов.

--virtual-wan

Имя или идентификатор виртуальной глобальной сети.

--with-link

Создайте VPN-сайт со ссылкой по умолчанию.

Свойство Значение
Допустимые значения: false, true
Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Значение по умолчанию: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Значение по умолчанию: False
--output -o

Формат вывода.

Свойство Значение
Значение по умолчанию: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Значение по умолчанию: False

az network vpn-site delete

Удаление конфигурации VPN-сайта.

az network vpn-site delete [--acquire-policy-token]
                           [--change-reference]
                           [--ids]
                           [--name]
                           [--resource-group]
                           [--subscription]

Необязательные параметры

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

--acquire-policy-token

Автоматическое получение маркера Политика Azure для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--change-reference

Связанный идентификатор ссылки на изменение для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--ids

Один или несколько идентификаторов ресурсов (разделенных пробелами). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие параметры 'Resource Id'.

Свойство Значение
Группа параметров: Resource Id Arguments
--name -n

Имя конфигурации VPN-сайта.

Свойство Значение
Группа параметров: Resource Id Arguments
--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

Свойство Значение
Группа параметров: Resource Id Arguments
--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

Свойство Значение
Группа параметров: Resource Id Arguments
Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Значение по умолчанию: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Значение по умолчанию: False
--output -o

Формат вывода.

Свойство Значение
Значение по умолчанию: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Значение по умолчанию: False

az network vpn-site download

Укажите URL-адрес SAS для скачивания конфигурации для VPN-сайта.

az network vpn-site download --request
                             --resource-group
                             --vwan-name
                             [--acquire-policy-token]
                             [--change-reference]

Обязательные параметры

--request

Параметры, предоставленные для скачивания конфигурации VPN-сайтов. Тип модели или тип ввода-вывода. Required.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

--vwan-name

Имя виртуальной глобальной сети.

Необязательные параметры

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

--acquire-policy-token

Автоматическое получение маркера Политика Azure для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--change-reference

Связанный идентификатор ссылки на изменение для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Значение по умолчанию: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Значение по умолчанию: False
--output -o

Формат вывода.

Свойство Значение
Значение по умолчанию: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Значение по умолчанию: False

az network vpn-site list

Вывод списка конфигураций VPN-сайта.

az network vpn-site list [--resource-group]

Необязательные параметры

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

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Значение по умолчанию: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Значение по умолчанию: False
--output -o

Формат вывода.

Свойство Значение
Значение по умолчанию: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Значение по умолчанию: False

az network vpn-site show

Получите сведения о конфигурации VPN-сайта.

az network vpn-site show [--ids]
                         [--name]
                         [--resource-group]
                         [--subscription]

Необязательные параметры

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

--ids

Один или несколько идентификаторов ресурсов (разделенных пробелами). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие параметры 'Resource Id'.

Свойство Значение
Группа параметров: Resource Id Arguments
--name -n

Имя конфигурации VPN-сайта.

Свойство Значение
Группа параметров: Resource Id Arguments
--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

Свойство Значение
Группа параметров: Resource Id Arguments
--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

Свойство Значение
Группа параметров: Resource Id Arguments
Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Значение по умолчанию: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Значение по умолчанию: False
--output -o

Формат вывода.

Свойство Значение
Значение по умолчанию: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Значение по умолчанию: False

az network vpn-site update

Обновление параметров конфигурации VPN-сайта.

az network vpn-site update [--acquire-policy-token]
                           [--add]
                           [--address-prefixes]
                           [--asn]
                           [--bgp-peering-address]
                           [--change-reference]
                           [--device-model]
                           [--device-vendor]
                           [--force-string]
                           [--ids]
                           [--ip-address]
                           [--link-speed]
                           [--name]
                           [--no-wait]
                           [--peer-weight]
                           [--remove]
                           [--resource-group]
                           [--security-site {false, true}]
                           [--set]
                           [--site-key]
                           [--subscription]
                           [--tags]
                           [--virtual-wan]

Необязательные параметры

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

--acquire-policy-token

Автоматическое получение маркера Политика Azure для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--add

Добавьте объект в список объектов, указав пары пути и значения ключа. Пример: --add property.listProperty <key=value, string or JSON string>.

Свойство Значение
Группа параметров: Generic Update Arguments
Значение по умолчанию: []
--address-prefixes

Разделенный пробелами список префиксов адресов CIDR.

--asn

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

Свойство Значение
Группа параметров: BGP Peering Arguments
--bgp-peering-address

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

Свойство Значение
Группа параметров: BGP Peering Arguments
--change-reference

Связанный идентификатор ссылки на изменение для этой операции ресурса.

Свойство Значение
Группа параметров: Global Policy Arguments
--device-model

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

Свойство Значение
Группа параметров: Device Property Arguments
--device-vendor

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

Свойство Значение
Группа параметров: Device Property Arguments
--force-string

При использовании "set" или "add" сохраняйте строковые литералы вместо попытки преобразовать в JSON.

Свойство Значение
Группа параметров: Generic Update Arguments
Значение по умолчанию: False
--ids

Один или несколько идентификаторов ресурсов (разделенных пробелами). Это должен быть полный идентификатор ресурса, содержащий все сведения о аргументах Resource Id. Необходимо указать аргументы --ids или другие параметры 'Resource Id'.

Свойство Значение
Группа параметров: Resource Id Arguments
--ip-address

IP-адрес VPN-сайта.

--link-speed

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

Свойство Значение
Группа параметров: Device Property Arguments
--name -n

Имя конфигурации VPN-сайта.

Свойство Значение
Группа параметров: Resource Id Arguments
--no-wait

Не ожидать завершения длительной операции.

Свойство Значение
Значение по умолчанию: False
--peer-weight

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

Свойство Значение
Группа параметров: BGP Peering Arguments
--remove

Удалите свойство или элемент из списка. Пример: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Свойство Значение
Группа параметров: Generic Update Arguments
Значение по умолчанию: []
--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

Свойство Значение
Группа параметров: Resource Id Arguments
--security-site

Связан ли VPN-сайт с безопасностью.

Свойство Значение
Допустимые значения: false, true
--set

Обновите объект, указав путь к свойству и значение для задания. Пример: --set property1.property2=<value>.

Свойство Значение
Группа параметров: Generic Update Arguments
Значение по умолчанию: []
--site-key

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

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

Свойство Значение
Группа параметров: Resource Id Arguments
--tags

Теги, разделенные пробелами: key[=value] [key[=value] ...]. Используйте "" для очистки существующих тегов.

--virtual-wan

Имя или идентификатор виртуальной глобальной сети.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Значение по умолчанию: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Значение по умолчанию: False
--output -o

Формат вывода.

Свойство Значение
Значение по умолчанию: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Значение по умолчанию: False