Модуль azure.azcollection.azure_rm_sqldatabase — управление экземпляром SQL Database

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, на хост-компьютере должен быть включен модуль 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"

collation

string

Параметры сортировки базы данных. Если create_mode=default не задан, это значение игнорируется.

create_mode

string

Указывает режим создания базы данных.

default — обычное создание базы данных.

copy — создание базы данных как копии существующей базы данных.

online_secondary/non_readable_secondary — создание базы данных как (доступной для чтения или недоступной для чтения) вторичной реплики существующей базы данных.

point_in_time_restore — создание базы данных путем восстановления резервной копии существующей базы данных на определенный момент времени.

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

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

restore_long_term_retention_backup — создание базы данных путем восстановления из хранилища долгосрочного хранения.

copy, non_readable_secondary, online_secondary и restore_long_term_retention_backup не поддерживаются для выпуска data_warehouse.

Варианты:

• "copy"
• "default"
• "non_readable_secondary"
• "online_secondary"
• "point_in_time_restore"
• "recovery"
• "restore"
• "restore_long_term_retention_backup"

disable_instance_discovery

boolean

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

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

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

Варианты:

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

edition

string

(Устаревает) Выпуск базы данных. Перечисление DatabaseEditions содержит все допустимые выпуски.

Этот параметр будет объявлен устаревшим в версии 2.11; вместо него используйте sku.

Если задано это поле, нельзя задать sku.

Варианты:

• "web"
• "business"
• "basic"
• "standard"
• "premium"
• "free"
• "stretch"
• "data_warehouse"
• "system"
• "system2"

elastic_pool_name

string

Имя эластичного пула, в который входит база данных. Не поддерживается для edition=data_warehouse.

force_update

boolean

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

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

Варианты:

• false
• true

location

string

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

log_mode

string

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

log_path

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

profile

string

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

read_scale

boolean

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

Не поддерживается для edition=data_warehouse.

Варианты:

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

recovery_services_recovery_point_resource_id

string

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

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

resource_group

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

Имя группы ресурсов, содержащей ресурс. Это значение можно получить через API Azure Resource Manager или на портале.

restore_point_in_time

string

Обязательно, если задано create_mode=point_in_time_restore. Если задано create_mode=restore, значение необязательно.

Указывает момент времени (в формате ISO8601) для исходной базы данных, до которого нужно выполнить восстановление при создании новой базы данных.

Должно быть больше или равно значению earliestRestoreDate исходной базы данных.

sample_name

string

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

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

Не поддерживается для edition=data_warehouse.

Варианты:

• "adventure_works_lt"

secret

string

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

server_name

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

Имя сервера.

sku

dictionary

SKU базы данных. Перечисление DatabaseEditions содержит все допустимые SKU.

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

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

Если задано это поле, нельзя задать edition.

capacity

integer

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

family

string

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

name

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

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

size

string

Размер данного SKU.

tier

string

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

source_database_deletion_date

string

Обязательно, если задано create_mode=restore, а source_database_id содержит исходный идентификатор ресурса удаленной базы данных, который использовался до ее удаления (а не текущий идентификатор удаленной базы данных, доступной для восстановления). Указывает время удаления базы данных.

source_database_id

string

Обязательно, если не задано create_mode=default или create_mode=restore_long_term_retention_backup.

Указывает идентификатор ресурса исходной базы данных.

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

database_id

строка

Идентификатор базы данных.

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

Пример: "database_id"

id

строка

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

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

Пример: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Sql/servers/sqlcrudtest-5961/databases/t estdb"

status

строка

Состояние базы данных.

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

Пример: "Online"