модуль azure.azcollection.azure_rm_keyvault_info — получение сведений об Azure Key Vault

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.

log_mode

string

Родительский аргумент.

log_path

string

Родительский аргумент.

name

string

Имя хранилища ключей.

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.

resource_group

string

Имя группы ресурсов, к которой относится хранилище ключей.

secret

string

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

subscription_id

string

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

tags

list / элементы=string

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

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, используемому для создания субъекта-службы.

Закрытый ключ должен быть добавлен в конец сертификата.

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

keyvaults

list / elements=string

Список хранилищ ключей Azure.

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

access_policies

complex

Список политик.

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

object_id

string

Идентификатор объекта пользователя, субъекта-службы или группы безопасности в AAD для хранилища.

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

Пример: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

permissions

complex

Разрешения субъекта для ключей, секретов и сертификатов.

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

certificates

list / elements=string

Разрешения для секретов.

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

Пример: ["get", "import"]

key_permissions

list / elements=string

Разрешения для ключей.

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

Пример: ["get", "create"]

keys

list / elements=string

Разрешения для ключей.

Это возвращаемое значение устарело и будет удалено в одном из выпусков после 2027-05-01. Вместо него используйте key_permissions.

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

Пример: ["get", "create"]

secrets

list / elements=string

Разрешения для секретов.

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

Пример: ["list", "set"]

tenant_id

string

Идентификатор клиента AAD, который следует использовать для аутентификации запросов к хранилищу ключей.

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

Пример: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

enable_purge_protection

boolean

Свойство, указывающее, включена ли для этого хранилища защита от окончательного удаления.

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

Пример: false

enable_rbac_authorization

boolean

Свойство, определяющее порядок авторизации действий с данными.

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

Пример: false

enable_soft_delete

boolean

Свойство, указывающее, разрешено ли Azure Resource Manager извлекать секреты из хранилища ключей.

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

Пример: true

enabled_for_deployments

boolean

Разрешено ли виртуальным машинам Azure извлекать из хранилища ключей сертификаты, сохранённые в виде секретов.

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

Пример: false

enabled_for_disk_encryption

boolean

Разрешено ли Azure Disk Encryption извлекать секреты из хранилища и расшифровывать ключи.

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

Пример: false

enabled_for_template_deployment

boolean

Разрешено ли Azure Resource Manager извлекать секреты из хранилища ключей.

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

Пример: false

id

string

Идентификатор ресурса хранилища.

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

Пример: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVault"

location

string

Расположение хранилища.

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

Пример: "eastus"

name

string

Имя хранилища.

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

Пример: "myVault"

network_acls

complex

Набор правил, определяющих доступность хранилища из определённых сетевых расположений.

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

bypass

string

Указывает, какой трафик может обходить сетевые правила.

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

Пример: "AzureServices"

default_action

string

Действие по умолчанию, если ни одно правило из ipRules и virtualNetworkRules не совпадает.

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

Пример: "Allow"

ip_rules

list / elements=string

Список правил для IP-адресов.

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

Пример: [{"value": "124.56.78.91/32"}]

virtual_network_rules

list / elements=string

Список правил для виртуальных сетей.

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

Пример: [{"id": "/subscriptions/**/resourcegroups/**/providers/microsoft.network/virtualnetworks/**/subnets/subnet01", "ignore_missing_vnet_service_endpoint": true}]

public_network_access

string

Свойство, указывающее, будет ли хранилище принимать трафик из общедоступного Интернета.

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

Пример: "Disabled"

sku

dictionary

Артикул хранилища.

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

family

string

Название семейства SKU.

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

Пример: "A"

name

string

Название SKU.

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

Пример: "standard"

soft_delete_retention_in_days

integer

Свойство, задающее количество дней хранения удалённых хранилищ.

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

Пример: 90

tags

list / elements=string

Список тегов.

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

Пример: ["foo"]

vault_uri

string

URI хранилища.

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

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