Модуль azure.azcollection.azure_rm_cognitivesearch_info — получение сведений о службе 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"

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"

disable_instance_discovery

boolean

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

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

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

Варианты:

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

log_mode

string

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

log_path

string

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

name

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.

password

string

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

profile

string

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

resource_group

string

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

secret

string

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

show_keys

boolean

Получить ключи администратора и запросов.

Варианты:

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

subscription_id

string

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

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

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

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

search

list / elements=string

Сведения об 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"

keys

dictionary

Ключи администратора и запросов для службы Azure Cognitive Search.

Это возвращаемое значение устарело и будет удалено в одном из выпусков после 2027-05-01. Вместо него используйте search_keys.

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

admin_primary

string

Первичный ключ администратора для службы Azure Cognitive Search.

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

Пример: "12345ABCDE67890FGHIJ123ABC456DEF"

admin_secondary

string

Вторичный ключ администратора для службы Azure Cognitive Search.

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

Пример: "12345ABCDE67890FGHIJ123ABC456DEF"

query

list / elements=string

Список ключей запросов для службы Azure Cognitive Search.

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

Пример: [{"key": "12345ABCDE67890FGHIJ123ABC456DEF", "name": "Query key"}]

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

search_keys

dictionary

Ключи администратора и запросов для службы Azure Cognitive Search.

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

admin_primary

string

Первичный ключ администратора для службы Azure Cognitive Search.

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

Пример: "12345ABCDE67890FGHIJ123ABC456DEF"

admin_secondary

string

Вторичный ключ администратора для службы Azure Cognitive Search.

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

Пример: "12345ABCDE67890FGHIJ123ABC456DEF"

query

list / elements=string

Список ключей запросов для службы Azure Cognitive Search.

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

Пример: [{"key": "12345ABCDE67890FGHIJ123ABC456DEF", "name": "Query key"}]

sku

string

Артикул службы Azure Cognitive Search.

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

Пример: "standard"

status

string

Состояние Azure Cognitive Search.

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

Пример: "Active running"

tags

dictionary

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

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

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