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

Примечание

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

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

Для использования в playbook, укажите: 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 строка / обязательно			Идентификатор группы управления.
id строка			Полностью квалифицированный идентификатор группы управления. Например, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000.
name строка			Имя группы управления. Например, 00000000-0000-0000-0000-000000000000.
password строка			Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы.
profile строка			Профиль безопасности, найденный в файле ~/.azure/credentials.
properties словарь			Свойства группы управления.
	display_name строка		Понятное имя группы управления.
	parent_id строка		Родитель группы управления.
	tenant_id строка		Идентификатор арендатора AAD, связанный с группой управления. Например, 00000000-0000-0000-0000-000000000000.
secret строка			Секретный ключ клиента Azure. Используется при аутентификации с принципалом службы.
state строка		Варианты: absent present ←	Утверждает состояние ManagementGroup. Используйте `present` для создания или обновления ManagementGroup и `absent` для её удаления.
subscription_id строка			Ваш идентификатор подписки Azure.
tags словарь			Словарь пар «строка:строка» для назначения метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите опцию append_tags в значение false.
tenant строка			Идентификатор Azure-арендатора. Используется при аутентификации с принципалом службы.
type строка			Тип ресурса. Например, /providers/Microsoft.Management/managementGroups.

Примечания

Примечание

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

Авторы

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