Services - Get

Referência

Serviço:: Search Management

Versão da API:: 2024-03-01-preview

Obtém o serviço de pesquisa com o nome fornecido no grupo de recursos fornecido.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}?api-version=2024-03-01-preview

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos na assinatura atual. Você pode obter esse valor por meio da API do Gerenciador de Recursos do Azure ou por meio do portal.
searchServiceName	path	True	string	O nome da IA do Azure serviço Pesquisa associado ao grupo de recursos especificado. Padrão Regex: `^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$`
subscriptionId	path	True	string	O identificador exclusivo para uma assinatura do Microsoft Azure. Você pode obter esse valor por meio da API do Gerenciador de Recursos do Azure ou por meio do portal.
api-version	query	True	string	A versão da API a ser usada para cada solicitação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
x-ms-client-request-id		string uuid	Um valor de GUID gerado pelo cliente que identifica esta solicitação. Se especificado, isso será incluído nas informações de resposta como uma maneira de acompanhar a solicitação.

Respostas

Nome	Tipo	Description
200 OK	SearchService	A definição do serviço de pesquisa foi recuperada com êxito e está na resposta. Se você estiver sondando a conclusão de uma operação de provisionamento ou escala, poderá marcar sua status por meio da propriedade provisioningState.
Other Status Codes	CloudError	HTTP 404 (Não encontrado): não foi possível encontrar a assinatura, o grupo de recursos ou o nome do serviço de pesquisa.

Segurança

azure_auth

Especifica um fluxo de concessão implícito, conforme suportado na plataforma do Microsoft Identity.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

SearchGetService

Solicitação de exemplo

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2024-03-01-preview

from azure.identity import DefaultAzureCredential
from azure.mgmt.search import SearchManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-search
# USAGE
    python search_get_service.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = SearchManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.services.get(
        resource_group_name="rg1",
        search_service_name="mysearchservice",
    )
    print(response)


# x-ms-original-file: specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/SearchGetService.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armsearch_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/search/armsearch"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/cf5ad1932d00c7d15497705ad6b71171d3d68b1e/specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/SearchGetService.json
func ExampleServicesClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsearch.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewServicesClient().Get(ctx, "rg1", "mysearchservice", &armsearch.SearchManagementRequestOptions{ClientRequestID: nil}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Service = armsearch.Service{
	// 	Name: to.Ptr("mysearchservice"),
	// 	Type: to.Ptr("Microsoft.Search/searchServices"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice"),
	// 	Location: to.Ptr("westus"),
	// 	Tags: map[string]*string{
	// 		"app-name": to.Ptr("My e-commerce app"),
	// 	},
	// 	Properties: &armsearch.ServiceProperties{
	// 		AuthOptions: &armsearch.DataPlaneAuthOptions{
	// 			APIKeyOnly: map[string]any{
	// 			},
	// 		},
	// 		DisableLocalAuth: to.Ptr(false),
	// 		DisabledDataExfiltrationOptions: []*armsearch.SearchDisabledDataExfiltrationOption{
	// 		},
	// 		EncryptionWithCmk: &armsearch.EncryptionWithCmk{
	// 			EncryptionComplianceStatus: to.Ptr(armsearch.SearchEncryptionComplianceStatusCompliant),
	// 			Enforcement: to.Ptr(armsearch.SearchEncryptionWithCmkUnspecified),
	// 		},
	// 		HostingMode: to.Ptr(armsearch.HostingModeDefault),
	// 		NetworkRuleSet: &armsearch.NetworkRuleSet{
	// 			Bypass: to.Ptr(armsearch.SearchBypassNone),
	// 			IPRules: []*armsearch.IPRule{
	// 			},
	// 		},
	// 		PartitionCount: to.Ptr[int32](1),
	// 		PrivateEndpointConnections: []*armsearch.PrivateEndpointConnection{
	// 		},
	// 		ProvisioningState: to.Ptr(armsearch.ProvisioningStateSucceeded),
	// 		PublicNetworkAccess: to.Ptr(armsearch.PublicNetworkAccessEnabled),
	// 		ReplicaCount: to.Ptr[int32](3),
	// 		SharedPrivateLinkResources: []*armsearch.SharedPrivateLinkResource{
	// 		},
	// 		Status: to.Ptr(armsearch.SearchServiceStatusRunning),
	// 		StatusDetails: to.Ptr(""),
	// 	},
	// 	SKU: &armsearch.SKU{
	// 		Name: to.Ptr(armsearch.SKUNameStandard),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { SearchManagementClient } = require("@azure/arm-search");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets the search service with the given name in the given resource group.
 *
 * @summary Gets the search service with the given name in the given resource group.
 * x-ms-original-file: specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/SearchGetService.json
 */
async function searchGetService() {
  const subscriptionId = process.env["SEARCH_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["SEARCH_RESOURCE_GROUP"] || "rg1";
  const searchServiceName = "mysearchservice";
  const credential = new DefaultAzureCredential();
  const client = new SearchManagementClient(credential, subscriptionId);
  const result = await client.services.get(resourceGroupName, searchServiceName);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Search.Models;
using Azure.ResourceManager.Search;

// Generated from example definition: specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/SearchGetService.json
// this example is just showing the usage of "Services_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this SearchServiceResource
SearchServiceCollection collection = resourceGroupResource.GetSearchServices();

// invoke the operation
string searchServiceName = "mysearchservice";
NullableResponse<SearchServiceResource> response = await collection.GetIfExistsAsync(searchServiceName);
SearchServiceResource result = response.HasValue ? response.Value : null;

if (result == null)
{
    Console.WriteLine($"Succeeded with null as result");
}
else
{
    // the variable result is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    SearchServiceData resourceData = result.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Resposta de exemplo

Código de status:: 200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "running",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "succeeded",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  }
}

Definições

Nome	Description
AadAuthFailureMode	Descreve qual resposta a API do plano de dados de um serviço de pesquisa enviaria para solicitações que falharam na autenticação.
ApiKeyOnly	Indica que somente a chave de API pode ser usada para autenticaçã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 de um locatário Microsoft Entra ID pode ser usado para autenticação.
DataPlaneAuthOptions	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.
EncryptionWithCmk	Descreve uma política que determina como os recursos dentro do serviço de pesquisa devem ser criptografados com chaves gerenciadas pelo cliente.
HostingMode	Aplicável somente para o SKU standard3. Você pode definir essa propriedade para habilitar até três partições de alta densidade que permitem até 1000 índices, o que é muito maior do que o máximo de índices permitidos para qualquer outro SKU. Para o SKU standard3, o valor é 'default' ou 'highDensity'. Para todos os outros SKUs, esse valor deve ser 'default'.
Identity	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.
IdentityType	O tipo de identidade usado para o recurso. O tipo "SystemAssigned, UserAssigned" inclui uma identidade criada pelo sistema e um conjunto de identidades atribuídas pelo usuário. O tipo 'None' remove todas as identidades do serviço.
IpRule	A regra de restrição de IP do serviço Pesquisa de IA do Azure.
NetworkRuleSet	Regras específicas de rede que determinam como o serviço Pesquisa de IA do Azure pode ser atingido.
PrivateEndpoint	O recurso de ponto de extremidade privado do provedor Microsoft.Network.
PrivateEndpointConnection	Descreve uma conexão de ponto de extremidade privado existente com o serviço Pesquisa de IA do Azure.
PrivateEndpointConnectionProperties	Descreve as propriedades de uma conexão de ponto de extremidade privado existente com o serviço de pesquisa.
PrivateLinkServiceConnectionProvisioningState	O estado de provisionamento da conexão do serviço de link privado. Os valores válidos são Atualização, Exclusão, Falha, Êxito, Incompleto ou Cancelado.
PrivateLinkServiceConnectionState	Descreve o estado atual de uma conexão de serviço Link Privado do Azure existente com o ponto de extremidade privado.
PrivateLinkServiceConnectionStatus	Status da conexão do serviço de link privado. Os valores válidos são Pendente, Aprovado, Rejeitado ou Desconectado.
ProvisioningState	O estado da última operação de provisionamento executada no serviço de pesquisa. O provisionamento é um estado intermediário que ocorre enquanto a capacidade de serviço está sendo estabelecida. Depois que a capacidade é configurada, provisioningState é alterado para 'bem-sucedido' ou 'falhou'. Os aplicativos cliente podem sondar o provisionamento status (o intervalo de sondagem recomendado é de 30 segundos a um minuto) usando a operação Obter Serviço de Pesquisa para ver quando uma operação é concluída. Se você estiver usando o serviço gratuito, esse valor tende a voltar como "bem-sucedido" diretamente na chamada para Criar serviço de pesquisa. Isso ocorre porque o serviço gratuito usa a capacidade que já está configurada.
PublicNetworkAccess	Esse valor pode ser definido como "habilitado" para evitar alterações interruptivas em modelos e recursos existentes do cliente. Se definido como "desabilitado", o tráfego pela interface pública não será permitido e as conexões de ponto de extremidade privado serão o método de acesso exclusivo.
SearchBypass	Possíveis origens do tráfego de entrada que podem ignorar as regras definidas na seção 'ipRules'.
SearchDisabledDataExfiltrationOption	Uma lista de cenários de exfiltração de dados que são explicitamente não permitidos para o serviço de pesquisa. Atualmente, o único valor com suporte é 'All' para desabilitar todos os cenários de exportação de dados possíveis com controles mais refinados planejados para o futuro.
SearchEncryptionComplianceStatus	Retorna o status de conformidade do serviço de pesquisa em relação a objetos não criptografados por CMK. Se um serviço tiver mais de um objeto não criptografado e a imposição estiver habilitada, o serviço será marcado como não compatível.
SearchEncryptionWithCmk	Descreve como um serviço de pesquisa deve impor a conformidade se encontrar objetos que não são criptografados com a chave gerenciada pelo cliente.
SearchSemanticSearch	Define opções que controlam a disponibilidade da pesquisa semântica. Essa configuração só é possível para determinados SKUs do Azure AI Search em determinados locais.
SearchService	Descreve um serviço Pesquisa de IA do Azure e seu estado atual.
SearchServiceStatus	O status do serviço de pesquisa. Os valores possíveis incluem: 'running': o serviço de pesquisa está em execução e nenhuma operação de provisionamento está em andamento. 'provisioning': o serviço de pesquisa está sendo provisionado ou dimensionado para cima ou para baixo. 'deleting': o serviço de pesquisa está sendo excluído. 'degradado': o serviço de pesquisa está degradado. Isso pode ocorrer quando as unidades de pesquisa subjacentes não estão íntegras. O serviço de pesquisa provavelmente está operacional, mas o desempenho pode ser lento e algumas solicitações podem ser descartadas. 'desabilitado': o serviço de pesquisa está desabilitado. Nesse estado, o serviço rejeita todas as solicitações da API. 'error': o serviço de pesquisa está em um estado de erro. 'stopped': o serviço de pesquisa está em uma assinatura desabilitada. Se o serviço estiver nos estados degradados, desabilitados ou de erro, isso significa que a equipe do Azure AI Search está investigando ativamente o problema subjacente. Serviços dedicados nesses estados ainda são passíveis de cobrança com base no número de unidades de pesquisa provisionadas.
SharedPrivateLinkResource	Descreve um recurso de link privado compartilhado gerenciado pelo serviço Pesquisa de IA do Azure.
SharedPrivateLinkResourceProperties	Descreve as propriedades de um recurso de link privado compartilhado existente gerenciado pelo serviço Pesquisa de IA do Azure.
SharedPrivateLinkResourceProvisioningState	O estado de provisionamento do recurso de link privado compartilhado. Os valores válidos são Atualização, Exclusão, Falha, Êxito ou Incompleto.
SharedPrivateLinkResourceStatus	Status do recurso de link privado compartilhado. Os valores válidos são Pendente, Aprovado, Rejeitado ou Desconectado.
Sku	Define o SKU de um serviço de pesquisa, que determina a taxa de cobrança e os limites de capacidade.
SkuName	A SKU do serviço de pesquisa. Os valores válidos incluem: 'gratuito': serviço compartilhado. 'basic': serviço dedicado com até três réplicas. 'standard': serviço dedicado com até 12 partições e 12 réplicas. 'standard2': semelhante ao padrão, mas com mais capacidade por unidade de pesquisa. 'standard3': a maior oferta Standard com até 12 partições e 12 réplicas (ou até três partições com mais índices se você também definir a propriedade hostingMode como 'highDensity'). 'storage_optimized_l1': dá suporte a 1 TB por partição, até 12 partições. 'storage_optimized_l2': dá suporte a 2 TB por partição, até 12 partições.
UserAssignedManagedIdentity	Os detalhes da identidade gerenciada atribuída pelo usuário atribuída ao serviço de pesquisa.

AadAuthFailureMode

Descreve qual resposta a API do plano de dados de um serviço de pesquisa enviaria para solicitações que falharam na autenticação.

Nome	Tipo	Description
http401WithBearerChallenge	string	Indica que as solicitações que falharam na autenticação devem ser apresentadas com um código http status 401 (Não autorizado) e apresentar um desafio de portador.
http403	string	Indica que as solicitações que falharam na autenticação devem ser apresentadas com um código HTTP status 403 (Proibido).

ApiKeyOnly

Indica que somente a chave de API pode ser usada para autenticação.

CloudError

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

Nome	Tipo	Description
error	CloudErrorBody	Descreve um erro de API específico com um código de erro e uma mensagem.
message	string	Uma breve descrição do erro que indica o que deu errado (para obter detalhes/informações de depuração, consulte a propriedade 'error.message').

CloudErrorBody

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

Nome	Tipo	Description
code	string	Um código de erro que descreve a condição de erro com mais precisão do que um código de status HTTP. Pode ser usado para lidar programaticamente com casos de erro específicos.
details	CloudErrorBody[]	Contém erros aninhados relacionados a esse erro.
message	string	Uma mensagem que descreve o erro em detalhes e fornece informações de depuração.
target	string	O destino do erro específico (por exemplo, o nome da propriedade em erro).

DataPlaneAadOrApiKeyAuthOption

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

Nome	Tipo	Description
aadAuthFailureMode	AadAuthFailureMode	Descreve qual resposta a API do plano de dados de um serviço de pesquisa enviaria para solicitações que falharam na autenticação.

DataPlaneAuthOptions

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.

Nome	Tipo	Description
aadOrApiKey	DataPlaneAadOrApiKeyAuthOption	Indica que a chave de API ou um token de acesso de um locatário Microsoft Entra ID pode ser usado para autenticação.
apiKeyOnly	ApiKeyOnly	Indica que somente a chave de API pode ser usada para autenticação.

EncryptionWithCmk

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

Nome	Tipo	Description
encryptionComplianceStatus	SearchEncryptionComplianceStatus	Retorna o status de conformidade do serviço de pesquisa em relação a objetos não criptografados por CMK. Se um serviço tiver mais de um objeto não criptografado e a imposição estiver habilitada, o serviço será marcado como não compatível.
enforcement	SearchEncryptionWithCmk	Descreve como um serviço de pesquisa deve impor a conformidade se encontrar objetos que não são criptografados com a chave gerenciada pelo cliente.

HostingMode

Aplicável somente para o SKU standard3. Você pode definir essa propriedade para habilitar até três partições de alta densidade que permitem até 1000 índices, o que é muito maior do que o máximo de índices permitidos para qualquer outro SKU. Para o SKU standard3, o valor é 'default' ou 'highDensity'. Para todos os outros SKUs, esse valor deve ser 'default'.

Nome	Tipo	Description
default	string	O limite no número de índices é determinado pelos limites padrão para o SKU.
highDensity	string	Somente aplicativo para SKU Standard3, em que o serviço de pesquisa pode ter até 1000 índices.

Identity

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.

Nome	Tipo	Description
principalId	string	A ID da entidade de segurança da identidade atribuída pelo sistema do serviço de pesquisa.
tenantId	string	A ID do locatário da identidade atribuída pelo sistema do serviço de pesquisa.
type	IdentityType	O tipo de identidade usado para o recurso. O tipo "SystemAssigned, UserAssigned" inclui uma identidade criada pelo sistema e um conjunto de identidades atribuídas pelo usuário. O tipo 'None' remove todas as identidades do serviço.
userAssignedIdentities	<string, UserAssignedManagedIdentity>	A lista de identidades de usuário associadas ao recurso. As referências de chave do dicionário de identidade do usuário serão IDs de recurso do ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

IdentityType

O tipo de identidade usado para o recurso. O tipo "SystemAssigned, UserAssigned" inclui uma identidade criada pelo sistema e um conjunto de identidades atribuídas pelo usuário. O tipo 'None' remove todas as identidades do serviço.

Nome	Tipo	Description
None	string	Indica que qualquer identidade associada ao serviço de pesquisa precisa ser removida.
SystemAssigned	string	Indica que a identidade atribuída pelo sistema para o serviço de pesquisa será habilitada.
SystemAssigned, UserAssigned	string	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.
UserAssigned	string	Indica que uma ou mais identidades atribuídas pelo usuário serão atribuídas ao serviço de pesquisa.

IpRule

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

Nome	Tipo	Description
value	string	Valor correspondente a um único endereço IPv4 (por exemplo, 123.1.2.3) ou um intervalo de IP no formato CIDR (por exemplo, 123.1.2.3/24) a ser permitido.

NetworkRuleSet

Regras específicas de rede que determinam como o serviço Pesquisa de IA do Azure pode ser atingido.

Nome	Tipo	Description
bypass	SearchBypass	Possíveis origens do tráfego de entrada que podem ignorar as regras definidas na seção 'ipRules'.
ipRules	IpRule[]	Uma lista de regras de restrição de IP que define a(s) rede(s) de entrada com a permissão de acesso ao ponto de extremidade de serviço de pesquisa. Enquanto isso, todas as outras redes DE IP públicas são bloqueadas pelo firewall. Essas regras de restrição são aplicadas somente quando o 'publicNetworkAccess' do serviço de pesquisa está 'habilitado'; caso contrário, o tráfego pela interface pública não é permitido mesmo com nenhuma regra de IP público, e as conexões de ponto de extremidade privado seriam o método de acesso exclusivo.

PrivateEndpoint

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

Nome	Tipo	Description
id	string	A ID do recurso de ponto de extremidade privado do provedor Microsoft.Network.

PrivateEndpointConnection

Descreve uma conexão de ponto de extremidade privado existente com o serviço Pesquisa de IA do Azure.

Nome	Tipo	Description
id	string	ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	O nome do recurso
properties	PrivateEndpointConnectionProperties	Descreve as propriedades de uma conexão de ponto de extremidade privado existente com o serviço Pesquisa de IA do Azure.
type	string	Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProperties

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

Nome	Tipo	Description
groupId	string	A ID do grupo do recurso do Azure para o qual o serviço de link privado serve.
privateEndpoint	PrivateEndpoint	O recurso de ponto de extremidade privado do provedor Microsoft.Network.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Descreve o estado atual de uma conexão de serviço Link Privado do Azure existente com o ponto de extremidade privado.
provisioningState	PrivateLinkServiceConnectionProvisioningState	O estado de provisionamento da conexão do serviço de link privado. Os valores válidos são Atualização, Exclusão, Falha, Êxito, Incompleto ou Cancelado.

PrivateLinkServiceConnectionProvisioningState

O estado de provisionamento da conexão do serviço de link privado. Os valores válidos são Atualização, Exclusão, Falha, Êxito, Incompleto ou Cancelado.

Nome	Tipo	Description
Canceled	string	A solicitação de provisionamento para o recurso de conexão do serviço de link privado foi cancelada.
Deleting	string	A conexão do serviço de link privado está em processo de exclusão.
Failed	string	A conexão do serviço de link privado não foi provisionada ou excluída.
Incomplete	string	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.
Succeeded	string	A conexão do serviço de link privado terminou o provisionamento e está pronta para aprovação.
Updating	string	A conexão de serviço de link privado está no processo de ser criada junto com outros recursos para que ela seja totalmente funcional.

PrivateLinkServiceConnectionState

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

Nome	Tipo	Valor padrão	Description
actionsRequired	string	None	Uma descrição de todas as ações extras que podem ser necessárias.
description	string		A descrição do estado de conexão do serviço de link privado.
status	PrivateLinkServiceConnectionStatus		Status da conexão do serviço de link privado. Os valores válidos são Pendente, Aprovado, Rejeitado ou Desconectado.

PrivateLinkServiceConnectionStatus

Status da conexão do serviço de link privado. Os valores válidos são Pendente, Aprovado, Rejeitado ou Desconectado.

Nome	Tipo	Description
Approved	string	A conexão de ponto de extremidade privado é aprovada e está pronta para uso.
Disconnected	string	A conexão de ponto de extremidade privado foi removida do serviço.
Pending	string	A conexão de ponto de extremidade privado foi criada e está pendente de aprovação.
Rejected	string	A conexão de ponto de extremidade privado foi rejeitada e não pode ser usada.

ProvisioningState

O estado da última operação de provisionamento executada no serviço de pesquisa. O provisionamento é um estado intermediário que ocorre enquanto a capacidade de serviço está sendo estabelecida. Depois que a capacidade é configurada, provisioningState é alterado para 'bem-sucedido' ou 'falhou'. Os aplicativos cliente podem sondar o provisionamento status (o intervalo de sondagem recomendado é de 30 segundos a um minuto) usando a operação Obter Serviço de Pesquisa para ver quando uma operação é concluída. Se você estiver usando o serviço gratuito, esse valor tende a voltar como "bem-sucedido" diretamente na chamada para Criar serviço de pesquisa. Isso ocorre porque o serviço gratuito usa a capacidade que já está configurada.

Nome	Tipo	Description
failed	string	A última operação de provisionamento falhou.
provisioning	string	O serviço de pesquisa está sendo provisionado ou dimensionado para cima ou para baixo.
succeeded	string	A última operação de provisionamento foi concluída com êxito.

PublicNetworkAccess

Esse valor pode ser definido como "habilitado" para evitar alterações interruptivas em modelos e recursos existentes do cliente. Se definido como "desabilitado", o tráfego pela interface pública não será permitido e as conexões de ponto de extremidade privado serão o método de acesso exclusivo.

Nome	Tipo	Description
disabled	string	O serviço de pesquisa não está acessível a partir do tráfego proveniente da Internet pública. O acesso só é permitido em conexões de ponto de extremidade privado aprovadas.
enabled	string	O serviço de pesquisa é acessível a partir do tráfego proveniente da Internet pública.

SearchBypass

Possíveis origens do tráfego de entrada que podem ignorar as regras definidas na seção 'ipRules'.

Nome	Tipo	Description
AzurePortal	string	Indica que as solicitações originadas do portal do Azure podem ignorar as regras definidas na seção 'ipRules'.
None	string	Indica que nenhuma origem pode ignorar as regras definidas na seção 'ipRules'. Esse é o padrão.

SearchDisabledDataExfiltrationOption

Uma lista de cenários de exfiltração de dados que são explicitamente não permitidos para o serviço de pesquisa. Atualmente, o único valor com suporte é 'All' para desabilitar todos os cenários de exportação de dados possíveis com controles mais refinados planejados para o futuro.

Nome	Tipo	Description
All	string	Indica que todos os cenários de exfiltração de dados estão desabilitados.

SearchEncryptionComplianceStatus

Retorna o status de conformidade do serviço de pesquisa em relação a objetos não criptografados por CMK. Se um serviço tiver mais de um objeto não criptografado e a imposição estiver habilitada, o serviço será marcado como não compatível.

Nome	Tipo	Description
Compliant	string	Indica que o serviço de pesquisa está em conformidade, seja porque o número de objetos não criptografados por CMK é zero ou a imposição está desabilitada.
NonCompliant	string	Indica que o serviço de pesquisa tem mais de um objeto não criptografado por CMK.

SearchEncryptionWithCmk

Descreve como um serviço de pesquisa deve impor a conformidade se encontrar objetos que não são criptografados com a chave gerenciada pelo cliente.

Nome	Tipo	Description
Disabled	string	Nenhuma imposição de criptografia de chave gerenciada pelo cliente será feita. Somente a criptografia interna gerenciada pelo serviço é usada.
Enabled	string	serviço Pesquisa serão marcados como não compatíveis se um ou mais objetos não forem criptografados com uma chave gerenciada pelo cliente.
Unspecified	string	A política de imposição não é especificada explicitamente, com o comportamento sendo o mesmo que se fosse definido como 'Desabilitado'.

SearchSemanticSearch

Define opções que controlam a disponibilidade da pesquisa semântica. Essa configuração só é possível para determinados SKUs do Azure AI Search em determinados locais.

Nome	Tipo	Description
disabled	string	Indica que o reclassificador semântico está desabilitado para o serviço de pesquisa. Esse é o padrão.
free	string	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	string	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 reclassificados.

SearchService

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

Nome	Tipo	Valor padrão	Description
id	string		ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity		A identidade do recurso.
location	string		A localização geográfica em que o recurso reside
name	string		O nome do recurso
properties.authOptions	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 poderá ser definido se 'disableLocalAuth' estiver definido como true.
properties.disableLocalAuth	boolean		Quando definido como true, as chamadas para o serviço de pesquisa não terão permissão para utilizar chaves de API para autenticação. Isso não poderá ser definido como true se 'dataPlaneAuthOptions' estiver definido.
properties.disabledDataExfiltrationOptions	SearchDisabledDataExfiltrationOption[]		Uma lista de cenários de exfiltração de dados que são explicitamente não permitidos para o serviço de pesquisa. Atualmente, o único valor com suporte é 'All' para desabilitar todos os cenários de exportação de dados possíveis com controles mais refinados planejados para o futuro.
properties.eTag	string		Uma propriedade gerada pelo sistema que representa a etag do serviço que pode ser para controle de simultaneidade otimista durante as atualizações.
properties.encryptionWithCmk	EncryptionWithCmk		Especifica qualquer política relativa à criptografia de recursos (como índices) usando chaves do gerenciador de clientes em um serviço de pesquisa.
properties.hostingMode	HostingMode	default	Aplicável somente para o SKU standard3. Você pode definir essa propriedade para habilitar até três partições de alta densidade que permitem até 1000 índices, o que é muito maior do que o máximo de índices permitidos para qualquer outro SKU. Para o SKU standard3, o valor é 'default' ou 'highDensity'. Para todos os outros SKUs, esse valor deve ser 'default'.
properties.networkRuleSet	NetworkRuleSet		Regras específicas de rede que determinam como o serviço Pesquisa de IA do Azure pode ser atingido.
properties.partitionCount	integer	1	O número de partições no serviço de pesquisa; se especificado, pode ser 1, 2, 3, 4, 6 ou 12. Valores maiores que 1 são válidos apenas para SKUs padrão. Para serviços 'standard3' com hostingMode definido como 'highDensity', os valores permitidos estão entre 1 e 3.
properties.privateEndpointConnections	PrivateEndpointConnection[]		A lista de conexões de ponto de extremidade privado com o serviço Pesquisa de IA do Azure.
properties.provisioningState	ProvisioningState		O estado da última operação de provisionamento executada no serviço de pesquisa. O provisionamento é um estado intermediário que ocorre enquanto a capacidade de serviço está sendo estabelecida. Depois que a capacidade é configurada, provisioningState é alterado para 'bem-sucedido' ou 'falhou'. Os aplicativos cliente podem sondar o provisionamento status (o intervalo de sondagem recomendado é de 30 segundos a um minuto) usando a operação Obter Serviço de Pesquisa para ver quando uma operação é concluída. Se você estiver usando o serviço gratuito, esse valor tende a voltar como "bem-sucedido" diretamente na chamada para Criar serviço de pesquisa. Isso ocorre porque o serviço gratuito usa a capacidade que já está configurada.
properties.publicNetworkAccess	PublicNetworkAccess	enabled	Esse valor pode ser definido como "habilitado" para evitar alterações interruptivas em modelos e recursos existentes do cliente. Se definido como "desabilitado", o tráfego pela interface pública não será permitido e as conexões de ponto de extremidade privado serão o método de acesso exclusivo.
properties.replicaCount	integer	1	O número de réplicas no serviço de pesquisa. Se especificado, ele deve ser um valor entre 1 e 12 inclusive para SKUs padrão ou entre 1 e 3 inclusive para SKU básico.
properties.semanticSearch	SearchSemanticSearch		Define opções que controlam a disponibilidade da pesquisa semântica. Essa configuração só é possível para determinados SKUs do Azure AI Search em determinados locais.
properties.sharedPrivateLinkResources	SharedPrivateLinkResource[]		A lista de recursos de link privado compartilhado gerenciados pelo serviço Pesquisa de IA do Azure.
properties.status	SearchServiceStatus		O status do serviço de pesquisa. Os valores possíveis incluem: 'running': o serviço de pesquisa está em execução e nenhuma operação de provisionamento está em andamento. 'provisioning': o serviço de pesquisa está sendo provisionado ou dimensionado para cima ou para baixo. 'deleting': o serviço de pesquisa está sendo excluído. 'degradado': o serviço de pesquisa está degradado. Isso pode ocorrer quando as unidades de pesquisa subjacentes não estão íntegras. O serviço de pesquisa provavelmente está operacional, mas o desempenho pode ser lento e algumas solicitações podem ser descartadas. 'desabilitado': o serviço de pesquisa está desabilitado. Nesse estado, o serviço rejeita todas as solicitações da API. 'error': o serviço de pesquisa está em um estado de erro. 'stopped': o serviço de pesquisa está em uma assinatura desabilitada. Se o serviço estiver nos estados degradados, desabilitados ou de erro, isso significa que a equipe do Azure AI Search está investigando ativamente o problema subjacente. Serviços dedicados nesses estados ainda são passíveis de cobrança com base no número de unidades de pesquisa provisionadas.
properties.statusDetails	string		Os detalhes do serviço de pesquisa status.
sku	Sku		O SKU do serviço de pesquisa, que determina a faixa de preço e os limites de capacidade. Essa propriedade é necessária ao criar um novo serviço de pesquisa.
tags	object		Marcas de recurso.
type	string		Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

SearchServiceStatus

O status do serviço de pesquisa. Os valores possíveis incluem: 'running': o serviço de pesquisa está em execução e nenhuma operação de provisionamento está em andamento. 'provisioning': o serviço de pesquisa está sendo provisionado ou dimensionado para cima ou para baixo. 'deleting': o serviço de pesquisa está sendo excluído. 'degradado': o serviço de pesquisa está degradado. Isso pode ocorrer quando as unidades de pesquisa subjacentes não estão íntegras. O serviço de pesquisa provavelmente está operacional, mas o desempenho pode ser lento e algumas solicitações podem ser descartadas. 'desabilitado': o serviço de pesquisa está desabilitado. Nesse estado, o serviço rejeita todas as solicitações da API. 'error': o serviço de pesquisa está em um estado de erro. 'stopped': o serviço de pesquisa está em uma assinatura desabilitada. Se o serviço estiver nos estados degradados, desabilitados ou de erro, isso significa que a equipe do Azure AI Search está investigando ativamente o problema subjacente. Serviços dedicados nesses estados ainda são passíveis de cobrança com base no número de unidades de pesquisa provisionadas.

Nome	Tipo	Description
degraded	string	O serviço de pesquisa está degradado porque as unidades de pesquisa subjacentes não estão íntegras.
deleting	string	O serviço de pesquisa está sendo excluído.
disabled	string	O serviço de pesquisa está desabilitado e todas as solicitações de API serão rejeitadas.
error	string	O serviço de pesquisa está em estado de erro, indicando uma falha ao provisionar ou ser excluído.
provisioning	string	O serviço de pesquisa está sendo provisionado ou dimensionado para cima ou para baixo.
running	string	O serviço de pesquisa está em execução e nenhuma operação de provisionamento está em andamento.
stopped	string	O serviço de pesquisa está em uma assinatura desabilitada.

SharedPrivateLinkResource

Descreve um recurso de link privado compartilhado gerenciado pelo serviço Pesquisa de IA do Azure.

Nome	Tipo	Description
id	string	ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	O nome do recurso
properties	SharedPrivateLinkResourceProperties	Descreve as propriedades de um recurso de link privado compartilhado gerenciado pelo serviço Pesquisa de IA do Azure.
type	string	Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

SharedPrivateLinkResourceProperties

Descreve as propriedades de um recurso de link privado compartilhado existente gerenciado pelo serviço Pesquisa de IA do Azure.

Nome	Tipo	Description
groupId	string	A ID do grupo do provedor de recursos para o qual o recurso de link privado compartilhado serve.
privateLinkResourceId	string	A ID do recurso para o qual o recurso de link privado compartilhado serve.
provisioningState	SharedPrivateLinkResourceProvisioningState	O estado de provisionamento do recurso de link privado compartilhado. Os valores válidos são Atualização, Exclusão, Falha, Êxito ou Incompleto.
requestMessage	string	A mensagem para solicitar a aprovação do recurso de link privado compartilhado.
resourceRegion	string	Opcional. Pode ser usado para especificar o Azure Resource Manager local do recurso para o qual um link privado compartilhado está sendo criado. Isso só é necessário para esses recursos cuja configuração de DNS é regional (como Serviço de Kubernetes do Azure).
status	SharedPrivateLinkResourceStatus	Status do recurso de link privado compartilhado. Os valores válidos são Pendente, Aprovado, Rejeitado ou Desconectado.

SharedPrivateLinkResourceProvisioningState

O estado de provisionamento do recurso de link privado compartilhado. Os valores válidos são Atualização, Exclusão, Falha, Êxito ou Incompleto.

Nome	Tipo	Description
Deleting	string	O recurso de link privado compartilhado está em processo de exclusão.
Failed	string	O recurso de link privado compartilhado não foi provisionado ou excluído.
Incomplete	string	A solicitação de provisionamento para o recurso de link privado compartilhado foi aceita, mas o processo de criação ainda não começou.
Succeeded	string	O recurso de link privado compartilhado terminou o provisionamento e está pronto para aprovação.
Updating	string	O recurso de link privado compartilhado está no processo de ser criado junto com outros recursos para que ele seja totalmente funcional.

SharedPrivateLinkResourceStatus

Status do recurso de link privado compartilhado. Os valores válidos são Pendente, Aprovado, Rejeitado ou Desconectado.

Nome	Tipo	Description
Approved	string	O recurso de link privado compartilhado é aprovado e está pronto para uso.
Disconnected	string	O recurso de link privado compartilhado foi removido do serviço.
Pending	string	O recurso de link privado compartilhado foi criado e está aguardando aprovação.
Rejected	string	O recurso de link privado compartilhado foi rejeitado e não pode ser usado.

Sku

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

Nome	Tipo	Description
name	SkuName	A SKU do serviço de pesquisa. Os valores válidos incluem: 'gratuito': serviço compartilhado. 'basic': serviço dedicado com até três réplicas. 'standard': serviço dedicado com até 12 partições e 12 réplicas. 'standard2': semelhante ao padrão, mas com mais capacidade por unidade de pesquisa. 'standard3': a maior oferta Standard com até 12 partições e 12 réplicas (ou até três partições com mais índices se você também definir a propriedade hostingMode como 'highDensity'). 'storage_optimized_l1': dá suporte a 1 TB por partição, até 12 partições. 'storage_optimized_l2': dá suporte a 2 TB por partição, até 12 partições.

SkuName

A SKU do serviço de pesquisa. Os valores válidos incluem: 'gratuito': serviço compartilhado. 'basic': serviço dedicado com até três réplicas. 'standard': serviço dedicado com até 12 partições e 12 réplicas. 'standard2': semelhante ao padrão, mas com mais capacidade por unidade de pesquisa. 'standard3': a maior oferta Standard com até 12 partições e 12 réplicas (ou até três partições com mais índices se você também definir a propriedade hostingMode como 'highDensity'). 'storage_optimized_l1': dá suporte a 1 TB por partição, até 12 partições. 'storage_optimized_l2': dá suporte a 2 TB por partição, até 12 partições.

Nome	Tipo	Description
basic	string	Camada faturável para um serviço dedicado com até três réplicas.
free	string	Camada gratuita, sem garantias de SLA e um subconjunto dos recursos oferecidos em camadas faturáveis.
standard	string	Camada faturável para um serviço dedicado com até 12 partições e 12 réplicas.
standard2	string	Semelhante a "padrão", mas com mais capacidade por unidade de pesquisa.
standard3	string	A maior oferta Standard com até 12 partições e 12 réplicas (ou até três partições com mais índices se você também definir a propriedade hostingMode como 'highDensity').
storage_optimized_l1	string	Camada faturável para um serviço dedicado que dá suporte a 1 TB por partição, até 12 partições.
storage_optimized_l2	string	Camada faturável para um serviço dedicado que dá suporte a 2 TB por partição, até 12 partições.

UserAssignedManagedIdentity

Os detalhes da identidade gerenciada atribuída pelo usuário atribuída ao serviço de pesquisa.

Nome	Tipo	Description
clientId	string	A ID do cliente da identidade atribuída pelo usuário.
principalId	string	A ID principal da identidade atribuída pelo usuário.

Compartilhar via

Services - Get

Parâmetros de URI

Cabeçalho da solicitação

Respostas

Segurança

azure_auth

Escopos

Exemplos

SearchGetService

Solicitação de exemplo

Resposta de exemplo

Definições

AadAuthFailureMode

ApiKeyOnly

CloudError

CloudErrorBody

DataPlaneAadOrApiKeyAuthOption

DataPlaneAuthOptions

EncryptionWithCmk

HostingMode

Identity

IdentityType

IpRule

NetworkRuleSet

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateLinkServiceConnectionProvisioningState

PrivateLinkServiceConnectionState

PrivateLinkServiceConnectionStatus

ProvisioningState

PublicNetworkAccess

SearchBypass

SearchDisabledDataExfiltrationOption

SearchEncryptionComplianceStatus

SearchEncryptionWithCmk

SearchSemanticSearch

SearchService

SearchServiceStatus

SharedPrivateLinkResource

SharedPrivateLinkResourceProperties

SharedPrivateLinkResourceProvisioningState

SharedPrivateLinkResourceStatus

Sku

SkuName

UserAssignedManagedIdentity

Recursos adicionais