Модуль azure.azcollection.azure_rm_expressroute — Управление цепями ExpressRoute

Примечание

Этот модуль входит в коллекцию azure.azcollection (версия 2.7.0).

Возможна предварительная установка этой коллекции, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля требуются дополнительные условия, см. Требования для получения подробностей.

Для использования в книге задач укажите: azure.azcollection.azure_rm_expressroute.

Новая в azure.azcollection 1.7.0

Описание
Требования
Параметры
Примечания
См. также
Примеры
Возвращаемые значения

Описание

Создание, обновление и удаление экземпляров ExpressRoute.

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

python >= 2.7
На хосте, где выполняется этот модуль, должна быть установлена коллекция azure.azcollection через galaxy
Все пакеты python, указанные в requirements.txt коллекции, должны быть установлены через pip на хосте, на котором выполняются модули из azure.azcollection
Полные инструкции по установке можно найти по адресу https://galaxy.ansible.com/azure/azcollection

Параметры

Параметр	Комментарии
ad_user строка	Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо служебного принципала.
adfs_authority_url строка добавлен в azure.azcollection 0.0.1	URL-адрес авторизации Azure AD. Используется при аутентификации с именем пользователя/паролем и собственной авторизацией ADFS.
allow_classic_operations булево	Поддержка классических операций. Варианты: `false` `true`
api_profile строка добавлен в azure.azcollection 0.0.1	Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack. По умолчанию: `"latest"`
append_tags булево	Управляет тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. В случае каноничности, любые теги, отсутствующие в параметре tags, будут удалены из метаданных объекта. Варианты: `false` `true` ← (по умолчанию)
auth_source строка добавлен в azure.azcollection 0.0.1	Управляет источником учетных данных для аутентификации. Также может быть установлен через переменную среды `ANSIBLE_AZURE_AUTH_SOURCE`. При значении `auto` (по умолчанию) приоритет модульные параметры -> `env` -> `credential_file` -> `cli`. При значении `env`, учетные данные будут считываться из переменных окружения. При значении `credential_file`, профиль будет считан из `~/.azure/credentials`. При значении `cli`, учетные данные будут получены из профиля Azure CLI. `subscription_id` или переменная окружения `AZURE_SUBSCRIPTION_ID` могут использоваться для идентификации идентификатора подписки, если их несколько, иначе используется стандартная подписка az cli. При значении `msi`, хост-машина должна быть Azure-ресурсом с включенным расширением MSI. `subscription_id` или переменная окружения `AZURE_SUBSCRIPTION_ID` могут быть использованы для определения идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, в противном случае выбирается первая подписка. `msi` был добавлен в Ansible 2.6. Варианты: `"auto"` ← (по умолчанию) `"cli"` `"credential_file"` `"env"` `"msi"`
authorizations список / элементы=словарь	Список разрешений.
name строка / обязательный	Имя разрешения.
cert_validation_mode строка добавлен в azure.azcollection 0.0.1	Управляет поведением проверки сертификатов для Azure-точек конечного доступа. По умолчанию все модули проверяют серверный сертификат, но при использовании HTTPS-прокси или подключении к Azure Stack может потребоваться отключить это поведение, передав `ignore`. Также может быть установлен через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`. Варианты: `"ignore"` `"validate"`
client_id строка	Идентификатор клиента Azure. Используется при аутентификации с помощью служебного принципала или управляемой идентичности (msi). Также может быть установлен через переменную среды `AZURE_CLIENT_ID`.
cloud_environment строка добавлен в azure.azcollection 0.0.1	Для облачных сред, отличных от общедоступного облака США, имя среды (как определено Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`), или URL-адрес точки конечного доступа для обнаружения метаданных (требуется для Azure Stack). Также может быть установлен через профиль файла учетных данных или переменную среды `AZURE_CLOUD_ENVIRONMENT`. По умолчанию: `"AzureCloud"`
disable_instance_discovery булево добавлен в azure.azcollection 2.3.0	Определяет, будет ли выполняться обнаружение экземпляра при попытке аутентификации. Установка в значение true полностью отключит как обнаружение экземпляра, так и проверку авторизации. Эта функция предназначена для использования в сценариях, где точка конечного доступа к метаданным недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляра включает получение метаданных авторизации с https://login.microsoft.com/ для проверки авторизации. Установив это значение в True, отключается проверка авторизации. Поэтому крайне важно убедиться, что указанный хост авторизации действителен и надежен. Устанавливается через профиль файла учетных данных или переменную среды `AZURE_DISABLE_INSTANCE_DISCOVERY`. Варианты: `false` ← (по умолчанию) `true`
global_reach_enabled булево	Флаг, обозначающий статус глобального охвата. Варианты: `false` `true`
location строка	Расположение ресурса. Если не задано, используется расположение из группы ресурсов по умолчанию.

log_mode строка	Аргумент родительского элемента.
log_path строка	Аргумент родительского элемента.
name строка / обязательно	Уникальное имя плана службы приложений для создания или обновления.
password строка	Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory вместо службы-принципала.
profile строка	Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group строка / обязательно	Имя группы ресурсов, к которой относится ресурс.
secret строка	Секрет Azure клиента. Используйте при аутентификации с помощью службы-принципала.
service_provider_properties словарь	Свойства поставщика услуг.
bandwidth_in_mbps строка	Пропускная способность канала при его развертывании на ресурсе ExpressRoutePort.
peering_location строка	Расположение подключения.
service_provider_name строка	Название поставщика услуг.
sku словарь	Название SKU. https://azure.microsoft.com/en-in/pricing/details/expressroute/ Требуется sku, когда state=present.
family строка / обязательно	Семейство SKU. Варианты: `"metereddata"` `"unlimiteddata"`
tier строка / обязательно	Уровень SKU. Варианты: `"standard"` `"premium"`
state строка	Установить состояние маршрута ExpressRoute. Используйте `present` для создания или обновления маршрута ExpressRoute и `absent` для его удаления. Варианты: `"absent"` `"present"` ← (по умолчанию)
subscription_id строка	Ваш идентификатор подписки Azure.
tags словарь	Словарь пар «строка:строка» для назначения метаданных объекту. Метаданные теги объекта будут обновлены с предоставленными значениями. Для удаления тегов установите параметр append_tags в значение false. В настоящее время зоны Azure DNS и службы Traffic Manager также не позволяют использовать пробелы в тегах. Azure Front Door не поддерживает использование Azure Automation и Azure CDN поддерживают только 15 тегов для ресурсов.
tenant строка	Идентификатор Azure-аренды. Используйте при аутентификации с помощью службы-принципала.
thumbprint строка добавлено в azure.azcollection 1.14.0	Отпечаток цифровой подписи закрытого ключа, указанного в x509_certificate_path. Используйте при аутентификации с помощью службы-принципала. Требуется, если определен x509_certificate_path.
x509_certificate_path путь добавлено в azure.azcollection 1.14.0	Путь к X509-сертификату, используемому для создания службы-принципала в формате PEM. Сертификат должен быть присоединен к закрытому ключу. Используйте при аутентификации с помощью службы-принципала.

Примечания

Примечание

Для аутентификации с Azure вы можете передать параметры, установить переменные среды, использовать профиль, сохраненный в файле ~/.azure/credentials, или выполнить вход перед запуском задач или плана с помощью az login.
Аутентификация также возможна с использованием службы-принципала или пользователя Active Directory.
Для аутентификации через службу-принципал передайте subscription_id, client_id, secret и tenant или установите переменные среды AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET и AZURE_TENANT.
Для аутентификации через пользователя Active Directory передайте ad_user и password или установите AZURE_AD_USER и AZURE_PASSWORD в среде.
В качестве альтернативы данные учетных данных могут быть сохранены в ~/.azure/credentials. Это ini-файл, содержащий раздел [default] и следующие ключи: subscription_id, client_id, secret и tenant или subscription_id, ad_user и password. Также можно добавить дополнительные профили. Укажите профиль, передав profile или установив AZURE_PROFILE в среде.

См. также

Вход с помощью Azure CLI: Как войти в систему с помощью команды az login.

Примеры

- name: "Create Express route"
  azure_rm_expressroute:
    resource_group: rg
    location: eastus
    name: exp
    allow_classic_operations: true
    global_reach_enabled: false
    tags:
      - a: b
    authorizations:
      - name: authorization_test
    service_provider_properties:
      service_provider_name: Aryaka Networks
      peering_location: Seattle
      bandwidth_in_mbps: '200'
    sku:
      tier: premium
      family: metereddata

- name: Delete Express route
  azure_rm_expressroute:
    resource_group: rg
    name: exp
    state: absent

Значения возврата

Общие значения возврата описаны здесь, ниже приведены поля, уникальные для этого модуля:

Ключ	Описание
state словарь	Текущее состояние маршрута Express. Возвращается: всегда Пример: {"additional_properties": {}, "allow_classic_operations": true, "authorizations": [{"authorization_key": "d83e18b5-0200-4e0b-9cdb-6fdf95b00267", "authorization_use_status": "Available", "etag": "W/'09572845-c667-410c-b664-ed8e39242c13'", "id": "/subscriptions/subs_id/resourceGroups/rg/providers/Microsoft.Network/expressRouteCircuits/exp/authorizations/az", "name": "authorization_test", "provisioning_state": "Succeeded", "type": "Microsoft.Network/expressRouteCircuits/authorizations"}], "bandwidth_in_gbps": null, "circuit_provisioning_state": "Enabled", "express_route_port": null, "gateway_manager_etag": "", "global_reach_enabled": false, "id": "/subscriptions/subs_id/resourceGroups/rg/providers/Microsoft.Network/expressRouteCircuits/exp", "location": "eastus", "name": "exp", "peerings": [], "provisioning_state": "Succeeded", "service_key": "e1956383-63b6-4709-8baa-3615bbf5d22b", "service_provider_notes": null, "service_provider_provisioning_state": "NotProvisioned", "stag": 27, "status": "Deleted", "tags": {"a": "b"}, "type": "Microsoft.Network/expressRouteCircuits"}

Ключ

Описание

state

словарь

Текущее состояние маршрута Express.

Возвращается: всегда

Пример: {"additional_properties": {}, "allow_classic_operations": true, "authorizations": [{"authorization_key": "d83e18b5-0200-4e0b-9cdb-6fdf95b00267", "authorization_use_status": "Available", "etag": "W/'09572845-c667-410c-b664-ed8e39242c13'", "id": "/subscriptions/subs_id/resourceGroups/rg/providers/Microsoft.Network/expressRouteCircuits/exp/authorizations/az", "name": "authorization_test", "provisioning_state": "Succeeded", "type": "Microsoft.Network/expressRouteCircuits/authorizations"}], "bandwidth_in_gbps": null, "circuit_provisioning_state": "Enabled", "express_route_port": null, "gateway_manager_etag": "", "global_reach_enabled": false, "id": "/subscriptions/subs_id/resourceGroups/rg/providers/Microsoft.Network/expressRouteCircuits/exp", "location": "eastus", "name": "exp", "peerings": [], "provisioning_state": "Succeeded", "service_key": "e1956383-63b6-4709-8baa-3615bbf5d22b", "service_provider_notes": null, "service_provider_provisioning_state": "NotProvisioned", "stag": 27, "status": "Deleted", "tags": {"a": "b"}, "type": "Microsoft.Network/expressRouteCircuits"}

Авторы

Praveen Ghuge (@praveenghuge)
Karl Dasan (@ikarldasan)
Sakar Mehra (@sakar97)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/azure/azcollection/azure_rm_expressroute_module.html