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 Azure Cognitive Search.

AdminKeys

Interface que representa um AdminKeys.

AdminKeysGetOptionalParams

Parâmetros opcionais.

AdminKeysRegenerateOptionalParams

Parâmetros opcionais.

AsyncOperationResult

Os detalhes de uma operação de recursos de ligação privada partilhada assíncrona de execução prolongada

CheckNameAvailabilityInput

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

CheckNameAvailabilityOutput

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

CloudError

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

CloudErrorBody

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

DataPlaneAadOrApiKeyAuthOption

Indica que a chave de API ou um token de acesso do Azure Active Directory podem ser utilizados para autenticação.

DataPlaneAuthOptions

Define as opções de como a API do plano de dados de um Serviço de pesquisa autentica pedidos. Isto não pode ser definido se "disableLocalAuth" estiver definido como verdadeiro.

EncryptionWithCmk

Descreve uma política que determina a forma como os recursos no serviço de pesquisa devem ser encriptados com Chaves Geridas pelo Cliente.

Identity

Identidade do recurso.

IpRule

A regra de restrição de IP do serviço Azure Cognitive Search.

ListQueryKeysResult

Resposta que contém as chaves de API de consulta de um determinado serviço Azure Cognitive Search.

NetworkRuleSet

Regras específicas de rede que determinam a forma como o serviço Azure Cognitive Search pode ser alcançado.

Operation

Descreve uma operação da API REST.

OperationDisplay

O objeto que descreve a operação.

OperationListResult

O resultado do pedido para listar as operações da API REST. Contém uma lista de operações e um URL para obter o próximo conjunto de resultados.

Operations

Interface que representa uma Operação.

OperationsListOptionalParams

Parâmetros opcionais.

PrivateEndpointConnection

Descreve uma ligação de Ponto Final Privado existente ao serviço Azure Cognitive Search.

PrivateEndpointConnectionListResult

Resposta que contém uma lista de ligações de Ponto Final Privado.

PrivateEndpointConnectionProperties

Descreve as propriedades de uma ligação de Ponto Final Privado existente ao serviço Azure Cognitive Search.

PrivateEndpointConnectionPropertiesPrivateEndpoint

O recurso de ponto final privado do fornecedor Microsoft.Network.

PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState

Descreve o estado atual de uma ligação do Serviço Private Link existente ao Ponto Final 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 ligação privada suportado para o serviço Azure Cognitive Search.

PrivateLinkResourceProperties

Descreve as propriedades de um recurso de ligação privada suportado para o serviço Azure Cognitive Search. Para uma determinada versão da API, isto representa os groupIds "suportados" ao criar um recurso de ligação privada partilhado.

PrivateLinkResources

Interface que representa um PrivateLinkResources.

PrivateLinkResourcesListSupportedOptionalParams

Parâmetros opcionais.

PrivateLinkResourcesResult

Resposta que contém uma lista de Recursos Private Link suportados.

QueryKey

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

QueryKeys

Interface que representa uma QueryKeys.

QueryKeysCreateOptionalParams

Parâmetros opcionais.

QueryKeysDeleteOptionalParams

Parâmetros opcionais.

QueryKeysListBySearchServiceNextOptionalParams

Parâmetros opcionais.

QueryKeysListBySearchServiceOptionalParams

Parâmetros opcionais.

QuotaUsageResult

Descreve a utilização de quota para um SKU específico suportado pelo Azure Cognitive Search.

QuotaUsageResultName

O nome do SKU suportado pelo Azure Cognitive Search.

QuotaUsagesListResult

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

Resource

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

SearchManagementClientOptionalParams

Parâmetros opcionais.

SearchManagementRequestOptions

Grupo de parâmetros

SearchService

Descreve um serviço Azure Cognitive Search e o respetivo estado atual.

SearchServiceListResult

Resposta que contém uma lista de serviços Azure Cognitive Search.

SearchServiceUpdate

Os parâmetros utilizados para atualizar um serviço Azure Cognitive Search.

Services

Interface que representa um Serviços.

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 no serviço de ligação privada, suportado por Azure Cognitive Search.

ShareablePrivateLinkResourceType

Descreve um tipo de recurso que foi integrado no serviço de ligação privada, suportado por Azure Cognitive Search.

SharedPrivateLinkResource

Descreve um Recurso de Private Link Partilhado gerido pelo serviço Azure Cognitive Search.

SharedPrivateLinkResourceListResult

Resposta que contém uma lista de Recursos de Private Link Partilhados.

SharedPrivateLinkResourceProperties

Descreve as propriedades de um Recurso de Private Link Partilhado existente gerido pelo serviço Azure Cognitive Search.

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 o SKU de um Serviço Azure Cognitive Search, que determina o escalão de preço e os limites de capacidade.

TrackedResource

A definição do modelo de recurso para um recurso de nível superior controlado do Azure Resource Manager que tem "etiquetas" e uma "localização"

UsageBySubscriptionSkuOptionalParams

Parâmetros opcionais.

Usages

Interface que representa uma Utilização.

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 eliminaçã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 pode ser utilizado alternadamente com PrivateLinkServiceConnectionProvisioningState. Esta enumeração contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

Atualização: a ligação do serviço de ligação privada está a ser criada juntamente com outros recursos para que esteja totalmente funcional.
A eliminar: a ligação do serviço de ligação privada está a ser eliminada.
Falha: a ligação do serviço de ligação privada não foi aprovisionada ou eliminada.
Com êxito: a ligação do serviço de ligação privada terminou o aprovisionamento e está pronta para aprovação.
Incompleto: o pedido de aprovisionamento do recurso de ligação do serviço de ligação privada foi aceite, mas o processo de criação ainda não começou.
Cancelado: o pedido de aprovisionamento para o recurso de ligação do serviço de ligação de ligação privada foi cancelado

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 de criação.

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 utilizado alternadamente com SearchSemanticSearch. Esta enumeração contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

desativado: indica que a pesquisa semântica está desativada para o serviço de pesquisa.
gratuito: ativa a pesquisa semântica num serviço de pesquisa e indica que deve ser utilizada dentro dos limites do escalão gratuito. Isto limitaria o volume de pedidos de pesquisa semântica e é oferecido sem custos adicionais. Esta é a predefinição para serviços de pesquisa recentemente aprovisionados.
padrão: ativa a pesquisa semântica num serviço de pesquisa como uma funcionalidade faturável, com maior débito 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 utilizado alternadamente com SharedPrivateLinkResourceAsyncOperationResult. Este enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

Em execução
Com êxito
Com falhas

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 utilizado alternadamente com UnavailableNameReason. Esta 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

Valores conhecidos de SearchSemanticSearch que o serviço aceita.

KnownSharedPrivateLinkResourceAsyncOperationResult

Valores conhecidos de SharedPrivateLinkResourceAsyncOperationResult que o serviço aceita.

KnownUnavailableNameReason

Valores conhecidos de UnavailableNameReason que o serviço aceita.

Funções

getContinuationToken(unknown)

Dado o último .value produzido pelo byPage iterador, devolve um token de continuação que pode ser utilizado para começar a paginar a partir desse ponto mais tarde.

Detalhes de Função

getContinuationToken(unknown)

Dado o último .value produzido pelo byPage iterador, devolve um token de continuação que pode ser utilizado para começar a paginar a partir desse ponto mais tarde.

function getContinuationToken(page: unknown): string | undefined

Parâmetros

page

unknown

Um objeto a value partir do acesso no IteratorResult a partir de um byPage iterador.

Devoluções

string | undefined

O token de continuação que pode ser transmitido porPage() durante futuras chamadas.