Spec-Zone.ru › Ansible 2.10

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

Примечание

Этот плагин входит в коллекцию azure.azcollection (версия 1.3.1).

Для его установки используйте: ansible-galaxy collection install azure.azcollection.

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

Новое в версии 0.1.0: из azure.azcollection

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

Обзор

  • Создание, обновление или удаление подсети в заданной виртуальной сети.
  • Позволяет задавать и обновлять префикс адреса 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
address_prefixes_cidr
список / элементы=строка
добавлен в 1.0.0 azure.azcollection
CIDR, определяющий адресное пространство IPv4 и IPv6 подсети. Должен быть допустимым в контексте виртуальной сети.
Если задан address_prefix, он не будет установлен.

Псевдонимы: address_prefixes
adfs_authority_url
строка
добавлен в 0.0.1 azure.azcollection
URL-адрес полномочий Azure AD. Используйте при аутентификации с именем пользователя/паролем и собственными полномочиями ADFS.
api_profile
строка
добавлен в 0.0.1 azure.azcollection
По умолчанию:
"latest"
Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.
auth_source
строка
добавлен в 0.0.1 azure.azcollection
    Варианты:
  • auto ←
  • cli
  • credential_file
  • env
  • msi
Управляет источником учетных данных для аутентификации.
Также может быть задан через переменную окружения 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.
cert_validation_mode
строка
добавлен в 0.0.1 azure.azcollection
    Варианты:
  • ignore
  • validate
Управляет поведением проверки сертификатов для Azure-точек входа. По умолчанию все модули проверяют сертификат сервера, но при использовании прокси-сервера HTTPS или с Azure Stack может потребоваться отключить это поведение, передав ignore. Также может быть задан в файле профиля учетных данных или переменной среды AZURE_CERT_VALIDATION.
client_id
строка
Идентификатор клиента Azure. Используйте при аутентификации с главным сервисом.
cloud_environment
строка
добавлен в 0.0.1 azure.azcollection
По умолчанию:
"AzureCloud"
Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment) или URL-адрес точки входа для обнаружения метаданных (требуется для Azure Stack). Также может быть задан в файле профиля учетных данных или переменной среды AZURE_CLOUD_ENVIRONMENT.
delegations
список / элементы=строка
Массив делегаций.
actions
список / элементы=строка
Список действий.
name
строка / обязательно
Имя делегации.
serviceName
строка / обязательно
    Варианты:
  • 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
Тип сервиса конечной точки.
name
строка / обязательно
Имя подсети.
password
строка
Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с главным сервисом.
private_endpoint_network_policies
строка
    Варианты:
  • Enabled ←
  • Disabled
Enabled или Disabled применяют сетевые политики к частным конечным точкам в подсети.
private_link_service_network_policies
строка
    Варианты:
  • Enabled ←
  • Disabled
Enabled или Disabled применяют сетевые политики к сервисам частной связи в подсети.
profile
строка
Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group
строка / обязательно
Имя группы ресурсов.
route_table
строка
Ссылка на ресурс RouteTable.
Может быть именем или идентификатором ресурса таблицы маршрутизации.
Может быть словарем, содержащим name и resource_group таблицы маршрутизации.
secret
строка
Секрет клиента Azure. Используйте при аутентификации с главным сервисом.
security_group
строка
Существующая группа безопасности, с которой нужно связать подсеть.
Может быть именем группы безопасности в той же группе ресурсов.
Может быть идентификатором ресурса группы безопасности.
Может быть словарем, содержащим name и resource_group группы безопасности.

Псевдонимы: security_group_name
service_endpoints
список / элементы=строка
Массив конечных точек сервиса.
locations
список / элементы=строка
Список местоположений.
service
строка / обязательно
Тип сервиса конечной точки.
state
строка
    Варианты:
  • absent
  • present ←
Установить состояние подсети. Используйте present для создания или обновления подсети и absent для удаления подсети.
subscription_id
строка
Ваш идентификатор Azure-подписки.
tenant
строка
Идентификатор Azure-аренды. Используйте при аутентификации с главным сервисом.
virtual_network_name
строка / обязательно
Имя существующей виртуальной сети, с которой подсеть связана или будет связана.

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

Примечания

Примечание

  • Для аутентификации в 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: Delete a subnet
  azure_rm_subnet:
    resource_group: myResourceGroup
    virtual_network_name: myVirtualNetwork
    name: mySubnet
    state: absent

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

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

Ключ Возвращаемое значение Описание
state
complex
success
Текущее состояние подсети.
address_prefix
string
всегда
CIDR адрес IP.

Пример:
10.1.0.0/16
address_prefixes
list / elements=string
всегда
Адрес IP для CIDR IPv4 и IPv6.

Пример:
['10.2.0.0/24', 'fdda:e69b:1587:495e::/64']
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 применяют сетевые политики к услугам частной связи в подсети.

Пример:
Disabled
provisioning_state
string
всегда
Результат события подготовки.

Пример:
Succeeded


Авторы

  • 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.10/collections/azure/azcollection/azure_rm_subnet_module.html

Spec-Zone.ru

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