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

Примечание

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

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

Для использования в playbook, укажите: azure.azcollection.azure_rm_registrationdefinition.

Новое в версии 1.3.0: of azure.azcollection

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

Описание

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

Требования

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

python >= 2.7
azure >= 2.0.0

Параметры

Параметр			Варианты/Значения по умолчанию	Комментарии
ad_user строка				Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с сервисным принципалом.
adfs_authority_url строка добавлено в 0.0.1 of azure.azcollection				URL-адрес авторизации Azure AD. Используется при аутентификации с именем пользователя/паролем и собственной авторизацией ADFS.
api_profile строка добавлено в 0.0.1 of azure.azcollection			По умолчанию: "latest"	Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.
append_tags логическое значение			Варианты: no да ←	Управляет тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам. При каноническом формате любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта.
auth_source строка добавлено в 0.0.1 of azure.azcollection			Варианты: auto ← 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` могут быть использованы для определения идентификатора подписки, если их несколько, в противном случае используется подписка Azure CLI по умолчанию. При установке в `msi`, хост-машина должна быть Azure-ресурсом с включённым расширением MSI. `subscription_id` или переменная среды `AZURE_SUBSCRIPTION_ID` могут быть использованы для определения идентификатора подписки, если ресурс имеет доступ к нескольким подпискам, в противном случае выбирается первая подписка. Параметр `msi` был добавлен в Ansible 2.6.
cert_validation_mode строка добавлено в 0.0.1 of azure.azcollection			Варианты: ignore validate	Управляет поведением проверки сертификатов для Azure-точек входа. По умолчанию все модули проверяют серверный сертификат, но при использовании прокси HTTPS или при работе с Azure Stack, может потребоваться отключить это поведение, передав `ignore`. Также может быть задано через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`.
client_id строка				Идентификатор клиента Azure. Используется при аутентификации с помощью сервисного принципала.
cloud_environment строка добавлено в 0.0.1 of azure.azcollection			По умолчанию: "AzureCloud"	Для облачных сред, отличных от общедоступного облака США, имя среды (определенное Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`), или URL-адрес точки входа для обнаружения метаданных (требуется для Azure Stack). Также может быть задано через профиль файла учетных данных или переменную среды `AZURE_CLOUD_ENVIRONMENT`.
password строка				Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с сервисным принципалом.
plan словарь				Подробности плана для управляемых служб.
	name строка / обязательно			Имя плана.
	product строка / обязательно			Код продукта.
	publisher строка / обязательно			Идентификатор издателя.
	version строка / обязательно			Версия плана.
profile строка				Профиль безопасности, найденный в файле ~/.azure/credentials.
properties словарь				Свойства определения регистрации.
	authorizations список / элементы=строка / обязательно			Кортеж авторизации, содержащий идентификатор принципала пользователя/группы безопасности или сервисного принципала и идентификатор встроенной роли.
		principal_id строка / обязательно		Идентификатор принципала группы безопасности/сервисного принципала/пользователя, которому будут назначены разрешения на спроецированную подписку.
		role_definition_id строка / обязательно		Идентификатор определения роли. Эта роль определит все разрешения, которые должна иметь группа безопасности/сервисный принципал/пользователь на спроецированной подписке. Эта роль не может быть ролью владельца.
	description строка			Описание определения регистрации.
	managed_by_tenant_id строка / обязательно			Идентификатор управляемого арендатора.
	registration_definition_name строка			Имя определения регистрации.
registration_definition_id строка				Идентификатор определения регистрации. Если не указано, для него будет сгенерирован UUID.
scope строка				Идентификатор подписки определяет подписку, в которой будет создано определение регистрации. Если не указано, будет использована подписка, полученная из AzureRMAuth.
secret строка				Секретный ключ клиента Azure. Используется при аутентификации с помощью сервисного принципала.
state строка			Варианты: absent present ←	Утвердить состояние RegistrationDefinition. Используйте `present` для создания или обновления RegistrationDefinition и `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. Также возможно добавить дополнительные профили. Укажите профиль, передав профиль или установив AZURE_PROFILE в среде.

См. также

Вход с помощью Azure CLI: Как войти в систему с помощью команды az login.

Примеры

- name: Create Registration Definition without scope
  azure_rm_registrationdefinition:
    registration_definition_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    properties:
      description: test
      authorizations:
        - principal_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
          role_definition_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
      managed_by_tenant_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
      registration_definition_name: def4

- name: Create Registration Definition with scope
  azure_rm_registrationdefinition:
    scope: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    registration_definition_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    properties:
      description: test
      authorizations:
        - principal_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
          role_definition_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
      managed_by_tenant_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
      registration_definition_name: def5

- name: Delete Registration Definition
  azure_rm_registrationdefinition:
    registration_definition_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    state: absent

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

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

Ключ				Возвращаемое	Описание
state сложное				всегда	Информация о состоянии назначения регистрации.
	id строка			всегда	Полный путь определения регистрации.
	name строка			всегда	Имя определения регистрации. Пример: /subscriptions/xxx-xxx/providers/Microsoft.ManagedServices/registrationDefinitions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
	plan сложное			всегда	Подробности плана для управляемых служб.
		name строка		всегда	Имя плана.
		product строка		всегда	Код продукта.
		publisher строка		всегда	Идентификатор издателя.
		version строка		всегда	Версия плана.
	properties сложное			всегда	Свойства определения регистрации.
		authorizations сложное		всегда	Кортеж авторизации, содержащий идентификатор принципала пользователя/группы безопасности или управляемого принципала и идентификатор встроенной роли.
			principal_id строка	всегда	Идентификатор принципала группы безопасности/управляемого принципала/пользователя, которому будут назначены разрешения на целевой подписке Пример: 99e3227f-8701-4099-869f-bc3efc7f1e64
			role_definition_id строка	всегда	Идентификатор определения роли. Эта роль определит все разрешения, которые должна иметь группа безопасности/управляемый принципал/пользователь на подписке. Эта роль не может быть ролью владельца. Пример: b24988ac-6180-42a0-ab88-20f7382dd24c
		description строка		всегда	Описание определения регистрации. Пример: test
		managed_by_tenant_id строка		всегда	Идентификатор управляемого арендатора.
		registration_definition_name строка		всегда	Имя определения регистрации.
	type строка			всегда	Тип ресурса. Пример: Microsoft.ManagedServices/registrationDefinitions

Авторы

Fred-Sun (@Fred-Sun)

© 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_registrationdefinition_module.html