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 indicado no grupo de recursos especificado.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos na subscrição atual. Pode obter este valor a partir da API do Azure Resource Manager ou do portal.
searchServiceName	path	True	string	O nome da IA do Azure Serviço de 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 de uma subscrição do Microsoft Azure. Pode obter este valor a partir da API do Azure Resource Manager ou do portal.
api-version	query	True	string	A versão da API a utilizar para cada pedido.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
x-ms-client-request-id		string uuid	Um valor GUID gerado pelo cliente que identifica este pedido. Se for especificado, isto será incluído nas informações de resposta como forma de controlar o pedido.

Respostas

Name	Tipo	Description
200 OK	SearchService	A definição do serviço de pesquisa foi obtida com êxito e está na resposta. Se estiver a consultar a conclusão de uma operação de aprovisionamento ou dimensionamento, pode verificar o respetivo estado através da propriedade provisioningState.
Other Status Codes	CloudError	HTTP 404 (Não Encontrado): não foi possível localizar a subscrição, 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 Identidade da Microsoft.

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

Âmbitos

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

SearchGetService

Pedido de amostra

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 da amostra

Código de estado:: 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

Name	Description
AadAuthFailureMode	Descreve a resposta que a API do plano de dados de um serviço de pesquisa enviaria para pedidos que falharam na autenticação.
ApiKeyOnly	Indica que apenas a chave de API pode ser utilizada para autenticaçã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 de um inquilino Microsoft Entra ID podem ser utilizados para autenticação.
DataPlaneAuthOptions	Define as opções de como o serviço de pesquisa autentica um pedido de plano de dados. 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.
HostingMode	Aplicável apenas para o SKU standard3. Pode definir esta propriedade para ativar até 3 partições de alta densidade que permitem até 1000 índices, o que é muito superior aos índices máximos permitidos para qualquer outro SKU. Para o SKU standard3, o valor é "predefinido" ou "highDensity". Para todos os outros SKUs, este valor tem de ser "predefinido".
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 utilizado para o recurso. O tipo "SystemAssigned, UserAssigned" inclui uma identidade criada pelo sistema e um conjunto de identidades atribuídas pelo utilizador. O tipo "Nenhum" removerá todas as identidades do serviço.
IpRule	A regra de restrição de IP do Serviço de pesquisa de IA do Azure.
NetworkRuleSet	Regras específicas de rede que determinam a forma como o Serviço de pesquisa de IA do Azure pode ser alcançado.
PrivateEndpoint	O recurso de ponto final privado do fornecedor Microsoft.Network.
PrivateEndpointConnection	Descreve uma ligação de ponto final privado existente à Serviço de pesquisa de IA do Azure.
PrivateEndpointConnectionProperties	Descreve as propriedades de uma ligação de ponto final privado existente ao serviço de pesquisa.
PrivateLinkServiceConnectionProvisioningState	O estado de aprovisionamento da ligação do serviço de ligação privada. Os valores válidos são Atualizar, Eliminar, Falhar, Com Êxito, Incompleto ou Cancelado.
PrivateLinkServiceConnectionState	Descreve o estado atual de uma ligação de serviço de Azure Private Link existente ao ponto final privado.
PrivateLinkServiceConnectionStatus	Estado da ligação do serviço de ligação privada. Os valores válidos são Pendentes, Aprovados, Rejeitados ou Desligados.
ProvisioningState	O estado da última operação de aprovisionamento realizada no serviço de pesquisa. O aprovisionamento é um estado intermédio que ocorre enquanto a capacidade do serviço está a ser estabelecida. Após a configuração da capacidade, provisioningState muda para "succeeded" ou "failed". As aplicações cliente podem consultar o estado de aprovisionamento (o intervalo de consulta recomendado é de 30 segundos a um minuto) ao utilizar a operação Obter Serviço de Pesquisa para ver quando uma operação é concluída. Se estiver a utilizar o serviço gratuito, este valor tende a voltar como "bem-sucedido" diretamente na chamada para Criar serviço de pesquisa. Isto acontece porque o serviço gratuito utiliza a capacidade que já está configurada.
PublicNetworkAccess	Este valor pode ser definido como "ativado" para evitar alterações interruptivas nos modelos e recursos de cliente existentes. Se estiver definido como "desativado", o tráfego através da interface pública não é permitido e as ligações de ponto final privado seriam o método de acesso exclusivo.
SearchBypass	Possíveis origens de tráfego de entrada que podem ignorar as regras definidas na secção "ipRules".
SearchDisabledDataExfiltrationOption	Uma lista de cenários de transferência de dados não permitidos explicitamente para o serviço de pesquisa. Atualmente, o único valor suportado é "Todos" para desativar todos os cenários de exportação de dados possíveis com controlos mais detalhados planeados para o futuro.
SearchEncryptionComplianceStatus	Devolve o estado de conformidade do serviço de pesquisa relativamente a objetos não encriptados por CMK. Se um serviço tiver mais do que um objeto não encriptado e a imposição estiver ativada, o serviço será marcado como não conforme.
SearchEncryptionWithCmk	Descreve como um serviço de pesquisa deve impor a conformidade se encontrar objetos que não estão encriptados com a chave gerida pelo cliente.
SearchSemanticSearch	Define opções que controlam a disponibilidade da pesquisa semântica. Esta configuração só é possível para determinados SKUs de Pesquisa de IA do Azure em determinadas localizações.
SearchService	Descreve um Serviço de pesquisa de IA do Azure e o respetivo estado atual.
SearchServiceStatus	O estado do serviço de pesquisa. Os valores possíveis incluem: "em execução": o serviço de pesquisa está em execução e não existem operações de aprovisionamento em curso. "aprovisionamento": o serviço de pesquisa está a ser aprovisionado ou aumentado ou reduzido verticalmente. "a eliminar": o serviço de pesquisa está a ser eliminado. "degradado": o serviço de pesquisa está degradado. Isto pode ocorrer quando as unidades de pesquisa subjacentes não estão em bom estado de funcionamento. O serviço de pesquisa está provavelmente operacional, mas o desempenho pode ser lento e alguns pedidos podem ser removidos. "desativado": o serviço de pesquisa está desativado. Neste estado, o serviço rejeitará todos os pedidos de API. 'error': O serviço de pesquisa está num estado de erro. "parado": o serviço de pesquisa está numa subscrição que está desativada. Se o serviço estiver nos estados degradados, desativados ou com erros, significa que a equipa do Azure AI Search está a investigar ativamente o problema subjacente. Os serviços dedicados nestes estados continuam a ser cobrados com base no número de unidades de pesquisa aprovisionadas.
SharedPrivateLinkResource	Descreve um recurso de ligação privada partilhado gerido pelo Serviço de pesquisa de IA do Azure.
SharedPrivateLinkResourceProperties	Descreve as propriedades de um recurso de ligação privada partilhado existente gerido pelo Serviço de pesquisa de IA do Azure.
SharedPrivateLinkResourceProvisioningState	O estado de aprovisionamento do recurso de ligação privada partilhada. Os valores válidos são Atualizar, Eliminar, Falhar, Com Êxito ou Incompleto.
SharedPrivateLinkResourceStatus	Estado do recurso de ligação privada partilhado. Os valores válidos são Pendentes, Aprovados, Rejeitados ou Desligados.
Sku	Define o SKU de um serviço de pesquisa, que determina a taxa de faturação e os limites de capacidade.
SkuName	O SKU do serviço de pesquisa. Os valores válidos incluem: "gratuito": Serviço partilhado. "básico": serviço dedicado com até 3 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é 3 partições com mais índices se também definir a propriedade hostingMode como "highDensity"). 'storage_optimized_l1': suporta 1 TB por partição, até 12 partições. "storage_optimized_l2": suporta 2 TB por partição, até 12 partições."
UserAssignedManagedIdentity	Os detalhes da identidade gerida atribuída pelo utilizador ao serviço de pesquisa.

AadAuthFailureMode

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

Name	Tipo	Description
http401WithBearerChallenge	string	Indica que os pedidos que falharam na autenticação devem ser apresentados com um código de estado HTTP 401 (Não Autorizado) e apresentar um Desafio do Portador.
http403	string	Indica que os pedidos que falharam na autenticação devem ser apresentados com um código de estado HTTP de 403 (Proibido).

ApiKeyOnly

Indica que apenas a chave de API pode ser utilizada para autenticação.

CloudError

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

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

CloudErrorBody

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

Name	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 estado HTTP. Pode ser utilizado para processar programaticamente casos de erro específicos.
details	CloudErrorBody[]	Contém erros aninhados relacionados com este erro.
message	string	Uma mensagem que descreve o erro em detalhe 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 inquilino Microsoft Entra ID podem ser utilizados para autenticação.

Name	Tipo	Description
aadAuthFailureMode	AadAuthFailureMode	Descreve a resposta que a API do plano de dados de um serviço de pesquisa enviaria para pedidos que falharam na autenticação.

DataPlaneAuthOptions

Define as opções de como o serviço de pesquisa autentica um pedido de plano de dados. Isto não pode ser definido se "disableLocalAuth" estiver definido como verdadeiro.

Name	Tipo	Description
aadOrApiKey	DataPlaneAadOrApiKeyAuthOption	Indica que a chave de API ou um token de acesso de um inquilino Microsoft Entra ID pode ser utilizado para autenticação.
apiKeyOnly	ApiKeyOnly	Indica que apenas a chave de API pode ser utilizada para autenticação.

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.

Name	Tipo	Description
encryptionComplianceStatus	SearchEncryptionComplianceStatus	Devolve o estado de conformidade do serviço de pesquisa relativamente a objetos não encriptados por CMK. Se um serviço tiver mais do que um objeto não encriptado e a imposição estiver ativada, o serviço será marcado como não conforme.
enforcement	SearchEncryptionWithCmk	Descreve como um serviço de pesquisa deve impor a conformidade se encontrar objetos que não estão encriptados com a chave gerida pelo cliente.

HostingMode

Aplicável apenas para o SKU standard3. Pode definir esta propriedade para ativar até 3 partições de alta densidade que permitem até 1000 índices, o que é muito superior aos índices máximos permitidos para qualquer outro SKU. Para o SKU standard3, o valor é "predefinido" ou "highDensity". Para todos os outros SKUs, este valor tem de ser "predefinido".

Name	Tipo	Description
default	string	O limite do número de índices é determinado pelos limites predefinidos para o SKU.
highDensity	string	Apenas aplicação para sKU standard3, onde 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.

Name	Tipo	Description
principalId	string	O ID principal da identidade atribuída pelo sistema do serviço de pesquisa.
tenantId	string	O ID de inquilino da identidade atribuída pelo sistema do serviço de pesquisa.
type	IdentityType	O tipo de identidade utilizado para o recurso. O tipo "SystemAssigned, UserAssigned" inclui uma identidade criada pelo sistema e um conjunto de identidades atribuídas pelo utilizador. O tipo "Nenhum" removerá todas as identidades do serviço.
userAssignedIdentities	<string, UserAssignedManagedIdentity>	A lista de identidades de utilizador associadas ao recurso. As referências da chave do dicionário de identidade do utilizador serão IDs de recursos do ARM no formulário: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

IdentityType

O tipo de identidade utilizado para o recurso. O tipo "SystemAssigned, UserAssigned" inclui uma identidade criada pelo sistema e um conjunto de identidades atribuídas pelo utilizador. O tipo "Nenhum" removerá todas as identidades do serviço.

Name	Tipo	Description
None	string	Indica que qualquer identidade associada ao serviço de pesquisa tem de ser removida.
SystemAssigned	string	Indica que a identidade atribuída pelo sistema para o serviço de pesquisa será ativada.
SystemAssigned, UserAssigned	string	Indica que a identidade atribuída pelo sistema para o serviço de pesquisa será ativada juntamente com a atribuição de uma ou mais identidades atribuídas pelo utilizador.
UserAssigned	string	Indica que uma ou mais identidades atribuídas pelo utilizador serão atribuídas ao serviço de pesquisa.

IpRule

A regra de restrição de IP do Serviço de pesquisa de IA do Azure.

Name	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 a forma como o Serviço de pesquisa de IA do Azure pode ser alcançado.

Name	Tipo	Description
bypass	SearchBypass	Possíveis origens de tráfego de entrada que podem ignorar as regras definidas na secção "ipRules".
ipRules	IpRule[]	Uma lista de regras de restrição de IP que define as redes de entrada ao permitir o acesso ao ponto final do serviço de pesquisa. Entretanto, todas as outras redes IP públicas são bloqueadas pela firewall. Estas regras de restrição só são aplicadas quando o "publicNetworkAccess" do serviço de pesquisa está "ativado"; caso contrário, o tráfego através da interface pública não é permitido, mesmo com quaisquer regras de IP públicos, e as ligações de ponto final privado seriam o método de acesso exclusivo.

PrivateEndpoint

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

Name	Tipo	Description
id	string	O ID de recurso do recurso de ponto final privado do fornecedor Microsoft.Network.

PrivateEndpointConnection

Descreve uma ligação de ponto final privado existente à Serviço de pesquisa de IA do Azure.

Name	Tipo	Description
id	string	ID de recurso completamente qualificado 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 ligação de ponto final privado existente ao Serviço de pesquisa de IA do Azure.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProperties

Descreve as propriedades de uma ligação de ponto final privado existente ao serviço de pesquisa.

Name	Tipo	Description
groupId	string	O ID de grupo do recurso do Azure para o qual se destina o serviço de ligação privada.
privateEndpoint	PrivateEndpoint	O recurso de ponto final privado do fornecedor Microsoft.Network.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Descreve o estado atual de uma ligação de serviço de Azure Private Link existente ao ponto final privado.
provisioningState	PrivateLinkServiceConnectionProvisioningState	O estado de aprovisionamento da ligação do serviço de ligação privada. Os valores válidos são Atualizar, Eliminar, Falhar, Com Êxito, Incompleto ou Cancelado.

PrivateLinkServiceConnectionProvisioningState

O estado de aprovisionamento da ligação do serviço de ligação privada. Os valores válidos são Atualizar, Eliminar, Falhar, Com Êxito, Incompleto ou Cancelado.

Name	Tipo	Description
Canceled	string	O pedido de aprovisionamento para o recurso de ligação do serviço de ligação do serviço de ligação de ligação privada foi cancelado.
Deleting	string	A ligação do serviço de ligação privada está em vias de ser eliminada.
Failed	string	A ligação do serviço de ligação privada não foi aprovisionada ou eliminada.
Incomplete	string	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.
Succeeded	string	A ligação do serviço de ligação privada terminou o aprovisionamento e está pronta para aprovação.
Updating	string	A ligação do serviço de ligação privada está em vias de ser criada juntamente com outros recursos para que fique totalmente funcional.

PrivateLinkServiceConnectionState

Descreve o estado atual de uma ligação de serviço de Azure Private Link existente ao ponto final privado.

Name	Tipo	Default value	Description
actionsRequired	string	None	Uma descrição de quaisquer ações adicionais que possam ser necessárias.
description	string		A descrição do estado de ligação do serviço de ligação de ligação privada.
status	PrivateLinkServiceConnectionStatus		Estado da ligação do serviço de ligação privada. Os valores válidos são Pendentes, Aprovados, Rejeitados ou Desligados.

PrivateLinkServiceConnectionStatus

Estado da ligação do serviço de ligação privada. Os valores válidos são Pendentes, Aprovados, Rejeitados ou Desligados.

Name	Tipo	Description
Approved	string	A ligação de ponto final privado é aprovada e está pronta para ser utilizada.
Disconnected	string	A ligação de ponto final privado foi removida do serviço.
Pending	string	A ligação de ponto final privado foi criada e está pendente de aprovação.
Rejected	string	A ligação de ponto final privado foi rejeitada e não pode ser utilizada.

ProvisioningState

O estado da última operação de aprovisionamento realizada no serviço de pesquisa. O aprovisionamento é um estado intermédio que ocorre enquanto a capacidade do serviço está a ser estabelecida. Após a configuração da capacidade, provisioningState muda para "succeeded" ou "failed". As aplicações cliente podem consultar o estado de aprovisionamento (o intervalo de consulta recomendado é de 30 segundos a um minuto) ao utilizar a operação Obter Serviço de Pesquisa para ver quando uma operação é concluída. Se estiver a utilizar o serviço gratuito, este valor tende a voltar como "bem-sucedido" diretamente na chamada para Criar serviço de pesquisa. Isto acontece porque o serviço gratuito utiliza a capacidade que já está configurada.

Name	Tipo	Description
failed	string	A última operação de aprovisionamento falhou.
provisioning	string	O serviço de pesquisa está a ser aprovisionado ou aumentado ou reduzido verticalmente.
succeeded	string	A última operação de aprovisionamento foi concluída com êxito.

PublicNetworkAccess

Este valor pode ser definido como "ativado" para evitar alterações interruptivas nos modelos e recursos de cliente existentes. Se estiver definido como "desativado", o tráfego através da interface pública não é permitido e as ligações de ponto final privado seriam o método de acesso exclusivo.

Name	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 através de ligações de ponto final privado aprovadas.
enabled	string	O serviço de pesquisa está acessível a partir do tráfego com origem na Internet pública.

SearchBypass

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

Name	Tipo	Description
AzurePortal	string	Indica que os pedidos provenientes do portal do Azure podem ignorar as regras definidas na secção "ipRules".
None	string	Indica que nenhuma origem pode ignorar as regras definidas na secção "ipRules". Esta é a predefinição.

SearchDisabledDataExfiltrationOption

Uma lista de cenários de transferência de dados não permitidos explicitamente para o serviço de pesquisa. Atualmente, o único valor suportado é "Todos" para desativar todos os cenários de exportação de dados possíveis com controlos mais detalhados planeados para o futuro.

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

SearchEncryptionComplianceStatus

Devolve o estado de conformidade do serviço de pesquisa relativamente a objetos não encriptados por CMK. Se um serviço tiver mais do que um objeto não encriptado e a imposição estiver ativada, o serviço será marcado como não conforme.

Name	Tipo	Description
Compliant	string	Indica que o serviço de pesquisa está em conformidade, porque o número de objetos não encriptados por CMK é zero ou a imposição está desativada.
NonCompliant	string	Indica que o serviço de pesquisa tem mais do que um objeto não encriptado por CMK.

SearchEncryptionWithCmk

Descreve como um serviço de pesquisa deve impor a conformidade se encontrar objetos que não estão encriptados com a chave gerida pelo cliente.

Name	Tipo	Description
Disabled	string	Não será efetuada qualquer imposição da encriptação de chaves gerida pelo cliente. Só é utilizada a encriptação gerida pelo serviço incorporada.
Enabled	string	Serviço de pesquisa serão marcados como não conformes se um ou mais objetos não estiverem encriptados com uma chave gerida pelo cliente.
Unspecified	string	A política de imposição não é especificada explicitamente, sendo que o comportamento é o mesmo que se estivesse definido como "Desativado".

SearchSemanticSearch

Define opções que controlam a disponibilidade da pesquisa semântica. Esta configuração só é possível para determinados SKUs de Pesquisa de IA do Azure em determinadas localizações.

Name	Tipo	Description
disabled	string	Indica que o reranker semântico está desativado para o serviço de pesquisa. Esta é a predefinição.
free	string	Ativa o reranker semântico num serviço de pesquisa e indica que deve ser utilizado dentro dos limites do plano gratuito. O plano gratuito limitaria o volume de pedidos de classificação semântica e é oferecido sem custos adicionais. Esta é a predefinição para serviços de pesquisa recentemente aprovisionados.
standard	string	Ativa a retransmissão semântica num serviço de pesquisa como uma funcionalidade faturável, com maior débito e volume de consultas semanticamente reclassificados.

SearchService

Descreve um Serviço de pesquisa de IA do Azure e o respetivo estado atual.

Name	Tipo	Default value	Description
id	string		ID de recurso completamente qualificado 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 onde reside o recurso
name	string		O nome do recurso
properties.authOptions	DataPlaneAuthOptions		Define as opções para a forma como a API do plano de dados de um serviço de pesquisa autentica os pedidos. Isto não pode ser definido se "disableLocalAuth" estiver definido como verdadeiro.
properties.disableLocalAuth	boolean		Quando definido como verdadeiro, as chamadas para o serviço de pesquisa não serão autorizadas a utilizar chaves de API para autenticação. Isto não pode ser definido como verdadeiro se "dataPlaneAuthOptions" estiver definido.
properties.disabledDataExfiltrationOptions	SearchDisabledDataExfiltrationOption[]		Uma lista de cenários de transferência de dados não permitidos explicitamente para o serviço de pesquisa. Atualmente, o único valor suportado é "Todos" para desativar todos os cenários de exportação de dados possíveis com controlos mais detalhados planeados para o futuro.
properties.eTag	string		Uma propriedade gerada pelo sistema que representa o etag do serviço que pode ser para o controlo de simultaneidade otimista durante as atualizações.
properties.encryptionWithCmk	EncryptionWithCmk		Especifica qualquer política relativa à encriptação de recursos (como índices) através de chaves do gestor de clientes num serviço de pesquisa.
properties.hostingMode	HostingMode	default	Aplicável apenas para o SKU standard3. Pode definir esta propriedade para ativar até 3 partições de alta densidade que permitem até 1000 índices, o que é muito superior aos índices máximos permitidos para qualquer outro SKU. Para o SKU standard3, o valor é "predefinido" ou "highDensity". Para todos os outros SKUs, este valor tem de ser "predefinido".
properties.networkRuleSet	NetworkRuleSet		Regras específicas de rede que determinam a forma como o Serviço de pesquisa de IA do Azure pode ser alcançado.
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. Os valores superiores a 1 só são válidos 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 ligações de pontos finais privados à IA do Azure Serviço de pesquisa.
properties.provisioningState	ProvisioningState		O estado da última operação de aprovisionamento realizada no serviço de pesquisa. O aprovisionamento é um estado intermédio que ocorre enquanto a capacidade do serviço está a ser estabelecida. Após a configuração da capacidade, provisioningState muda para "succeeded" ou "failed". As aplicações cliente podem consultar o estado de aprovisionamento (o intervalo de consulta recomendado é de 30 segundos a um minuto) ao utilizar a operação Obter Serviço de Pesquisa para ver quando uma operação é concluída. Se estiver a utilizar o serviço gratuito, este valor tende a voltar como "bem-sucedido" diretamente na chamada para Criar serviço de pesquisa. Isto acontece porque o serviço gratuito utiliza a capacidade que já está configurada.
properties.publicNetworkAccess	PublicNetworkAccess	enabled	Este valor pode ser definido como "ativado" para evitar alterações interruptivas nos modelos e recursos de cliente existentes. Se estiver definido como "desativado", o tráfego através da interface pública não é permitido e as ligações de ponto final privado seriam o método de acesso exclusivo.
properties.replicaCount	integer	1	O número de réplicas no serviço de pesquisa. Se especificado, tem de 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. Esta configuração só é possível para determinados SKUs de Pesquisa de IA do Azure em determinadas localizações.
properties.sharedPrivateLinkResources	SharedPrivateLinkResource[]		A lista de recursos de ligação privada partilhados geridos pela IA do Azure Serviço de pesquisa.
properties.status	SearchServiceStatus		O estado do serviço de pesquisa. Os valores possíveis incluem: "em execução": o serviço de pesquisa está em execução e não existem operações de aprovisionamento em curso. "aprovisionamento": o serviço de pesquisa está a ser aprovisionado ou aumentado ou reduzido verticalmente. "a eliminar": o serviço de pesquisa está a ser eliminado. "degradado": o serviço de pesquisa está degradado. Isto pode ocorrer quando as unidades de pesquisa subjacentes não estão em bom estado de funcionamento. O serviço de pesquisa está provavelmente operacional, mas o desempenho pode ser lento e alguns pedidos podem ser removidos. "desativado": o serviço de pesquisa está desativado. Neste estado, o serviço rejeitará todos os pedidos de API. 'error': O serviço de pesquisa está num estado de erro. "parado": o serviço de pesquisa está numa subscrição que está desativada. Se o serviço estiver nos estados degradados, desativados ou com erros, significa que a equipa do Azure AI Search está a investigar ativamente o problema subjacente. Os serviços dedicados nestes estados continuam a ser cobrados com base no número de unidades de pesquisa aprovisionadas.
properties.statusDetails	string		Os detalhes do estado do serviço de pesquisa.
sku	Sku		O SKU do serviço de pesquisa, que determina o escalão de preço e os limites de capacidade. Esta propriedade é necessária ao criar um novo serviço de pesquisa.
tags	object		Etiquetas de recursos.
type	string		O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

SearchServiceStatus

O estado do serviço de pesquisa. Os valores possíveis incluem: "em execução": o serviço de pesquisa está em execução e não existem operações de aprovisionamento em curso. "aprovisionamento": o serviço de pesquisa está a ser aprovisionado ou aumentado ou reduzido verticalmente. "a eliminar": o serviço de pesquisa está a ser eliminado. "degradado": o serviço de pesquisa está degradado. Isto pode ocorrer quando as unidades de pesquisa subjacentes não estão em bom estado de funcionamento. O serviço de pesquisa está provavelmente operacional, mas o desempenho pode ser lento e alguns pedidos podem ser removidos. "desativado": o serviço de pesquisa está desativado. Neste estado, o serviço rejeitará todos os pedidos de API. 'error': O serviço de pesquisa está num estado de erro. "parado": o serviço de pesquisa está numa subscrição que está desativada. Se o serviço estiver nos estados degradados, desativados ou com erros, significa que a equipa do Azure AI Search está a investigar ativamente o problema subjacente. Os serviços dedicados nestes estados continuam a ser cobrados com base no número de unidades de pesquisa aprovisionadas.

Name	Tipo	Description
degraded	string	O serviço de pesquisa está degradado porque as unidades de pesquisa subjacentes não estão em bom estado de funcionamento.
deleting	string	O serviço de pesquisa está a ser eliminado.
disabled	string	O serviço de pesquisa está desativado e todos os pedidos de API serão rejeitados.
error	string	O serviço de pesquisa está no estado de erro, indicando uma falha no aprovisionamento ou a eliminação.
provisioning	string	O serviço de pesquisa está a ser aprovisionado ou aumentado ou reduzido verticalmente.
running	string	O serviço de pesquisa está em execução e não estão em curso operações de aprovisionamento.
stopped	string	O serviço de pesquisa está numa subscrição que está desativada.

SharedPrivateLinkResource

Descreve um recurso de ligação privada partilhado gerido pelo Serviço de pesquisa de IA do Azure.

Name	Tipo	Description
id	string	ID de recurso completamente qualificado 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 ligação privada partilhado gerido pelo Serviço de pesquisa de IA do Azure.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

SharedPrivateLinkResourceProperties

Descreve as propriedades de um recurso de ligação privada partilhado existente gerido pelo Serviço de pesquisa de IA do Azure.

Name	Tipo	Description
groupId	string	O ID de grupo do fornecedor do recurso para o qual se destina o recurso de ligação privada partilhada.
privateLinkResourceId	string	O ID de recurso do recurso para o recurso de ligação privada partilhado.
provisioningState	SharedPrivateLinkResourceProvisioningState	O estado de aprovisionamento do recurso de ligação privada partilhada. Os valores válidos são Atualizar, Eliminar, Falhar, Com Êxito ou Incompleto.
requestMessage	string	A mensagem para pedir a aprovação do recurso de ligação privada partilhada.
resourceRegion	string	Opcional. Pode ser utilizado para especificar a localização do Azure Resource Manager do recurso para o qual está a ser criada uma ligação privada partilhada. Isto só é necessário para os recursos cuja configuração DNS é regional (por exemplo, Azure Kubernetes Service).
status	SharedPrivateLinkResourceStatus	Estado do recurso de ligação privada partilhado. Os valores válidos são Pendentes, Aprovados, Rejeitados ou Desligados.

SharedPrivateLinkResourceProvisioningState

O estado de aprovisionamento do recurso de ligação privada partilhada. Os valores válidos são Atualizar, Eliminar, Falhar, Com Êxito ou Incompleto.

Name	Tipo	Description
Deleting	string	O recurso de ligação privada partilhado está em vias de ser eliminado.
Failed	string	O recurso de ligação privada partilhado não foi aprovisionado ou eliminado.
Incomplete	string	O pedido de aprovisionamento para o recurso de ligação privada partilhado foi aceite, mas o processo de criação ainda não começou.
Succeeded	string	O recurso de ligação privada partilhado terminou o aprovisionamento e está pronto para aprovação.
Updating	string	O recurso de ligação privada partilhado está em vias de ser criado juntamente com outros recursos para que fique totalmente funcional.

SharedPrivateLinkResourceStatus

Estado do recurso de ligação privada partilhado. Os valores válidos são Pendentes, Aprovados, Rejeitados ou Desligados.

Name	Tipo	Description
Approved	string	O recurso de ligação privada partilhado é aprovado e está pronto para ser utilizado.
Disconnected	string	O recurso de ligação privada partilhado foi removido do serviço.
Pending	string	O recurso de ligação privada partilhado foi criado e está pendente de aprovação.
Rejected	string	O recurso de ligação privada partilhado foi rejeitado e não pode ser utilizado.

Sku

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

Name	Tipo	Description
name	SkuName	O SKU do serviço de pesquisa. Os valores válidos incluem: "gratuito": Serviço partilhado. "básico": serviço dedicado com até 3 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é 3 partições com mais índices se também definir a propriedade hostingMode como "highDensity"). 'storage_optimized_l1': suporta 1 TB por partição, até 12 partições. "storage_optimized_l2": suporta 2 TB por partição, até 12 partições."

SkuName

O SKU do serviço de pesquisa. Os valores válidos incluem: "gratuito": Serviço partilhado. "básico": serviço dedicado com até 3 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é 3 partições com mais índices se também definir a propriedade hostingMode como "highDensity"). 'storage_optimized_l1': suporta 1 TB por partição, até 12 partições. "storage_optimized_l2": suporta 2 TB por partição, até 12 partições."

Name	Tipo	Description
basic	string	Escalão faturável para um serviço dedicado com até 3 réplicas.
free	string	Escalão gratuito, sem garantias de SLA e um subconjunto das funcionalidades oferecidas em escalões faturáveis.
standard	string	Escalão faturável para um serviço dedicado com até 12 partições e 12 réplicas.
standard2	string	Semelhante a "standard", 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é 3 partições com mais índices se também definir a propriedade hostingMode como "highDensity").
storage_optimized_l1	string	Escalão faturável para um serviço dedicado que suporta 1 TB por partição, até 12 partições.
storage_optimized_l2	string	Escalão faturável para um serviço dedicado que suporta 2 TB por partição, até 12 partições.

UserAssignedManagedIdentity

Os detalhes da identidade gerida atribuída pelo utilizador ao serviço de pesquisa.

Name	Tipo	Description
clientId	string	O ID de cliente da identidade atribuída pelo utilizador.
principalId	string	O ID principal da identidade atribuída pelo utilizador.

Partilhar via

Services - Get

Parâmetros do URI

Cabeçalho do Pedido

Respostas

Segurança

azure_auth

Âmbitos

Exemplos

SearchGetService

Pedido de amostra

Resposta da amostra

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