Microsoft. Recherche searchServices 2023-11-01
Définition de ressource Bicep
Le type de ressource searchServices peut être déployé avec des opérations qui ciblent :
- Groupes de ressources - Voir commandes de déploiement de groupe de ressources
Pour obtenir la liste des propriétés modifiées dans chaque version d’API, consultez journal des modifications.
Format des ressources
Pour créer un Microsoft. Recherche/searchServices, ajoutez le Bicep suivant à votre modèle.
resource symbolicname 'Microsoft.Search/searchServices@2023-11-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
sku: {
name: 'string'
}
identity: {
type: 'string'
}
properties: {
authOptions: {
aadOrApiKey: {
aadAuthFailureMode: 'string'
}
apiKeyOnly: any()
}
disableLocalAuth: bool
encryptionWithCmk: {
enforcement: 'string'
}
hostingMode: 'string'
networkRuleSet: {
ipRules: [
{
value: 'string'
}
]
}
partitionCount: int
publicNetworkAccess: 'string'
replicaCount: int
semanticSearch: 'string'
}
}
Valeurs de propriétés
searchServices
| Nom | Description | Valeur |
|---|---|---|
| name | Nom de la ressource | string (obligatoire) |
| location | Emplacement géographique où réside la ressource | string (obligatoire) |
| tags | Balises de ressource. | Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles |
| 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. | Sku |
| identité | Identité de la ressource. | Identité |
| properties | Propriétés du service de recherche. | SearchServiceProperties |
Identité
| Nom | Description | Valeur |
|---|---|---|
| type | Type d’identité. | 'None' 'SystemAssigned' (obligatoire) |
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. Cette valeur ne peut pas être définie 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 des clés API pour l’authentification. Cette valeur ne peut pas être définie sur true si « dataPlaneAuthOptions » est défini. | bool |
| 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. | EncryptionWithCmk |
| 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 ». | '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 ; 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. | int Contraintes : Valeur minimale = 1 Valeur maximale = 12 |
| 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. | 'disabled' 'enabled' |
| replicaCount | 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. | 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' |
DataPlaneAuthOptions
| Nom | Description | Valeur |
|---|---|---|
| aadOrApiKey | Indique que la clé API ou un jeton d’accès d’un locataire Microsoft Entra ID peuvent être utilisés pour l’authentification. | DataPlaneAadOrApiKeyAuthOption |
| apiKeyOnly | Indique que seule la clé API peut être utilisée pour l’authentification. | Pour Bicep, vous pouvez utiliser la fonction any(). |
DataPlaneAadOrApiKeyAuthOption
| Nom | Description | Valeur |
|---|---|---|
| aadAuthFailureMode | Décrit la réponse que l’API de plan de données d’un service de recherche enverrait pour les demandes ayant échoué à l’authentification. | 'http401WithBearerChallenge' 'http403' |
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é' 'Enabled' 'Non spécifié' |
NetworkRuleSet
| Nom | Description | Valeur |
|---|---|---|
| ipRules | 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 ne sont appliquées que lorsque le « publicNetworkAccess » du service de recherche est « enabled ». | IpRule[] |
IpRule
| Nom | Description | Valeur |
|---|---|---|
| value | Valeur correspondant à une adresse IPv4 unique (par exemple, 123.1.2.3) ou à une plage IP au format CIDR (par exemple, 123.1.2.3/24) à autoriser. | string |
Sku
| Nom | Description | Valeur |
|---|---|---|
| name | Référence SKU du service de recherche. Les valeurs valides sont les suivantes : « free » : service partagé. « basic » : 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 » : la plus grande offre Standard avec jusqu’à 12 partitions et 12 réplicas (ou jusqu’à 3 partitions avec davantage 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' |
Modèles de démarrage rapide
Les modèles de démarrage rapide suivants déploient ce type de ressource.
| Modèle | Description |
|---|---|
Application web avec un SQL Database, Azure Cosmos DB, Azure Recherche
|
Ce modèle approvisionne une application web, une SQL Database, Azure Cosmos DB, Azure Recherche et Application Insights. |
|
Service Recherche cognitive Azure
|
Ce modèle crée un service Recherche cognitive Azure |
|
Recherche cognitive Azure service avec point de terminaison privé
|
Ce modèle crée un service Recherche cognitive Azure avec un point de terminaison privé. |
Définition de ressources de modèle ARM
Le type de ressource searchServices peut être déployé avec des opérations qui ciblent :
- Groupes de ressources - Voir 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 des ressources
Pour créer un Microsoft. Recherche/searchServices ressource, ajoutez le code JSON suivant à votre modèle.
{
"type": "Microsoft.Search/searchServices",
"apiVersion": "2023-11-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"sku": {
"name": "string"
},
"identity": {
"type": "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"
}
}
Valeurs de propriétés
searchServices
| Nom | Description | Valeur |
|---|---|---|
| type | Type de ressource | 'Microsoft. Recherche/searchServices' |
| apiVersion | Version de l’API de ressource | '2023-11-01' |
| name | Nom de la ressource | string (obligatoire) |
| location | Emplacement géographique où réside la ressource | string (obligatoire) |
| tags | Balises de ressource. | Dictionnaire de noms et de valeurs d’étiquettes. Voir Balises dans les modèles |
| 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. | Sku |
| identité | Identité de la ressource. | Identité |
| properties | Propriétés du service de recherche. | SearchServiceProperties |
Identité
| Nom | Description | Valeur |
|---|---|---|
| type | Type d’identité. | 'None' 'SystemAssigned' (obligatoire) |
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. Cette valeur ne peut pas être définie 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 des clés API pour l’authentification. Cette valeur ne peut pas être définie sur true si « dataPlaneAuthOptions » est défini. | bool |
| 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. | EncryptionWithCmk |
| 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 ». | '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 ; 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. | int Contraintes : Valeur minimale = 1 Valeur maximale = 12 |
| 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. | 'disabled' 'enabled' |
| replicaCount | 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. | 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' |
DataPlaneAuthOptions
| Nom | Description | Valeur |
|---|---|---|
| aadOrApiKey | Indique que la clé API ou un jeton d’accès 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. |
DataPlaneAadOrApiKeyAuthOption
| Nom | Description | Valeur |
|---|---|---|
| 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é. | 'http401WithBearerChallenge' 'http403' |
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é' 'Enabled' 'Non spécifié' |
NetworkRuleSet
| Nom | Description | Valeur |
|---|---|---|
| ipRules | 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é ». | IpRule[] |
IpRule
| Nom | Description | Valeur |
|---|---|---|
| value | 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. | string |
Sku
| Nom | Description | Valeur |
|---|---|---|
| name | 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. » | 'basic' 'free' 'standard' 'standard2' 'standard3' 'storage_optimized_l1' 'storage_optimized_l2' |
Modèles de démarrage rapide
Les modèles de démarrage rapide suivants déploient ce type de ressource.
| Modèle | Description |
|---|---|
|
Application web avec un SQL Database, Azure Cosmos DB, Azure Recherche
|
Ce modèle provisionne une application web, un SQL Database, Azure Cosmos DB, Azure Recherche et Application Insights. |
|
Service Recherche cognitive Azure
|
Ce modèle crée un service Recherche cognitive Azure |
|
Recherche cognitive Azure service avec point de terminaison privé
|
Ce modèle crée un service Recherche cognitive Azure avec un point de terminaison privé. |
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 d’API, consultez journal des modifications.
Format des ressources
Pour créer un Microsoft. Recherche ressource/searchServices, ajoutez le Terraform suivant à votre modèle.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Search/searchServices@2023-11-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "SystemAssigned"
}
body = jsonencode({
properties = {
authOptions = {
aadOrApiKey = {
aadAuthFailureMode = "string"
}
}
disableLocalAuth = bool
encryptionWithCmk = {
enforcement = "string"
}
hostingMode = "string"
networkRuleSet = {
ipRules = [
{
value = "string"
}
]
}
partitionCount = int
publicNetworkAccess = "string"
replicaCount = int
semanticSearch = "string"
}
sku = {
name = "string"
}
})
}
Valeurs de propriétés
searchServices
| Nom | Description | Valeur |
|---|---|---|
| type | Type de ressource | « Microsoft. Recherche/searchServices@2023-11-01" |
| name | Nom de la ressource | string (obligatoire) |
| location | Emplacement géographique où réside la ressource | string (obligatoire) |
| parent_id | Pour effectuer un déploiement dans un groupe de ressources, utilisez l’ID de ce groupe de ressources. | string (obligatoire) |
| tags | Balises de ressource. | Dictionnaire de noms et de valeurs d’étiquettes. |
| 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. | Sku |
| identité | Identité de la ressource. | Identité |
| properties | Propriétés du service de recherche. | SearchServiceProperties |
Identité
| Nom | Description | Valeur |
|---|---|---|
| type | Type d’identité. | « SystemAssigned » (obligatoire) |
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. Cette valeur ne peut pas être définie si « disableLocalAuth » a la valeur true. | DataPlaneAuthOptions |
| disableLocalAuth | Lorsqu’il est défini sur 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éfinie. | bool |
| encryptionWithCmk | Spécifie toute stratégie concernant le chiffrement des ressources (telles que les index) à l’aide de clés customer Manager 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 « default ». | « valeur par défaut » « 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 ne sont valides que 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 « enabled » pour éviter les modifications cassants sur les modèles et les ressources client existants. Si la valeur est « disabled », 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. | "disabled" (désactivé) "enabled" (activé) |
| replicaCount | 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 inclus pour les références SKU standard ou comprise entre 1 et 3 inclus 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" (désactivé) « gratuit » « standard » |
DataPlaneAuthOptions
| Nom | Description | Valeur |
|---|---|---|
| aadOrApiKey | Indique que la clé API ou un jeton d’accès d’un locataire Microsoft Entra ID peuvent être utilisés pour l’authentification. | DataPlaneAadOrApiKeyAuthOption |
| apiKeyOnly | Indique que seule la clé API peut être utilisée pour l’authentification. |
DataPlaneAadOrApiKeyAuthOption
| Nom | Description | Valeur |
|---|---|---|
| aadAuthFailureMode | Décrit la réponse que l’API de plan de données d’un service de recherche enverrait pour les demandes ayant échoué à l’authentification. | « http401WithBearerChallenge » « http403 » |
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é » |
NetworkRuleSet
| Nom | Description | Valeur |
|---|---|---|
| ipRules | 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 ne sont appliquées que lorsque le « publicNetworkAccess » du service de recherche est « enabled ». | IpRule[] |
IpRule
| Nom | Description | Valeur |
|---|---|---|
| value | Valeur correspondant à une adresse IPv4 unique (par exemple, 123.1.2.3) ou à une plage IP au format CIDR (par exemple, 123.1.2.3/24) à autoriser. | string |
Sku
| Nom | Description | Valeur |
|---|---|---|
| name | Référence SKU du service de recherche. Les valeurs valides sont les suivantes : « free » : service partagé. « basic » : 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 » : la plus grande offre Standard avec jusqu’à 12 partitions et 12 réplicas (ou jusqu’à 3 partitions avec davantage 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. » | « de base » « gratuit » « standard » « standard2 » « standard3 » « storage_optimized_l1 » « storage_optimized_l2 » |