Services - Get

Service:

Search Management

API Version:

2023-11-01

Obtient le service de recherche avec 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 au sein de 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 demande. S’il est spécifié, il est inclus dans les informations de réponse afin 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 figure dans la réponse. Si vous interrogez la fin d’une opération d’approvisionnement ou de mise à l’échelle, vous pouvez case activée son status 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 est introuvable.

Sécurité

azure_auth

Microsoft Entra ID flux d’autorisation OAuth2.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

Exemples

SearchGetService

Sample Request

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

Sample Response

Status code:

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 enverrait pour les demandes ayant é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 d’un locataire Microsoft Entra ID peut être utilisé pour l’authentification.
DataPlaneAuthOptions	Définit les options pour la façon dont le service de recherche authentifie une demande de plan de données. Cette valeur ne peut pas être définie si « disableLocalAuth » a la valeur true.
EncryptionWithCmk	Décrit une stratégie qui détermine comment les ressources au sein du service de recherche doivent être chiffrées avec customer=managed keys.
HostingMode	Applicable uniquement à 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 « default ».
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 comment 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 au service private link. Les valeurs valides sont Mise à jour, Suppression, Échec, Réussi ou Incomplet
PrivateLinkServiceConnectionState	Décrit l’état actuel d’une connexion Private Link Service existante au point de terminaison privé Azure.
PrivateLinkServiceConnectionStatus	État de la connexion au service de liaison privée. Les valeurs valides sont En attente, Approuvé, Rejeté ou Déconnecté.
ProvisioningState	État de la dernière opération d’approvisionnement effectuée sur le service de recherche. Le déploiement désigne un état intermédiaire pendant lequel la capacité de service est établie. Une fois la capacité configurée, provisioningState passe à « succeeded » ou « failed ». Les applications clientes peuvent interroger l’approvisionnement status (l’intervalle d’interrogation recommandé est de 30 secondes à une minute) à l’aide de l’opération Obtenir le service de recherche pour voir quand une opération est terminée. Si vous utilisez le service gratuit, cette valeur a tendance à revenir comme « réussi » directement dans l’appel à Créer un service de recherche. Cela est dû au fait que le service gratuit utilise une capacité déjà configurée.
PublicNetworkAccess	Cette valeur peut être définie sur « enabled » pour éviter les changements cassants sur les modèles et les ressources 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é constituent la méthode d’accès exclusif.
SearchEncryptionComplianceStatus	Indique si le service de recherche est conforme ou non en ce qui concerne la présence de ressources non chiffrées par le client. Si un service a plusieurs ressources non chiffrées par le client et que « 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	Status du service de recherche. Les valeurs possibles sont les suivantes : « running » : le service de recherche est en cours d’exécution et aucune opération d’approvisionnement n’est en cours. « provisionnement » : le service de recherche est en cours d’approvisionnement ou de scale-up ou de scale-down. « 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 demandes peuvent être supprimées. « disabled » : 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 est dans l’état détérioré, désactivé ou d’erreur, Microsoft étudie activement le problème sous-jacent. Les services dédiés indiquant ces états peuvent faire l’objet d’une facturation en fonction du nombre d’unités de recherche déployées.
SharedPrivateLinkResource	Décrit une ressource de Private Link partagée gérée par le service de recherche.
SharedPrivateLinkResourceProperties	Décrit les propriétés d’une ressource de Private Link 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éussi ou Incomplet.
SharedPrivateLinkResourceStatus	État de la ressource de liaison privée partagée. Les valeurs valides sont Pending, Approved, Rejected ou Disconnected.
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 : « free » : 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 à standard, mais avec plus de capacité par unité de recherche. « standard3 » : offre Standard la plus grande 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

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

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

ApiKeyOnly

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

CloudError

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

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 status 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 l’erreur en détail et fournit des informations de débogage.
target	string	Cible de l’erreur particulière (par exemple, le nom de la propriété dans l’erreur).

DataPlaneAadOrApiKeyAuthOption

Indique que la clé API ou un jeton d’accès 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 enverrait pour les demandes ayant échoué.

DataPlaneAuthOptions

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

Nom	Type	Description
aadOrApiKey	DataPlaneAadOrApiKeyAuthOption	Indique que la clé API ou un jeton d’accès 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

Décrit une stratégie qui détermine comment les ressources au sein du service de recherche doivent être chiffrées avec customer=managed keys.

Nom	Type	Description
encryptionComplianceStatus	SearchEncryptionComplianceStatus	Indique si le service de recherche est conforme ou non en ce qui concerne la présence de ressources non chiffrées par le client. Si un service a plusieurs ressources non chiffrées par le client et que « 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

Applicable uniquement à 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 « default ».

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

Identity

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

Type d’identité.

Nom	Type	Description
None	string
SystemAssigned	string

IpRule

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 d’adresses IP au format CIDR (par exemple, 123.1.2.3/24) à autoriser.

NetworkRuleSet

Règles spécifiques au réseau qui déterminent comment 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. Toutes 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 « publicNetworkAccess » du service de recherche est « activé ».

PrivateEndpoint

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

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

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

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

PrivateLinkServiceConnectionProvisioningState

État d’approvisionnement de la connexion au service private link. Les valeurs valides sont Mise à jour, Suppression, Échec, Réussi ou Incomplet

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

PrivateLinkServiceConnectionState

Décrit l’état actuel d’une connexion Private Link Service 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 private link.
status	PrivateLinkServiceConnectionStatus		État de la connexion au service de liaison privée. Les valeurs valides sont En attente, Approuvé, Rejeté ou Déconnecté.

PrivateLinkServiceConnectionStatus

État de la connexion au service de liaison privée. Les valeurs valides sont En attente, Approuvé, Rejeté ou Déconnecté.

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

ProvisioningState

État de la dernière opération d’approvisionnement effectuée sur le service de recherche. Le déploiement désigne un état intermédiaire pendant lequel la capacité de service est établie. Une fois la capacité configurée, provisioningState passe à « succeeded » ou « failed ». Les applications clientes peuvent interroger l’approvisionnement status (l’intervalle d’interrogation recommandé est de 30 secondes à une minute) à l’aide de l’opération Obtenir le service de recherche pour voir quand une opération est terminée. Si vous utilisez le service gratuit, cette valeur a tendance à revenir comme « réussi » directement dans l’appel à Créer un service de recherche. Cela est dû au fait que le service gratuit utilise une capacité déjà configurée.

Nom	Type	Description
failed	string	La dernière opération d’approvisionnement a échoué.
provisioning	string	Le service de recherche est en cours d’approvisionnement ou de scale-up ou de scale-down.
succeeded	string	La dernière opération d’approvisionnement s’est terminée avec succès.

PublicNetworkAccess

Cette valeur peut être définie sur « enabled » pour éviter les changements cassants sur les modèles et les ressources 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é constituent la méthode d’accès exclusif.

Nom	Type	Description
disabled	string
enabled	string

SearchEncryptionComplianceStatus

Indique si le service de recherche est conforme ou non en ce qui concerne la présence de ressources non chiffrées par le client. Si un service a plusieurs ressources non chiffrées par le client et que « Application » est « activée », le service est marqué comme « non conforme ».

Nom	Type	Description
Compliant	string	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, soit parce que l’application est désactivée.
NonCompliant	string	Indique que le service de recherche a plusieurs ressources non chiffrées par le client.

SearchEncryptionWithCmk

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

Nom	Type	Description
Disabled	string	Aucune application ne sera appliquée et le service de recherche peut avoir des ressources non chiffrées par le client.
Enabled	string	service Search seront marqués comme non conformes s’il existe une ou plusieurs ressources non chiffrées par le client.
Unspecified	string	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

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.

Nom	Type	Description
disabled	string	Indique que le classement sémantique est désactivé pour le service de recherche.
free	string	Active le classement sémantique sur un service de recherche et indique qu’il doit être utilisé dans les limites du niveau gratuit. Cela limiterait 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	string	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 demandes de classement sémantique.

SearchService

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. Cette valeur ne peut pas être définie 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 des clés API pour l’authentification. Cette valeur ne peut pas être définie sur true si « dataPlaneAuthOptions » est défini.
properties.encryptionWithCmk	EncryptionWithCmk		Spécifie toute stratégie concernant le chiffrement des ressources (comme les index) à l’aide de clés customer manager au sein d’un service de recherche.
properties.hostingMode	HostingMode	default	Applicable uniquement à 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 « default ».
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	1	Nombre de partitions dans le service de recherche ; s’il est spécifié, il peut s’agir de 1, 2, 3, 4, 6 ou 12. Les valeurs supérieures à 1 sont uniquement valides 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. Le déploiement désigne un état intermédiaire pendant lequel la capacité de service est établie. Une fois la capacité configurée, provisioningState passe à « succeeded » ou « failed ». Les applications clientes peuvent interroger l’approvisionnement status (l’intervalle d’interrogation recommandé est de 30 secondes à une minute) à l’aide de l’opération Obtenir le service de recherche pour voir quand une opération est terminée. Si vous utilisez le service gratuit, cette valeur a tendance à revenir comme « réussi » directement dans l’appel à Créer un service de recherche. Cela est dû au fait que le service gratuit utilise une capacité déjà configurée.
properties.publicNetworkAccess	PublicNetworkAccess	enabled	Cette valeur peut être définie sur « enabled » pour éviter les changements cassants sur les modèles et les ressources 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é constituent la méthode d’accès exclusif.
properties.replicaCount	integer	1	Nombre de réplicas dans le service de recherche. Si elle est spécifiée, il doit s’agir d’une valeur comprise entre 1 et 12 inclusive pour les références SKU standard ou comprise entre 1 et 3 inclus 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		Status du service de recherche. Les valeurs possibles sont les suivantes : « running » : le service de recherche est en cours d’exécution et aucune opération d’approvisionnement n’est en cours. « provisionnement » : le service de recherche est en cours d’approvisionnement ou de scale-up ou de scale-down. « 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 demandes peuvent être supprimées. « disabled » : 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 est dans l’état détérioré, désactivé ou d’erreur, Microsoft étudie activement le problème sous-jacent. Les services dédiés indiquant ces états peuvent faire l’objet d’une facturation en fonction du nombre d’unités de recherche déployées.
properties.statusDetails	string		Détails du service de recherche status.
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

Status du service de recherche. Les valeurs possibles sont les suivantes : « running » : le service de recherche est en cours d’exécution et aucune opération d’approvisionnement n’est en cours. « provisionnement » : le service de recherche est en cours d’approvisionnement ou de scale-up ou de scale-down. « 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 demandes peuvent être supprimées. « disabled » : 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 est dans l’état détérioré, désactivé ou d’erreur, Microsoft étudie activement le problème sous-jacent. Les services dédiés indiquant ces états peuvent faire l’objet d’une facturation en fonction du nombre d’unités de recherche déployées.

Nom	Type	Description
degraded	string	Le service de recherche est dégradé, car les unités de recherche sous-jacentes ne sont pas saines.
deleting	string	Le service de recherche est en cours de suppression.
disabled	string	Le service de recherche est désactivé et toutes les demandes d’API sont rejetées.
error	string	Le service de recherche est à l’état d’erreur, ce qui indique un échec d’approvisionnement ou de suppression.
provisioning	string	Le service de recherche est en cours d’approvisionnement ou de scale-up ou de scale-down.
running	string	Le service de recherche est en cours d’exécution et aucune opération d’approvisionnement n’est en cours.

SharedPrivateLinkResource

Décrit une ressource de Private Link 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 Private Link 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

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

Nom	Type	Description
groupId	string	ID de groupe du fournisseur de la ressource pour laquelle la ressource de liaison privée partagée est destinée.
privateLinkResourceId	string	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éussi ou Incomplet.
requestMessage	string	Message de demande d’approbation de la ressource de liaison privée partagée.
resourceRegion	string	facultatif. Peut être utilisé pour spécifier l’emplacement azure Resource Manager de la ressource vers laquelle une liaison privée partagée doit être créée. Cela est nécessaire uniquement 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 Pending, Approved, Rejected ou Disconnected.

SharedPrivateLinkResourceProvisioningState

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

Nom	Type	Description
Deleting	string
Failed	string
Incomplete	string
Succeeded	string
Updating	string

SharedPrivateLinkResourceStatus

État de la ressource de liaison privée partagée. Les valeurs valides sont Pending, Approved, Rejected ou Disconnected.

Nom	Type	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

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é.

Nom	Type	Description
name	SkuName	Référence SKU du service de recherche. Les valeurs valides sont les suivantes : « free » : 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 à standard, mais avec plus de capacité par unité de recherche. « standard3 » : offre Standard la plus grande 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

Référence SKU du service de recherche. Les valeurs valides sont les suivantes : « free » : 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 à standard, mais avec plus de capacité par unité de recherche. « standard3 » : offre Standard la plus grande 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. »

Nom	Type	Description
basic	string	Niveau facturable pour un service dédié ayant jusqu’à 3 réplicas.
free	string	Niveau gratuit, sans garantie sla et un sous-ensemble des fonctionnalités proposées sur les niveaux facturables.
standard	string	Niveau facturable pour un service dédié ayant jusqu’à 12 partitions et 12 réplicas.
standard2	string	Similaire à « standard », mais avec plus de capacité par unité de recherche.
standard3	string	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	string	Niveau facturable pour un service dédié qui prend en charge 1 To par partition, jusqu’à 12 partitions.
storage_optimized_l2	string	Niveau facturable pour un service dédié qui prend en charge 2 To par partition, jusqu’à 12 partitions.