Модуль azure.azcollection.azure_rm_privateendpointconnection – Управление подключением к частному конечному пункту

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: azure.azcollection.azure_rm_privateendpointconnection.

Новая версия в 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-сервисами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack. По умолчанию: `"latest"`
auth_source строка добавлен в 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 строка добавлен в azure.azcollection 0.0.1	Управляет поведением проверки сертификатов для Azure-точек конечного доступа. По умолчанию все модули проверяют серверный сертификат, но при использовании прокси HTTPS или подключении к Azure Stack может потребоваться отключить это поведение, передав `ignore`. Также может быть задан через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`. Варианты: `"ignore"` `"validate"`
client_id строка	Идентификатор Azure клиента. Используйте при аутентификации с служебным принципалом или управляемой учетной записью (msi). Также может быть задан через переменную среды `AZURE_CLIENT_ID`.
cloud_environment строка добавлен в azure.azcollection 0.0.1	Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`) или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Также может быть задан через профиль файла учетных данных или переменную среды `AZURE_CLOUD_ENVIRONMENT`. По умолчанию: `"AzureCloud"`
connection_state словарь	Сбор информации о состоянии подключения между потребителем и поставщиком услуг.
actions_required строка	Сообщение, указывающее, требуют ли изменения со стороны поставщика услуг каких-либо обновлений со стороны потребителя.
description строка	Причина утверждения/отклонения подключения.
status строка	Указывает, было ли подключение утверждено/отклонено/удалено владельцем услуги. Варианты: `"Approved"` `"Rejected"` `"Removed"`
disable_instance_discovery логический добавлен в azure.azcollection 2.3.0	Определяет, выполняется ли обнаружение экземпляра при попытке аутентификации. Установка в значение true полностью отключает обнаружение экземпляра и проверку авторизации. Эта функция предназначена для использования в сценариях, где конечная точка метаданных недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляра включает получение метаданных авторизации с https://login.microsoft.com/ для проверки авторизации. Установив это значение в True, проверка авторизации отключается. Поэтому крайне важно убедиться, что настроенный хост авторизации действителен и заслуживает доверия. Настраивается через профиль файла учетных данных или переменную среды `AZURE_DISABLE_INSTANCE_DISCOVERY`. Варианты: `false` ← (по умолчанию) `true`
log_mode строка	Родительский аргумент.
log_path строка	Родительский аргумент.
name строка / обязательно	Имя подключения к частной точке конечного доступа.

пароль строка	Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory вместо служебного принципала.
профиль строка	Профиль безопасности, найденный в файле ~/.azure/credentials.
группа_ресурсов строка / обязательно	Имя группы ресурсов.
секрет строка	Служебный секрет Azure. Используйте при аутентификации со служебным принципалом.
имя_службы строка / обязательно	Имя службы частной связи.
состояние строка	Утвердить состояние подключения. Используйте `present` для обновления подключения и `absent` для его удаления. Варианты: `"absent"` `"present"` ← (по умолчанию)
идентификатор_подписки строка	Ваш идентификатор подписки Azure.
арендатор строка	Идентификатор арендатора Azure. Используйте при аутентификации со служебным принципалом.
отпечаток_пальца строка добавлено в azure.azcollection 1.14.0	Отпечаток цифрового сертификата, указанного в x509_certificate_path. Используйте при аутентификации со служебным принципалом. Требуется, если определен x509_certificate_path.
путь_к_сертификату_x509 путь добавлено в azure.azcollection 1.14.0	Путь к сертификату X509, используемому для создания служебного принципала в формате PEM. Сертификат должен быть присоединен к закрытому ключу. Используйте при аутентификации со служебным принципалом.

Примечания

Примечание

Для аутентификации с Azure вы можете передавать параметры, устанавливать переменные среды, использовать профиль, сохраненный в файле ~/.azure/credentials, или войти в систему перед выполнением задач или книги задач с помощью az login.
Аутентификация также возможна с помощью служебного принципала или пользователя Active Directory.
Для аутентификации через служебный принципал передайте идентификатор подписки, идентификатор клиента, секрет и арендатора или установите переменные среды AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET и AZURE_TENANT.
Для аутентификации через пользователя Active Directory передайте ad_user и пароль или установите AZURE_AD_USER и AZURE_PASSWORD в среде.
В качестве альтернативы учетные данные могут храниться в ~/.azure/credentials. Это файл ini, содержащий раздел [default] и следующие ключи: идентификатор подписки, идентификатор клиента, секрет и арендатор или идентификатор подписки, имя_пользователя и пароль. Также можно добавить дополнительные профили. Укажите профиль, передав профиль или установив AZURE_PROFILE в среде.

См. также

Вход в Azure CLI: Как войти в систему с помощью команды az login.

Примеры

- name: Update private endpoint connection
  azure_rm_privateendpointconnection_info:
    name: pe-connection-name
    service_name: testserviceName
    resource_group: myRG
    connection_state:
      description: "new_description string"
      actions_required: "Message string"
      status: "Rejected"

- name: Delee private endpoint connection
  azure_rm_privateendpointconnection_info:
    name: pe-connection-name
    service_name: testserviceName
    resource_group: myRG
    state: absent

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

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

Ключ	Описание
state сложный	Список информации о подключении частного конечного пункта. Возвращается: всегда
etag строка	Уникальная неизменяемая строка, которая изменяется всякий раз, когда ресурс обновляется. Возвращается: всегда Пример: `"f7d60f37-ea2b-4091-8546-1327f35468c4"`
id строка	Идентификатор ресурса подключения частного конечного пункта. Возвращается: всегда Пример: `"/subscriptions/xxx/resourceGroups/myRG/providers/Microsoft.Network/privateLinkServices/linkservice/privateEndpointConnections/link.09"`
link_identifier строка	Идентификатор ссылки потребителя. Возвращается: всегда Пример: `"536890208"`
name строка	Имя подключения частного конечного пункта. Возвращается: всегда Пример: `"testlink.09"`
private_link_service_connection_state сложный	Коллекция информации о состоянии подключения между потребителем службы и провайдером. Возвращается: всегда
actions_required строка	Сообщение, указывающее, требуются ли обновления на стороне потребителя в связи с изменениями на стороне провайдера службы. Возвращается: всегда Пример: `"This is action_required string"`
description строка	Причина одобрения/отклонения подключения. Возвращается: всегда Пример: `"Auto Approved"`
status строка	Указывает, было ли подключение одобрено/отклонено/удалено владельцем службы. Возвращается: всегда Пример: `"Approved"`
PrivateEndpoint сложный	Ресурс частного конечного пункта. Возвращается: всегда
id строка	Идентификатор ресурса частного конечного пункта. Возвращается: всегда Пример: `"/subscriptions/xxx-xxx/resourceGroups/myRG/providers/Microsoft.Network/privateEndpoints/testlink02"`
provisioning_state строка	Состояние подготовки ресурса. Возвращается: всегда Пример: `"Succeeded"`
type строка	Тип ресурса. Возвращается: всегда Пример: `"Microsoft.Network/privateLinkServices/privateEndpointConnections"`

Авторы

xuzhang3 (@xuzhang3)
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_privateendpointconnection_module.html