Модуль azure.azcollection.azure_rm_dedicatedhost — создание, удаление и обновление выделенного узла

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"

append_tags

boolean

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

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

Варианты:

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

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"

auto_replace_on_failure

boolean

Указывает, следует ли автоматически заменять выделенный узел в случае сбоя.

Если значение не указано, по умолчанию используется true.

Варианты:

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

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

host_group_name

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

Имя группы узлов.

is_restart

boolean

Следует ли перезапустить выделенный узел.

Варианты:

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

license_type

string

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

Варианты:

• "None"
• "Windows_Server_Hybrid"
• "Windows_Server_Perpetual"

location

string

Допустимое расположение Azure для выделенного узла. По умолчанию используется расположение группы ресурсов.

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, а не субъекта-службы.

platform_fault_domain

integer

Домен сбоя выделенного узла в группе выделенных узлов.

Варианты:

• 0

profile

string

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

resource_group

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

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

secret

string

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

sku

dictionary

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

Необходимо указать только name

name

string

Имя артикула.

state

string

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

Варианты:

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

subscription_id

string

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

tags

dictionary

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

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

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

В настоящее время в зонах Azure DNS и службах 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.

x509_certificate_path

path

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

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

Закрытый ключ должен быть добавлен в конец сертификата.

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

state

complex

Получает список выделенных хостов.

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

auto_replace_on_failure

boolean

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

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

Пример: true

host_group_name

string

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

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

Пример: "myDedicatedHostGroup"

id

string

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

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

Пример: "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup/hosts/myHost"

license_type

string

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

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

Пример: "Windows_Server_Hybrid"

location

string

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

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

Пример: "eastus"

name

string

Имя выделенного хоста.

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

Пример: "myHost"

platform_fault_domain

string

Домен сбоя платформы выделенного хоста в группе выделенных хостов.

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

Пример: "1"

provisioning_state

string

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

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

Пример: "Succeeded"

resource_group

string

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

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

Пример: "myResourceGroup"

sku

dictionary

SKU выделенного хоста для поколения оборудования и семейства виртуальных машин.

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

Пример: {"name": "DSv3-Type4"}

tags

dictionary

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

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

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

virtual_machines

string

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

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

Пример: "[{'id': '/subscriptions/subId/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/vm1'}]"