Модуль azure.azcollection.azure_rm_subnet — Управление подсетями Azure

Примечание

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

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

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

Для использования в плейбуке укажите: azure.azcollection.azure_rm_subnet.

Введено в azure.azcollection 0.1.0

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

Описание

Создание, обновление или удаление подсети в заданной виртуальной сети.
Позволяет устанавливать и обновлять префикс адреса CIDR, который должен быть допустимым в контексте виртуальной сети.
Используйте модуль azure.azcollection.azure_rm_networkinterface для ассоциации интерфейсов с подсетью и назначения конкретных IP-адресов.

Требования

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

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

Параметры

Параметр	Комментарии
ad_user string	Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с главным субъектом безопасности.
address_prefix_cidr aliases: address_prefix string	CIDR, определяющий адресное пространство IPv4 подсети. Должен быть допустимым в контексте виртуальной сети.
address_prefixes_cidr aliases: address_prefixes list / elements=string added in azure.azcollection 1.0.0	CIDR, определяющий адресное пространство IPv4 и IPv6 подсети. Должен быть допустимым в контексте виртуальной сети. Если задан address_prefix, он не будет установлен.
adfs_authority_url string added in azure.azcollection 0.0.1	URL-адрес центра проверки подлинности Azure AD. Используйте при аутентификации с помощью имени пользователя/пароля и имеете собственный центр проверки подлинности ADFS.
api_profile string added in azure.azcollection 0.0.1	Выбирает профиль API для использования при взаимодействии с службами Azure. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack. По умолчанию: `"latest"`
auth_source string added in 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"`
cert_validation_mode string added in azure.azcollection 0.0.1	Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси-сервера HTTPS или в Azure Stack может потребоваться отключить это поведение, передав `ignore`. Может быть также установлен с помощью профиля файла учетных данных или переменной среды `AZURE_CERT_VALIDATION`. Варианты: `"ignore"` `"validate"`
client_id string	Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта безопасности или управляемой идентичности (msi). Может быть также установлен с помощью переменной среды `AZURE_CLIENT_ID`.
cloud_environment string added in azure.azcollection 0.0.1	Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`), или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Может быть также установлен с помощью профиля файла учетных данных или переменной среды `AZURE_CLOUD_ENVIRONMENT`. По умолчанию: `"AzureCloud"`
delegations list / elements=dictionary	Массив делегаций.
actions list / elements=string	Список действий. По умолчанию: `[]`
name string / required	Имя делегации.
serviceName string / required	Тип службы конечной точки. Варианты: `"Microsoft.ContainerService/managedClusters"` `"Microsoft.Web/serverFarms"` `"Microsoft.ContainerInstance/containerGroups"` `"Microsoft.Netapp/volumes"` `"Microsoft.HardwareSecurityModules/dedicatedHSMs"` `"Microsoft.ServiceFabricMesh/networks"` `"Microsoft.Logic/integrationServiceEnvironments"` `"Microsoft.Batch/batchAccounts"` `"Microsoft.Sql/managedInstances"` `"Microsoft.Web/hostingEnvironments"` `"Microsoft.BareMetal/CrayServers"` `"Microsoft.BareMetal/MonitoringServers"` `"Microsoft.Databricks/workspaces"` `"Microsoft.BareMetal/AzureHostedService"` `"Microsoft.BareMetal/AzureVMware"` `"Microsoft.BareMetal/AzureHPC"` `"Microsoft.BareMetal/AzurePaymentHSM"` `"Microsoft.StreamAnalytics/streamingJobs"` `"Microsoft.DBforPostgreSQL/serversv2"` `"Microsoft.AzureCosmosDB/clusters"` `"Microsoft.MachineLearningServices/workspaces"` `"Microsoft.DBforPostgreSQL/singleServers"` `"Microsoft.DBforPostgreSQL/flexibleServers"` `"Microsoft.DBforMySQL/serversv2"` `"Microsoft.DBforMySQL/flexibleServers"` `"Microsoft.ApiManagement/service"` `"Microsoft.Synapse/workspaces"` `"Microsoft.PowerPlatform/vnetaccesslinks"` `"Microsoft.Network/managedResolvers"` `"Microsoft.Kusto/clusters"`

disable_instance_discovery boolean added in azure.azcollection 2.3.0	Определяет, будет ли выполняться обнаружение экземпляра при попытке аутентификации. Установка в значение true полностью отключит как обнаружение экземпляра, так и проверку подлинности полномочий. Эта функциональность предназначена для использования в сценариях, где метаданные конечная точка недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляра включает извлечение метаданных полномочий из https://login.microsoft.com/ для проверки полномочий. Установив это значение в True, отключается проверка подлинности полномочий. В результате крайне важно убедиться, что настроенный хост полномочий действителен и заслуживает доверия. Устанавливается через профиль файла учетных данных или переменную среды `AZURE_DISABLE_INSTANCE_DISCOVERY`. Варианты: `false` ← (по умолчанию) `true`
log_mode string	Аргумент родительского элемента.
log_path string	Аргумент родительского элемента.
name string / обязательно	Имя подсети.
nat_gateway string	Существующий шлюз NAT для ассоциации с подсетью. Может быть именем шлюза NAT в той же группе ресурсов. Может быть идентификатором ресурса шлюза NAT. Может быть словарем, содержащим имя и группу_ресурсов шлюза NAT.
password string	Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы.
private_endpoint_network_policies string	`Enabled` или `Disabled` применяют сетевые политики к частным конечным точкам в подсети. Варианты: `"Enabled"` ← (по умолчанию) `"Disabled"`
private_link_service_network_policies string	`Enabled` или `Disabled` применяют сетевые политики к службам частных подключений в подсети. Варианты: `"Enabled"` ← (по умолчанию) `"Disabled"`
profile string	Профиль безопасности в файле ~/.azure/credentials.
resource_group string / обязательно	Имя группы ресурсов.
route_table any	Ссылка на ресурс RouteTable. Может быть именем или идентификатором ресурса таблицы маршрутизации. Может быть словарем, содержащим имя и группу_ресурсов таблицы маршрутизации. Без этой конфигурации связанная таблица маршрутизации будет диссоциирована. Если нет связанной таблицы маршрутизации, это не повлияет.
secret string	Секрет клиента Azure. Используется при аутентификации с принципалом службы.
security_group псевдонимы: security_group_name any	Существующая группа безопасности для ассоциации с подсетью. Может быть именем группы безопасности в той же группе ресурсов. Может быть идентификатором ресурса группы безопасности. Может быть словарем, содержащим имя и группу_ресурсов группы безопасности.
service_endpoints list / элементы=словарь	Массив служб конечных точек.
locations list / элементы=строка	Список местоположений.
service string / обязательно	Тип службы конечной точки.
state string	Утверждение состояния подсети. Используйте `present` для создания или обновления подсети и `absent` для удаления подсети. Варианты: `"absent"` `"present"` ← (по умолчанию)
subscription_id string	Ваш идентификатор подписки Azure.
tenant string	Идентификатор клиента Azure. Используется при аутентификации с принципалом службы.

thumbprint строка добавлен в azure.azcollection 1.14.0	Отпечаток цифрового сертификата для закрытого ключа, указанного в x509_certificate_path. Используется при аутентификации с помощью сервисного принципала. Обязательно, если задан параметр x509_certificate_path.
virtual_network_name псевдонимы: virtual_network строка / обязательно	Имя существующей виртуальной сети, к которой подключена или будет подключена подсеть.
x509_certificate_path путь добавлен в azure.azcollection 1.14.0	Путь к X509 сертификату, используемому для создания сервисного принципала в формате PEM. Сертификат должен быть присоединён к закрытому ключу. Используется при аутентификации с помощью сервисного принципала.

Примечания

Примечание

Для аутентификации с Azure можно передавать параметры, устанавливать переменные окружения, использовать профиль, сохранённый в ~/.azure/credentials, или войти в систему перед запуском задач или playbook с помощью 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: Create a subnet with service endpoint
  azure_rm_subnet:
    resource_group: myResourceGroup
    virtual_network_name: myVirtualNetwork
    name: mySubnet
    address_prefix_cidr: "10.1.0.0/16"
    service_endpoints:
      - service: "Microsoft.Sql"
        locations:
          - "eastus"

- name: Create a subnet with delegations
  azure_rm_subnet:
    resource_group: myResourceGroup
    virtual_network_name: myVirtualNetwork
    name: mySubnet
    address_prefix_cidr: "10.1.0.0/16"
    delegations:
      - name: 'mydeleg'
        serviceName: 'Microsoft.ContainerInstance/containerGroups'

- name: Create a subnet with an associated NAT Gateway
  azure_rm_subnet:
    resource_group: myResourceGroup
    virtual_network_name: myVirtualNetwork
    name: mySubnet
    address_prefix_cidr: "10.1.0.0/16"
    nat_gateway: myNatGateway

- name: Delete a subnet
  azure_rm_subnet:
    resource_group: myResourceGroup
    virtual_network_name: myVirtualNetwork
    name: mySubnet
    state: absent

END_OF_DOCUMENT_MARKER

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

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

Ключ	Описание
state сложный	Текущее состояние подсети. Возвращается: успешно
address_prefix строка	CIDR адреса IP. Возвращается: всегда Пример: `"10.1.0.0/16"`
address_prefixes список / элементы=строка	Адрес IP для IPv4 и IPv6 CIDR. Возвращается: всегда Пример: `["10.2.0.0/24", "fdda:e69b:1587:495e::/64"]`
delegations список / элементы=строка	Ассоциированная делегация подсетей Возвращается: всегда
actions список / элементы=строка	список действий, связанных с сервисом делегирования Возвращается: при наличии делегирования Пример: `["Microsoft.Network/virtualNetworks/subnets/action"]`
name строка	имя делегирования Возвращается: при наличии делегирования Пример: `"delegationname"`
serviceName строка	сервис, связанный с делегированием Возвращается: при наличии делегирования Пример: `"Microsoft.ContainerInstance/containerGroups"`
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"`
private_endpoint_network_policies строка	`Enabled` или `Disabled` применяют сетевые политики к частным конечным точкам в подсети. Возвращается: всегда Пример: `"Enabled"`
private_link_service_network_policies строка	`Enabled` или `Disabled` применяют сетевые политики к сервисам частных подключений в подсети. Возвращается: всегда Пример: `"Disabled"`
provisioning_state строка	Успешное или неудачное завершение события подготовки. Возвращается: всегда Пример: `"Succeeded"`

Авторы

Chris Houseknecht (@chouseknecht)
Matt Davis (@nitzmahone)

Ссылки на сборку

© 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_subnet_module.html