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

ad_user

string

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

adfs_authority_url

string

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

URL-адрес центра Azure AD. Используйте при аутентификации по имени пользователя и паролю, если у вас есть собственный центр ADFS.

administrator_login

string

Имя пользователя администратора для управляемого экземпляра.

Можно указать только при создании управляемого экземпляра (для создания параметр обязателен).

administrator_login_password

string

Пароль для входа администратора (обязателен при создании управляемого экземпляра).

administrators

string

Администратор сервера в Azure Active Directory.

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"

collation

string

Параметры сортировки управляемого экземпляра.

disable_instance_discovery

boolean

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

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

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

Варианты:

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

dns_zone

string

Зона DNS, в которой находится управляемый экземпляр.

dns_zone_partner

string

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

identity

dictionary

Удостоверение объекта

type

string

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

Варианты:

• "SystemAssigned"
• "UserAssigned"
• "SystemAssigned, UserAssigned"
• "None" ← (по умолчанию)

user_assigned_identities

dictionary

Назначенные пользователем управляемые удостоверения и их параметры

По умолчанию: {}

append

boolean

Следует ли добавить список удостоверений к текущим удостоверениям (true) или заменить текущие удостоверения (false)

Варианты:

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

id

list / elements=string

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

По умолчанию: []

instance_pool_id

string

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

key_id

string

URI ключа CMK, используемого для шифрования.

license_type

string

Тип лицензии.

Возможные значения: LicenseIncluded и BasePrice.

Льготная цена AHB при использовании собственных лицензий SQL.

Обычная цена, включающая новую лицензию SQL.

Варианты:

• "LicenseIncluded"
• "BasePrice"

location

string

Расположение управляемого экземпляра SQL.

log_mode

string

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

log_path

string

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

maintenance_configuration_id

string

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

managed_instance_create_mode

string

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

minimal_tls_version

string

Минимальная версия TLS. Допустимые значения: None, 1.0, 1.1, 1.2.

Варианты:

• "None"
• "1.0"
• "1.1"
• "1.2"

name

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

Имя управляемого экземпляра SQL.

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

primary_user_assigned_identity_id

string

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

private_endpoint_connections

list / elements=string

Список подключений к частным конечным точкам управляемого экземпляра.

profile

string

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

proxy_override

string

Тип подключения к экземпляру.

Варианты:

• "Proxy"
• "Redirect"
• "Default"

public_data_endpoint_enabled

boolean

Определяет, включена ли общедоступная конечная точка данных.

Варианты:

• false
• true

resource_group

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

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

restore_point_in_time

string

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

secret

string

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

sku

dictionary

Артикул ресурса ARM.

capacity

string

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

family

string

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

name

string

Название SKU, обычно представляющее собой код из буквы и цифр.

size

string

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

tier

string

Уровень или выпуск конкретной SKU.

source_managed_instance_id

string

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

state

string

Состояние управляемого экземпляра SQL.

Используйте present для создания или обновления runbook автоматизации и absent для удаления.

Варианты:

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

storage_account_type

string

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

storage_size_in_gb

integer

Объем хранилища в ГБ.

Минимальное значение — 32. Максимальное значение — 8192.

Допускаются только приращения по 32 ГБ.

subnet_id

string

Идентификатор ресурса подсети для управляемого экземпляра.

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.

timezone_id

string

Идентификатор часового пояса.

Допустимые значения — часовые пояса, поддерживаемые Windows.

Сведения о поддерживаемых часовых поясах доступны в Windows.

v_cores

integer

Количество виртуальных ядер (vCore).

Варианты:

• 8
• 16
• 24
• 32
• 40
• 64
• 80

x509_certificate_path

path

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

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

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

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

zone_redundant

boolean

Включена ли поддержка нескольких зон доступности.

Варианты:

• false
• true

sql_managed_instance

complex

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

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

administrator_login

string

Имя пользователя администратора управляемого экземпляра.

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

Пример: "azureuser"

administrators

string

Администратор сервера в Azure Active Directory.

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

collation

string

Параметры сортировки управляемого экземпляра SQL.

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

Пример: "SQL_Latin1_General_CP1_CI_AS"

dns_zone

string

- Зона DNS, в которой находится управляемый экземпляр.

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

Пример: "8a23abba54cd"

dns_zone_partner

string

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

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

fully_qualified_domain_name

string

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

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

Пример: "fredsqlinstance.8a23abba54cd.database.windows.net"

id

string

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

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

Пример: "/subscription/xxx-xxx/resourceGroups/testRG/providers/Microsoft.Sql/managedInstances/fredsqlinstance"

identity

complex

Конфигурация удостоверения Azure Active Directory для ресурса.

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

principal_id

string

Идентификатор субъекта Azure Active Directory.

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

Пример: "895c-xxx-xxxbe"

tenant_id

string

Идентификатор клиента Azure Active Directory.

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

Пример: "72fxxxxx-xxxx-xxxx-xxxx-xxxxxx11db47"

type

string

Тип удостоверения.

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

Пример: "SystemAssigned"

user_assigned_identities

string

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

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

instance_pool_id

string

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

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

key_id

string

URI CMK ключа, используемого для шифрования.

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

license_type

string

Тип лицензии.

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

Пример: "LicenseIncluded"

location

string

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

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

Пример: "eastus"

maintenance_configuration_id

string

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

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

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

managed_instance_create_mode

string

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

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

minimal_tls_version

string

Минимальная версия TLS. Допустимые значения: «None», «1.0», «1.1», «1.2».

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

Пример: "1.2"

name

string

Имя управляемого экземпляра SQL.

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

Пример: "testmanagedinstance"

primary_user_assigned_identity_id

string

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

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

private_endpoint_connections

list / elements=string

Список подключений к частным конечным точкам управляемого экземпляра.

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

Пример: []

provisioning_state

string

Состояние управляемого экземпляра SQL.

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

Пример: "Successed"

proxy_override

string

Тип подключения для соединения с экземпляром.

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

Пример: "Proxy"

public_data_endpoint_enabled

boolean

Включена ли общедоступная конечная точка данных.

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

Пример: false

restore_point_in_time

string

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

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

sku

complex

Артикул ресурса ARM.

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

capacity

integer

Емкость артикула SKU.

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

Пример: 2

family

string

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

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

Пример: "Gen5"

name

string

Имя SKU.

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

Пример: "BC_Gen4_2"

size

string

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

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

tier

string

Уровень SKU.

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

Пример: "BusinessCritical"

source_managed_instance_id

string

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

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

state

string

Состояние управляемого экземпляра.

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

Пример: "Ready"

storage_account_type

string

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

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

Пример: "GRS"

storage_size_in_gb

integer

Размер хранилища в ГБ. Минимальное значение — 32. Максимальное значение — 8192.

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

Пример: 256

subnet_id

string

Идентификатор ресурса подсети для управляемого экземпляра.

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

Пример: "/subscriptions/xxx-xxxx/resourceGroups/testRG/providers/Microsoft.Network/virtualNetworks/vnet-smi/subnets/sqi_sub"

tags

dictionary

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

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

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

timezone_id

string

Идентификатор часового пояса. Допустимы часовые пояса, поддерживаемые Windows.

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

Пример: "UTC"

type

string

Тип управляемого экземпляра SQL.

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

Пример: "Microsoft.Sql/managedInstances"

v_cores

integer

Количество виртуальных ядер. Допустимые значения: 8, 16, 24, 32, 40, 64, 80.

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

Пример: 8

zone_redundant

boolean

Включена ли поддержка нескольких зон доступности.

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

Пример: false