Microsoft.Search searchServices 2023-11-01

Article
12/20/2024

Définition de ressource Bicep

Le type de ressource searchServices peut être déployé avec des opérations qui ciblent :

groupes de ressources - Consultez commandes de déploiement de groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.Search/searchServices, ajoutez le bicep suivant à votre modèle.

resource symbolicname 'Microsoft.Search/searchServices@2023-11-01' = {
  identity: {
    type: 'string'
  }
  location: 'string'
  name: 'string'
  properties: {
    authOptions: {
      aadOrApiKey: {
        aadAuthFailureMode: 'string'
      }
      apiKeyOnly: any(Azure.Bicep.Types.Concrete.AnyType)
    }
    disableLocalAuth: bool
    encryptionWithCmk: {
      enforcement: 'string'
    }
    hostingMode: 'string'
    networkRuleSet: {
      ipRules: [
        {
          value: 'string'
        }
      ]
    }
    partitionCount: int
    publicNetworkAccess: 'string'
    replicaCount: int
    semanticSearch: 'string'
  }
  sku: {
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Valeurs de propriété

DataPlaneAadOrApiKeyAuthOption

Nom	Description	Valeur
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é.	'http401WithBearerChallenge' 'http403'

DataPlaneAuthOptions

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

EncryptionWithCmk

Nom	Description	Valeur
application	Décrit comment un service de recherche doit appliquer une ou plusieurs ressources non chiffrées par le client.	'Désactivé' 'Activé' 'Non spécifié'

Identité

Nom	Description	Valeur
type	Type d’identité.	'None' 'SystemAssigned' (obligatoire)

IpRule

Nom	Description	Valeur
valeur	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.	corde

Microsoft.Search/searchServices

Nom	Description	Valeur
identité	Identité de la ressource.	Identity
emplacement	Emplacement géographique où réside la ressource	chaîne (obligatoire)
nom	Nom de la ressource	chaîne (obligatoire)
Propriétés	Propriétés du service de recherche.	SearchServiceProperties
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.	référence SKU
étiquettes	Balises de ressource	Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles

NetworkRuleSet

Nom	Description	Valeur
ipRules	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é ».	IpRule []

SearchServiceProperties

Nom	Description	Valeur
authOptions	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.	DataPlaneAuthOptions
disableLocalAuth	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.	Bool
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.	EncryptionWithCmk
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 ».	'default' 'highDensity'
networkRuleSet	Règles spécifiques au réseau qui déterminent la façon dont le service de recherche peut être atteint.	NetworkRuleSet
partitionCount	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.	Int Contraintes: Valeur minimale = 1 Valeur maximale = 12
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.	'disabled' 'enabled'
replicaCount	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.	Int Contraintes: Valeur minimale = 1 Valeur maximale = 12
semanticSearch	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.	'disabled' 'free' 'standard'

Sku

Nom	Description	Valeur
nom	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.	'basic' 'free' 'standard' 'standard2' 'standard3' 'storage_optimized_l1' 'storage_optimized_l2'

TrackedResourceTags

Nom	Description	Valeur

Exemples de démarrage rapide

Les exemples de démarrage rapide suivants déploient ce type de ressource.

Fichier Bicep	Description
restreint réseau Azure AI Studio	Cet ensemble de modèles montre comment configurer Azure AI Studio avec une liaison privée et une sortie désactivées, à l’aide de clés gérées par Microsoft pour le chiffrement et la configuration d’identité managée par Microsoft pour la ressource IA.
service Recherche cognitive Azure	Ce modèle crée un service Recherche cognitive Azure

Définition de ressource de modèle ARM

Le type de ressource searchServices peut être déployé avec des opérations qui ciblent :

groupes de ressources - Consultez commandes de déploiement de groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.Search/searchServices, ajoutez le code JSON suivant à votre modèle.

{
  "type": "Microsoft.Search/searchServices",
  "apiVersion": "2023-11-01",
  "name": "string",
  "identity": {
    "type": "string"
  },
  "location": "string",
  "properties": {
    "authOptions": {
      "aadOrApiKey": {
        "aadAuthFailureMode": "string"
      },
      "apiKeyOnly": {}
    },
    "disableLocalAuth": "bool",
    "encryptionWithCmk": {
      "enforcement": "string"
    },
    "hostingMode": "string",
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "string"
        }
      ]
    },
    "partitionCount": "int",
    "publicNetworkAccess": "string",
    "replicaCount": "int",
    "semanticSearch": "string"
  },
  "sku": {
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valeurs de propriété

DataPlaneAadOrApiKeyAuthOption

Nom	Description	Valeur
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é.	'http401WithBearerChallenge' 'http403'

DataPlaneAuthOptions

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

EncryptionWithCmk

Nom	Description	Valeur
application	Décrit comment un service de recherche doit appliquer une ou plusieurs ressources non chiffrées par le client.	'Désactivé' 'Activé' 'Non spécifié'

Identité

Nom	Description	Valeur
type	Type d’identité.	'None' 'SystemAssigned' (obligatoire)

IpRule

Nom	Description	Valeur
valeur	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.	corde

Microsoft.Search/searchServices

Nom	Description	Valeur
apiVersion	Version de l’API	'2023-11-01'
identité	Identité de la ressource.	Identity
emplacement	Emplacement géographique où réside la ressource	chaîne (obligatoire)
nom	Nom de la ressource	chaîne (obligatoire)
Propriétés	Propriétés du service de recherche.	SearchServiceProperties
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.	référence SKU
étiquettes	Balises de ressource	Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles
type	Type de ressource	'Microsoft.Search/searchServices'

NetworkRuleSet

Nom	Description	Valeur
ipRules	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é ».	IpRule []

SearchServiceProperties

Nom	Description	Valeur
authOptions	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.	DataPlaneAuthOptions
disableLocalAuth	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.	Bool
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.	EncryptionWithCmk
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 ».	'default' 'highDensity'
networkRuleSet	Règles spécifiques au réseau qui déterminent la façon dont le service de recherche peut être atteint.	NetworkRuleSet
partitionCount	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.	Int Contraintes: Valeur minimale = 1 Valeur maximale = 12
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.	'disabled' 'enabled'
replicaCount	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.	Int Contraintes: Valeur minimale = 1 Valeur maximale = 12
semanticSearch	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.	'disabled' 'free' 'standard'

Sku

Nom	Description	Valeur
nom	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.	'basic' 'free' 'standard' 'standard2' 'standard3' 'storage_optimized_l1' 'storage_optimized_l2'

TrackedResourceTags

Nom	Description	Valeur

Modèles de démarrage rapide

Les modèles de démarrage rapide suivants déploient ce type de ressource.

Modèle	Description
restreint réseau Azure AI Studio	Cet ensemble de modèles montre comment configurer Azure AI Studio avec une liaison privée et une sortie désactivées, à l’aide de clés gérées par Microsoft pour le chiffrement et la configuration d’identité managée par Microsoft pour la ressource IA.
service Recherche cognitive Azure	Ce modèle crée un service Recherche cognitive Azure
service Recherche cognitive Azure avec de point de terminaison privé	Ce modèle crée un service Recherche cognitive Azure avec un point de terminaison privé.
Application web avec une base de données SQL, Azure Cosmos DB, azure Search	Ce modèle provisionne une application web, une base de données SQL, Azure Cosmos DB, Azure Search et Application Insights.

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource searchServices peut être déployé avec des opérations qui ciblent :

groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.Search/searchServices, ajoutez terraform suivant à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Search/searchServices@2023-11-01"
  name = "string"
  identity = {
    type = "string"
  }
  location = "string"
  sku = {
    name = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      authOptions = {
        aadOrApiKey = {
          aadAuthFailureMode = "string"
        }
        apiKeyOnly = ?
      }
      disableLocalAuth = bool
      encryptionWithCmk = {
        enforcement = "string"
      }
      hostingMode = "string"
      networkRuleSet = {
        ipRules = [
          {
            value = "string"
          }
        ]
      }
      partitionCount = int
      publicNetworkAccess = "string"
      replicaCount = int
      semanticSearch = "string"
    }
  })
}

Valeurs de propriété

DataPlaneAadOrApiKeyAuthOption

Nom	Description	Valeur
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é.	'http401WithBearerChallenge' 'http403'

DataPlaneAuthOptions

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

EncryptionWithCmk

Nom	Description	Valeur
application	Décrit comment un service de recherche doit appliquer une ou plusieurs ressources non chiffrées par le client.	'Désactivé' 'Activé' 'Non spécifié'

Identité

Nom	Description	Valeur
type	Type d’identité.	'None' 'SystemAssigned' (obligatoire)

IpRule

Nom	Description	Valeur
valeur	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.	corde

Microsoft.Search/searchServices

Nom	Description	Valeur
identité	Identité de la ressource.	Identity
emplacement	Emplacement géographique où réside la ressource	chaîne (obligatoire)
nom	Nom de la ressource	chaîne (obligatoire)
Propriétés	Propriétés du service de recherche.	SearchServiceProperties
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.	référence SKU
étiquettes	Balises de ressource	Dictionnaire de noms et de valeurs d’étiquettes.
type	Type de ressource	« Microsoft.Search/searchServices@2023-11-01 »

NetworkRuleSet

Nom	Description	Valeur
ipRules	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é ».	IpRule []

SearchServiceProperties

Nom	Description	Valeur
authOptions	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.	DataPlaneAuthOptions
disableLocalAuth	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.	Bool
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.	EncryptionWithCmk
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 ».	'default' 'highDensity'
networkRuleSet	Règles spécifiques au réseau qui déterminent la façon dont le service de recherche peut être atteint.	NetworkRuleSet
partitionCount	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.	Int Contraintes: Valeur minimale = 1 Valeur maximale = 12
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.	'disabled' 'enabled'
replicaCount	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.	Int Contraintes: Valeur minimale = 1 Valeur maximale = 12
semanticSearch	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.	'disabled' 'free' 'standard'

Sku

Nom	Description	Valeur
nom	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.	'basic' 'free' 'standard' 'standard2' 'standard3' 'storage_optimized_l1' 'storage_optimized_l2'

TrackedResourceTags

Nom	Description	Valeur

Partager via

Microsoft.Search searchServices 2023-11-01

Définition de ressource Bicep

Format de ressource

Valeurs de propriété

DataPlaneAadOrApiKeyAuthOption

DataPlaneAuthOptions

EncryptionWithCmk

Identité

IpRule

Microsoft.Search/searchServices

NetworkRuleSet

SearchServiceProperties

Sku

TrackedResourceTags

Exemples de démarrage rapide

Définition de ressource de modèle ARM

Format de ressource

Valeurs de propriété

DataPlaneAadOrApiKeyAuthOption

DataPlaneAuthOptions

EncryptionWithCmk

Identité

IpRule

Microsoft.Search/searchServices

NetworkRuleSet

SearchServiceProperties

Sku

TrackedResourceTags

Modèles de démarrage rapide

Définition de ressource Terraform (fournisseur AzAPI)

Format de ressource

Valeurs de propriété

DataPlaneAadOrApiKeyAuthOption

DataPlaneAuthOptions

EncryptionWithCmk

Identité

IpRule

Microsoft.Search/searchServices

NetworkRuleSet

SearchServiceProperties

Sku

TrackedResourceTags

Commentaires

Ressources supplémentaires