azure.azcollection.azure_rm_devtestlabschedule – Управление экземпляром расписания Azure DevTest Lab

Примечание

Этот плагин является частью коллекции azure.azcollection (версия 1.3.1).

Для его установки используйте: ansible-galaxy collection install azure.azcollection.

Чтобы использовать его в книге задач, укажите: azure.azcollection.azure_rm_devtestlabschedule.

Новый в версии 0.1.2: коллекции azure.azcollection

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

Обзор

Создание, обновление и удаление экземпляра расписания Azure DecTest Lab.

Требования

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

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	Варианты: авто ← cli credential_file env msi	Управляет источником учетных данных для аутентификации. Также может быть задан через переменную среды `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	Варианты: ignore validate	Управляет поведением проверки сертификата для 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`.
lab_name строка / обязательно		Имя лаборатории.
name строка / обязательно	Варианты: lab_vms_startup lab_vms_shutdown	Имя расписания.
password строка		Пароль пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не принципала службы.
profile строка		Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group строка / обязательно		Имя группы ресурсов.
secret строка		Секрет клиента Azure. Используется при аутентификации с помощью принципала службы.
state строка	Варианты: absent present ←	Утверждение состояния расписания. Используйте `present` для создания или обновления расписания и `absent` для его удаления.
subscription_id строка		Идентификатор вашей Azure-подписки.
tags словарь		Словарь пар строка:строка для присвоения в качестве метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите параметр append_tags в false.
tenant строка		Идентификатор Azure-арендатора. Используется при аутентификации с помощью принципала службы.
time строка		Время суток, когда произойдёт выполнение расписания.
time_zone_id строка		Идентификатор часового пояса.

Примечания

Примечание

Для аутентификации с 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) DevTest Lab Schedule
  azure_rm_devtestlabschedule:
    resource_group: myResourceGroup
    lab_name: myLab
    name: lab_vms_shutdown
    time: "1030"
    time_zone_id: "UTC+12"

Возвращаемые значения

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

Ключ	Возвращаемое значение	Описание
id строка	всегда	Идентификатор ресурса. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/myResourceGroup/providers/microsoft.devtestlab/labs/myLab/schedules/l abVmsShutdown

Авторы

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_devtestlabschedule_module.html