модуль azure.azcollection.azure_rm_sqlelasticpool — управление экземпляром эластичного пула SQL

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; в противном случае используется подписка Azure CLI по умолчанию.

При значении msi на компьютере узла должен быть включен модуль MSI, а сам компьютер должен быть ресурсом Azure. Для определения идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, можно использовать 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

license_type

string

Тип лицензии, применяемый к этому эластичному пулу.

Варианты:

• "LicenseIncluded" ← (по умолчанию)
• "BasePrice"

location

string

Расположение ресурса. Если не задано, по умолчанию используется расположение группы ресурсов.

log_mode

string

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

log_path

string

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

maintenance_configuration_id

string

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

max_size_bytes

string

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

Если create_mode=default не задан, это значение игнорируется.

Чтобы узнать возможные значения, запросите API возможностей (/subscriptions/{subscriptionId}/providers/Microsoft.Sql/locations/{locationID}/capabilities), соответствующий operationId:’Capabilities_ListByLocation’.

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

per_elasticpool_settings

dictionary

Настройки отдельных баз данных эластичного пула.

max_capacity

float

Максимальная гарантированная емкость для всех баз данных.

min_capacity

float

Минимальная гарантированная емкость для всех баз данных.

profile

string

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

resource_group

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

Имя группы ресурсов, содержащей ресурс.

Это значение можно получить через API Azure Resource Manager или на портале.

secret

string

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

server_name

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

Имя сервера.

sku

dictionary

SKU эластичного пула. Перечисление Elastic PoolEditions содержит все допустимые SKU.

capacity

integer

Емкость указанного SKU.

family

string

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

name

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

Имя SKU эластичного пула, обычно код из буквы и цифры, например P3.

size

string

Размер указанного SKU.

tier

string

Уровень или выпуск указанного SKU, например Basic, Premium.

state

string

Задайте требуемое состояние эластичного пула SQL. Используйте present для создания или обновления эластичного пула SQL и 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, используемому для создания субъекта-службы.

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

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

zone_redundant

boolean

Используется ли для этого эластичного пула зональное резервирование? Это означает, что реплики пула будут распределены между несколькими зонами доступности.

Варианты:

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

elastic_pool

complex

Список словарей, содержащих сведения о пуле эластичных баз данных SQL.

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

id

string

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

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

Пример: "/subscriptions/xxx-xxx/resourceGroups/testrg/providers/Microsoft.Sql/servers/sqlsrvfredsqldb/elasticPools/fedelastic01"

license_type

string

Тип лицензии, применяемой к этому пулу эластичных баз данных.

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

Пример: "LicenseIncluded"

location

string

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

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

Пример: "eastus"

maintenance_configuration_id

string

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

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

Пример: "/subscriptions/xxx-xxx/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/SQL_Default"

max_size_bytes

string

Ограничение объёма хранилища для пула эластичных баз данных в байтах.

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

Пример: "34359738368"

name

string

Имя пула эластичных баз данных.

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

Пример: "testEP"

per_database_settings

complex

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

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

max_capacity

float

Максимальная ёмкость, которую может использовать одна база данных.

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

Пример: 2.0

min_capacity

float

Минимальная ёмкость, гарантированная для всех баз данных.

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

Пример: 0.0

sku

complex

Название и уровень SKU.

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

capacity

integer

Ёмкость SKU.

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

Пример: 2

family

string

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

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

Пример: "Gen5"

name

string

Название SKU.

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

Пример: "GP_Gen5"

size

string

Размер конкретной SKU.

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

tier

string

Уровень SKU.

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

Пример: "GeneralPurpose"

tags

dictionary

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

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

Пример: {"taga": "aaa", "tagb": "bbb"}

zone_redundant

boolean

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

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

Пример: true