azure_rm_keyvault – Управление экземпляром хранилища ключей

Новая версия с 2.5.

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

Обзор

Создание, обновление и удаление экземпляра хранилища ключей.

Требования

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

python >= 2.7
azure >= 2.0.0

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
access_policies -			Массив от 0 до 16 идентификаторов, имеющих доступ к хранилищу ключей. Все идентификаторы в массиве должны использовать тот же идентификатор клиента, что и хранилище ключей.
	application_id -		Идентификатор приложения клиента, выполняющего запрос от имени принципала.
	certificates -	Варианты: get list delete create import update managecontacts getissuers listissuers setissuers deleteissuers manageissuers recover purge	Список разрешений для сертификатов.
	keys -	Варианты: encrypt decrypt wrapkey unwrapkey sign verify get list create update import delete backup restore recover purge	Список разрешений для ключей.
	object_id - / обязательно		Идентификатор объекта пользователя, службы-принципала или группы безопасности в клиенте Azure Active Directory для хранилища. Идентификатор объекта должен быть уникальным для списка политик доступа. Обратите внимание, что это не идентификатор приложения. Идентификатор объекта можно получить, выполнив команду «az ad sp show --id <идентификатор приложения>».
	secrets -	Варианты: get list set delete backup restore recover purge	Список разрешений для секретов.
	storage -		Список разрешений для учетных записей хранилища.
	tenant_id -		Идентификатор клиента Azure Active Directory, который следует использовать для аутентификации запросов к хранилищу ключей. Текущее значение `tenant_id` хранилища ключей будет использовано, если не указано другое.
ad_user строка			Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory вместо службы-принципала.
adfs_authority_url строка добавлен в 2.6			URL-адрес полномочий Azure AD. Используйте при аутентификации с именем пользователя/паролем и собственным авторитетом ADFS.
api_profile строка добавлен в 2.5		Значение по умолчанию: "latest"	Выбирает профиль API для использования при взаимодействии с Azure-службами. Значение по умолчанию `latest` подходит для общедоступных облачных платформ; будущие значения позволят использовать с Azure Stack.
append_tags логическое		Варианты: нет да ←	Управляет тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам. В каноническом режиме любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта.
auth_source строка добавлен в 2.5		Варианты: auto cli credential_file env msi	Управляет источником учетных данных для аутентификации. Если не указано, будет использована переменная среды ANSIBLE_AZURE_AUTH_SOURCE, по умолчанию `auto` если переменная не определена. `auto` будет следовать умолчанию приоритетов параметров модуля -> переменных окружения -> профиля по умолчанию в файле учетных данных `~/.azure/credentials`. При установке значения `cli`, учетные данные будут взяты из профиля Azure CLI по умолчанию. Также может быть установлен через переменную среды `ANSIBLE_AZURE_AUTH_SOURCE`. При установке значения `msi`, хост-машина должна быть Azure-ресурсом с включенным расширением MSI. `subscription_id` или переменная окружения `AZURE_SUBSCRIPTION_ID` могут использоваться для определения идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, в противном случае выбирается первая подписка. `msi` был добавлен в Ansible 2.6.
cert_validation_mode строка добавлен в 2.5		Варианты: ignore validate	Управляет поведением проверки сертификатов для Azure-сервисов. По умолчанию все модули проверяют серверный сертификат, но при использовании HTTPS-прокси или работе с Azure Stack может потребоваться отключить это поведение, передав `ignore`. Также может быть установлен в профиле файла учетных данных или переменной среды `AZURE_CERT_VALIDATION`.
client_id строка			Идентификатор клиента Azure. Используйте при аутентификации с помощью службы-принципала.
cloud_environment строка добавлен в 2.4		Значение по умолчанию: "AzureCloud"	Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`) или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Также может быть установлен в профиле файла учетных данных или переменной среды `AZURE_CLOUD_ENVIRONMENT`.
enable_soft_delete логическое		Варианты: нет да	Свойство, определяющее, включена ли функция мягкого удаления для данного хранилища ключей.
enabled_for_deployment логическое		Варианты: нет да	Свойство, определяющее, разрешено ли виртуальным машинам Azure извлекать сертификаты, хранящиеся в виде секретов в хранилище ключей.
enabled_for_disk_encryption логическое		Варианты: нет да	Свойство, определяющее, разрешено ли Azure Disk Encryption извлекать секреты из хранилища и расшифровывать ключи.
enabled_for_template_deployment логическое		Варианты: нет да	Свойство, определяющее, разрешено ли Azure Resource Manager извлекать секреты из хранилища ключей.
location -			Расположение ресурса. Если не задано, используется расположение из группы ресурсов по умолчанию.
password строка			Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory вместо службы-принципала.
profile строка			Профиль безопасности в файле ~/.azure/credentials.
recover_mode логическое		Варианты: нет да	Создать хранилище в режиме восстановления.
resource_group - / обязательно			Имя группы ресурсов, к которой принадлежит сервер.
secret строка			Секрет клиента Azure. Используйте при аутентификации с помощью службы-принципала.
sku -			Детали SKU.
	family -		Имя семейства SKU.
	name - / обязательно	Варианты: standard premium	Имя SKU для указания, является ли хранилище ключей стандартным или премиальным.

Состояние -	Варианты: отсутствует наличие ←	Утвердите состояние хранилища ключей. Используйте `present` для создания или обновления хранилища ключей и `absent` для его удаления.
subscription_id строка		Ваш идентификатор подписки Azure.
метки словарь		Словарь пар строка:строка для назначения метаданных объекту. Метаданные метки объекта будут обновлены любыми предоставленными значениями. Чтобы удалить метки, установите параметр append_tags в false.
арендатор строка		Идентификатор арендатора Azure. Используйте при аутентификации с помощью Служебного принципа.
vault_name - / требуется		Имя хранилища.
vault_tenant -		Идентификатор арендатора Azure Active Directory, который должен использоваться для аутентификации запросов к хранилищу ключей.

Примечания

Примечание

Для аутентификации с 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 instance of Key Vault
  azure_rm_keyvault:
    resource_group: myResourceGroup
    vault_name: samplekeyvault
    enabled_for_deployment: yes
    vault_tenant: 72f98888-8666-4144-9199-2d7cd0111111
    sku:
      name: standard
    access_policies:
      - tenant_id: 72f98888-8666-4144-9199-2d7cd0111111
        object_id: 99998888-8666-4144-9199-2d7cd0111111
        keys:
          - get
          - list

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

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

Ключ	Возвращено	Описание
id строка	всегда	Идентификатор ресурса Azure Resource Manager для хранилища ключей. Пример: id

Статус

Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

Zim Kalinowski (@zikalino)

Подсказка

Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/azure_rm_keyvault_module.html