azure_rm_galleryimage – Управление экземпляром изображения Azure SIG
Новая версия с 2.9.
Обзор
- Создание, обновление и удаление экземпляра изображения Azure SIG.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | ||
|---|---|---|---|---|
| ad_user строка | Имя пользователя Active Directory. Используется при аутентификации пользователем Active Directory, а не служебным принципалом. | |||
| adfs_authority_url строка добавлено в 2.6 | URL-адрес авторитета Azure AD. Используется при аутентификации с помощью имени пользователя/пароля и собственном авторитете ADFS. | |||
| api_profile строка добавлено в 2.5 | По умолчанию: "последняя версия" | Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack. | ||
| append_tags логическое значение |
| Используется для управления тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам. При каноническом формате любые теги, отсутствующие в параметре tags, будут удалены из метаданных объекта. | ||
| auth_source строка добавлено в 2.5 |
| Управляет источником учетных данных для аутентификации. Если не указано, будет использоваться переменная среды ANSIBLE_AZURE_AUTH_SOURCE, которая по умолчанию будет равна auto, если переменная не определена.auto будет следовать умолчанию приоритета параметров модуля -> переменные среды -> профиль по умолчанию в файле credential ~/.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 |
| Управляет поведением проверки сертификатов для 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. | ||
| 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 строка | URI заметки о выпуске. | |||
| 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 строка | всегда | Идентификатор ресурса Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myGalle ry1283/images/myImage |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом 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_galleryimage_module.html
