Services - List By Subscription

Serviço:

Search Management

Versão da API:

2023-11-01

Obtém uma lista de todos os serviços de Pesquisa na subscrição especificada.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Search/searchServices?api-version=2023-11-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
subscriptionId	path	True	string	O identificador exclusivo de uma subscrição do Microsoft Azure. Pode obter este valor a partir da API de Resource Manager do Azure, das ferramentas de linha de comandos 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	SearchServiceListResult	A operação foi efetuada com êxito. A resposta contém a lista de todas as definições de serviço de pesquisa para a subscrição especificada.
Other Status Codes	CloudError	Ocorreu um erro inesperado durante a operação.

Segurança

azure_auth

Microsoft Entra ID fluxo de autorização OAuth2.

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

SearchListServicesBySubscription

Pedido de amostra

HTTP

GET https://management.azure.com/subscriptions/subid/providers/Microsoft.Search/searchServices?api-version=2023-11-01

Java

/**
 * Samples for Services List.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/
     * SearchListServicesBySubscription.json
     */
    /**
     * Sample code: SearchListServicesBySubscription.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void searchListServicesBySubscription(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.searchServices().manager().serviceClient().getServices().list(null, com.azure.core.util.Context.NONE);
    }
}

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

Python

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

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-search
# USAGE
    python search_list_services_by_subscription.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.list_by_subscription()
    for item in response:
        print(item)


# x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchListServicesBySubscription.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

Go

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/7e29dd59eef13ef347d09e41a63f2585be77b3ca/specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchListServicesBySubscription.json
func ExampleServicesClient_NewListBySubscriptionPager() {
	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)
	}
	pager := clientFactory.NewServicesClient().NewListBySubscriptionPager(&armsearch.SearchManagementRequestOptions{ClientRequestID: nil}, nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ServiceListResult = armsearch.ServiceListResult{
		// 	Value: []*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{
		// 				HostingMode: to.Ptr(armsearch.HostingModeDefault),
		// 				NetworkRuleSet: &armsearch.NetworkRuleSet{
		// 					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),
		// 				Status: to.Ptr(armsearch.SearchServiceStatusRunning),
		// 				StatusDetails: to.Ptr(""),
		// 			},
		// 			SKU: &armsearch.SKU{
		// 				Name: to.Ptr(armsearch.SKUNameStandard),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("mysearchservice2"),
		// 			Type: to.Ptr("Microsoft.Search/searchServices"),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Search/searchServices/mysearchservice2"),
		// 			Location: to.Ptr("eastus"),
		// 			Tags: map[string]*string{
		// 				"app-name": to.Ptr("My e-commerce app"),
		// 			},
		// 			Properties: &armsearch.ServiceProperties{
		// 				HostingMode: to.Ptr(armsearch.HostingModeDefault),
		// 				NetworkRuleSet: &armsearch.NetworkRuleSet{
		// 					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](1),
		// 				Status: to.Ptr(armsearch.SearchServiceStatusRunning),
		// 				StatusDetails: to.Ptr(""),
		// 			},
		// 			SKU: &armsearch.SKU{
		// 				Name: to.Ptr(armsearch.SKUNameBasic),
		// 			},
		// 	}},
		// }
	}
}

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

JavaScript

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

/**
 * This sample demonstrates how to Gets a list of all Search services in the given subscription.
 *
 * @summary Gets a list of all Search services in the given subscription.
 * x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchListServicesBySubscription.json
 */
async function searchListServicesBySubscription() {
  const subscriptionId = process.env["SEARCH_SUBSCRIPTION_ID"] || "subid";
  const credential = new DefaultAzureCredential();
  const client = new SearchManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.services.listBySubscription()) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

dotnet

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

// Generated from example definition: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchListServicesBySubscription.json
// this example is just showing the usage of "Services_ListBySubscription" 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 SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "subid";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
await foreach (SearchServiceResource item in subscriptionResource.GetSearchServicesAsync())
{
    // the variable item 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 = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

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

{
  "value": [
    {
      "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": []
        },
        "privateEndpointConnections": []
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Search/searchServices/mysearchservice2",
      "name": "mysearchservice2",
      "location": "eastus",
      "type": "Microsoft.Search/searchServices",
      "tags": {
        "app-name": "My e-commerce app"
      },
      "sku": {
        "name": "basic"
      },
      "properties": {
        "replicaCount": 1,
        "partitionCount": 1,
        "status": "running",
        "statusDetails": "",
        "hostingMode": "default",
        "provisioningState": "succeeded",
        "publicNetworkAccess": "enabled",
        "networkRuleSet": {
          "ipRules": []
        },
        "privateEndpointConnections": []
      }
    }
  ]
}

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=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	Identidade do recurso.
IdentityType	O tipo de identidade.
IpRule	A regra de restrição de IP do serviço de pesquisa.
NetworkRuleSet	Regras específicas da rede que determinam a forma como o serviço de pesquisa 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 ao serviço de pesquisa.
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 ou Incompleto
PrivateLinkServiceConnectionState	Descreve o estado atual de uma ligação do Serviço Private Link existente ao Ponto Final Privado do Azure.
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, o provisioningState muda para "com êxito" ou "falhou". 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 recursos e modelos de clientes 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.
SearchEncryptionComplianceStatus	Descreve se o serviço de pesquisa está ou não em conformidade com a existência de recursos não encriptados pelo cliente. Se um serviço tiver mais do que um recurso não encriptado pelo cliente e "Imposição" estiver "ativado", o serviço será marcado como "não Conforme".
SearchEncryptionWithCmk	Descreve como um serviço de pesquisa deve impor ter um ou mais recursos não encriptados 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 em determinadas localizações.
SearchService	Descreve um serviço de pesquisa e o respetivo estado atual.
SearchServiceListResult	Resposta que contém uma lista de serviços de pesquisa.
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 estão em curso operações de aprovisionamento. "aprovisionamento": o serviço de pesquisa está a ser aprovisionado ou aumentado ou reduzido verticalmente. "eliminação": 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 é 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. "erro": o serviço de pesquisa está num estado de erro. Se o seu serviço estiver nos estados degradados, desativados ou com erros, a Microsoft 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 Private Link Partilhado gerido pelo serviço de pesquisa.
SharedPrivateLinkResourceProperties	Descreve as propriedades de um Recurso de Private Link Partilhado existente gerido pelo serviço de pesquisa.
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."

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.

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 podem ser utilizados 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=cliente.

Name	Tipo	Description
encryptionComplianceStatus	SearchEncryptionComplianceStatus	Descreve se o serviço de pesquisa está ou não em conformidade com a existência de recursos não encriptados pelo cliente. Se um serviço tiver mais do que um recurso não encriptado pelo cliente e "Imposição" estiver "ativado", o serviço será marcado como "não Conforme".
enforcement	SearchEncryptionWithCmk	Descreve como um serviço de pesquisa deve impor ter um ou mais recursos não encriptados 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 a aplicação para sKU standard3, onde o serviço de pesquisa pode ter até 1000 índices.

Identity

Identidade do recurso.

Name	Tipo	Description
principalId	string	O ID principal da identidade atribuída pelo sistema do serviço de pesquisa.
tenantId	string	O ID do inquilino da identidade atribuída pelo sistema do serviço de pesquisa.
type	IdentityType	O tipo de identidade.

IdentityType

O tipo de identidade.

Name	Tipo	Description
None	string
SystemAssigned	string

IpRule

A regra de restrição de IP do serviço de pesquisa.

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 da rede que determinam a forma como o serviço de pesquisa pode ser alcançado.

Name	Tipo	Description
ipRules	IpRule[]	Uma lista das regras de restrição de IP utilizadas para uma firewall de IP. Quaisquer IPs que não correspondam às regras são bloqueados pela firewall. Estas regras só são aplicadas quando a "publicNetworkAccess" do serviço de pesquisa está "ativada".

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 ao serviço de pesquisa.

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.
type	string	O tipo de 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 fornecedor do recurso para o qual se destina a ligação do 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 do Serviço Private Link existente ao Ponto Final Privado do Azure.
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 ou Incompleto

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 ou Incompleto

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 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 do Serviço Private Link existente ao Ponto Final Privado do Azure.

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, o provisioningState muda para "com êxito" ou "falhou". 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 recursos e modelos de clientes 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
enabled	string

SearchEncryptionComplianceStatus

Descreve se o serviço de pesquisa está ou não em conformidade com a existência de recursos não encriptados pelo cliente. Se um serviço tiver mais do que um recurso não encriptado pelo cliente e "Imposição" estiver "ativado", 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 recursos não encriptados pelo cliente é zero ou a imposição está desativada.
NonCompliant	string	Indica que o serviço de pesquisa tem mais do que um recurso não encriptado pelo cliente.

SearchEncryptionWithCmk

Descreve como um serviço de pesquisa deve impor ter um ou mais recursos não encriptados pelo cliente.

Name	Tipo	Description
Disabled	string	Não será efetuada qualquer imposição e o serviço de pesquisa pode ter recursos não encriptados pelo cliente.
Enabled	string	Serviço de pesquisa serão marcados como não conformes se existirem um ou mais recursos não encriptados pelo cliente.
Unspecified	string	A política de imposição não é especificada explicitamente, com o comportamento a ser 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 em determinadas localizações.

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

SearchService

Descreve um serviço de pesquisa 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 o recurso se encontra
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 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.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 da rede que determinam a forma como o serviço de pesquisa 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 ponto final privado ao 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, o provisioningState muda para "com êxito" ou "falhou". 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 recursos e modelos de clientes 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 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 em determinadas localizações.
properties.sharedPrivateLinkResources	SharedPrivateLinkResource[]		A lista de recursos de ligação privada partilhados geridos pelo 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 estão em curso operações de aprovisionamento. "aprovisionamento": o serviço de pesquisa está a ser aprovisionado ou aumentado ou reduzido verticalmente. "eliminação": 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 é 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. "erro": o serviço de pesquisa está num estado de erro. Se o seu serviço estiver nos estados degradados, desativados ou com erros, a Microsoft 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 a taxa de faturaçã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 de recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

SearchServiceListResult

Resposta que contém uma lista de serviços de pesquisa.

Name	Tipo	Description
nextLink	string	URL do pedido que pode ser utilizado para consultar a página seguinte dos serviços de pesquisa. Devolvido quando o número total de serviços de pesquisa pedidos exceder o tamanho máximo da página.
value	SearchService[]	A lista de serviços de pesquisa.

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 estão em curso operações de aprovisionamento. "aprovisionamento": o serviço de pesquisa está a ser aprovisionado ou aumentado ou reduzido verticalmente. "eliminação": 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 é 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. "erro": o serviço de pesquisa está num estado de erro. Se o seu serviço estiver nos estados degradados, desativados ou com erros, a Microsoft 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, o que indica 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.

SharedPrivateLinkResource

Descreve um Recurso de Private Link Partilhado gerido pelo serviço de pesquisa.

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 Private Link Partilhado gerido pelo serviço de pesquisa.
type	string	O tipo de recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

SharedPrivateLinkResourceProperties

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

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 de pedido 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 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
Failed	string
Incomplete	string
Succeeded	string
Updating	string

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
Disconnected	string
Pending	string
Rejected	string

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.