azure.azcollection.azure_rm_galleryimage – Управление экземпляром изображения Azure SIG
Примечание
Этот плагин входит в коллекцию azure.azcollection (версия 1.4.0).
Для его установки используйте: ansible-galaxy collection install azure.azcollection.
Для использования в книге задач укажите: azure.azcollection.azure_rm_galleryimage.
Новое в версии 0.1.2: of azure.azcollection
Обзор
- Создание, обновление и удаление экземпляра изображения Azure SIG.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | ||
|---|---|---|---|---|
| ad_user строка | Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с сервисным принципалом. | |||
| adfs_authority_url строка добавлено в 0.0.1 azure.azcollection | URL авторизации Azure AD. Используйте при аутентификации с именем пользователя/паролем и собственной авторизацией ADFS. | |||
| api_profile строка добавлено в 0.0.1 azure.azcollection | Значение по умолчанию: "latest" | Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию latest подходит для публичных облаков; будущие значения позволят использовать с Azure Stack. | ||
| append_tags булево |
| Используйте для управления тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам. При каноническом значении любые теги, не найденные в параметре тегов, будут удалены из метаданных объекта. | ||
| auth_source строка добавлено в 0.0.1 azure.azcollection |
| Определяет источник учетных данных для аутентификации. Также может быть задан через переменную среды 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. | ||
| cert_validation_mode строка добавлено в 0.0.1 azure.azcollection |
| Управляет поведением проверки сертификатов для Azure-точек конечного доступа. По умолчанию все модули проверяют серверный сертификат, но при использовании прокси HTTPS или работе с Azure Stack может потребоваться отключить это поведение, передав ignore. Также может быть задано через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION. | ||
| client_id строка | Идентификатор клиента Azure. Используйте при аутентификации с сервисным принципалом. | |||
| cloud_environment строка добавлено в 0.0.1 azure.azcollection | Значение по умолчанию: "AzureCloud" | Для облачных сред, отличных от публичного облака США, имя среды (как определено Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment ), или URL конечной точки обнаружения метаданных (необходим для Azure Stack). Также может быть задан через профиль файла учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT. | ||
| description строка | Описание ресурса определения изображения галереи. Это свойство обновляется. | |||
| disallowed словарь | Недопустимые значения параметров. | |||
| disk_types список / элементы=строка | Список недопустимых типов дисков. | |||
| end_of_life_date строка | Дата окончания срока действия определения изображения галереи. Это свойство может быть использовано для целей вывода из эксплуатации. Это свойство обновляется. Формат должен соответствовать ISO-8601, например "2019-06-26". | |||
| eula строка | Соглашение EULA для определения изображения галереи. | |||
| gallery_name строка / обязательно | Имя общей галереи изображений, в которой должно быть создано определение изображения. | |||
| identifier словарь / обязательно | Идентификатор изображения. | |||
| offer строка / обязательно | Имя предложения определения изображения галереи. | |||
| publisher строка / обязательно | Имя издателя определения изображения галереи. | |||
| sku строка / обязательно | Имя SKU определения изображения галереи. | |||
| location строка | Расположение ресурса. | |||
| name строка / обязательно | Имя определения изображения галереи для создания или обновления. Разрешенные символы: буквы и цифры, точки, тире и периоды в середине. Максимальная длина - 80 символов. | |||
| os_state строка / обязательно |
| Разрешенные значения для состояния ОС: generalized. | ||
| os_type строка / обязательно |
| Это свойство позволяет указать тип ОС, включённой в диск при создании ВМ из управляемого изображения. | ||
| password строка | Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с сервисным принципалом. | |||
| privacy_statement_uri строка | URL политики конфиденциальности. | |||
| profile строка | Профиль безопасности в файле ~/.azure/credentials. | |||
| purchase_plan словарь | План закупки. | |||
| name строка | Идентификатор плана. | |||
| product строка | Идентификатор продукта. | |||
| publisher строка | Идентификатор издателя. | |||
| recommended словарь | Рекомендуемые значения параметров. | |||
| memory словарь | Память. | |||
| max целое число | Максимальное количество ресурса. | |||
| min целое число | Минимальное количество ресурса. | |||
| v_cpus словарь | Количество виртуальных процессоров. | |||
| max целое число | Максимальное количество ресурса. | |||
| min целое число | Минимальное количество ресурса. | |||
| release_note_uri строка | URL заметки о выпуске. | |||
| resource_group строка / обязательно | Имя группы ресурсов. | |||
| secret строка | Секретный ключ клиента Azure. Используйте при аутентификации с сервисным принципалом. | |||
| state строка |
| Утверждение состояния GalleryImage. Используйте present для создания или обновления GalleryImage и absent для удаления. | ||
| subscription_id строка | Идентификатор вашей подписки Azure. | |||
| tags словарь | Словарь пар строка:строка, назначаемых в качестве метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите параметр append_tags в значение false. | |||
| tenant строка | Идентификатор Azure-аренды. Используйте при аутентификации с сервисным принципалом. | |||
Примечания
Примечание
- Для аутентификации с Azure можно передать параметры, установить переменные среды, использовать профиль, сохранённый в ~/.azure/credentials, или войти в систему перед запуском задач или playbook с
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 or update gallery image
azure_rm_galleryimage:
resource_group: myResourceGroup
gallery_name: myGallery1283
name: myImage
location: West US
os_type: linux
os_state: generalized
identifier:
publisher: myPublisherName
offer: myOfferName
sku: mySkuName
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| id строка | всегда | Идентификатор ресурса. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalle ry1283/images/myImage |
Авторы
- Zim Kalinowski (@zikalino)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/azure/azcollection/azure_rm_galleryimage_module.html
