azure_rm_subnet – Управление подсетями Azure
Описание
- Создание, обновление или удаление подсети в заданной виртуальной сети.
- Позволяет устанавливать и обновлять префикс адреса 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 строка | Идентификатор клиента 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. Может быть именем или идентификатором ресурса таблицы маршрутизации. Может быть словарем, содержащим имя и группу_ресурсов таблицы маршрутизации. | ||
| secret строка | Секрет клиента Azure. Используется при аутентификации с принципалом службы. | ||
| security_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 сложный | успех | Текущее состояние подсети. | ||
| address_prefix строка | всегда | IP-адрес CIDR. Пример: 10.1.0.0/16 | ||
| id строка | всегда | Путь к ресурсу подсети. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVirtualNetwork/subnets/mySubnet | ||
| name строка | всегда | Имя подсети. Пример: foobar | ||
| network_security_group сложный | всегда | Связанная группа безопасности сети подсетей. | ||
| id строка | всегда | Идентификатор ресурса группы безопасности. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/secgroupfoo | ||
| name строка | всегда | Имя группы безопасности. Пример: secgroupfoo | ||
| provisioning_state строка | всегда | Результат выполнения операции настройки. Пример: Успешно завершено | ||
Статус
- Данный модуль не гарантирует обратную совместимость. [предварительная версия]
- Этот модуль поддерживается сообществом 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.9/modules/azure_rm_subnet_module.html
