модуль azure.azcollection.azure_rm_multiplemanageddisks – Управление несколькими управляемыми дисками 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"

append_tags

boolean

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

При полной замене все теги, отсутствующие в параметре 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"

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

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

managed_by_extended

list / elements=dictionary

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

Если state=present, диски будут подключены к указанным виртуальным машинам.

Если state=present, используйте [], чтобы отключить диски от всех виртуальных машин.

Если state=absent и этот параметр задан, диски будут отключены от указанных виртуальных машин.

Если state=absent и этот параметр не задан, диски будут удалены.

name

string

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

resource_group

string

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

managed_disks

list / elements=dictionary

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

attach_caching

string

Политика кэширования диска, управляемая виртуальной машиной. Будет применяться при подключении к виртуальной машине, указанной в managed_by.

Если этот параметр отличается от текущей политики кэширования, управляемый диск будет отключен и снова подключен с заданной политикой кэширования.

Варианты:

• ""
• "read_only"
• "read_write"

create_option

string

import из файла VHD, указанного в source_uri, и copy из предыдущего управляемого диска, указанного в source_uri.

Варианты:

• "empty"
• "import"
• "copy"

disk_size_gb

integer

Размер создаваемого управляемого диска в ГБ.

Обязателен, если create_option=empty.

Если create_option=copy, значение должно быть больше размера исходного диска или равно ему.

location

string

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

lun

integer

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

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

max_shares

integer

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

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

name

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

Имя управляемого диска.

os_type

string

Тип операционной системы.

Используется, если create_option=copy или create_option=import, а источник является диском ОС.

Если при создании параметр не указан, значение не задается.

Если при обновлении параметр не указан, изменения не вносятся.

После задания это значение нельзя очистить.

Варианты:

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

resource_group

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

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

source_uri

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

string

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

Обязателен, если create_option=import или create_option=copy.

storage_account_id

string

Полный путь к учетной записи хранения, из которой импортируется образ.

Обязателен, если create_option=import.

storage_account_type

string

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

Если не указано, диск создается как Standard_LRS.

Standard_LRS соответствует стандартному HDD.

StandardSSD_LRS (добавлено в версии 2.8) соответствует стандартному SSD.

StandardSSD_ZRS соответствует стандартному SSD с зональным резервированием.

Premium_LRS соответствует SSD Premium.

Premium_ZRS соответствует SSD Premium с зональным резервированием.

UltraSSD_LRS (добавлено в версии 2.8) соответствует Ultra SSD, доступному только для некоторых типов экземпляров.

Дополнительные сведения о типах дисков см. на странице https://docs.microsoft.com/en-us/azure/virtual-machines/windows/disks-types.

Варианты:

• "Standard_LRS"
• "StandardSSD_LRS"
• "StandardSSD_ZRS"
• "Premium_LRS"
• "Premium_ZRS"
• "UltraSSD_LRS"

zone

string

Зона управляемого диска Azure.

Допустимые значения: 1, 2, 3 и ''.

Варианты:

• "1"
• "2"
• "3"
• ""

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.

secret

string

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

state

string

Задает требуемое состояние управляемых дисков.

Используйте present для создания или обновления управляемых дисков и/или подключения и отключения дисков к списку виртуальных машин в зависимости от заданного значения managed_by_extended.

Используйте absent для отключения или удаления управляемых дисков в зависимости от заданного значения managed_by_extended.

Варианты:

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

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.

x509_certificate_path

path

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

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

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

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

state

complex

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

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

create_option

string

Параметр создания диска.

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

Пример: "copy"

disk_size_gb

string

Размер создаваемого управляемого диска в ГБ.

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

id

string

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

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

location

string

Допустимое расположение Azure.

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

managed_by

string

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

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

managed_by_extended

list / elements=string

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

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

Пример: ["/subscriptions/xxx-xxx/resourceGroups/myRG/providers/Microsoft.Compute/virtualMachines/testVM"]

max_shares

integer

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

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

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

Пример: 3

name

string

Имя управляемого диска.

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

os_type

string

Тип операционной системы.

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

Пример: "linux"

source_uri

string

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

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

storage_account_id

string

Полный путь к учетной записи хранения, из которой импортируется образ.

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

Пример: "/subscriptions/<uuid>/resourceGroups/<resource group name>/providers/Microsoft.Storage/storageAccounts/<storage account name>"

storage_account_type

string

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

Дополнительные сведения об этом типе см. на странице https://docs.microsoft.com/en-us/azure/virtual-machines/windows/disks-types.

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

Пример: "Standard_LRS"

tags

dictionary

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

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

Пример: {"tag": "value"}