Модуль azure.azcollection.azure_rm_privatednszonelink — создание, удаление и обновление ссылки на виртуальную сеть для частной зоны DNS
Примечание
Этот модуль входит в коллекцию azure.azcollection (версия 3.18.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: azure.azcollection.azure_rm_privatednszonelink.
Добавлено в azure.azcollection 1.6.0
Краткое описание
- Создаёт, удаляет и обновляет ссылки на виртуальные сети для существующей частной зоны DNS Azure.
Требования
На узле, выполняющем этот модуль, должны быть соблюдены следующие требования.
- 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, а не субъекта-службы. |
adfs_authority_url string добавлено в azure.azcollection 0.0.1 | URL центра Azure AD. Используйте при аутентификации с помощью имени пользователя и пароля, если у вас есть собственный центр ADFS. |
api_profile string добавлено в azure.azcollection 0.0.1 | Выбирает профиль API для взаимодействия со службами Azure. Значение по умолчанию По умолчанию: |
append_tags boolean | Определяет, является ли поле тегов каноническим или теги только добавляются к существующим. При каноническом режиме все теги, отсутствующие в параметре tags, удаляются из метаданных объекта. Варианты:
|
auth_source string добавлено в azure.azcollection 0.0.1 | Определяет источник учётных данных для аутентификации. Также можно задать с помощью переменной среды Если задано значение Если задано значение Если задано значение Если задано значение Если задано значение Параметр Варианты:
|
cert_validation_mode string добавлено в azure.azcollection 0.0.1 | Определяет поведение проверки сертификата для конечных точек Azure. По умолчанию все модули проверяют сертификат сервера, но при использовании HTTPS-прокси или Azure Stack может потребоваться отключить эту проверку, передав Варианты:
|
client_id string | Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта-службы или управляемого удостоверения (msi). Также можно задать с помощью переменной среды |
cloud_environment string добавлено в azure.azcollection 0.0.1 | Для облачных сред, отличных от общедоступного облака США: имя среды (согласно определению в Azure Python SDK, например По умолчанию: |
disable_instance_discovery boolean добавлено в azure.azcollection 2.3.0 | Определяет, выполняется ли обнаружение экземпляра при попытке аутентификации. Если задать значение true, обнаружение экземпляра и проверка центра будут полностью отключены. Эта возможность предназначена для сценариев, в которых недоступна конечная точка метаданных, например в частных облаках или Azure Stack. Обнаружение экземпляра подразумевает получение метаданных центра с https://login.microsoft.com/ для проверки центра. Если задать значение **True**, проверка центра будет отключена. Поэтому крайне важно убедиться в корректности и надёжности настроенного узла центра. Задаётся в профиле файла учётных данных или с помощью переменной среды Варианты:
|
log_mode string | Родительский аргумент. |
log_path string | Родительский аргумент. |
name string / обязательный | Имя ссылки на виртуальную сеть. |
oidc_token string добавлено в azure.azcollection 3.17.0 | Токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с помощью удостоверения рабочей нагрузки. Этот токен обменивается с Azure AD посредством федеративного удостоверения OIDC. Полезен в системах CI (например, GitHub Actions, Azure DevOps), где платформа предоставляет токен OIDC напрямую. Также можно задать с помощью переменной среды |
oidc_token_file_path path добавлено в azure.azcollection 3.17.0 | Путь к файлу с токеном OpenID Connect (OIDC) (JWT), используемым для аутентификации с помощью удостоверения рабочей нагрузки. Файл должен содержать только необработанный токен. Этот способ обычно используется на платформах, которые сохраняют токены OIDC в виде файлов. Также можно задать с помощью переменной среды |
password string | Пароль пользователя Active Directory. Используйте при аутентификации от имени пользователя Active Directory, а не субъекта-службы. |
profile string | Профиль безопасности из файла ~/.azure/credentials. |
registration_enabled boolean | Включена ли в частной зоне DNS автоматическая регистрация записей виртуальных машин в виртуальной сети Варианты:
|
resolution_policy string добавлено в azure.azcollection 3.7.0 | Политика разрешения имён для ссылки на виртуальную сеть. Применяется только к ссылкам на виртуальные сети для зон privatelink и запросам A, AAAA и CNAME. Если задано значение Варианты:
|
resource_group string / обязательный | Имя группы ресурсов. |
secret string | Секрет клиента Azure. Используйте при аутентификации с помощью субъекта-службы. |
state string | Задаёт требуемое состояние ссылки на виртуальную сеть. Используйте Варианты:
|
subscription_id string | Идентификатор вашей подписки Azure. |
tags dictionary | Словарь пар «строка:строка», назначаемых объекту в качестве метаданных. Теги метаданных объекта будут обновлены с использованием всех указанных значений. Чтобы удалить теги, установите для параметра append_tags значение false. В настоящее время в тегах зон Azure DNS и служб Traffic Manager также запрещено использовать пробелы. Azure Front Door не поддерживает использование Azure Automation и Azure CDN поддерживают не более 15 тегов для ресурса. |
tenant string | Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта-службы. |
thumbprint string добавлено в azure.azcollection 1.14.0 | Отпечаток закрытого ключа, указанного в x509_certificate_path. Используйте при аутентификации с помощью субъекта-службы. Обязателен, если задан x509_certificate_path. |
virtual_network string | Ссылка на виртуальную сеть. |
x509_certificate_path path добавлено в azure.azcollection 1.14.0 | Путь к сертификату X509 в формате PEM, используемому для создания субъекта-службы. Сертификат должен быть добавлен к закрытому ключу. Используйте при аутентификации с помощью субъекта-службы. |
zone_name string / обязательный | Имя частной зоны DNS. |
Примечания
Примечание
- Для аутентификации в 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 virtual network link
azure_rm_privatednszonelink:
resource_group: myResourceGroup
name: vnetlink1
zone_name: privatezone.com
virtual_network: MyAzureVNet
state: present
- name: Update virtual network link
azure_rm_privatednszonelink:
resource_group: myResourceGroup
name: vnetlink1
zone_name: privatezone.com
virtual_network: MyAzureVNet
registration_enabled: true
state: present
tags:
key1: "value1"
- name: Delete a virtual network link
azure_rm_privatednszonelink:
resource_group: myResourceGroup
name: vnetlink1
zone_name: privatezone.com
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
state complex | Текущее состояние связи виртуальной сети. Возвращается: всегда |
|
etag string |
ETag связи виртуальной сети. Возвращается: всегда Пример: |
|
id string |
Идентификатор связи виртуальной сети. Возвращается: всегда Пример: |
|
location string |
Регион Azure, в котором находится ресурс. Возвращается: всегда Пример: |
|
name string |
Имя связи виртуальной сети. Возвращается: всегда Пример: |
|
provisioning_state string |
Состояние подготовки ресурса. Возвращается: всегда Пример: |
|
registration_enabled boolean |
Состояние автоматической регистрации записей виртуальных машин в виртуальной сети в частной DNS-зоне. Возвращается: всегда Пример: |
|
resolution_policy string |
Политика разрешения имен для связи виртуальной сети. Возвращается: всегда Пример: |
|
tags list / elements=string |
Теги ресурса. Возвращается: всегда Пример: |
|
virtual_network dictionary |
Ссылка на виртуальную сеть. Возвращается: всегда Пример: |
|
virtual_network_link_state string |
Состояние связи виртуальной сети. Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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_privatednszonelink_module.html