модуль azure.azcollection.azure_rm_virtualmachine_info — Получение сведений о виртуальных машинах

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"

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

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

name

string

Имя виртуальной машины.

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.

resource_group

string

Имя группы ресурсов, содержащей виртуальные машины (обязательно при фильтрации по имени виртуальной машины).

secret

string

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

subscription_id

string

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

tags

list / элементы=string

Ограничьте результаты, указав список тегов. Формат тегов: «ключ» или «ключ:значение».

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, используемому для создания субъекта-службы.

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

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

vms

complex

Список виртуальных машин.

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

additional_capabilities

dictionary

Включает или отключает возможность виртуальной машины.

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

Пример: {"ultra_ssd_enabled": false}

admin_username

string

Имя пользователя администратора.

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

Пример: "admin"

boot_diagnostics

complex

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

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

console_screenshot_uri

string

Содержит URI для получения снимка экрана консоли.

Присутствует только при включенной функции.

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

Пример: "https://mystorageaccountname.blob.core.windows.net/bootdiagnostics-myvm01-a4db09a6-ab7f-4d80-9da8-fbceaef9288a/ myVm.a4db09a6-ab7f-4d80-9da8-fbceaef9288a.screenshot.bmp"

enabled

boolean

Указывает, включена ли диагностика загрузки.

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

Пример: true

serial_console_log_uri

string

Содержит URI для получения журнала последовательной консоли.

Присутствует только при включенной функции.

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

Пример: "https://mystorageaccountname.blob.core.windows.net/bootdiagnostics-myvm01-a4db09a6-ab7f-4d80-9da8-fbceaef9288a/ myVm.a4db09a6-ab7f-4d80-9da8-fbceaef9288a.serialconsole.log"

storage_uri

string

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

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

Пример: "https://mystorageaccountname.blob.core.windows.net/"

CapacityReservation

dictionary

Имя или идентификатор группы резервирования емкости, с которой следует связать ресурс.

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

Пример: {}

data_disks

complex

Список подключенных дисков данных.

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

caching

string

Тип кэширования диска данных.

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

Пример: "ReadOnly"

disk_size_gb

integer

Начальный размер пустого диска данных в ГБ.

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

Пример: 64

lun

integer

Логический номер устройства диска данных.

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

Пример: 0

managed_disk_id

string

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

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

Пример: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/Microsoft.Compute/disks/diskName"

managed_disk_type

string

Тип управляемого диска данных.

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

Пример: "Standard_LRS"

write_accelerator_enabled

boolean

Указывает, следует ли включить или отключить writeAccelerator для диска.

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

Пример: false

display_status

string

Краткая локализуемая метка состояния.

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

Пример: "VM running"

id

string

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

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

Пример: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVm"

identity

dictionary

Идентификатор виртуальной машины.

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

Пример: {"principal_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "tenant_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "type": "SystemAssigned, UserAssigned", "user_assigned_identities": {"/subscriptions/xxx/resourceGroups/testRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/test": {"client_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "principal_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"}}}

image

complex

Параметры образа.

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

community_gallery_image_id

string

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

Возвращается: если создано на основе образа из общедоступной коллекции

Пример: "/CommunityGalleries/yellowbrick-fc7e81f1-87dd-4989-9ca8-03743762e873/Images/Ubuntu-5.15.0-1035-azure_22.04"

id

string

Идентификатор ресурса пользовательского образа.

Возвращается: если создано на основе пользовательского образа

Пример: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/myImage"

offer

string

Предложение образа платформы или образа из Marketplace, использованного для создания виртуальной машины.

Возвращается: если создано на основе образа из Marketplace

Пример: "RHEL"

publisher

string

Имя издателя.

Возвращается: если создано на основе образа из Marketplace

Пример: "RedHat"

sku

string

Имя SKU.

Возвращается: если создано на основе образа из Marketplace

Пример: "7-RAW"

version

string

Версия образа.

Возвращается: если создано на основе образа из Marketplace

Пример: "7.5.2018050901"

location

string

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

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

Пример: "japaneast"

maintenance_redeploy_status

dictionary

Если для этого сервера запланировано обслуживание, задается значение, например, такое; в противном случае возвращается пустой словарь.

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

Пример: {"is_customer_initiated_maintenance_allowed": true, "last_operation_result_code": "None", "maintenance_window_end_time": "2025-06-18T23:59:00.000Z", "maintenance_window_start_time": "2025-06-12T00:00:00.000Z", "pre_maintenance_window_end_time": "2025-06-11T23:30:00.000Z", "pre_maintenance_window_start_time": "2025-01-30T00:00:00.000Z"}

name

string

Имя ресурса.

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

Пример: "myVm"

network_interface_names

list / elements=string

Список подключенных сетевых интерфейсов.

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

Пример: ["myNetworkInterface"]

os_disk_caching

string

Тип кэширования диска ОС.

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

Пример: "ReadOnly"

os_type

string

Базовый тип операционной системы.

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

Пример: "Linux"

power_state

string

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

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

Пример: "running"

provisioning_state

string

Состояние подготовки, отображаемое только в ответе.

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

Пример: "running"

proximityPlacementGroup

dictionary

Имя или идентификатор группы близкого размещения, с которой следует связать виртуальную машину.

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

Пример: {"id": "/subscriptions/xxx/resourceGroups/xxx/providers/Microsoft.Compute/proximityPlacementGroups/testid13"}

resource_group

string

Группа ресурсов.

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

Пример: "myResourceGroup"

security_profile

complex

Задает параметры профиля безопасности виртуальной машины.

Возвращается: при использовании

encryption_at_host

boolean

Пользователь может использовать это свойство в запросе, чтобы включить или отключить шифрование виртуальной машины на узле.

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

Возвращается: если включено

Пример: true

security_type

string

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

Для включения UefiSettings устанавливается значение TrustedLaunch.

Возвращается: если включено

Пример: "TrustedLaunch"

uefi_settings

complex

Задает параметры безопасности, например безопасную загрузку и vTPM, используемые при создании виртуальной машины.

Возвращается: если включено

secure_boot_enabled

boolean

Указывает, следует ли включить безопасную загрузку на виртуальной машине.

Возвращается: если включено

Пример: true

v_tpm_enabled

boolean

Указывает, следует ли включить vTPM на виртуальной машине.

Возвращается: если включено

Пример: true

state

string

Состояние ресурса.

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

Пример: "present"

tags

dictionary

Теги ресурса.

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

Пример: {"key1": "value1"}

user_data

string

UserData для виртуальной машины, закодированные в формате Base64.

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

Пример: "None"

vm_agent_version

string

Версия агента Azure VM (waagent), запущенного внутри виртуальной машины.

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

Пример: "2.9.1.1"

vm_size

string

Размер виртуальной машины.

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

Пример: "Standard_D4"

zones

list / elements=string

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

Возвращается: успешно

Пример: [1]