Spec-Zone.ru › Ansible

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

Примечание

Этот модуль входит в коллекцию azure.azcollection (версия 3.18.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

псевдонимы: address_prefix

string

Диапазон адресов IPv4 подсети в формате CIDR. Должен быть допустимым в контексте виртуальной сети.

address_prefixes_cidr

псевдонимы: address_prefixes

list / элементы=string

добавлено в azure.azcollection 1.0.0

Диапазон адресов IPv4 и IPv6 подсети в формате CIDR. Должен быть допустимым в контексте виртуальной сети.

Если задан address_prefix, этот параметр не будет задан.

adfs_authority_url

string

добавлено в azure.azcollection 0.0.1

URL центра сертификации Azure AD. Используйте при аутентификации по имени пользователя и паролю, если у вас есть собственный центр сертификации ADFS.

api_profile

string

добавлено в azure.azcollection 0.0.1

Выбирает профиль API для обмена данными со службами Azure. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.

По умолчанию: "latest"

auth_source

string

добавлено в 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

добавлено в 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

добавлено в azure.azcollection 0.0.1

Для облачных сред, отличных от общедоступного облака США, укажите имя среды (как определено в Azure Python SDK, например AzureChinaCloud, AzureUSGovernment) или URL конечной точки обнаружения метаданных (обязательно для Azure Stack). Также можно задать в профиле файла учётных данных или с помощью переменной окружения AZURE_CLOUD_ENVIRONMENT.

По умолчанию: "AzureCloud"

default_outbound_access

boolean

Задайте для этого свойства значение false, чтобы отключить исходящее подключение по умолчанию для всех виртуальных машин в подсети.

Варианты:

  • false
  • true

delegations

list / элементы=dictionary

Массив делегирований.

actions

list / элементы=string

Список действий.

По умолчанию: []

name

string / обязательно

Имя делегирования.

serviceName

string / обязательно

Тип службы конечной точки.

Варианты:

  • "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"
  • "Microsoft.App/environments"
  • "Microsoft.Network/applicationGateways"

disable_instance_discovery

boolean

добавлено в 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.

Можно указать словарь, содержащий name и resource_group шлюза NAT.

oidc_token

string

добавлено в azure.azcollection 3.17.0

Токен OpenID Connect (OIDC) (JWT), используемый непосредственно для аутентификации с удостоверением рабочей нагрузки.

Этот токен обменивается с Azure AD с помощью федеративного удостоверения OIDC.

Полезно в системах CI (например, GitHub Actions, Azure DevOps), где платформа напрямую предоставляет токен OIDC.

Также можно задать с помощью переменной окружения AZURE_FEDERATED_TOKEN.

oidc_token_file_path

path

добавлено в azure.azcollection 3.17.0

Путь к файлу, содержащему токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с удостоверением рабочей нагрузки.

Файл должен содержать только необработанный токен.

Этот способ обычно используется на платформах, которые сохраняют токены OIDC в виде файлов.

Также можно задать с помощью переменной окружения AZURE_FEDERATED_TOKEN_FILE.

password

string

Пароль пользователя Active Directory. Используйте при аутентификации от имени пользователя Active Directory, а не субъекта-службы.

private_endpoint_network_policies

string

Enabled или Disabled применяют сетевые политики к частным конечным точкам в подсети.

Варианты:

  • "Enabled" ← (по умолчанию)
  • "Disabled"
  • "NetworkSecurityGroupEnabled"
  • "RouteTableEnabled"

private_link_service_network_policies

string

Enabled или Disabled применяют сетевые политики к службе Private Link в подсети.

Варианты:

  • "Enabled" ← (по умолчанию)
  • "Disabled"

profile

string

Профиль безопасности из файла ~/.azure/credentials.

resource_group

string / обязательно

Имя группы ресурсов.

route_table

any

Ссылка на ресурс RouteTable.

Можно указать имя или идентификатор ресурса таблицы маршрутизации.

Можно указать словарь, содержащий name и resource_group таблицы маршрутизации.

Если этот параметр не задан, связанная таблица маршрутизации будет отсоединена. Если связанной таблицы маршрутизации нет, это не повлияет на работу.

secret

string

Секрет клиента Azure. Используйте при аутентификации с помощью субъекта-службы.

security_group

псевдонимы: security_group_name

any

Существующая группа безопасности, с которой нужно связать подсеть.

Можно указать имя группы безопасности, находящейся в той же группе ресурсов.

Можно указать идентификатор ресурса группы безопасности.

Можно указать словарь, содержащий name и resource_group группы безопасности.

service_endpoint_policies

list / элементы=dictionary

Массив политик конечных точек службы.

id

string

Идентификатор ресурса политики конечной точки службы.

service_endpoints

list / элементы=dictionary

Массив конечных точек службы.

locations

list / элементы=string

Список расположений.

service

string / обязательно

Тип службы конечной точки.

sharing_scope

string

Задайте для этого свойства значение Tenant, чтобы разрешить совместное использование подсети с другими подписками в вашем клиенте AAD.

Варианты:

  • "DelegatedServices"
  • "Tenant"

state

string

Задаёт требуемое состояние подсети. Используйте present для создания или обновления подсети и absent для удаления подсети.

Варианты:

  • "absent"
  • "present" ← (по умолчанию)

subscription_id

string

Идентификатор вашей подписки Azure.

tenant

string

Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта-службы.

thumbprint

string

добавлено в azure.azcollection 1.14.0

Отпечаток закрытого ключа, указанного в x509_certificate_path.

Используйте при аутентификации с помощью субъекта-службы.

Обязателен, если задан x509_certificate_path.

virtual_network_name

псевдонимы: virtual_network

string / обязательно

Имя существующей виртуальной сети, с которой подсеть связана или будет связана.

x509_certificate_path

path

добавлено в azure.azcollection 1.14.0

Путь к сертификату X509 в формате PEM, используемому для создания субъекта-службы.

Сертификат должен быть добавлен в конец файла закрытого ключа.

Используйте при аутентификации с помощью субъекта-службы.

Примечания

Примечание

  • Для аутентификации в Azure можно передать параметры, задать переменные среды, использовать профиль, сохранённый в ~/.azure/credentials, или войти в систему перед запуском задач или плейбука с помощью az login.
  • Аутентификация также возможна с использованием субъекта-службы или пользователя Active Directory.
  • Для аутентификации через OIDC передайте client_id, tenant и oidc_token или oidc_token_file_path либо задайте переменные среды AZURE_CLIENT_ID, AZURE_TENANT и AZURE_FEDERATED_TOKEN или AZURE_FEDERATED_TOKEN_FILE.
  • Для аутентификации через субъект-службу передайте 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

Возвращаемые значения

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

Ключ

Описание

state

complex

Текущее состояние подсети.

Возвращается: при успешном выполнении

address_prefix

string

IP-адрес в формате CIDR.

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

Пример: "10.1.0.0/16"

address_prefixes

list / elements=string

IP-адреса в формате CIDR для IPv4 и IPv6.

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

Пример: ["10.2.0.0/24", "fdda:e69b:1587:495e::/64"]

default_outbound_access

boolean

Установите для этого свойства значение false, чтобы отключить исходящее подключение по умолчанию для всех виртуальных машин в подсети.

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

Пример: false

delegations

list / elements=string

Связанные делегирования подсетей

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

actions

list / elements=string

Список действий, связанных со службой делегирования

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

Пример: ["Microsoft.Network/virtualNetworks/subnets/action"]

name

string

Имя делегирования

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

Пример: "delegationname"

serviceName

string

Служба, связанная с делегированием

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

Пример: "Microsoft.ContainerInstance/containerGroups"

id

string

Путь к ресурсу подсети.

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

Пример: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVirtualNetwork/subnets/mySubnet"

name

string

Имя подсети.

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

Пример: "foobar"

network_security_group

complex

Связанная с подсетью группа безопасности сети.

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

id

string

Идентификатор ресурса группы безопасности.

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

Пример: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/secgroupfoo"

name

string

Имя группы безопасности.

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

Пример: "secgroupfoo"

private_endpoint_network_policies

string

Enabled или Disabled применяют сетевые политики к частным конечным точкам в подсети.

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

Пример: "Enabled"

private_link_service_network_policies

string

Enabled или Disabled применяют сетевые политики к службе Private Link в подсети.

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

Пример: "Disabled"

provisioning_state

string

Результат операции подготовки ресурса: успех или сбой.

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

Пример: "Succeeded"

service_endpoint_policies

list / elements=string

Массив политик конечных точек службы.

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

Пример: ["/subscriptions/xxx-xxx/resourceGroups/TestRG/providers/Microsoft.Network/serviceEndpointPolicies/testpolicy"]

sharing_scope

string

Установите для этого свойства значение Tenant, чтобы разрешить совместное использование подсети с другими подписками в вашем клиенте AAD.

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

Пример: "None"

Авторы

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

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

  • Отслеживание проблем
  • Главная страница
  • Репозиторий (исходный код)

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API