Partilhar via


@azure/arm-search package

Classes

SearchManagementClient

Interfaces

AdminKeyResult

Resposta que contém as chaves de API de administração primária e secundária para um determinado serviço de Pesquisa Cognitiva do Azure.

AdminKeys

Interface que representa um AdminKeys.

AdminKeysGetOptionalParams

Parâmetros opcionais.

AdminKeysRegenerateOptionalParams

Parâmetros opcionais.

AsyncOperationResult

Os detalhes de uma operação de recurso de link privado compartilhado assíncrono de longa duração

CheckNameAvailabilityInput

Entrada da API de disponibilidade de nome de verificação.

CheckNameAvailabilityOutput

Saída da API de disponibilidade de nome de verificação.

CloudError

Contém informações sobre um erro de API.

CloudErrorBody

Descreve um erro de API específico com um código de erro e uma mensagem.

DataPlaneAadOrApiKeyAuthOption

Indica que a chave de API ou um token de acesso do Azure Ative Directory pode ser usado para autenticação.

DataPlaneAuthOptions

Define as opções de como a API do plano de dados de um serviço de Pesquisa autentica solicitações. Isso não pode ser definido se 'disableLocalAuth' estiver definido como true.

EncryptionWithCmk

Descreve uma política que determina como os recursos dentro do serviço de pesquisa devem ser criptografados com Chaves Gerenciadas pelo Cliente.

Identity

Identidade do recurso.

IpRule

A regra de restrição de IP do serviço de Pesquisa Cognitiva do Azure.

ListQueryKeysResult

Resposta que contém as chaves da API de consulta para um determinado serviço de Pesquisa Cognitiva do Azure.

NetworkRuleSet

Regras específicas de rede que determinam como o serviço de Pesquisa Cognitiva do Azure pode ser alcançado.

Operation

Descreve uma operação da API REST.

OperationDisplay

O objeto que descreve a operação.

OperationListResult

O resultado da solicitação para listar operações da API REST. Ele contém uma lista de operações e uma URL para obter o próximo conjunto de resultados.

Operations

Interface que representa uma Operação.

OperationsListOptionalParams

Parâmetros opcionais.

PrivateEndpointConnection

Descreve uma conexão de Ponto de Extremidade Privado existente com o serviço de Pesquisa Cognitiva do Azure.

PrivateEndpointConnectionListResult

Resposta contendo uma lista de conexões de Ponto Final Privado.

PrivateEndpointConnectionProperties

Descreve as propriedades de uma conexão de Ponto de Extremidade Privado existente com o serviço de Pesquisa Cognitiva do Azure.

PrivateEndpointConnectionPropertiesPrivateEndpoint

O recurso de ponto de extremidade privado do provedor Microsoft.Network.

PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState

Descreve o estado atual de uma conexão existente do Serviço de Link Privado com o Ponto de Extremidade Privado do Azure.

PrivateEndpointConnections

Interface que representa um PrivateEndpointConnections.

PrivateEndpointConnectionsDeleteOptionalParams

Parâmetros opcionais.

PrivateEndpointConnectionsGetOptionalParams

Parâmetros opcionais.

PrivateEndpointConnectionsListByServiceNextOptionalParams

Parâmetros opcionais.

PrivateEndpointConnectionsListByServiceOptionalParams

Parâmetros opcionais.

PrivateEndpointConnectionsUpdateOptionalParams

Parâmetros opcionais.

PrivateLinkResource

Descreve um recurso de link privado com suporte para o serviço de Pesquisa Cognitiva do Azure.

PrivateLinkResourceProperties

Descreve as propriedades de um recurso de link privado com suporte para o serviço de Pesquisa Cognitiva do Azure. Para uma determinada versão da API, isso representa os groupIds 'suportados' ao criar um recurso de link privado compartilhado.

PrivateLinkResources

Interface que representa um PrivateLinkResources.

PrivateLinkResourcesListSupportedOptionalParams

Parâmetros opcionais.

PrivateLinkResourcesResult

Resposta contendo uma lista de Recursos de Link Privado suportados.

QueryKey

Descreve uma chave de API para um determinado serviço de Pesquisa Cognitiva do Azure que tem permissões apenas para operações de consulta.

QueryKeys

Interface que representa um QueryKeys.

QueryKeysCreateOptionalParams

Parâmetros opcionais.

QueryKeysDeleteOptionalParams

Parâmetros opcionais.

QueryKeysListBySearchServiceNextOptionalParams

Parâmetros opcionais.

QueryKeysListBySearchServiceOptionalParams

Parâmetros opcionais.

QuotaUsageResult

Descreve o uso da cota para uma sku específica suportada pela Pesquisa Cognitiva do Azure.

QuotaUsageResultName

O nome da sku suportada pela Pesquisa Cognitiva do Azure.

QuotaUsagesListResult

Resposta que contém as informações de utilização da quota para todos os skus suportados do serviço de Pesquisa Cognitiva do Azure.

Resource

Campos comuns que são retornados na resposta para todos os recursos do Azure Resource Manager

SearchManagementClientOptionalParams

Parâmetros opcionais.

SearchManagementRequestOptions

Grupo de parâmetros

SearchService

Descreve um serviço de Pesquisa Cognitiva do Azure e seu estado atual.

SearchServiceListResult

Resposta que contém uma lista de serviços de Pesquisa Cognitiva do Azure.

SearchServiceUpdate

Os parâmetros usados para atualizar um serviço de Pesquisa Cognitiva do Azure.

Services

Interface que representa um Serviço.

ServicesCheckNameAvailabilityOptionalParams

Parâmetros opcionais.

ServicesCreateOrUpdateOptionalParams

Parâmetros opcionais.

ServicesDeleteOptionalParams

Parâmetros opcionais.

ServicesGetOptionalParams

Parâmetros opcionais.

ServicesListByResourceGroupNextOptionalParams

Parâmetros opcionais.

ServicesListByResourceGroupOptionalParams

Parâmetros opcionais.

ServicesListBySubscriptionNextOptionalParams

Parâmetros opcionais.

ServicesListBySubscriptionOptionalParams

Parâmetros opcionais.

ServicesUpdateOptionalParams

Parâmetros opcionais.

ShareablePrivateLinkResourceProperties

Descreve as propriedades de um tipo de recurso que foi integrado ao serviço de link privado, com suporte da Pesquisa Cognitiva do Azure.

ShareablePrivateLinkResourceType

Descreve um tipo de recurso que foi integrado ao serviço de link privado, suportado pela Pesquisa Cognitiva do Azure.

SharedPrivateLinkResource

Descreve um Recurso de Link Privado Compartilhado gerenciado pelo serviço de Pesquisa Cognitiva do Azure.

SharedPrivateLinkResourceListResult

Resposta contendo uma lista de Recursos de Link Privado Compartilhado.

SharedPrivateLinkResourceProperties

Descreve as propriedades de um Recurso de Link Privado Compartilhado existente gerenciado pelo serviço de Pesquisa Cognitiva do Azure.

SharedPrivateLinkResources

Interface que representa um SharedPrivateLinkResources.

SharedPrivateLinkResourcesCreateOrUpdateOptionalParams

Parâmetros opcionais.

SharedPrivateLinkResourcesDeleteOptionalParams

Parâmetros opcionais.

SharedPrivateLinkResourcesGetOptionalParams

Parâmetros opcionais.

SharedPrivateLinkResourcesListByServiceNextOptionalParams

Parâmetros opcionais.

SharedPrivateLinkResourcesListByServiceOptionalParams

Parâmetros opcionais.

Sku

Define a SKU de um Serviço de Pesquisa Cognitiva do Azure, que determina a camada de preço e os limites de capacidade.

TrackedResource

A definição do modelo de recursos para um recurso de nível superior rastreado do Azure Resource Manager que tem 'tags' e um 'local'

UsageBySubscriptionSkuOptionalParams

Parâmetros opcionais.

Usages

Interface que representa um Usos.

UsagesListBySubscriptionNextOptionalParams

Parâmetros opcionais.

UsagesListBySubscriptionOptionalParams

Parâmetros opcionais.

Aliases de Tipo

AadAuthFailureMode

Define valores para AadAuthFailureMode.

AdminKeyKind

Define valores para AdminKeyKind.

AdminKeysGetResponse

Contém dados de resposta para a operação get.

AdminKeysRegenerateResponse

Contém dados de resposta para a operação de regeneração.

HostingMode

Define valores para HostingMode.

IdentityType

Define valores para IdentityType.

OperationsListResponse

Contém dados de resposta para a operação de lista.

PrivateEndpointConnectionsDeleteResponse

Contém dados de resposta para a operação de exclusão.

PrivateEndpointConnectionsGetResponse

Contém dados de resposta para a operação get.

PrivateEndpointConnectionsListByServiceNextResponse

Contém dados de resposta para a operação listByServiceNext.

PrivateEndpointConnectionsListByServiceResponse

Contém dados de resposta para a operação listByService.

PrivateEndpointConnectionsUpdateResponse

Contém dados de resposta para a operação de atualização.

PrivateLinkResourcesListSupportedResponse

Contém dados de resposta para a operação listSupported.

PrivateLinkServiceConnectionProvisioningState

Define valores para PrivateLinkServiceConnectionProvisioningState.
KnownPrivateLinkServiceConnectionProvisioningState puder ser usado de forma intercambiável com PrivateLinkServiceConnectionProvisioningState, esse enum contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

Atualizando: A conexão do serviço de link privado está em processo de criação junto com outros recursos para que seja totalmente funcional.
Excluindo: A conexão do serviço de link privado está em processo de exclusão.
Falha: A conexão do serviço de link privado não pôde ser provisionada ou excluída.
bem-sucedido: A conexão de serviço de link privado terminou o provisionamento e está pronta para aprovação.
incompleto: A solicitação de provisionamento para o recurso de conexão de serviço de link privado foi aceita, mas o processo de criação ainda não começou.
cancelada: A solicitação de provisionamento para o recurso de conexão do serviço de link privado foi cancelada

PrivateLinkServiceConnectionStatus

Define valores para PrivateLinkServiceConnectionStatus.

ProvisioningState

Define valores para ProvisioningState.

PublicNetworkAccess

Define valores para PublicNetworkAccess.

QueryKeysCreateResponse

Contém dados de resposta para a operação create.

QueryKeysListBySearchServiceNextResponse

Contém dados de resposta para a operação listBySearchServiceNext.

QueryKeysListBySearchServiceResponse

Contém dados de resposta para a operação listBySearchService.

SearchEncryptionComplianceStatus

Define valores para SearchEncryptionComplianceStatus.

SearchEncryptionWithCmk

Define valores para SearchEncryptionWithCmk.

SearchSemanticSearch

Define valores para SearchSemanticSearch.
KnownSearchSemanticSearch pode ser usado de forma intercambiável com SearchSemanticSearch, esse enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

desabilitado: Indica que a pesquisa semântica está desabilitada para o serviço de pesquisa.
livre : Permite a pesquisa semântica em um serviço de pesquisa e indica que ela deve ser usada dentro dos limites da camada livre. Isso limitaria o volume de solicitações de pesquisa semântica e é oferecido sem custo extra. Este é o padrão para serviços de pesquisa recém-provisionados.
padrão: Permite a pesquisa semântica em um serviço de pesquisa como um recurso faturável, com maior taxa de transferência e volume de consultas de pesquisa semântica.

SearchServiceStatus

Define valores para SearchServiceStatus.

ServicesCheckNameAvailabilityResponse

Contém dados de resposta para a operação checkNameAvailability.

ServicesCreateOrUpdateResponse

Contém dados de resposta para a operação createOrUpdate.

ServicesGetResponse

Contém dados de resposta para a operação get.

ServicesListByResourceGroupNextResponse

Contém dados de resposta para a operação listByResourceGroupNext.

ServicesListByResourceGroupResponse

Contém dados de resposta para a operação listByResourceGroup.

ServicesListBySubscriptionNextResponse

Contém dados de resposta para a operação listBySubscriptionNext.

ServicesListBySubscriptionResponse

Contém dados de resposta para a operação listBySubscription.

ServicesUpdateResponse

Contém dados de resposta para a operação de atualização.

SharedPrivateLinkResourceAsyncOperationResult

Define valores para SharedPrivateLinkResourceAsyncOperationResult.
KnownSharedPrivateLinkResourceAsyncOperationResult pode ser usado de forma intercambiável com SharedPrivateLinkResourceAsyncOperationResult, esse enum contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

Executando
Sucedeu
Falhou

SharedPrivateLinkResourceProvisioningState

Define valores para SharedPrivateLinkResourceProvisioningState.

SharedPrivateLinkResourceStatus

Define valores para SharedPrivateLinkResourceStatus.

SharedPrivateLinkResourcesCreateOrUpdateResponse

Contém dados de resposta para a operação createOrUpdate.

SharedPrivateLinkResourcesGetResponse

Contém dados de resposta para a operação get.

SharedPrivateLinkResourcesListByServiceNextResponse

Contém dados de resposta para a operação listByServiceNext.

SharedPrivateLinkResourcesListByServiceResponse

Contém dados de resposta para a operação listByService.

SkuName

Define valores para SkuName.

UnavailableNameReason

Define valores para UnavailableNameReason.
KnownUnavailableNameReason pode ser usado de forma intercambiável com UnavailableNameReason, este enum contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

inválido: O nome do serviço de pesquisa não corresponde aos requisitos de nomenclatura.
AlreadyExists: O nome do serviço de pesquisa já está atribuído a um serviço de pesquisa diferente.

UsageBySubscriptionSkuResponse

Contém dados de resposta para a operação usageBySubscriptionSku.

UsagesListBySubscriptionNextResponse

Contém dados de resposta para a operação listBySubscriptionNext.

UsagesListBySubscriptionResponse

Contém dados de resposta para a operação listBySubscription.

Enumerações

KnownPrivateLinkServiceConnectionProvisioningState

Valores conhecidos de PrivateLinkServiceConnectionProvisioningState que o serviço aceita.

KnownSearchSemanticSearch

Os valores conhecidos de SearchSemanticSearch que o serviço aceita.

KnownSharedPrivateLinkResourceAsyncOperationResult

Os valores conhecidos de SharedPrivateLinkResourceAsyncOperationResult que o serviço aceita.

KnownUnavailableNameReason

Os valores conhecidos de UnavailableNameReason que o serviço aceita.

Funções

getContinuationToken(unknown)

Dado o último .value produzido pelo iterador byPage, retorna um token de continuação que pode ser usado para iniciar a paginação a partir desse ponto mais tarde.

Detalhes de Função

getContinuationToken(unknown)

Dado o último .value produzido pelo iterador byPage, retorna um token de continuação que pode ser usado para iniciar a paginação a partir desse ponto mais tarde.

function getContinuationToken(page: unknown): string | undefined

Parâmetros

page

unknown

Um objeto de acessar value no IteratorResult de um iterador byPage.

Devoluções

string | undefined

O token de continuação que pode ser passado para byPage() durante chamadas futuras.