модуль azure.azcollection.azure_rm_manageddisk — Управление управляемыми дисками 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 ← (по умолчанию)

attach_caching

string

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

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

Варианты:

• ""
• "read_only"
• "read_write"

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"

create_option

string

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

Варианты:

• "empty"
• "import"
• "copy"
• "upload"
• "fromimage"
• "restore"
• "uploadpreparedsecure"

disable_instance_discovery

boolean

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

Определяет, выполняется ли обнаружение экземпляра при попытке аутентификации. Установка значения true полностью отключает обнаружение экземпляра и проверку центра сертификации. Эта функция предназначена для сценариев, в которых конечная точка метаданных недоступна, например в частных облаках или Azure Stack. Процесс обнаружения экземпляра включает получение метаданных центра сертификации с https://login.microsoft.com/ для проверки центра сертификации. Если задать значение **True**, проверка центра сертификации будет отключена. Поэтому крайне важно убедиться, что настроенный узел центра сертификации действителен и заслуживает доверия.

Задается в профиле файла учетных данных или с помощью переменной среды AZURE_DISABLE_INSTANCE_DISCOVERY.

Варианты:

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

disk_access_id

string

Идентификатор ARM ресурса DiskAccess для использования частных конечных точек на дисках.

disk_iops_read_only

integer

Общая пропускная способность (МБ/с), разрешенная для всех виртуальных машин, подключающих общий диск в режиме «только чтение».

За одну операцию можно передать от 4 КБ до 256 КБ данных.

disk_iops_read_write

integer

Количество операций ввода-вывода в секунду, разрешенное для этого диска.

Можно задать только для дисков storage_account_type=UltraSSD_LRS.

За одну операцию можно передать от 4 КБ до 256 КБ данных.

disk_m_bps_read_only

integer

Общая пропускная способность (МБ/с), разрешенная для всех виртуальных машин, подключающих общий диск в режиме «только чтение».

МБ/с означает миллионы байтов в секунду; здесь МБ используется в обозначении ISO, то есть в степенях 10.

disk_m_bps_read_write

integer

Пропускная способность, разрешенная для этого диска.

Можно задать только для дисков storage_account_type=UltraSSD_LRS.

За одну операцию можно передать от 4 КБ до 256 КБ данных.

disk_size_gb

integer

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

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

gallery_image_reference

dictionary

Обязателен при создании из образа галереи.

Значение id/sharedGalleryImageId/communityGalleryImageId объекта ImageDiskReference будет идентификатором ARM версии общего образа галереи, на основе которой создается диск.

community_gallery_image_id

string

Относительный URI, содержащий ссылку на образ из Azure Compute Gallery сообщества.

id

string

Относительный URI, содержащий ссылку на образ из репозитория образов платформы, пользовательский образ или образ Azure Compute Gallery.

shared_gallery_image_id

string

Относительный URI, содержащий прямую ссылку на образ из общей Azure Compute Gallery.

image_reference

dictionary

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

community_gallery_image_id

string

Относительный URI, содержащий ссылку на образ из Azure Compute Gallery сообщества.

id

string

Относительный URI, содержащий ссылку на образ из репозитория образов платформы, пользовательский образ или образ Azure Compute Gallery.

shared_gallery_image_id

string

Относительный URI, содержащий прямую ссылку на образ из общей Azure Compute Gallery.

location

string

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

log_mode

string

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

log_path

string

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

logical_sector_size

integer

Размер логического сектора в байтах для дисков Ultra.

Поддерживаемые значения: 512 и 4096. Значение по умолчанию — 4096.

lun

integer

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

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

managed_by

string

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

Чтобы отключить диск от виртуальной машины, явно задайте значение ‘’.

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

managed_by_extended

list / elements=dictionary

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

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

name

string

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

resource_group

string

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

max_shares

integer

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

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

name

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

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

network_access_policy

string

Политика доступа к диску по сети.

Варианты:

• "AllowAll"
• "AllowPrivate"
• "DenyAll"

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

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

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

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

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

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

Варианты:

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

password

string

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

performance_plus

boolean

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

Этот флаг можно установить только при создании диска; после включения его нельзя отключить.

Варианты:

• false
• true

profile

string

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

public_network_access

string

Политика управления экспортом диска.

Варианты:

• "Enabled"
• "Disabled"

resource_group

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

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

secret

string

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

security_profile

dictionary

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

secure_vm_disk_encryption_set_id

string

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

security_type

string

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

Варианты:

• "TrustedLaunch"
• "ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey"
• "ConfidentialVM_DiskEncryptedWithPlatformKey"
• "ConfidentialVM_DiskEncryptedWithCustomerKey"

source_resource_id

string

Если задано create_option=copy, это идентификатор ARM исходного моментального снимка или диска.

source_uri

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

строка

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

state

строка

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

Варианты:

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

storage_account_id

строка

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

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

storage_account_type

строка

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

Если не указано, диск создается типа 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"
• "PremiumV2_LRS"
• "Premium_ZRS"
• "UltraSSD_LRS"

subscription_id

строка

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

tags

словарь

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

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

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

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

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

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

tenant

строка

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

thumbprint

строка

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

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

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

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

tier

строка

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

Можно задать только для дисков storage_account_type=Premium_LRS.

Допустимые значения: P1, P2, P3, P4, P6, P10, P15, P20, P30, P40, P50, P60, P70, P80

Дополнительные сведения об уровнях производительности дисков см. на странице https://learn.microsoft.com/en-us/azure/virtual-machines/disks-change-performance.

Не применяется к дискам Ultra.

Варианты:

• "P1"
• "P2"
• "P3"
• "P4"
• "P6"
• "P10"
• "P15"
• "P20"
• "P30"
• "P40"
• "P50"
• "P60"
• "P70"
• "P80"

upload_size_bytes

целое число

Если задано create_option=upload, это размер загружаемого содержимого, включая нижний колонтитул VHD.

Значение должно быть в диапазоне от 20972032 (20 МиБ + 512 байт для нижнего колонтитула VHD) до 35183298347520 байт (32 ТиБ + 512 байт для нижнего колонтитула VHD).

write_accelerator_enabled

логическое значение

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

Варианты:

• false
• true

x509_certificate_path

путь

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

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

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

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

zone

строка

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

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

Варианты:

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

changed

boolean

Изменился ли ресурс.

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

state

complex

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

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

create_option

string

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

Возвращается: при успехе

Пример: "copy"

disk_access_id

string

Идентификатор ARM ресурса DiskAccess для использования частных конечных точек на дисках.

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

Пример: "/subscriptions/*********/resourceGroups/myRG/providers/Microsoft.Compute/diskAccesses/diskacc"

disk_iops_read_only

integer

Общая пропускная способность (МБ/с), разрешённая для всех виртуальных машин, подключающих общий диск в режиме ReadOnly.

За одну операцию можно передать от 4 КБ до 256 КБ.

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

Пример: 200

disk_iops_read_write

integer

Количество операций ввода-вывода в секунду, разрешённое для этого диска.

Можно задать только для дисков storage_account_type=UltraSSD_LRS.

За одну операцию можно передать от 4 КБ до 256 КБ.

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

Пример: 200

disk_m_bps_read_only

integer

Общая пропускная способность (МБ/с), разрешённая для всех виртуальных машин, подключающих общий диск в режиме ReadOnly.

МБ/с означает миллионы байт в секунду; здесь МБ используется в соответствии с обозначениями ISO, основанными на степенях 10.

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

Пример: 30

disk_m_bps_read_write

integer

Пропускная способность, разрешённая для этого диска.

Можно задать только для дисков storage_account_type=UltraSSD_LRS.

За одну операцию можно передать от 4 КБ до 256 КБ.

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

Пример: 30

disk_size_gb

string

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

Возвращается: при успехе

gallery_image_reference

dictionary

Сведения об образе из коллекции.

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

Пример: "None"

id

string

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

Возвращается: при успехе

image_reference

dictionary

Сведения об источнике диска: PIR, пользовательский образ или образ из коллекции.

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

Пример: "None"

location

string

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

Возвращается: при успехе

logical_sector_size

integer

Размер логического сектора в байтах для дисков Ultra.

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

Пример: "None"

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

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

Возвращается: при успехе

network_access_policy

string

Политика доступа к диску через сеть.

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

Пример: "AllowAll"

os_type

string

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

Возвращается: при успехе

Пример: "linux"

performance_plus

boolean

Флаг целевого уровня производительности развернутого диска.

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

Пример: false

public_network_access

string

Политика управления экспортом диска.

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

Пример: "Enabled"

security_profile

complex

Сведения о безопасности ресурса.

Возвращается: при успехе

secure_vm_disk_encryption_set_id

string

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

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

Пример: "None"

security_type

string

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

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

Пример: "TrustedLaunch"

source_resource_id

string

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

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

Пример: "None"

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"}

tier

string

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

Возвращается: при успехе

Пример: "P30"

upload_size_bytes

integer

Размер загружаемого содержимого, включая нижний колонтитул VHD.

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

Пример: "None"