@azure/arm-search package

Regra de acesso em um perfil de configuração de perímetro de segurança de rede

Propriedades da regra de acesso

Identificadores de assinatura

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

Interface que representa um AdminKeys.

Parâmetros opcionais.

Parâmetros opcionais.

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

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

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

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

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

Indica que a chave de API ou um token de acesso de um locatário da ID do Microsoft Entra pode ser usado para autenticação.

Define as opções de como o serviço de pesquisa autentica uma solicitação de plano de dados. Isso não poderá ser definido se 'disableLocalAuth' estiver definido como true.

Descreve uma política que determina como os recursos dentro do serviço de pesquisa devem ser criptografados com chaves gerenciadas pelo cliente.

Detalhes sobre a identidade do serviço de pesquisa. Um valor nulo indica que o serviço de pesquisa não tem nenhuma identidade atribuída.

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

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

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

Informações sobre um NSP (perímetro de segurança de rede)

Recurso de configuração do NSP (perímetro de segurança de rede)

Resultado de uma solicitação de configurações de NSP (perímetro de segurança de rede) de lista.

Propriedades de configuração de segurança de rede.

Interface que representa um NetworkSecurityPerimeterConfigurations.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Define cabeçalhos para NetworkSecurityPerimeterConfigurations_reconcile operação.

Parâmetros opcionais.

Perfil de configuração de perímetro de segurança de rede

Detalhes de uma operação de API REST, retornada da API de Operações do Provedor de Recursos

Informações de exibição localizadas para esta operação específica.

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.

Interface que representa uma operação.

Parâmetros opcionais.

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

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

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

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

Descreve o estado atual de uma conexão de serviço de Link Privado do Azure existente com o ponto de extremidade privado.

Interface que representa um PrivateEndpointConnections.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Descreve um recurso de link privado com suporte para o serviço Azure AI Search.

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

Interface que representa um PrivateLinkResources.

Parâmetros opcionais.

Resposta que contém uma lista de recursos de link privado com suporte.

Descreve um problema de provisionamento para uma configuração de perímetro de segurança de rede

Detalhes de um problema de provisionamento para uma configuração de perímetro de segurança de rede (NSP). Os provedores de recursos devem gerar elementos de problema de provisionamento separados para cada problema separado detectado e incluir uma descrição significativa e distinta, bem como as sugestões apropriadasResourceIds e suggestedAccessRules

A definição do modelo de recurso para um recurso proxy do Azure Resource Manager. Ele não terá marcas e um local

Descreve uma chave de API para um determinado serviço do Azure AI Search que transmite permissões somente leitura na coleção docs de um índice.

Interface que representa um QueryKeys.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Descreve o uso de cota para um SKU específico.

O nome da SKU compatível com o Azure AI Search.

Resposta que contém as informações de uso de cota para todos os SKUs compatíveis do Azure AI Search.

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

Informações sobre associação de recursos

Parâmetros opcionais.

Grupo de parâmetros

Descreve um serviço do Azure AI Search e seu estado atual.

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

Os parâmetros usados para atualizar um serviço do Azure AI Search.

Interface que representa um Serviços.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Define cabeçalhos para Services_upgrade operação.

Parâmetros opcionais.

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

Descreve um tipo de recurso que foi integrado ao serviço de link privado, com suporte do Azure AI Search.

Descreve um recurso de link privado compartilhado gerenciado pelo serviço Azure AI Search.

Resposta que contém uma lista de recursos de link privado compartilhados.

Descreve as propriedades de um recurso de link privado compartilhado existente gerenciado pelo serviço Azure AI Search.

Interface que representa um SharedPrivateLinkResources.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Parâmetros opcionais.

Define a SKU de um serviço de pesquisa, que determina a taxa de cobrança e os limites de capacidade.

Metadados relativos à criação e última modificação do recurso.

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

Parâmetros opcionais.

Interface que representa um Usos.

Parâmetros opcionais.

Parâmetros opcionais.

Propriedades de identidade atribuídas pelo usuário

Define valores para AadAuthFailureMode.

Define valores para AccessRuleDirection.
KnownAccessRuleDirection pode ser usado de forma intercambiável com AccessRuleDirection, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

de entrada: aplica-se ao tráfego de rede de entrada aos recursos protegidos.
de saída: aplica-se ao tráfego de rede de saída dos recursos protegidos

Define valores para ActionType.
KnownActionType pode ser usado de forma intercambiável com ActionType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Internal

Define valores para AdminKeyKind.

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

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

Define valores para ComputeType.
KnownComputeType pode ser usado de forma intercambiável com ComputeType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

default: crie o serviço com a computação padrão.
confidential: crie o serviço com a Computação Confidencial do Azure.

Define valores para CreatedByType.
KnownCreatedByType pode ser usado de forma intercambiável com CreatedByType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

User
Application
ManagedIdentity
Key

Define valores para HostingMode.

Define valores para IdentityType.
KnownIdentityType pode ser usado de forma intercambiável com IdentityType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Nenhum: indica que qualquer identidade associada ao serviço de pesquisa precisa ser removida.
SystemAssigned: indica que a identidade atribuída pelo sistema para o serviço de pesquisa será habilitada.
UserAssigned: indica que uma ou mais identidades atribuídas pelo usuário serão atribuídas ao serviço de pesquisa.
SystemAssigned, UserAssigned: indica que a identidade atribuída pelo sistema para o serviço de pesquisa será habilitada junto com a atribuição de uma ou mais identidades atribuídas pelo usuário.

Define valores para IssueType.
KnownIssueType pode ser usado de forma intercambiável com IssueType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Desconhecido: tipo de problema desconhecido
ConfigurationPropagationFailure: ocorreu um erro ao aplicar a configuração de NSP (perímetro de segurança de rede).
MissingPerimeterConfiguration: um problema de conectividade de rede está acontecendo no recurso que pode ser resolvido adicionando novos recursos ao NSP (perímetro de segurança de rede) ou modificando as regras de acesso.
MissingIdentityConfiguration: uma identidade gerenciada não foi associada ao recurso. O recurso ainda poderá validar o tráfego de entrada do NSP (perímetro de segurança de rede) ou as regras de acesso de entrada correspondentes, mas não poderá executar o acesso de saída como membro do NSP.

Define valores para NetworkSecurityPerimeterConfigurationProvisioningState.
KnownNetworkSecurityPerimeterConfigurationProvisioningState pode ser usado de forma intercambiável com NetworkSecurityPerimeterConfigurationProvisioningState, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Succeeded
Creating
Updating
Deleting
Accepted
Failed
Canceled

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

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

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

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

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

Define valores de Origem.
KnownOrigin pode ser usado de forma intercambiável com Origin, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

user
system
user,system

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

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

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

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

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

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

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

Atualizando: a conexão do 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.
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.
Cancelado: a solicitação de provisionamento para o recurso de conexão do serviço de link privado foi cancelada.

Define valores para PrivateLinkServiceConnectionStatus.

Define valores para ProvisioningState.

Define valores para PublicNetworkAccess.
KnownPublicNetworkAccess podem ser usados de forma intercambiável com PublicNetworkAccess, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

enabled: o serviço de pesquisa pode ser acessado a partir do tráfego originado da Internet pública.
disabled: o serviço de pesquisa não pode ser acessado pelo tráfego originado da Internet pública. O acesso só é permitido em conexões de ponto de extremidade privado aprovadas.
securedByPerimeter: as regras de configuração do perímetro de segurança de rede permitem ou não o acesso de rede pública ao recurso. Requer um perímetro de segurança de rede associado.

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

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

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

Define valores para ResourceAssociationAccessMode.
KnownResourceAssociationAccessMode pode ser usado de forma intercambiável com ResourceAssociationAccessMode, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

imposta: modo de acesso imposto – o tráfego para o recurso que falhou nas verificações de acesso está bloqueado
Learning: modo de acesso de aprendizagem – o tráfego para o recurso está habilitado para análise, mas não bloqueado
Auditoria: Modo de acesso de auditoria – o tráfego para o recurso que falha nas verificações de acesso é registrado, mas não bloqueado

Define valores para SearchBypass.
KnownSearchBypass pode ser usado de forma intercambiável com SearchBypass, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Nenhum: indica que nenhuma origem pode ignorar as regras definidas na seção 'ipRules'. Esse é o padrão.
AzureServices: indica que as solicitações originadas dos serviços confiáveis do Azure podem ignorar as regras definidas na seção 'ipRules'.

Define valores para SearchDataExfiltrationProtection.
KnownSearchDataExfiltrationProtection pode ser usado de forma intercambiável com SearchDataExfiltrationProtection, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

BlockAll: indica que todos os cenários de exfiltração de dados estão desabilitados.

Define valores para SearchEncryptionComplianceStatus.

Define valores para SearchEncryptionWithCmk.

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

disabled: indica que o reclassificador semântico está desabilitado para o serviço de pesquisa. Esse é o padrão.
free: Habilita o reclassificador semântico em um serviço de pesquisa e indica que ele deve ser usado dentro dos limites do plano gratuito. O plano gratuito limitaria o volume de solicitações de classificação semântica e é oferecido sem custo adicional. Esse é o padrão para serviços de pesquisa provisionados recentemente.
standard: habilita o reclassificador semântico em um serviço de pesquisa como um recurso faturável, com maior taxa de transferência e volume de consultas semanticamente reclassificadas.

Define valores para SearchServiceStatus.

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

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

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

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

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

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

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

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

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

Define valores para Severidade.
KnownSeverity pode ser usado de forma intercambiável com Severidade, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Warning
Error

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

Running
Succeeded
Failed

Define valores para SharedPrivateLinkResourceProvisioningState.
KnownSharedPrivateLinkResourceProvisioningState pode ser usado de forma intercambiável com SharedPrivateLinkResourceProvisioningState, 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: o recurso de link privado compartilhado está em processo de criação junto com outros recursos para que seja totalmente funcional.
Exclusão: o recurso de link privado compartilhado está em processo de exclusão.
Falha: o recurso de link privado compartilhado não foi provisionado ou excluído.
Bem-sucedido: o recurso de link privado compartilhado concluiu o provisionamento e está pronto para aprovação.
Incompleto: a solicitação de provisionamento para o recurso de link privado compartilhado foi aceita, mas o processo de criação ainda não foi iniciado.

Define valores para SharedPrivateLinkResourceStatus.
KnownSharedPrivateLinkResourceStatus pode ser usado de forma intercambiável com SharedPrivateLinkResourceStatus, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Pendente: o recurso de link privado compartilhado foi criado e está aguardando aprovação.
Aprovado: o recurso de link privado compartilhado foi aprovado e está pronto para uso.
Rejeitado: o recurso de link privado compartilhado foi rejeitado e não pode ser usado.
Desconectado: o recurso de link privado compartilhado foi removido do serviço.

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

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

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

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

Define valores para SkuName.
KnownSkuName pode ser usado de forma intercambiável com SkuName, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

gratuito: camada gratuita, sem garantias de SLA e um subconjunto dos recursos oferecidos nas camadas faturáveis.
basic: camada faturável para um serviço dedicado com até 3 réplicas.
standard: camada faturável para um serviço dedicado com até 12 partições e 12 réplicas.
standard2: semelhante ao 'standard', mas com mais capacidade por unidade de pesquisa.
standard3: a maior oferta Standard com até 12 partições e 12 réplicas (ou até 3 partições com mais índices se você também definir a propriedade hostingMode como 'highDensity').
storage_optimized_l1: camada faturável para um serviço dedicado que dá suporte a 1 TB por partição, até 12 partições.
storage_optimized_l2: camada faturável para um serviço dedicado que dá suporte a 2 TB por partição, até 12 partições.

Define valores para UnavailableNameReason.
KnownUnavailableNameReason pode ser usado de forma 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.

Define valores para UpgradeAvailable.
KnownUpgradeAvailable pode ser usado de forma intercambiável com UpgradeAvailable, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

notAvailable: no momento, não há uma atualização disponível para o serviço.
disponível: há uma atualização disponível para o serviço.

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

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

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

Valores conhecidos de AccessRuleDirection que o serviço aceita.

Valores conhecidos de ActionType que o serviço aceita.

Valores conhecidos de ComputeType que o serviço aceita.

Valores conhecidos de CreatedByType que o serviço aceita.

Valores conhecidos de IdentityType que o serviço aceita.

Valores conhecidos de IssueType que o serviço aceita.

Valores conhecidos de NetworkSecurityPerimeterConfigurationProvisioningState que o serviço aceita.

Valores conhecidos de Origin que o serviço aceita.

Valores conhecidos de PrivateLinkServiceConnectionProvisioningState que o serviço aceita.

Valores conhecidos de PublicNetworkAccess que o serviço aceita.

Valores conhecidos de ResourceAssociationAccessMode que o serviço aceita.

Valores conhecidos de SearchBypass que o serviço aceita.

Valores conhecidos de SearchDataExfiltrationProtection que o serviço aceita.

Valores conhecidos de SearchSemanticSearch que o serviço aceita.

Valores conhecidos de Severidade que o serviço aceita.

Valores conhecidos de SharedPrivateLinkResourceAsyncOperationResult que o serviço aceita.

Valores conhecidos de SharedPrivateLinkResourceProvisioningState que o serviço aceita.

Valores conhecidos de SharedPrivateLinkResourceStatus que o serviço aceita.

Valores conhecidos de SkuName que o serviço aceita.

Valores conhecidos de UnavailableNameReason que o serviço aceita.

Valores conhecidos de UpgradeAvailable que o serviço aceita.

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.