azure.azcollection.azure_rm_managementgroup – Управление экземпляром Azure ManagementGroup

Примечание

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

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

Для использования в книге задач укажите: azure.azcollection.azure_rm_managementgroup.

Новое в версии 0.1.1: из azure.azcollection

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

Описание

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

Требования

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

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`.
group_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 management group
  azure_rm_managementgroup:
    group_id: ChildGroup
    type: /providers/Microsoft.Management/managementGroups/
    name: ChildGroup
    properties:
      tenantId: 20000000-0000-0000-0000-000000000000
      display_name: ChildGroup
      parent_id: /providers/Microsoft.Management/managementGroups/RootGroup

- name: delete management group
  azure_rm_managementgroup:
    group_id: ChildGroup
    state: absent

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

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

Ключ				Возвращаемое значение	Описание
id string				всегда	Полный квалифицированный идентификатор группы управления. Например /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000.
name string				всегда	Имя группы управления. Например 00000000-0000-0000-0000-000000000000.
properties complex				всегда	Свойства группы управления.
	details complex			всегда	Детали группы управления.
		children complex		всегда	Список дочерних элементов.
			display_name string	всегда	Наименование дочернего ресурса (в удобочитаемой форме).
			id string	всегда	Полный квалифицированный идентификатор дочернего ресурса (группы управления или подписки). Например /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000.
			name string	всегда	Имя дочернего объекта.
			type string	всегда	Полный квалифицированный тип ресурса, включающий пространство имен поставщика. Например /providers/Microsoft.Management/managementGroups.
		parent complex		всегда	Родительская группа управления.
			display_name string	всегда	Наименование родительской группы управления (в удобочитаемой форме).
			id string	всегда	Полный квалифицированный идентификатор родительской группы управления. Например /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000.
			name string	всегда	Имя родительской группы управления.
		updated_by string		всегда	Идентификатор субъекта или процесса, обновившего объект.
		updated_time string		всегда	Дата и время последнего обновления объекта.
		version string		всегда	Номер версии объекта.
	display_name string			всегда	Наименование группы управления (в удобочитаемой форме).
	roles string			всегда	Определения ролей, связанные с группой управления.
	tenant_id string			всегда	Идентификатор арендатора AAD, связанный с группой управления. Например 00000000-0000-0000-0000-000000000000.
type string				всегда	Тип ресурса. Например /providers/Microsoft.Management/managementGroups.

Авторы

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