azure.azcollection.azure_rm_galleryimage – Управление экземпляром изображения Azure SIG
Примечание
Этот плагин входит в коллекцию azure.azcollection (версия 1.3.1).
Для его установки используйте: ansible-galaxy collection install azure.azcollection.
Для использования в книге задач укажите: azure.azcollection.azure_rm_galleryimage.
Новое в версии 0.1.2: коллекции 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, или войти в систему перед запуском задач или книги команд с
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 string | всегда | Идентификатор ресурса. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalle ry1283/images/myImage |
Авторы
- 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.10/collections/azure/azcollection/azure_rm_galleryimage_module.html
