Модуль azure.azcollection.azure_rm_devtestlabvirtualmachine — управление виртуальной машиной Azure DevTest Lab

ad_user

string

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

adfs_authority_url

string

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

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

allow_claim

string

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

api_profile

string

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

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

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

append_tags

boolean

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

В каноническом режиме все теги, отсутствующие в параметре tags, удаляются из метаданных объекта.

Варианты:

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

artifacts

list / elements=dictionary

Артефакты, которые необходимо установить на виртуальной машине.

parameters

list / elements=dictionary

Параметры артефакта.

name

string

Имя параметра артефакта.

value

string

Значение параметра артефакта.

source_name

string

Имя источника артефакта.

source_path

string

Путь к артефакту в исходном репозитории.

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

disallow_public_ip_address

string

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

expiration_date

string

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

image

dictionary

Ссылка на образ виртуальной машины из Microsoft Azure Marketplace.

offer

string

Предложение образа из галереи.

os_type

string

Тип ОС образа из галереи.

publisher

string

Издатель образа из галереи.

sku

string

SKU образа из галереи.

version

string

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

is_authentication_with_ssh_key

boolean

Указывает, использует ли эта виртуальная машина SSH-ключ для аутентификации.

is_authentication_with_ssh_key=True, если для аутентификации по SSH задан параметр ssh_key.

Варианты:

• false
• true

lab_name

string / обязательный

Имя лаборатории.

lab_subnet

any

Существующая подсеть в виртуальной сети лаборатории.

Это может быть идентификатор ресурса подсети.

Это может быть словарь, содержащий virtual_network_name и name.

log_mode

string

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

log_path

string

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

name

string / обязательный

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

notes

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.

os_type

string

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

Варианты:

• "windows"
• "linux"
• "Windows"
• "Linux"

password

string

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

profile

string

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

resource_group

string / обязательный

Имя группы ресурсов.

secret

string

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

ssh_key

string

SSH-ключ администратора виртуальной машины.

state

string

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

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

Варианты:

• "absent"
• "present" ← (по умолчанию)

storage_type

string

Тип хранилища для виртуальной машины.

Варианты:

• "standard"
• "premium"

subscription_id

string

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

tags

dictionary

Словарь пар строка:строка, назначаемых объекту в качестве метаданных.

Метаданные тегов объекта будут обновлены с учетом всех указанных значений.

Чтобы удалить теги, установите для параметра append_tags значение false.

В настоящее время зоны DNS Azure и службы Traffic Manager также не позволяют использовать пробелы в тегах.

Azure Front Door не поддерживает использование

Azure Automation и Azure CDN поддерживают не более 15 тегов для ресурсов.

tenant

string

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

thumbprint

string

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

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

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

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

user_name

string

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

vm_size

string

Допустимое значение размера виртуальной машины Azure. Например, Standard_D4.

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

Доступные значения приведены на сайте: https://docs.microsoft.com/en-us/azure/virtual-machines/windows/sizes-general.

Обязательно, если state=present.

x509_certificate_path

path

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

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

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

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

compute_id

string

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

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

Пример: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/myrg/providers/microsoft.devtestlab/labs/mylab/virtualmachines/myvm"

fqdn

string

Полное доменное имя или IP-адрес виртуальной машины.

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

Пример: "myvm.eastus.cloudapp.azure.com"

id

string

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

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

Пример: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/myrg/providers/microsoft.devtestlab/labs/mylab/virtualmachines/myvm"