azure.azcollection.azure_rm_resource_info module – Общие сведения о ресурсах 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"

api_version

string

Используемая версия API.

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; в противном случае будет использована подписка az 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"

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

log_mode

string

Родительский аргумент.

log_path

string

Родительский аргумент.

method

string

Метод HTTP-запроса или ответа. Он должен быть указан в верхнем регистре.

Варианты:

• "GET" ← (по умолчанию)
• "PUT"
• "POST"
• "HEAD"
• "PATCH"
• "DELETE"
• "MERGE"

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.

provider

string

Тип поставщика; его следует указать, если URL-адрес не задан.

resource_group

string

Используемая группа ресурсов.

Обязательный параметр, если URL-адрес не указан.

resource_name

string

Имя ресурса.

resource_type

string

Тип ресурса.

secret

string

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

subresource

list / elements=dictionary

Список подресурсов.

По умолчанию: []

name

string

Имя подресурса.

namespace

string

Пространство имен подресурса.

type

string

Тип подресурса.

subscription_id

string

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

tags

dictionary

Словарь тегов для фильтрации.

Каждая пара «ключ—значение» в словаре задает имя тега и его значение для фильтрации различных ресурсов.

По умолчанию: {}

tenant

string

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

thumbprint

string

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

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

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

Обязательный параметр, если задан x509_certificate_path.

url

string

URL-адрес ресурса Azure RM.

x509_certificate_path

path

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

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

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

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

response

complex

Ответ, специфичный для типа ресурса.

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

id

string

Идентификатор ресурса Azure.

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

Пример: "/subscriptions/xxxx...xxxx/resourceGroups/v-xisuRG/providers/Microsoft.Compute/virtualMachines/myVM"

location

string

Расположение ресурса.

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

Пример: "eastus"

name

string

Имя ресурса.

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

Пример: "myVM"

properties

complex

Содержит свойства виртуальной машины.

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

diagnosticsProfile

complex

Содержит состояние параметров диагностики загрузки.

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

bootDiagnostics

dictionary

Функция отладки, позволяющая просматривать вывод консоли и снимок экрана для диагностики состояния виртуальной машины.

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

Пример: {"enabled": true, "storageUri": "https://vxisurgdiag.blob.core.windows.net/"}

hardwareProfile

dictionary

Содержит настройки оборудования виртуальной машины.

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

Пример: {"vmSize": "Standard_D2s_v3"}

networkProfile

complex

Содержит сетевые интерфейсы виртуальной машины.

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

networkInterfaces

list / elements=string

Описывает ссылку на сетевой интерфейс.

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

Пример: [{"id": "/subscriptions/xxxx...xxxx/resourceGroups/v-xisuRG/providers/Microsoft.Network/networkInterfaces/myvm441"}]

osProfile

complex

Содержит настройки операционной системы виртуальной машины.

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

adminUsername

string

Содержит имя учетной записи администратора.

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

Пример: "azureuser"

allowExtensionOperations

boolean

Указывает, разрешены ли операции с расширениями на виртуальной машине.

Это значение можно установить в False, только если на виртуальной машине нет расширений.

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

Пример: true

computerName

string

Содержит имя хоста операционной системы виртуальной машины.

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

Пример: "myVM"

linuxConfiguration

dictionary

Содержит настройки операционной системы Linux на виртуальной машине.

Возвращается: если тип ОС — Linux

Пример: {"disablePasswordAuthentication": false, "provisionVMAgent": true}

requireGuestProvisionSignale

boolean

Указывает, требуется ли хосту сигнал о подготовке гостевой системы.

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

Пример: true

secrets

list / elements=string

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

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

Пример: []

provisioningState

string

Состояние подготовки.

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

Пример: "Succeeded"

storageProfile

complex

Содержит тип учетной записи хранения для управляемого диска.

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

dataDisks

list / elements=string

Содержит параметры, используемые для добавления диска данных к виртуальной машине.

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

Пример: [{"caching": "None", "createOption": "Attach", "diskSizeGB": 1023, "lun": 2, "managedDisk": {"id": "/subscriptions/xxxx....xxxx/resourceGroups/V-XISURG/providers/Microsoft.Compute/disks/testdisk2", "storageAccountType": "StandardSSD_LRS"}, "name": "testdisk2"}, {"caching": "None", "createOption": "Attach", "diskSizeGB": 1023, "lun": 1, "managedDisk": {"id": "/subscriptions/xxxx...xxxx/resourceGroups/V-XISURG/providers/Microsoft.Compute/disks/testdisk3", "storageAccountType": "StandardSSD_LRS"}, "name": "testdisk3"}]

imageReference

dictionary

Содержит информацию об используемом образе.

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

Пример: {"offer": "UbuntuServer", "publisher": "Canonical", "sku": "20_04-lts", "version": "latest"}

osDisk

dictionary

Содержит информацию о диске операционной системы, используемом виртуальной машиной.

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

Пример: {"caching": "ReadWrite", "createOption": "FromImage", "diskSizeGB": 30, "managedDisk": {"id": "/subscriptions/xxx...xxxx/resourceGroups/v-xisuRG/providers/Microsoft.Compute/disks/myVM_disk1_xxx", "storageAccountType": "Premium_LRS"}, "name": "myVM_disk1_xxx", "osType": "Linux"}

vmID

string

Содержит уникальный идентификатор виртуальной машины — 128-битный идентификатор, закодированный и сохраненный в SMBIOS всех виртуальных машин Azure IaaS.

Его можно прочитать с помощью команд BIOS платформы.

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

Пример: "eb86d9bb-6725-4787-a487-2e497d5b340c"

type

string

Тип удостоверения, используемого виртуальной машиной.

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

Пример: "Microsoft.Compute/virtualMachines"