Модуль azure.azcollection.azure_rm_privateendpoint — Управление частным конечным пунктом Azure

Примечание

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

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

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

Для использования в книге задач укажите: azure.azcollection.azure_rm_privateendpoint.

Новое в azure.azcollection 1.8.0

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

Обзор

Создание, обновление или удаление частного конечного пункта.

Требования

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

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 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. Default: `"latest"`
append_tags boolean	Используется для управления тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. В каноническом режиме любые теги, не найденные в параметре тегов, будут удалены из метаданных объекта. Choices: `false` `true` ← (default)
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. Choices: `"auto"` ← (default) `"cli"` `"credential_file"` `"env"` `"msi"`
cert_validation_mode string added in azure.azcollection 0.0.1	Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси-сервера HTTPS или в Azure Stack может потребоваться отключить это поведение, передав `ignore`. Также может быть установлено через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`. Choices: `"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`. Default: `"AzureCloud"`
disable_instance_discovery boolean added in azure.azcollection 2.3.0	Определяет, выполняется ли обнаружение экземпляров при попытке аутентификации. Установка этого параметра в true полностью отключит как обнаружение экземпляров, так и проверку подлинности. Эта функция предназначена для использования в сценариях, когда конечная точка метаданных недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляров включает в себя извлечение метаданных центра проверки подлинности из https://login.microsoft.com/ для проверки центра проверки подлинности. Установив это значение в True, проверка центра проверки подлинности отключается. В результате важно убедиться, что настроенный хост центра проверки подлинности является действительным и заслуживающим доверия. Устанавливается через профиль файла учетных данных или переменную среды `AZURE_DISABLE_INSTANCE_DISCOVERY`. Choices: `false` ← (default) `true`
location string	Допустимое расположение Azure. По умолчанию используется расположение группы ресурсов.
log_mode string	Родительский аргумент.
log_path string	Родительский аргумент.
name string / required	Имя частной конечной точки.
password string	Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с главным субъектом безопасности.
private_link_service_connections list / elements=dictionary	Группировка информации о соединении с удаленным ресурсом. Этот параметр обязателен для создания или обновления.

group_ids список / элементы=строка	Идентификатор(ы) группы(группы) полученный(ые) из удаленного ресурса, к которому должен подключиться этот частный конечный пункт.
name строка	Имя ресурса, уникального в рамках группы ресурсов.
private_link_service_id строка	Идентификатор ресурса частного конечного пункта для подключения.
profile строка	Профиль безопасности, находящийся в файле ~/.azure/credentials.
resource_group строка / обязательно	Имя группы ресурсов.
secret строка	Секрет Azure клиента. Используется при аутентификации с помощью Служебного принципала.
state строка	Состояние виртуальной сети. Используйте `present` для создания или обновления и `absent` для удаления. Варианты: `"absent"` `"present"` ← (по умолчанию)
subnet словарь	Идентификатор подсети, из которой будет выделен частный IP-адрес. Этот параметр необходим для создания или обновления.
id строка	Идентификатор подсети, из которой будет выделен частный IP-адрес.
subscription_id строка	Ваш идентификатор подписки Azure.
tags словарь	Словарь пар строка:строка, назначаемых в качестве метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Чтобы удалить теги, установите параметр append_tags в false. В настоящее время зоны Azure DNS и службы Traffic Manager также не допускают использования пробелов в теге. Azure Front Door не поддерживает использование Azure Automation и Azure CDN поддерживают только 15 тегов на ресурсах.
tenant строка	Идентификатор Azure-аренды. Используется при аутентификации с помощью Служебного принципала.
thumbprint строка добавлено в azure.azcollection 1.14.0	Отпечаток пальца закрытого ключа, указанного в x509_certificate_path. Используется при аутентификации с помощью Служебного принципала. Обязательно, если определен x509_certificate_path.
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 private endpoint
  azure_rm_privateendpoint:
    name: testprivateendpoint
    resource_group: v-xisuRG
    private_link_service_connections:
      - name: Test_private_link_service
        private_link_service_id: /subscriptions/xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateLinkServices/testervice
    subnet:
      id: /subscriptions/xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/fredvnet/subnets/default
    tags:
      key1: value1
      key2: value2

- name: Delete private endpoint
  azure_rm_privateendpoint:
    name: testprivateendpoint
    resource_group: myResourceGroup
    state: absent

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

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

Ключ	Описание
state сложный	Список словарей частных конечных точек с тем же форматом, что и параметр модуля azure.azcollection.azure_rm_privateendpoint. Возвращается: всегда
etag строка	Уникальная неизменяемая строка, которая изменяется всякий раз, когда ресурс обновляется. Возвращается: всегда Пример: `"W/\"20803842-7d51-46b2-a790-ded8971b4d8a"`
id строка	Идентификатор ресурса частной конечной точки. Возвращается: всегда Пример: `"/subscriptions/xxx-xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/testprivateendpoint"`
location строка	Действительное расположение Azure. Возвращается: всегда Пример: `"eastus"`
name строка	Имя частной конечной точки. Возвращается: всегда Пример: `"estprivateendpoint"`
network_interfaces список / элементы=строка	Список идентификаторов сетевых интерфейсов. Возвращается: всегда Пример: `["/subscriptions/xxx-xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/fredprivateendpoint002.nic"]`
private_link_service_connections список / элементы=строка	Идентификатор ресурса частной конечной точки для подключения. Возвращается: всегда Пример: `["/subscriptions/xxx/resourceGroups/myRG/providers/Microsoft.Network/privateEndpoints/point/privateLinkServiceConnections/point"]`
provisioning_state строка	Состояние подготовки ресурса. Возвращается: всегда Пример: `"Succeeded"`
subnets_id строка	Подсети, связанные с виртуальной сетью. Возвращается: всегда Пример: `"/subscriptions/xxx-xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/fredtestRG-vnet/subnets/default"`
tags словарь	Теги, назначенные ресурсу. Словарь пар «строка:строка». Возвращается: всегда Пример: `{"tag1": "abc"}`
type строка	Тип ресурса. Возвращается: всегда Пример: `"Microsoft.Network/privateEndpoints"`

Авторы

Fred-sun (@Fred-sun)

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

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