модуль azure.azcollection.azure_rm_managementgroup_info — получение сведений о группах управления Azure

ad_user

string

Имя пользователя Active Directory. Используется при аутентификации от имени пользователя Active Directory, а не субъекта-службы.

adfs_authority_url

string

добавлено в azure.azcollection 0.0.1

URL-адрес центра Azure AD. Используется при аутентификации по имени пользователя и паролю, если у вас есть собственный центр ADFS.

api_profile

string

добавлено в azure.azcollection 0.0.1

Выбирает профиль API для взаимодействия со службами Azure. Значение latest по умолчанию подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.

По умолчанию: "latest"

auth_source

string

добавлено в azure.azcollection 0.0.1

Определяет источник учетных данных для аутентификации.

Также можно задать с помощью переменной окружения 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.

Варианты:

• "auto" ← (по умолчанию)
• "cli"
• "credential_file"
• "env"
• "msi"

cert_validation_mode

string

добавлено в azure.azcollection 0.0.1

Управляет проверкой сертификатов конечных точек Azure. По умолчанию все модули проверяют сертификат сервера, однако при использовании HTTPS-прокси или Azure Stack может потребоваться отключить эту проверку, передав ignore. Значение также можно задать в профиле файла учетных данных или с помощью переменной окружения AZURE_CERT_VALIDATION.

Варианты:

• "ignore"
• "validate"

children

boolean

Если задано c(False), будут получены только группа name или id либо только список корневых групп.

Если задано c(True), также будут возвращены дочерние группы.

Варианты:

• false ← (по умолчанию)
• true

client_id

string

Идентификатор клиента Azure. Используется при аутентификации с помощью субъекта-службы или управляемого удостоверения (msi).

Также можно задать с помощью переменной окружения AZURE_CLIENT_ID.

cloud_environment

string

добавлено в azure.azcollection 0.0.1

Для облачных сред, отличных от общедоступного облака США, укажите имя среды (согласно Azure Python SDK, например AzureChinaCloud, AzureUSGovernment) или URL-адрес конечной точки обнаружения метаданных (обязательно для Azure Stack). Значение также можно задать в профиле файла учетных данных или с помощью переменной окружения AZURE_CLOUD_ENVIRONMENT.

По умолчанию: "AzureCloud"

disable_instance_discovery

boolean

добавлено в azure.azcollection 2.3.0

Определяет, выполняется ли обнаружение экземпляров при попытке аутентификации. Если задать значение true, обнаружение экземпляров и проверка центра будут полностью отключены. Эта функция предназначена для сценариев, в которых невозможно подключиться к конечной точке метаданных, например в частных облаках или Azure Stack. Обнаружение экземпляров включает получение метаданных центра с сайта https://login.microsoft.com/ для проверки центра. Если задать значение **True**, проверка центра будет отключена. Поэтому крайне важно убедиться, что настроенный узел центра является допустимым и заслуживающим доверия.

Задается в профиле файла учетных данных или с помощью переменной окружения AZURE_DISABLE_INSTANCE_DISCOVERY.

Варианты:

• false ← (по умолчанию)
• true

flatten

boolean

Если задано c(True), дочерние элементы management_groups и subscriptions будут скопированы соответственно в корневой список возвращаемых элементов management_groups и subscriptions.

По умолчанию задано c(False), поэтому дочерние элементы отображаются только во вложенной структуре.

Параметр учитывается только при значении c(True) для children; в противном случае он будет проигнорирован без предупреждения.

Варианты:

• false ← (по умолчанию)
• true

id

string

Ограничивает результаты указанной группой управления по ее идентификатору.

Взаимоисключающий параметр с name.

log_mode

string

Аргумент родительского модуля.

log_path

string

Аргумент родительского модуля.

name

псевдонимы: management_group_name

string

Ограничивает результаты указанной группой управления по ее имени.

Взаимоисключающий параметр с id.

oidc_token

string

добавлено в azure.azcollection 3.17.0

Токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с помощью удостоверения рабочей нагрузки.

Этот токен обменивается на токен Azure AD с использованием федеративного удостоверения OIDC.

Полезен в системах CI (например, GitHub Actions, Azure DevOps), где платформа напрямую предоставляет токен OIDC.

Также можно задать с помощью переменной окружения AZURE_FEDERATED_TOKEN.

oidc_token_file_path

path

добавлено в azure.azcollection 3.17.0

Путь к файлу с токеном OpenID Connect (OIDC) (JWT), используемым для аутентификации с помощью удостоверения рабочей нагрузки.

Файл должен содержать только необработанный токен.

Этот способ обычно используется на платформах, которые сохраняют токены OIDC в файлах.

Также можно задать с помощью переменной окружения AZURE_FEDERATED_TOKEN_FILE.

password

string

Пароль пользователя Active Directory. Используется при аутентификации от имени пользователя Active Directory, а не субъекта-службы.

profile

string

Профиль безопасности из файла ~/.azure/credentials.

recurse

boolean

По умолчанию задано c(False): если для children установлено значение c(True), возвращаются только непосредственные дочерние элементы.

Если задано c(True), возвращаются все потомки в иерархии.

Параметр учитывается только при значении c(True) для children; в противном случае он будет проигнорирован без предупреждения.

Варианты:

• false ← (по умолчанию)
• true

secret

string

Секрет клиента Azure. Используется при аутентификации с помощью субъекта-службы.

subscription_id

string

Идентификатор вашей подписки Azure.

tenant

string

Идентификатор клиента Azure. Используется при аутентификации с помощью субъекта-службы.

thumbprint

string

добавлено в azure.azcollection 1.14.0

Отпечаток закрытого ключа, указанного в x509_certificate_path.

Используется при аутентификации с помощью субъекта-службы.

Обязателен, если задан x509_certificate_path.

x509_certificate_path

path

добавлено в azure.azcollection 1.14.0

Путь к сертификату X509 в формате PEM, используемому для создания субъекта-службы.

Сертификат должен быть добавлен к закрытому ключу.

Используется при аутентификации с помощью субъекта-службы.

management_groups

list / elements=string

Список словарей групп управления.

Возвращается: всегда

children

list / elements=string

Дочерние группы управления или подписки.

Возвращается: если children равно c(True)

Пример: ["Nested list of children. Same as top groups", " but without tenant_id."]

display_name

string

Отображаемое имя группы управления.

Возвращается: всегда

Пример: "My Management Group"

id

string

Полный идентификатор группы управления.

Возвращается: всегда

Пример: "/providers/Microsoft.Management/managementGroups/group-name"

name

string

Отображаемое имя группы управления.

Возвращается: всегда

Пример: "group-name"

tenant_id

string

Идентификатор клиента группы управления

Возвращается: всегда

Пример: "00000000-0000-0000-0000-000000000000"

type

string

Тип группы управления

Возвращается: всегда

Пример: "/providers/Microsoft.Management/managementGroups"

subscriptions

list / elements=string

Список объектов подписок.

Возвращается: если children и flatten оба равны c(True)

display_name

string

Отображаемое имя подписки.

Возвращается: всегда

Пример: "some-subscription-name"

id

string

Полный идентификатор подписки.

Возвращается: всегда

Пример: "/subscriptions/00000000-0000-0000-0000-feedc0ffee000000"

subscription_id

string

GUID подписки.

Возвращается: всегда

Пример: "00000000-0000-0000-0000-feedc0ffee000000"

type

string

Тип группы управления

Возвращается: всегда

Пример: "/subscriptions"