модуль azure.azcollection.azure_rm_keyvaultsecuritydomain – Управление доменом безопасности Key Vault для HSM

Примечание

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

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

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

Чтобы использовать модуль в сценарии, укажите: azure.azcollection.azure_rm_keyvaultsecuritydomain.

Добавлено в azure.azcollection 3.0.0

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

Краткое описание

Создание и удаление экземпляра домена безопасности Key Vault.

Требования

На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.

python >= 2.7
На узле, выполняющем этот модуль, должна быть установлена коллекция azure.azcollection из Galaxy
Все пакеты Python, перечисленные в файле requirements.txt коллекции, должны быть установлены с помощью pip на узле, выполняющем модули из azure.azcollection
Полные инструкции по установке см. на странице https://galaxy.ansible.com/azure/azcollection

Параметры

Параметр	Комментарии
action string	Действие, выполняемое с доменом безопасности. Используйте `download` для скачивания файла домена безопасности и `upload` для восстановления HSM. Варианты: `"download"` ← (по умолчанию) `"upload"`
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. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack. По умолчанию: `"latest"`
auth_source string добавлено в 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 string добавлено в azure.azcollection 0.0.1	Управляет проверкой сертификатов конечных точек Azure. По умолчанию все модули проверяют сертификат сервера, однако при использовании HTTPS-прокси или Azure Stack может потребоваться отключить эту проверку, передав `ignore`. Значение также можно задать в профиле файла учётных данных или с помощью переменной среды `AZURE_CERT_VALIDATION`. Варианты: `"ignore"` `"validate"`
client_id string	Идентификатор клиента Azure. Используйте при аутентификации с субъектом-службой или управляемым удостоверением (msi). Также можно задать с помощью переменной среды `AZURE_CLIENT_ID`.
cloud_environment string добавлено в azure.azcollection 0.0.1	Для облачных сред, отличных от общедоступного облака США, укажите имя среды (согласно определению в Azure Python SDK, например `AzureChinaCloud`, `AzureUSGovernment`) или URL-адрес конечной точки обнаружения метаданных (обязательно для Azure Stack). Значение также можно задать в профиле файла учётных данных или с помощью переменной среды `AZURE_CLOUD_ENVIRONMENT`. По умолчанию: `"AzureCloud"`
disable_instance_discovery boolean добавлено в azure.azcollection 2.3.0	Определяет, выполняется ли обнаружение экземпляров при попытке аутентификации. Если задать значение true, обнаружение экземпляров и проверка центра сертификации будут полностью отключены. Эта возможность предназначена для сценариев, в которых невозможно обратиться к конечной точке метаданных, например в частных облаках или Azure Stack. Процесс обнаружения экземпляров включает получение метаданных центра сертификации с адреса https://login.microsoft.com/ для проверки центра сертификации. При установке значения True проверка центра сертификации отключается. Поэтому крайне важно убедиться, что настроенный хост центра сертификации является действительным и заслуживающим доверия. Задаётся в профиле файла учётных данных или с помощью переменной среды `AZURE_DISABLE_INSTANCE_DISCOVERY`. Варианты: `false` ← (по умолчанию) `true`
hsm_name string	Имя HSM.
keyvault_uri string	URI конечной точки Key Vault.
log_mode string	Аргумент родительского объекта.
log_path string	Аргумент родительского объекта.
no_wait boolean	Не ожидать завершения операции Варианты: `false` ← (по умолчанию) `true`
oidc_token string добавлено в azure.azcollection 3.17.0	Токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с удостоверением рабочей нагрузки. Этот токен обменивается с Azure AD с использованием федеративного удостоверения OIDC. Полезно в системах CI (например, GitHub Actions, Azure DevOps), где платформа напрямую предоставляет токен OIDC. Также можно задать с помощью переменной среды `AZURE_FEDERATED_TOKEN`.
oidc_token_file_path path добавлено в azure.azcollection 3.17.0	Путь к файлу, содержащему токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с удостоверением рабочей нагрузки. Файл должен содержать только исходный токен. Этот способ обычно используется на платформах, которые сохраняют токены OIDC в виде файлов. Также можно задать с помощью переменной среды `AZURE_FEDERATED_TOKEN_FILE`.
password string	Пароль пользователя Active Directory. Используйте при аутентификации с учётной записью пользователя Active Directory, а не с субъектом-службой.
profile string	Профиль безопасности, указанный в файле ~/.azure/credentials.
sd_quorum integer / обязательный	Минимальное количество долей, необходимое для расшифровки домена безопасности при восстановлении. Кворум домена безопасности должен находиться в диапазоне [2, 10].
sd_wrapping_keys list / элементы=string / обязательный	Список ключей-обёрток, содержащих открытые ключи. Количество ключей-обёрток должно находиться в диапазоне [3, 10].
secret string	Секрет клиента Azure. Используйте при аутентификации с субъектом-службой.
subscription_id string	Идентификатор вашей подписки Azure.
tenant string	Идентификатор клиента Azure. Используйте при аутентификации с субъектом-службой.
thumbprint string добавлено в azure.azcollection 1.14.0	Отпечаток закрытого ключа, указанного в x509_certificate_path. Используйте при аутентификации с субъектом-службой. Обязателен, если задан x509_certificate_path.
x509_certificate_path path добавлено в azure.azcollection 1.14.0	Путь к сертификату X509 в формате PEM, используемому для создания субъекта-службы. Сертификат должен быть добавлен к закрытому ключу. Используйте при аутентификации с субъектом-службой.

Примечания

Примечание

Для аутентификации в 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: Download Security domain file
  azure_rm_keyvaultsecuritydomain:
    keyvault_uri: https://samplehsmvault.managedhsm.azure.net
    sd_quorum: 2
    sd_wrapping_keys:
      - "{{ lookup('file', 'certfile1') }}"
      - "{{ lookup('file', 'certfile2') }}"
      - "{{ lookup('file', 'certfile3') }}"
    action: download

- name: Upload Security domain
  azure_rm_keyvaultsecuritydomain:
    keyvault_uri: https://samplehsmvault.managedhsm.azure.net
    action: upload

Возвращаемые значения

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

Ключ	Описание
security_domain string	Объект JSON Возвращается: всегда

Авторы

Bill Peck (@p3ck)

Ссылки на коллекцию

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