azure_rm_subnet – Управление подсетями Azure
Новое в версии 2.1.
Описание
- Создание, обновление или удаление подсети в заданной виртуальной сети. Позволяет устанавливать и обновлять префикс адреса CIDR, который должен быть валидным в контексте виртуальной сети. Используйте модуль azure_rm_networkinterface для ассоциации интерфейсов с подсетью и назначения конкретных IP-адресов.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| ad_user строка | Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо сервисного принципала. | ||
| address_prefix_cidr - | CIDR, определяющий пространство IPv4 адресов подсети. Должен быть валидным в контексте виртуальной сети. псевдонимы: address_prefix | ||
| adfs_authority_url строка добавлен в 2.6 | URL авторизации Azure AD. Используется при аутентификации с именем пользователя/паролем и собственной авторизацией ADFS. | ||
| api_profile строка добавлен в 2.5 | По умолчанию: "latest" | Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack. | |
| auth_source строка добавлен в 2.5 |
| Управляет источником учетных данных для аутентификации. Если не указано, будет использована переменная среды ANSIBLE_AZURE_AUTH_SOURCE и по умолчанию auto если переменная не определена.auto будет следовать стандартному приоритету параметров модуля -> переменные среды -> профиль по умолчанию в файле учетных данных ~/.azure/credentials.При установке на cli, учетные данные будут взяты из профиля Azure CLI по умолчанию.Также может быть установлено через переменную среды ANSIBLE_AZURE_AUTH_SOURCE.Когда установлено на msi, машина должна быть Azure-ресурсом с включенным расширением MSI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID могут быть использованы для определения идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, иначе выбирается первая подписка.msi был добавлен в Ansible 2.6. | |
| cert_validation_mode строка добавлен в 2.5 |
| Управляет поведением проверки сертификатов для Azure-точек конечных вычислений. По умолчанию все модули будут проверять серверный сертификат, но когда используется прокси HTTPS или Azure Stack, может потребоваться отключить это поведение, передав ignore. Также может быть установлено через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION. | |
| client_id строка | ID клиента Azure. Используется при аутентификации с помощью сервисного принципала. | ||
| cloud_environment строка добавлен в 2.4 | По умолчанию: "AzureCloud" | Для облачных сред, отличных от общедоступного облака США, имя среды (как определено Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment) или URL конечной точки обнаружения метаданных (требуется для Azure Stack). Также может быть установлено через профиль файла учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT. | |
| name - / обязательно | Имя подсети. | ||
| password - | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо сервисного принципала. | ||
| profile строка | Профиль безопасности, найденный в файле ~/.azure/credentials. | ||
| resource_group - / обязательно | Имя группы ресурсов. | ||
| route_table - добавлен в 2.7 | Ссылка на ресурс RouteTable. Может принимать как строку, так и словарь. Строка может быть именем или идентификатором ресурса таблицы маршрутизации. Словарь может содержать name и resource_group таблицы маршрутизации. | ||
| secret строка | Секретный ключ клиента Azure. Используется при аутентификации с помощью сервисного принципала. | ||
| security_group - | Существующая группа безопасности, с которой нужно связать подсеть. Может быть именем группы безопасности в той же группе ресурсов. Может быть идентификатором ресурса. Может быть словарем, содержащим name и resource_group группы безопасности.псевдонимы: security_group_name | ||
| service_endpoints список добавлен в 2.8 | Массив точек конечных вычислений службы. | ||
| locations список | Список местоположений. | ||
| service - / обязательно | Тип службы конечной точки. | ||
| state - |
| Утвердить состояние подсети. Используйте present для создания или обновления подсети и absent для удаления подсети. | |
| subscription_id строка | Ваш идентификатор подписки Azure. | ||
| tenant строка | Идентификатор арендатора Azure. Используется при аутентификации с помощью сервисного принципала. | ||
| virtual_network_name - / обязательно | Имя существующей виртуальной сети, с которой подсеть связана или будет связана. псевдонимы: virtual_network | ||
Примечания
Примечание
- Для аутентификации с 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 a subnet
azure_rm_subnet:
resource_group: myResourceGroup
virtual_network_name: myVirtualNetwork
name: mySubnet
address_prefix_cidr: "10.1.0.0/24"
- name: Create a subnet refer nsg from other resource group
azure_rm_subnet:
resource_group: myResourceGroup
virtual_network_name: myVirtualNetwork
name: mySubnet
address_prefix_cidr: "10.1.0.0/16"
security_group:
name: secgroupfoo
resource_group: mySecondResourceGroup
route_table: route
- name: Delete a subnet
azure_rm_subnet:
resource_group: myResourceGroup
virtual_network_name: myVirtualNetwork
name: mySubnet
state: absent
Значения возврата
Общие значения возврата документированы здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращенное значение | Описание | ||
|---|---|---|---|---|
| state complex | success | Текущее состояние подсети. | ||
| address_prefix string | IP-адрес CIDR. | |||
| id string | Путь к ресурсу подсети. | |||
| name string | Имя подсети. | |||
| network_security_group complex | | |||
| id string | Идентификатор ресурса группы безопасности. | |||
| name string | Имя группы безопасности. | |||
| provisioning_state string | Успех или неудача операции подготовки. | |||
Статус
- Этот модуль не гарантирует обратную совместимость. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Chris Houseknecht (@chouseknecht)
- Matt Davis (@nitzmahone)
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/azure_rm_subnet_module.html