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

Примечание

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

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

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

Введено в версии 1.3.0: коллекции azure.azcollection

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

Обзор

Создание и удаление экземпляра Azure RegistrationAssignment.

Требования

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

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 логический тип		Варианты: нет да ←	Управление тем, является ли поле тегов каноническим или добавляется к существующим тегам. При каноническом поле теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта.
auth_source строка добавлен в 0.0.1 of 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 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 вместо сервисного принципала.
profile строка			Профиль безопасности, найденный в файле ~/.azure/credentials.
properties словарь			Свойства присвоения регистрации.
	registration_definition_id строка / обязательный		Полный путь определения регистрации.
registration_assignment_id строка			Идентификатор присвоения регистрации. Если не указан, будет сгенерирован UUID.
scope строка / обязательный			Область применения присвоения регистрации. Может быть на уровне подписки или группы.
secret строка			Секрет клиента Azure. Используется при аутентификации с помощью сервисного принципала.
state строка		Варианты: absent present ←	Утверждение состояния RegistrationAssignment. Используйте `present` для создания или обновления RegistrationAssignment и `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: Delete Registration Assignment
  azure_rm_registrationassignment:
    scope: subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    registration_assignment_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    state: absent


- name: Create Registration Assignment in subscription level
  azure_rm_registrationassignment:
    scope: subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    registration_assignment_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    properties:
      registration_definition_id: /subscriptions/xxx-xxx/providers/Microsoft.ManagedServices/registrationDefinitions/xxx-xxx


- name: Create Registration Assignment in resourcegroup level with randomly generating registration_assignment_id
  azure_rm_registrationassignment:
    scope: subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup
    properties:
      registration_definition_id: /subscriptions/xxx-xxx/providers/Microsoft.ManagedServices/registrationDefinitions/xxx-xxx

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

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

Ключ			Возвращено	Описание
state сложное			всегда	Информация о состоянии присвоения регистрации.
	id строка		всегда	Полный путь к присвоению регистрации. Пример: /subscriptions/xxx-xxx/providers/Microsoft.ManagedServices/registrationAssignments/xxx-xxx
	name строка		всегда	Имя присвоения регистрации. Пример: 9b2895ec-fb1e-4a1e-a978-abd9933d6b20
	properties сложное		всегда	Свойства присвоения регистрации.
		registration_definition_id строка	всегда	Полный путь определения регистрации.
	type строка		всегда	Тип ресурса. Пример: Microsoft.ManagedServices/registrationAssignments

Авторы

Fred-Sun (@Fred-Sun)

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