Services - Get

Service:

Search Management

Version d'API:

2023-11-01

Obtient le service de recherche portant le nom donné dans le groupe de ressources donné.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
resourceGroupName	path	True	string	Nom du groupe de ressources dans l’abonnement actuel. Vous pouvez obtenir cette valeur à partir de l’API Azure Resource Manager ou du portail.
searchServiceName	path	True	string	Nom du service de recherche associé au groupe de ressources spécifié.
subscriptionId	path	True	string	Identificateur unique d’un abonnement Microsoft Azure. Vous pouvez obtenir cette valeur à partir de l’API Azure Resource Manager, des outils en ligne de commande ou du portail.
api-version	query	True	string	Version de l’API à utiliser pour chaque requête.

En-tête de la demande

Nom	Obligatoire	Type	Description
x-ms-client-request-id		string (uuid)	Valeur GUID générée par le client qui identifie cette requête. S’il est spécifié, cela sera inclus dans les informations de réponse comme moyen de suivre la demande.

Réponses

Nom	Type	Description
200 OK	SearchService	La définition du service de recherche a été récupérée avec succès et se trouve dans la réponse. Si vous interrogez l’achèvement d’une opération d’approvisionnement ou de mise à l’échelle, vous pouvez vérifier son état via la propriété provisioningState.
Other Status Codes	CloudError	HTTP 404 (introuvable) : l’abonnement, le groupe de ressources ou le nom du service de recherche sont introuvables.

Sécurité

azure_auth

Flux d’autorisation OAuth2 d’ID Microsoft Entra.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

SearchGetService

Exemple de requête

HTTP

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

Java

/**
 * Samples for Services GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchGetService.json
     */
    /**
     * Sample code: SearchGetService.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void searchGetService(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.searchServices().manager().serviceClient().getServices().getByResourceGroupWithResponse("rg1",
            "mysearchservice", 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_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/stable/2023-11-01/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

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/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{
	// 		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),
	// 	},
	// }
}

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 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/stable/2023-11-01/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

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/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 SearchServiceResource created on azure
// for more information of creating SearchServiceResource, please refer to the document of SearchServiceResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string searchServiceName = "mysearchservice";
ResourceIdentifier searchServiceResourceId = SearchServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, searchServiceName);
SearchServiceResource searchService = client.GetSearchServiceResource(searchServiceResourceId);

// invoke the operation
SearchServiceResource result = await searchService.GetAsync();

// 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

Exemple de réponse

Code d’état:

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": []
    },
    "privateEndpointConnections": []
  }
}

Définitions

Nom	Description
AadAuthFailureMode	Décrit la réponse que l’API du plan de données d’un service de recherche envoie pour les demandes qui ont échoué.
ApiKeyOnly	Indique que seule la clé API peut être utilisée pour l’authentification.
CloudError	Contient des informations sur une erreur d’API.
CloudErrorBody	Décrit une erreur d’API particulière avec un code d’erreur et un message.
DataPlaneAadOrApiKeyAuthOption	Indique que la clé API ou un jeton d’accès à partir d’un locataire Microsoft Entra ID peut être utilisé pour l’authentification.
DataPlaneAuthOptions	Définit les options de la façon dont le service de recherche authentifie une demande de plan de données. Cela ne peut pas être défini si « disableLocalAuth » a la valeur true.
EncryptionWithCmk	Décrit une stratégie qui détermine la façon dont les ressources du service de recherche doivent être chiffrées avec des clés gérées par customer=.
HostingMode	Applicable uniquement pour la référence SKU standard3. Vous pouvez définir cette propriété pour activer jusqu’à 3 partitions à haute densité qui autorisent jusqu’à 1 000 index, ce qui est beaucoup plus élevé que les index maximum autorisés pour toute autre référence SKU. Pour la référence SKU standard3, la valeur est « default » ou « highDensity ». Pour toutes les autres références SKU, cette valeur doit être « par défaut ».
Identity	Identité de la ressource.
IdentityType	Type d’identité.
IpRule	Règle de restriction IP du service de recherche.
NetworkRuleSet	Règles spécifiques au réseau qui déterminent la façon dont le service de recherche peut être atteint.
PrivateEndpoint	Ressource de point de terminaison privé du fournisseur Microsoft.Network.
PrivateEndpointConnection	Décrit une connexion de point de terminaison privé existante au service de recherche.
PrivateEndpointConnectionProperties	Décrit les propriétés d’une connexion de point de terminaison privé existante au service de recherche.
PrivateLinkServiceConnectionProvisioningState	État d’approvisionnement de la connexion de service de liaison privée. Les valeurs valides sont Mise à jour, Suppression, Échec, Réussite ou Incomplet
PrivateLinkServiceConnectionState	Décrit l’état actuel d’une connexion de service Private Link existante au point de terminaison privé Azure.
PrivateLinkServiceConnectionStatus	État de la connexion du service de liaison privée. Les valeurs valides sont en attente, approuvées, rejetées ou déconnectées.
ProvisioningState	État de la dernière opération d’approvisionnement effectuée sur le service de recherche. L’approvisionnement est un état intermédiaire qui se produit pendant l’établissement de la capacité de service. Une fois la capacité configurée, provisioningState passe à « réussi » ou « échec ». Les applications clientes peuvent interroger l’état d’approvisionnement (l’intervalle d’interrogation recommandé est de 30 secondes à une minute) à l’aide de l’opération Get Search Service pour voir quand une opération est terminée. Si vous utilisez le service gratuit, cette valeur a tendance à revenir en tant que « réussi » directement dans l’appel pour créer un service de recherche. Cela est dû au fait que le service gratuit utilise la capacité déjà configurée.
PublicNetworkAccess	Cette valeur peut être définie sur « activé » pour éviter les modifications cassants sur les ressources et les modèles clients existants. Si la valeur est « désactivée », le trafic sur l’interface publique n’est pas autorisé et les connexions de point de terminaison privé sont la méthode d’accès exclusive.
SearchEncryptionComplianceStatus	Décrit si le service de recherche est conforme ou non en ce qui concerne l’utilisation de ressources non chiffrées par le client. Si un service a plusieurs ressources non chiffrées par le client et que l’option « Application » est « activée », le service est marqué comme « non conforme ».
SearchEncryptionWithCmk	Décrit comment un service de recherche doit appliquer une ou plusieurs ressources non chiffrées par le client.
SearchSemanticSearch	Définit les options qui contrôlent la disponibilité de la recherche sémantique. Cette configuration n’est possible que pour certaines références SKU de recherche dans certains emplacements.
SearchService	Décrit un service de recherche et son état actuel.
SearchServiceStatus	État du service de recherche. Les valeurs possibles sont les suivantes : « en cours d’exécution » : le service de recherche est en cours d’exécution et aucune opération d’approvisionnement n’est en cours. « approvisionnement » : le service de recherche est approvisionné ou mis à l’échelle vers le haut ou vers le bas. « suppression » : le service de recherche est en cours de suppression. « détérioré » : le service de recherche est détérioré. Cela peut se produire lorsque les unités de recherche sous-jacentes ne sont pas saines. Le service de recherche est probablement opérationnel, mais les performances peuvent être lentes et certaines requêtes peuvent être supprimées. ' désactivé' : le service de recherche est désactivé. Dans cet état, le service rejette toutes les demandes d’API. ' erreur' : le service de recherche est dans un état d’erreur. Si votre service se trouve dans les états détériorés, désactivés ou d’erreur, Microsoft examine activement le problème sous-jacent. Les services dédiés dans ces états sont toujours facturés en fonction du nombre d’unités de recherche approvisionnées.
SharedPrivateLinkResource	Décrit une ressource de liaison privée partagée gérée par le service de recherche.
SharedPrivateLinkResourceProperties	Décrit les propriétés d’une ressource de liaison privée partagée existante gérée par le service de recherche.
SharedPrivateLinkResourceProvisioningState	État d’approvisionnement de la ressource de liaison privée partagée. Les valeurs valides sont Mise à jour, Suppression, Échec, Réussite ou Incomplet.
SharedPrivateLinkResourceStatus	État de la ressource de liaison privée partagée. Les valeurs valides sont en attente, approuvées, rejetées ou déconnectées.
Sku	Définit la référence SKU d’un service de recherche, qui détermine le taux de facturation et les limites de capacité.
SkuName	Référence SKU du service de recherche. Les valeurs valides sont les suivantes : « gratuit » : service partagé. « de base » : service dédié avec jusqu’à 3 réplicas. « standard » : service dédié avec jusqu’à 12 partitions et 12 réplicas. « standard2 » : similaire à la norme, mais avec plus de capacité par unité de recherche. « standard3 » : la plus grande offre Standard avec jusqu’à 12 partitions et 12 réplicas (ou jusqu’à 3 partitions avec plus d’index si vous définissez également la propriété hostingMode sur « highDensity »). 'storage_optimized_l1' : prend en charge 1 To par partition, jusqu’à 12 partitions. 'storage_optimized_l2' : prend en charge 2 To par partition, jusqu’à 12 partitions.

AadAuthFailureMode

Énumération

Décrit la réponse que l’API du plan de données d’un service de recherche envoie pour les demandes qui ont échoué.

Valeur	Description
http401WithBearerChallenge	Indique que les demandes qui ont échoué l’authentification doivent être présentées avec un code d’état HTTP de 401 (non autorisé) et présenter un défi du porteur.
http403	Indique que les demandes qui ont échoué l’authentification doivent être présentées avec un code d’état HTTP de 403 (Interdit).

ApiKeyOnly

Object

Indique que seule la clé API peut être utilisée pour l’authentification.

CloudError

Object

Contient des informations sur une erreur d’API.

Nom	Type	Description
error	CloudErrorBody	Décrit une erreur d’API particulière avec un code d’erreur et un message.

CloudErrorBody

Object

Décrit une erreur d’API particulière avec un code d’erreur et un message.

Nom	Type	Description
code	string	Code d’erreur qui décrit la condition d’erreur plus précisément qu’un code d’état HTTP. Peut être utilisé pour gérer par programmation des cas d’erreur spécifiques.
details	CloudErrorBody[]	Contient des erreurs imbriquées liées à cette erreur.
message	string	Message qui décrit en détail l’erreur et fournit des informations de débogage.
target	string	Cible de l’erreur particulière (par exemple, le nom de la propriété en erreur).

DataPlaneAadOrApiKeyAuthOption

Object

Indique que la clé API ou un jeton d’accès à partir d’un locataire Microsoft Entra ID peut être utilisé pour l’authentification.

Nom	Type	Description
aadAuthFailureMode	AadAuthFailureMode	Décrit la réponse que l’API du plan de données d’un service de recherche envoie pour les demandes qui ont échoué.

DataPlaneAuthOptions

Object

Définit les options de la façon dont le service de recherche authentifie une demande de plan de données. Cela ne peut pas être défini si « disableLocalAuth » a la valeur true.

Nom	Type	Description
aadOrApiKey	DataPlaneAadOrApiKeyAuthOption	Indique que la clé API ou un jeton d’accès à partir d’un locataire Microsoft Entra ID peut être utilisé pour l’authentification.
apiKeyOnly	ApiKeyOnly	Indique que seule la clé API peut être utilisée pour l’authentification.

EncryptionWithCmk

Object

Décrit une stratégie qui détermine la façon dont les ressources du service de recherche doivent être chiffrées avec des clés gérées par customer=.

Nom	Type	Description
encryptionComplianceStatus	SearchEncryptionComplianceStatus	Décrit si le service de recherche est conforme ou non en ce qui concerne l’utilisation de ressources non chiffrées par le client. Si un service a plusieurs ressources non chiffrées par le client et que l’option « Application » est « activée », le service est marqué comme « non conforme ».
enforcement	SearchEncryptionWithCmk	Décrit comment un service de recherche doit appliquer une ou plusieurs ressources non chiffrées par le client.

HostingMode

Énumération

Applicable uniquement pour la référence SKU standard3. Vous pouvez définir cette propriété pour activer jusqu’à 3 partitions à haute densité qui autorisent jusqu’à 1 000 index, ce qui est beaucoup plus élevé que les index maximum autorisés pour toute autre référence SKU. Pour la référence SKU standard3, la valeur est « default » ou « highDensity ». Pour toutes les autres références SKU, cette valeur doit être « par défaut ».

Valeur	Description
default	La limite du nombre d’index est déterminée par les limites par défaut de la référence SKU.
highDensity	Application uniquement pour la référence SKU standard3, où le service de recherche peut avoir jusqu’à 1 000 index.

Identity

Object

Identité de la ressource.

Nom	Type	Description
principalId	string	ID principal de l’identité affectée par le système du service de recherche.
tenantId	string	ID de locataire de l’identité affectée par le système du service de recherche.
type	IdentityType	Type d’identité.

IdentityType

Énumération

Type d’identité.

Valeur	Description
None
SystemAssigned

IpRule

Object

Règle de restriction IP du service de recherche.

Nom	Type	Description
value	string	Valeur correspondant à une seule adresse IPv4 (par exemple, 123.1.2.3) ou à une plage IP au format CIDR (par exemple, 123.1.2.3/24) à autoriser.

NetworkRuleSet

Object

Règles spécifiques au réseau qui déterminent la façon dont le service de recherche peut être atteint.

Nom	Type	Description
ipRules	IpRule[]	Liste des règles de restriction IP utilisées pour un pare-feu IP. Les adresses IP qui ne correspondent pas aux règles sont bloquées par le pare-feu. Ces règles sont appliquées uniquement lorsque le « publicNetworkAccess » du service de recherche est « activé ».

PrivateEndpoint

Object

Ressource de point de terminaison privé du fournisseur Microsoft.Network.

Nom	Type	Description
id	string	ID de ressource de la ressource de point de terminaison privé du fournisseur Microsoft.Network.

PrivateEndpointConnection

Object

Décrit une connexion de point de terminaison privé existante au service de recherche.

Nom	Type	Description
id	string	ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nom de la ressource
properties	PrivateEndpointConnectionProperties	Décrit les propriétés d’une connexion de point de terminaison privé existante au service de recherche.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

PrivateEndpointConnectionProperties

Object

Décrit les propriétés d’une connexion de point de terminaison privé existante au service de recherche.

Nom	Type	Description
groupId	string	L’ID de groupe du fournisseur de ressources pour laquelle la connexion de service de liaison privée est activée.
privateEndpoint	PrivateEndpoint	Ressource de point de terminaison privé du fournisseur Microsoft.Network.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Décrit l’état actuel d’une connexion de service Private Link existante au point de terminaison privé Azure.
provisioningState	PrivateLinkServiceConnectionProvisioningState	État d’approvisionnement de la connexion de service de liaison privée. Les valeurs valides sont Mise à jour, Suppression, Échec, Réussite ou Incomplet

PrivateLinkServiceConnectionProvisioningState

Énumération

État d’approvisionnement de la connexion de service de liaison privée. Les valeurs valides sont Mise à jour, Suppression, Échec, Réussite ou Incomplet

Valeur	Description
Canceled	La demande d’approvisionnement de la ressource de connexion de service de liaison privée a été annulée
Deleting	La connexion de service de liaison privée est en cours de suppression.
Failed	La connexion de service de liaison privée n’a pas pu être provisionnée ou supprimée.
Incomplete	La demande d’approvisionnement de la ressource de connexion de service de liaison privée a été acceptée, mais le processus de création n’a pas encore commencé.
Succeeded	La connexion de service de liaison privée a terminé l’approvisionnement et est prête à être approuvée.
Updating	La connexion de service de liaison privée est en cours de création ainsi que d’autres ressources pour qu’elle soit entièrement fonctionnelle.

PrivateLinkServiceConnectionState

Object

Décrit l’état actuel d’une connexion de service Private Link existante au point de terminaison privé Azure.

Nom	Type	Valeur par défaut	Description
actionsRequired	string	None	Description de toutes les actions supplémentaires qui peuvent être requises.
description	string		Description de l’état de connexion du service de liaison privée.
status	PrivateLinkServiceConnectionStatus		État de la connexion du service de liaison privée. Les valeurs valides sont en attente, approuvées, rejetées ou déconnectées.

PrivateLinkServiceConnectionStatus

Énumération

État de la connexion du service de liaison privée. Les valeurs valides sont en attente, approuvées, rejetées ou déconnectées.

Valeur	Description
Approved	La connexion de point de terminaison privé est approuvée et prête à être utilisée.
Disconnected	La connexion de point de terminaison privé a été supprimée du service.
Pending	La connexion de point de terminaison privé a été créée et est en attente d’approbation.
Rejected	La connexion de point de terminaison privé a été rejetée et ne peut pas être utilisée.

ProvisioningState

Énumération

État de la dernière opération d’approvisionnement effectuée sur le service de recherche. L’approvisionnement est un état intermédiaire qui se produit pendant l’établissement de la capacité de service. Une fois la capacité configurée, provisioningState passe à « réussi » ou « échec ». Les applications clientes peuvent interroger l’état d’approvisionnement (l’intervalle d’interrogation recommandé est de 30 secondes à une minute) à l’aide de l’opération Get Search Service pour voir quand une opération est terminée. Si vous utilisez le service gratuit, cette valeur a tendance à revenir en tant que « réussi » directement dans l’appel pour créer un service de recherche. Cela est dû au fait que le service gratuit utilise la capacité déjà configurée.

Valeur	Description
failed	La dernière opération d’approvisionnement a échoué.
provisioning	Le service de recherche est approvisionné ou mis à l’échelle vers le haut ou vers le bas.
succeeded	La dernière opération d’approvisionnement s’est terminée avec succès.

PublicNetworkAccess

Énumération

Cette valeur peut être définie sur « activé » pour éviter les modifications cassants sur les ressources et les modèles clients existants. Si la valeur est « désactivée », le trafic sur l’interface publique n’est pas autorisé et les connexions de point de terminaison privé sont la méthode d’accès exclusive.

Valeur	Description
disabled
enabled

SearchEncryptionComplianceStatus

Énumération

Décrit si le service de recherche est conforme ou non en ce qui concerne l’utilisation de ressources non chiffrées par le client. Si un service a plusieurs ressources non chiffrées par le client et que l’option « Application » est « activée », le service est marqué comme « non conforme ».

Valeur	Description
Compliant	Indique que le service de recherche est conforme, soit parce que le nombre de ressources non chiffrées par le client est égal à zéro ou que l’application est désactivée.
NonCompliant	Indique que le service de recherche a plusieurs ressources non chiffrées par le client.

SearchEncryptionWithCmk

Énumération

Décrit comment un service de recherche doit appliquer une ou plusieurs ressources non chiffrées par le client.

Valeur	Description
Disabled	Aucune application ne sera effectuée et le service de recherche peut avoir des ressources non chiffrées par le client.
Enabled	Le service de recherche est marqué comme non conforme s’il existe une ou plusieurs ressources non chiffrées par le client.
Unspecified	La stratégie d’application n’est pas spécifiée explicitement, le comportement étant le même que s’il était défini sur « Désactivé ».

SearchSemanticSearch

Énumération

Définit les options qui contrôlent la disponibilité de la recherche sémantique. Cette configuration n’est possible que pour certaines références SKU de recherche dans certains emplacements.

Valeur	Description
disabled	Indique que le classement sémantique est désactivé pour le service de recherche.
free	Active le classement sémantique sur un service de recherche et indique qu’il doit être utilisé dans les limites du niveau gratuit. Cela limite le volume des demandes de classement sémantique et est proposé sans frais supplémentaires. Il s’agit de la valeur par défaut pour les services de recherche nouvellement provisionnés.
standard	Active le classement sémantique sur un service de recherche en tant que fonctionnalité facturable, avec un débit et un volume plus élevés de requêtes de classement sémantique.

SearchService

Object

Décrit un service de recherche et son état actuel.

Nom	Type	Valeur par défaut	Description
id	string		ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity		Identité de la ressource.
location	string		Emplacement géographique où réside la ressource
name	string		Nom de la ressource
properties.authOptions	DataPlaneAuthOptions		Définit les options pour la façon dont l’API de plan de données d’un service de recherche authentifie les demandes. Cela ne peut pas être défini si « disableLocalAuth » a la valeur true.
properties.disableLocalAuth	boolean		Lorsque la valeur est true, les appels au service de recherche ne sont pas autorisés à utiliser les clés API pour l’authentification. Cela ne peut pas être défini sur true si « dataPlaneAuthOptions » sont définis.
properties.encryptionWithCmk	EncryptionWithCmk		Spécifie toute stratégie concernant le chiffrement des ressources (telles que les index) à l’aide de clés de gestionnaire de clients au sein d’un service de recherche.
properties.hostingMode	HostingMode	default	Applicable uniquement pour la référence SKU standard3. Vous pouvez définir cette propriété pour activer jusqu’à 3 partitions à haute densité qui autorisent jusqu’à 1 000 index, ce qui est beaucoup plus élevé que les index maximum autorisés pour toute autre référence SKU. Pour la référence SKU standard3, la valeur est « default » ou « highDensity ». Pour toutes les autres références SKU, cette valeur doit être « par défaut ».
properties.networkRuleSet	NetworkRuleSet		Règles spécifiques au réseau qui déterminent la façon dont le service de recherche peut être atteint.
properties.partitionCount	integer (int32) minimum: 1 maximum: 12	1	Nombre de partitions dans le service de recherche ; si spécifié, il peut s’agir de 1, 2, 3, 4, 6 ou 12. Les valeurs supérieures à 1 sont valides uniquement pour les références SKU standard. Pour les services « standard3 » avec hostingMode défini sur « highDensity », les valeurs autorisées sont comprises entre 1 et 3.
properties.privateEndpointConnections	PrivateEndpointConnection[]		Liste des connexions de point de terminaison privé au service de recherche.
properties.provisioningState	ProvisioningState		État de la dernière opération d’approvisionnement effectuée sur le service de recherche. L’approvisionnement est un état intermédiaire qui se produit pendant l’établissement de la capacité de service. Une fois la capacité configurée, provisioningState passe à « réussi » ou « échec ». Les applications clientes peuvent interroger l’état d’approvisionnement (l’intervalle d’interrogation recommandé est de 30 secondes à une minute) à l’aide de l’opération Get Search Service pour voir quand une opération est terminée. Si vous utilisez le service gratuit, cette valeur a tendance à revenir en tant que « réussi » directement dans l’appel pour créer un service de recherche. Cela est dû au fait que le service gratuit utilise la capacité déjà configurée.
properties.publicNetworkAccess	PublicNetworkAccess	enabled	Cette valeur peut être définie sur « activé » pour éviter les modifications cassants sur les ressources et les modèles clients existants. Si la valeur est « désactivée », le trafic sur l’interface publique n’est pas autorisé et les connexions de point de terminaison privé sont la méthode d’accès exclusive.
properties.replicaCount	integer (int32) minimum: 1 maximum: 12	1	Nombre de réplicas dans le service de recherche. S’il est spécifié, il doit s’agir d’une valeur comprise entre 1 et 12 inclus pour les références SKU standard ou comprises entre 1 et 3 pour la référence SKU de base.
properties.semanticSearch	SearchSemanticSearch		Définit les options qui contrôlent la disponibilité de la recherche sémantique. Cette configuration n’est possible que pour certaines références SKU de recherche dans certains emplacements.
properties.sharedPrivateLinkResources	SharedPrivateLinkResource[]		Liste des ressources de liaison privée partagées gérées par le service de recherche.
properties.status	SearchServiceStatus		État du service de recherche. Les valeurs possibles sont les suivantes : « en cours d’exécution » : le service de recherche est en cours d’exécution et aucune opération d’approvisionnement n’est en cours. « approvisionnement » : le service de recherche est approvisionné ou mis à l’échelle vers le haut ou vers le bas. « suppression » : le service de recherche est en cours de suppression. « détérioré » : le service de recherche est détérioré. Cela peut se produire lorsque les unités de recherche sous-jacentes ne sont pas saines. Le service de recherche est probablement opérationnel, mais les performances peuvent être lentes et certaines requêtes peuvent être supprimées. ' désactivé' : le service de recherche est désactivé. Dans cet état, le service rejette toutes les demandes d’API. ' erreur' : le service de recherche est dans un état d’erreur. Si votre service se trouve dans les états détériorés, désactivés ou d’erreur, Microsoft examine activement le problème sous-jacent. Les services dédiés dans ces états sont toujours facturés en fonction du nombre d’unités de recherche approvisionnées.
properties.statusDetails	string		Détails de l’état du service de recherche.
sku	Sku		Référence SKU du service de recherche, qui détermine le taux de facturation et les limites de capacité. Cette propriété est requise lors de la création d’un service de recherche.
tags	object		Balises de ressource.
type	string		Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

SearchServiceStatus

Énumération

État du service de recherche. Les valeurs possibles sont les suivantes : « en cours d’exécution » : le service de recherche est en cours d’exécution et aucune opération d’approvisionnement n’est en cours. « approvisionnement » : le service de recherche est approvisionné ou mis à l’échelle vers le haut ou vers le bas. « suppression » : le service de recherche est en cours de suppression. « détérioré » : le service de recherche est détérioré. Cela peut se produire lorsque les unités de recherche sous-jacentes ne sont pas saines. Le service de recherche est probablement opérationnel, mais les performances peuvent être lentes et certaines requêtes peuvent être supprimées. ' désactivé' : le service de recherche est désactivé. Dans cet état, le service rejette toutes les demandes d’API. ' erreur' : le service de recherche est dans un état d’erreur. Si votre service se trouve dans les états détériorés, désactivés ou d’erreur, Microsoft examine activement le problème sous-jacent. Les services dédiés dans ces états sont toujours facturés en fonction du nombre d’unités de recherche approvisionnées.

Valeur	Description
degraded	Le service de recherche est détérioré, car les unités de recherche sous-jacentes ne sont pas saines.
deleting	Le service de recherche est en cours de suppression.
disabled	Le service de recherche est désactivé et toutes les demandes d’API sont rejetées.
error	Le service de recherche est dans un état d’erreur, indiquant un échec de provisionnement ou de suppression.
provisioning	Le service de recherche est approvisionné ou mis à l’échelle vers le haut ou vers le bas.
running	Le service de recherche est en cours d’exécution et aucune opération d’approvisionnement n’est en cours.

SharedPrivateLinkResource

Object

Décrit une ressource de liaison privée partagée gérée par le service de recherche.

Nom	Type	Description
id	string	ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nom de la ressource
properties	SharedPrivateLinkResourceProperties	Décrit les propriétés d’une ressource de liaison privée partagée gérée par le service de recherche.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

SharedPrivateLinkResourceProperties

Object

Décrit les propriétés d’une ressource de liaison privée partagée existante gérée par le service de recherche.

Nom	Type	Description
groupId	string	L’ID de groupe du fournisseur de ressources pour laquelle la ressource de liaison privée partagée est destinée.
privateLinkResourceId	string	L’ID de ressource de la ressource pour laquelle la ressource de liaison privée partagée est destinée.
provisioningState	SharedPrivateLinkResourceProvisioningState	État d’approvisionnement de la ressource de liaison privée partagée. Les valeurs valides sont Mise à jour, Suppression, Échec, Réussite ou Incomplet.
requestMessage	string	Message de demande d’approbation de la ressource de liaison privée partagée.
resourceRegion	string	Optionnel. Peut être utilisé pour spécifier l’emplacement Azure Resource Manager de la ressource à laquelle une liaison privée partagée doit être créée. Cela n’est nécessaire que pour les ressources dont la configuration DNS est régionale (par exemple, Azure Kubernetes Service).
status	SharedPrivateLinkResourceStatus	État de la ressource de liaison privée partagée. Les valeurs valides sont en attente, approuvées, rejetées ou déconnectées.

SharedPrivateLinkResourceProvisioningState

Énumération

État d’approvisionnement de la ressource de liaison privée partagée. Les valeurs valides sont Mise à jour, Suppression, Échec, Réussite ou Incomplet.

Valeur	Description
Deleting
Failed
Incomplete
Succeeded
Updating

SharedPrivateLinkResourceStatus

Énumération

État de la ressource de liaison privée partagée. Les valeurs valides sont en attente, approuvées, rejetées ou déconnectées.

Valeur	Description
Approved
Disconnected
Pending
Rejected

Sku

Object

Définit la référence SKU d’un service de recherche, qui détermine le taux de facturation et les limites de capacité.

Nom	Type	Description
name	SkuName	Référence SKU du service de recherche. Les valeurs valides sont les suivantes : « gratuit » : service partagé. « de base » : service dédié avec jusqu’à 3 réplicas. « standard » : service dédié avec jusqu’à 12 partitions et 12 réplicas. « standard2 » : similaire à la norme, mais avec plus de capacité par unité de recherche. « standard3 » : la plus grande offre Standard avec jusqu’à 12 partitions et 12 réplicas (ou jusqu’à 3 partitions avec plus d’index si vous définissez également la propriété hostingMode sur « highDensity »). 'storage_optimized_l1' : prend en charge 1 To par partition, jusqu’à 12 partitions. 'storage_optimized_l2' : prend en charge 2 To par partition, jusqu’à 12 partitions.

SkuName

Énumération

Référence SKU du service de recherche. Les valeurs valides sont les suivantes : « gratuit » : service partagé. « de base » : service dédié avec jusqu’à 3 réplicas. « standard » : service dédié avec jusqu’à 12 partitions et 12 réplicas. « standard2 » : similaire à la norme, mais avec plus de capacité par unité de recherche. « standard3 » : la plus grande offre Standard avec jusqu’à 12 partitions et 12 réplicas (ou jusqu’à 3 partitions avec plus d’index si vous définissez également la propriété hostingMode sur « highDensity »). 'storage_optimized_l1' : prend en charge 1 To par partition, jusqu’à 12 partitions. 'storage_optimized_l2' : prend en charge 2 To par partition, jusqu’à 12 partitions.

Valeur	Description
basic	Niveau facturable pour un service dédié ayant jusqu’à 3 réplicas.
free	Niveau gratuit, sans garantie sla et sous-ensemble des fonctionnalités proposées sur les niveaux facturables.
standard	Niveau facturable pour un service dédié ayant jusqu’à 12 partitions et 12 réplicas.
standard2	Similaire à « standard », mais avec plus de capacité par unité de recherche.
standard3	La plus grande offre Standard avec jusqu’à 12 partitions et 12 réplicas (ou jusqu’à 3 partitions avec plus d’index si vous définissez également la propriété hostingMode sur « highDensity »).
storage_optimized_l1	Niveau facturable pour un service dédié qui prend en charge 1 To par partition, jusqu’à 12 partitions.
storage_optimized_l2	Niveau facturable pour un service dédié qui prend en charge 2 To par partition, jusqu’à 12 partitions.