azure.azcollection.azure_rm_keyvaultcertificate_info module – Получение сведений о сертификатах Azure Key Vault

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; в противном случае используется подписка Azure 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"

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

строка

Имя сертификата. Если не задано, будут перечислены все сертификаты в vault_uri.

oidc_token

строка

добавлено в 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

путь

добавлено в azure.azcollection 3.17.0

Путь к файлу, содержащему токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с удостоверением рабочей нагрузки.

Файл должен содержать только необработанный токен.

Этот способ обычно используется на платформах, которые сохраняют токены OIDC в виде файлов.

Также можно задать с помощью переменной среды AZURE_FEDERATED_TOKEN_FILE.

password

строка

Пароль пользователя Active Directory. Используется при аутентификации с учетной записью пользователя Active Directory, а не с субъектом-службой.

profile

строка

Профиль безопасности из файла ~/.azure/credentials.

secret

строка

Секрет клиента Azure. Используется при аутентификации с субъектом-службой.

show_deleted_certificate

логический

Задайте show_delete_certificate=true, чтобы отображать удаленные сертификаты. Задайте show_deleted_certificate=false, чтобы отображать неудаленные сертификаты.

Допустимые значения:

• false ← (по умолчанию)
• true

subscription_id

строка

Идентификатор вашей подписки Azure.

tags

список / элементы=строки

Ограничьте результаты, указав список тегов. Формат тегов: «ключ» или «ключ:значение».

tenant

строка

Идентификатор клиента Azure. Используется при аутентификации с субъектом-службой.

thumbprint

строка

добавлено в azure.azcollection 1.14.0

Отпечаток закрытого ключа, указанного в x509_certificate_path.

Используется при аутентификации с субъектом-службой.

Обязателен, если задан x509_certificate_path.

vault_uri

строка / обязательный

URI хранилища, в котором находится сертификат.

version

строка

Версия сертификата.

x509_certificate_path

путь

добавлено в azure.azcollection 1.14.0

Путь к сертификату X509 в формате PEM, использованному для создания субъекта-службы.

Сертификат должен быть добавлен к закрытому ключу.

Используется при аутентификации с субъектом-службой.

certificates

complex

Сведения о сертификатах в Azure Key Vault.

Возвращается: всегда

cert_data

string

Содержимое CER-сертификата X509.

Возвращается: всегда

Пример: "MIID*****************0pRjXE"

deleted_on

string

Время удаления сертификата в формате UTC.

Возвращается: всегда

Пример: "2025-01-14T09"

name

string

Имя сертификата.

Возвращается: всегда

Пример: "testcert"

policy

complex

Политика управления удалённым сертификатом.

Возвращается: всегда

attributes

complex

Атрибуты сертификата.

Возвращается: всегда

created

string

Дата и время создания.

Возвращается: всегда

Пример: "2025-01-14T09:41:20+00:00"

enabled

string

Указывает, включён ли сертификат.

Возвращается: всегда

Пример: "True"

expires

string

Дата и время истечения срока действия.

Возвращается: успешно

Пример: "None"

not_before

string

Дата и время начала действия.

Возвращается: успешно

Пример: "None"

recoverable_days

integer

Отражает срок восстановления после удаления в днях.

Возвращается: всегда

Пример: "None"

recovery_level

string

Отражает текущий уровень восстановления удалённых сертификатов в хранилище.

Если значение содержит «Purgeable», привилегированный пользователь может удалить сертификат без возможности восстановления.

В противном случае очистить сертификат может только система по окончании периода хранения.

Возвращается: всегда

Пример: "None"

updated

string

Дата и время обновления.

Возвращается: всегда

Пример: "2025-01-15T09:41:20+00:00"

certificate_transparency

boolean

Указывает, следует ли публиковать сертификаты, созданные согласно этой политике, в журналы прозрачности сертификатов.

Возвращается: всегда

Пример: "None"

certificate_type

string

Тип сертификата, запрашиваемого у поставщика издателя.

Возвращается: str

Пример: "None"

content_type

string

Если не указано, тип носителя (тип MIME) секрета, на основе которого создан сертификат.

Возвращается: всегда

Пример: "application/x-pkcs12"

enhanced_key_usage

list / elements=string

Дополнительные способы использования ключа сертификата.

Возвращается: всегда

Пример: ["1.3.6.1.5.5.7.3.1", "1.3.6.1.5.5.7.3.2"]

exportable

boolean

Указывает, можно ли экспортировать закрытый ключ.

Возвращается: всегда

Пример: true

issuer_name

string

Имя указанного объекта издателя или зарезервированное имя.

Возвращается: всегда

Пример: "Self"

key_curve_name

string

Название эллиптической кривой. Допустимые значения см. в разделе KeyCurveName.

Возвращается: всегда

Пример: "None"

key_size

integer

Размер ключа в битах.

Возвращается: всегда

Пример: 2048

key_type

string

Тип пары ключей, используемой для сертификата.

Возвращается: всегда

Пример: "RSA"

key_usage

list / elements=string

Список вариантов использования ключа.

Возвращается: всегда

Пример: ["digitalSignature", "keyEncipherment"]

lifetime_actions

list / elements=string

Действия, выполняемые Key Vault в течение срока действия сертификата.

Возвращается: всегда

Пример: [{"action": "AutoRenew", "days_before_expiry": "None", "lifetime_percentage": 80}]

reuse_key

boolean

Указывает, будет ли при продлении сертификата использоваться та же пара ключей.

Возвращается: всегда

Пример: false

san_dns_names

string

Альтернативные имена DNS субъекта объекта X509.

Для создания сертификата необходимо указать либо субъект, либо один из параметров альтернативного имени субъекта.

Возвращается: всегда

Пример: "None"

san_emails

string

Альтернативные адреса электронной почты субъекта объекта X509.

Для создания сертификата необходимо указать либо субъект, либо один из параметров альтернативного имени субъекта.

Возвращается: всегда

Пример: "None"

san_user_principal_names

string

Альтернативные имена участников-пользователей субъекта объекта X509.

Для создания сертификата необходимо указать либо субъект, либо один из параметров альтернативного имени субъекта.

Возвращается: всегда

Пример: "None"

subject

string

Имя субъекта сертификата.

Должно быть корректным различаемым именем X509.

Для создания сертификата необходимо указать либо субъект, либо один из параметров альтернативного имени субъекта.

При импорте сертификата это значение игнорируется; субъект будет извлечён из импортированного сертификата.

Возвращается: всегда

Пример: "CN=anhui.com"

validity_in_months

integer

Срок действия сертификата в месяцах.

Возвращается: всегда

Пример: 12

properties

complex

Свойства сертификата.

Возвращается: всегда

attributes

complex

Атрибуты сертификата.

Возвращается: всегда

created

string

Дата и время создания.

Возвращается: всегда

Пример: "2025-01-14T09"

enabled

string

Указывает, включён ли сертификат.

Возвращается: всегда

Пример: "True"

expires

string

Дата и время истечения срока действия.

Возвращается: успешно

Пример: "2025-03-14T09"

not_before

string

Дата и время начала действия.

Возвращается: успешно

Пример: "2025-02-14T09"

recovery_level

string

Отражает текущий уровень восстановления удалённых сертификатов в хранилище.

Если значение содержит «Purgeable», привилегированный пользователь может удалить сертификат без возможности восстановления.

В противном случае очистить сертификат может только система по окончании периода хранения.

Возвращается: всегда

Пример: "Recoverable+Purgeable"

updated

string

Дата и время обновления.

Возвращается: всегда

Пример: "2025-01-15T09"

id

string

Идентификатор сертификата. Если он указан, все остальные аргументы «Id» следует опустить.

Возвращается: всегда

Пример: "https://vaultrfred01.vault.azure.net/certificates/cert02/62409e6304c642f193209729b8360d2c"

tags

dictionary

Список тегов сертификата.

Возвращается: всегда

Пример: {"key": "value"}

vault_id

string

Идентификатор Key Vault.

Возвращается: всегда

Пример: "https://vaultrfred01.vault.azure.net"

x509_thumbprint

string

Отпечаток сертификата X509 из Key Vault в виде шестнадцатеричной строки.

Возвращается: всегда

Пример: "1blAnHN9ddng0qh1pYoUDY2lp1E="

recovery_id

string

URL объекта восстановления, используемый для идентификации и восстановления удалённого сертификата.

Возвращается: всегда

Пример: "https://vaultrfred01.vault.azure.net/deletedcertificates/cert02"

scheduled_purge_date

dictionary

Время запланированной окончательной очистки сертификата в формате UTC.

Возвращается: всегда

Пример: "2025-02-14T09"