Модуль azure.azcollection.azure_rm_cognitivesearch — управление службой Azure Cognitive Search

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

hosting_mode

string

Применяется только к SKU standard3.

Можно задать это свойство, чтобы включить до 3 разделов высокой плотности, допускающих до 1000 индексов.

Для SKU standard3 значение должно быть ‘default’ или ‘highDensity’.

Для всех остальных SKU значение должно быть ‘default’.

Варианты:

• "default" ← (по умолчанию)
• "highDensity"

identity

string

Удостоверение ресурса.

Варианты:

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

location

string

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

log_mode

string

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

log_path

string

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

name

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

Имя службы Azure Cognitive Search.

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

Имя не может начинаться с двух дефисов или заканчиваться дефисом.

Не может содержать несколько дефисов подряд.

Длина имени должна составлять от 2 до 60 символов.

Имена служб поиска должны быть уникальными в глобальном масштабе.

После создания службы изменить её имя нельзя.

network_rule_set

list / элементы=string

Правила, определяющие сетевые способы доступа к службе Azure Cognitive Search.

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.

partition_count

integer

Количество разделов в службе поиска.

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

Значения больше 1 допустимы только для SKU уровня standard.

Для служб ‘standard3’ с hostingMode, установленным в ‘highDensity’, допустимы значения от 1 до 3.

По умолчанию: 1

password

string

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

profile

string

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

public_network_access

string

Это значение можно задать как enabled, чтобы избежать критических изменений в существующих ресурсах и шаблонах клиентов.

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

Варианты:

• "enabled" ← (по умолчанию)
• "disabled"

replica_count

integer

Количество реплик в службе поиска.

Для sku=standard значение должно быть от 1 до 12 включительно.

Для sku=basic значение должно быть от 1 до 3 включительно.

По умолчанию: 1

resource_group

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

Имя группы ресурсов в текущей подписке.

secret

string

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

sku

string

Артикул службы поиска (SKU), определяющий ценовой уровень и ограничения ёмкости.

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

Варианты:

• "free"
• "basic" ← (по умолчанию)
• "standard"
• "standard2"
• "standard3"
• "storage_optimized_l1"
• "storage_optimized_l2"

state

string

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

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

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

state

dictionary

Сведения об Azure Cognitive Search.

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

hosting_mode

string

Выбранный тип режима размещения.

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

Пример: "default"

id

string

Уникальный идентификатор, связанный с этой службой Azure Cognitive Search.

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

Пример: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

identity

dictionary

Идентификатор службы Azure Cognitive Search.

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

Пример: {"principal_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "type": "SystemAssigned"}

principal_id

string

Назначенный идентификатор.

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

Пример: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

type

string

Тип идентификатора.

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

Пример: "SystemAssigned"

location

string

Географическое расположение службы Azure Cognitive Search.

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

Пример: "West Europe"

name

string

Имя службы Azure Cognitive Search.

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

Пример: "myazuresearch"

network_rule_set

list / elements=string

Правила сети, определяющие способы доступа к службе Azure Cognitive Search.

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

Пример: ["1.1.1.1", "8.8.8.8/31"]

partition_count

integer

Количество разделов в службе Azure Cognitive Search.

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

Пример: 3

provisioning_state

string

Состояние подготовки службы Azure Cognitive Search.

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

Пример: "succeeded"

public_network_access

string

Разрешен ли трафик через общедоступный интерфейс.

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

Пример: "enabled"

replica_count

integer

Количество реплик в службе Azure Cognitive Search.

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

Пример: 3

sku

string

SKU службы Azure Cognitive Search.

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

Пример: "standard"

status

string

Состояние службы Azure Cognitive Search.

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

Пример: "Active running"

tags

dictionary

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

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

Пример: {"tag1": "abc"}