Модуль azure.azcollection.azure_rm_privatelinkservice — Ресурс управляемой службы частной связи
Примечание
Этот модуль входит в коллекцию azure.azcollection (версия 2.7.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.
Для использования в playbook укажите: azure.azcollection.azure_rm_privatelinkservice.
Добавлена в azure.azcollection 1.12.0
Обзор
- Создание, обновление или удаление ресурса службы частной связи.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.7
- На хосте, выполняющем этот модуль, должна быть установлена коллекция azure.azcollection через galaxy
- Все пакеты python, перечисленные в файле requirements.txt коллекции, должны быть установлены через pip на хосте, на котором выполняются модули из azure.azcollection
- Полные инструкции по установке можно найти по адресу https://galaxy.ansible.com/azure/azcollection
Параметры
Параметр | Комментарии |
|---|---|
ad_user строка | Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с сервисным принципалом. |
adfs_authority_url строка добавлен в azure.azcollection 0.0.1 | URL-адрес авторизации Azure AD. Используется при аутентификации с именем пользователя/паролем и собственной авторизацией ADFS. |
api_profile строка добавлен в azure.azcollection 0.0.1 | Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию По умолчанию: |
append_tags логическое | Управляет тем, является ли поле тегов каноническим или добавляет теги к существующим. При каноническом режиме все теги, отсутствующие в параметре tags, будут удалены из метаданных объекта. Варианты:
|
auth_source строка добавлен в azure.azcollection 0.0.1 | Управляет источником учетных данных для аутентификации. Также может быть задан через переменную окружения При значении При значении При значении При значении При значении
Варианты:
|
auto_approval словарь | Список автоматического одобрения для службы частного подключения. |
|
subscriptions список / элементы=строка |
Список подписок. |
cert_validation_mode строка добавлен в azure.azcollection 0.0.1 | Управляет поведением проверки сертификатов для Azure-точек конечных пунктов. По умолчанию все модули проверяют серверный сертификат, но при использовании HTTPS-прокси или при работе с Azure Stack, может потребоваться отключить это поведение, передав Варианты:
|
client_id строка | Идентификатор клиента Azure. Используется при аутентификации с помощью сервисного принципала или управляемой учетной записи (msi). Также может быть задан через переменную окружения |
cloud_environment строка добавлен в azure.azcollection 0.0.1 | Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, По умолчанию: |
disable_instance_discovery логическое добавлен в azure.azcollection 2.3.0 | Определяет, выполняется ли обнаружение экземпляра при попытке аутентификации. Установка в значение true полностью отключит как обнаружение экземпляра, так и проверку авторизации. Эта функция предназначена для сценариев, где конечная точка метаданных недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляра подразумевает получение метаданных авторизации с https://login.microsoft.com/ для проверки авторизации. Установив это значение в **True**, проверка авторизации отключается. Поэтому крайне важно убедиться, что указанный хост авторизации действителен и надёжен. Настраивается через профиль файла учетных данных или переменную среды Варианты:
|
enable_proxy_protocol логическое | Включена ли поддержка протокола прокси для службы частного подключения. Варианты:
|
fqdns список / элементы=строка | Список Fqdn. |
ip_configurations список / элементы=словарь | Массив конфигураций IP службы частного подключения. |
|
name string |
Имя конфигурации IP-адреса частного подключения. |
|
properties dictionary |
Свойства конфигураций IP-адресов частного подключения. |
|
primary boolean |
Является ли конфигурация IP-адреса основной. Варианты:
|
|
private_ip_address_version string |
Используется ли IPv4 или IPv6 для конкретной конфигурации IP-адреса. Варианты:
|
|
private_ip_allocation_method string |
Метод распределения частных IP-адресов. Варианты:
|
|
subnet dictionary |
Ссылка на ресурс подсети. |
|
id string |
Идентификатор подсети. |
load_balancer_frontend_ip_configurations list / elements=dictionary | Массив ссылок на конфигурации IP-адресов балансировщика нагрузки. Не может быть более одной конфигурации IP-адреса балансировщика нагрузки для частного сервиса подключения. |
|
id string |
Идентификатор IP-адреса балансировщика нагрузки. |
location string | Расположение ресурса. |
log_mode string | Родительский аргумент. |
log_path string | Родительский аргумент. |
name string / обязательно | Имя частного сервиса подключения. |
password string | Пароль пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не с помощью принципала службы. |
profile string | Профиль безопасности, найденный в файле ~/.azure/credentials. |
resource_group string / обязательно | Имя группы ресурсов. |
secret string | Секретный ключ клиента Azure. Используется при аутентификации с помощью принципала службы. |
state string | Утвердить состояние частного сервиса подключения. Используйте state=present для создания или обновления сервиса подключения, а state=absent — для его удаления. Варианты:
|
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. |
visibility dictionary | Список видимости частного сервиса подключения. |
|
subscriptions список / элементы=строка |
Список подписок. |
x509_certificate_path путь добавлено в azure.azcollection 1.14.0 | Путь к X509 сертификату, используемому для создания служебного принципала в формате PEM. Сертификат должен быть присоединён к закрытому ключу. Используется при аутентификации с помощью Служебного принципала. |
Примечания
Примечание
- Для аутентификации с 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 the private link service
azure_rm_privatelinkservice:
name: linkservice-name
resource_group: myResourceGroup
enable_proxy_protocol: true
fqdns:
- 'dns01.com'
- 'dns02.com'
visibility:
subscriptions:
- xxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
- yyyyyy-yyyyy-yyyy-yyyy-yyyyyyyyyyy
auto_approval:
subscriptions:
- xxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
- yyyyyy-yyyyy-yyyy-yyyy-yyyyyyyyyyy
load_balancer_frontend_ip_configurations:
- id: load_balancer_frontend_ip_configurations_id
ip_configurations:
- name: testSubnet
properties:
primary: false
private_ip_allocation_method: 'Dynamic'
private_ip_address_version: 'IPv4'
subnet:
id: subnet_id
- name: subnetfredprivate-1
properties:
primary: true
private_ip_allocation_method: 'Static'
private_ip_address_version: 'IPv4'
subnet:
id: subnet_id
tags:
key1: value1
key2: value2
- name: delete the private link service
azure_rm_privatelinkservice:
name: linkservice-name
resource_group: myResourceGroup
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие являются полями, уникальными для данного модуля:
Ключ | Описание |
|---|---|
link_service complex | Список информации о частной службе подключения. Возвращается: всегда |
|
alias string |
Псевдоним частной службы подключения. Возвращается: всегда Пример: |
|
auto_approval dictionary |
Список автоматического утверждения частной службы подключения. Возвращается: всегда Пример: |
|
enable_proxy_protocol boolean |
Включена ли для частной службы подключения поддержка протокола прокси. Возвращается: всегда Пример: |
|
etag string |
Уникальная строка только для чтения, которая изменяется при каждом обновлении ресурса. Возвращается: всегда Пример: |
|
fqdns list / elements=string |
Список Fqdn. Возвращается: всегда Пример: |
|
id string |
Идентификатор ресурса частной службы подключения. Возвращается: всегда Пример: |
|
ip_configurations complex |
Массив IP-конфигураций частной службы подключения. Возвращается: всегда |
|
name string |
Имя IP-конфигураций Возвращается: всегда Пример: |
|
properties complex |
Свойства IP-конфигурации. Возвращается: всегда |
|
primary boolean |
Является ли IP-конфигурация основной. Возвращается: всегда Пример: |
|
private_ip_address_version string |
Является ли конкретная IP-конфигурация IPv4 или IPv6. Возвращается: всегда Пример: |
|
private_ip_allocation_method string |
Метод выделения частного IP-адреса. Возвращается: всегда Пример: |
|
subnet dictionary |
Ссылка на ресурс подсети. Возвращается: всегда Пример: |
|
load_balancer_frontend_ip_configurations list / elements=string |
Массив ссылок на IP-конфигурации балансировщика нагрузки. Возвращается: всегда Пример: |
|
location string |
Расположение ресурса. Возвращается: всегда Пример: |
|
name string |
Имя частной службы подключения. Возвращается: всегда Пример: |
|
network_interfaces список / элементы=строка |
Массив ссылок на сетевые интерфейсы, созданные для этой службы частной связи. Возвращается: всегда Пример: |
|
private_endpoint_connections сложный тип |
Массив списков подключений к частному конечному пункту. Возвращается: всегда |
|
id строка |
Идентификатор подключения к частному конечному пункту. Возвращается: всегда Пример: |
|
private_endpoint строка |
Идентификатор частного конечного пункта. Возвращается: всегда Пример: |
|
provisioning_state строка |
Состояние подготовки ресурса службы частной связи. Возвращается: всегда Пример: |
|
tags словарь |
Теги ресурса. Возвращается: всегда Пример: |
|
type строка |
Тип ресурса. Возвращается: всегда Пример: |
|
visibility словарь |
Список видимости службы частной связи. Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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_privatelinkservice_module.html