Compartilhar via


@azure/arm-search package

Classes

SearchManagementClient

Interfaces

AdminKeyResult

Resposta que contém as chaves de API de administração primárias e secundárias para um determinado serviço de 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 recurso de link privado compartilhado assíncrono de execução prolongada

CheckNameAvailabilityInput

Entrada de marcar API de disponibilidade de nome.

CheckNameAvailabilityOutput

Saída de marcar API de disponibilidade de nome.

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 Active Directory pode ser usado para autenticação.

DataPlaneAuthOptions

Define as opções de como a API do plano de dados de um serviço Pesquisa autentica solicitações. Isso não poderá 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 Azure Cognitive Search.

ListQueryKeysResult

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

NetworkRuleSet

Regras específicas de rede que determinam como o serviço de Azure Cognitive Search pode ser atingido.

Operation

Descreve uma operação da API REST.

OperationDisplay

O objeto que descreve a operação.

OperationListResult

O resultado da solicitação para listar as 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 operações.

OperationsListOptionalParams

Parâmetros opcionais.

PrivateEndpointConnection

Descreve uma conexão de ponto de extremidade privado existente com o serviço Azure Cognitive Search.

PrivateEndpointConnectionListResult

Resposta que contém uma lista de conexões de ponto de extremidade privado.

PrivateEndpointConnectionProperties

Descreve as propriedades de uma conexão de ponto de extremidade privado existente com o serviço Azure Cognitive Search.

PrivateEndpointConnectionPropertiesPrivateEndpoint

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

PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState

Descreve o estado atual de uma conexão de serviço Link Privado existente 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 Azure Cognitive Search.

PrivateLinkResourceProperties

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

PrivateLinkResources

Interface que representa um PrivateLinkResources.

PrivateLinkResourcesListSupportedOptionalParams

Parâmetros opcionais.

PrivateLinkResourcesResult

Resposta que contém uma lista de recursos de Link Privado com suporte.

QueryKey

Descreve uma chave de API para um determinado serviço de Azure Cognitive Search 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 de cota para um determinado sku compatível com Azure Cognitive Search.

QuotaUsageResultName

O nome do sku compatível com Azure Cognitive Search.

QuotaUsagesListResult

Resposta que contém as informações de uso de cota para todos os skus com suporte do serviço Azure Cognitive Search.

Resource

Campos comuns 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 Azure Cognitive Search e seu estado atual.

SearchServiceListResult

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

SearchServiceUpdate

Os parâmetros usados 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 ao serviço de link privado, compatível com Azure Cognitive Search.

ShareablePrivateLinkResourceType

Descreve um tipo de recurso que foi integrado ao serviço de link privado, compatível com Azure Cognitive Search.

SharedPrivateLinkResource

Descreve um recurso de Link Privado compartilhado gerenciado pelo serviço Azure Cognitive Search.

SharedPrivateLinkResourceListResult

Resposta que contém uma lista de Recursos de Link Privado Compartilhados.

SharedPrivateLinkResourceProperties

Descreve as propriedades de um Recurso de Link Privado Compartilhado existente gerenciado 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 de Azure Cognitive Search, que determina os limites de capacidade e de tipo de preço.

TrackedResource

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

UsageBySubscriptionSkuOptionalParams

Parâmetros opcionais.

Usages

Interface que representa um Usages.

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 pode ser usado de forma intercambiável com PrivateLinkServiceConnectionProvisioningState, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Atualização: a conexão de serviço de link privado está em processo de criação junto com outros recursos para que ela seja totalmente funcional.
Excluindo: a conexão do serviço de link privado está em processo de exclusão.
Falha: falha ao provisionar ou excluir a conexão do serviço de link privado.
Êxito: a conexão do 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.
Cancelado: a solicitação de provisionamento para o recurso de conexão de 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 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 usado de forma intercambiável com SearchSemanticSearch. Essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

desabilitado: indica que a pesquisa semântica está desabilitada para o serviço de pesquisa.
free: habilita a pesquisa semântica em um serviço de pesquisa e indica que ela deve ser usada dentro dos limites da camada gratuita. Isso limitaria o volume de solicitações de pesquisa semântica e é oferecido sem custo adicional. Esse é o padrão para serviços de pesquisa provisionados recentemente.
padrão: habilita 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, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Executando
Êxito
Com falha

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 intercambiável com UnavailableNameReason, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o 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, retorna um token de continuação que pode ser usado para iniciar a paginação a partir desse ponto mais tarde.

Detalhes da função

getContinuationToken(unknown)

Dado o último .value produzido pelo byPage iterador, 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 acesso value no IteratorResult de um byPage iterador.

Retornos

string | undefined

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