Services - Update

Service:: Search Management

Version d’API:: 2025-02-01-preview

Met à jour un service de recherche existant dans le groupe de ressources donné.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}?api-version=2025-02-01-preview

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 Recherche d’IA Azure à mettre à jour.
subscriptionId	path	True	string	Identificateur unique d’un abonnement Microsoft Azure. Vous pouvez obtenir cette valeur à partir de l’API Azure Resource Manager 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.

Corps de la demande

Nom	Type	Description
identity	Identity	Détails sur l’identité du service de recherche. Une valeur Null indique que le service de recherche n’a pas d’identité affectée.
location	string	Emplacement géographique de la ressource. Il doit s’agir de l’une des régions géographiques Azure prises en charge et inscrites (par exemple, USA Ouest, USA Est, Asie Sud-Est, etc.). Cette propriété est requise lors de la création d’une 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.computeType	ComputeType	Configurez cette propriété pour prendre en charge le service de recherche à l’aide du calcul par défaut ou du calcul confidentiel Azure.
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.disabledDataExfiltrationOptions	SearchDisabledDataExfiltrationOption[]	Liste des scénarios d’exfiltration de données qui sont explicitement interdits pour le service de recherche. Actuellement, la seule valeur prise en charge est « All » pour désactiver tous les scénarios d’exportation de données possibles avec des contrôles plus précis prévus pour l’avenir.
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.endpoint	string (uri)	Point de terminaison du service Recherche d’IA Azure.
properties.hostingMode	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 ».
properties.networkRuleSet	NetworkRuleSet	Règles spécifiques au réseau qui déterminent la façon dont le service Recherche d’IA Azure peut être atteint.
properties.partitionCount	integer (int32) minimum: 1 maximum: 12	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.publicNetworkAccess	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.
properties.replicaCount	integer (int32) minimum: 1 maximum: 12	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 Azure AI Search dans certains emplacements.
sku	Sku	Référence SKU du service de recherche, qui détermine le niveau tarifaire et les limites de capacité. Cette propriété est requise lors de la création d’un service de recherche.
tags	object	Balises pour aider à catégoriser la ressource dans le portail Azure.

Réponses

Nom	Type	Description
200 OK	SearchService	La définition de service existante a été correctement mise à jour. Si vous avez modifié le nombre de réplicas ou de partitions, l’opération de mise à l’échelle se produit de manière asynchrone. Vous pouvez vérifier l’état d’une opération de mise à l’échelle via la propriété provisioningState d’une requête Get Service.
Other Status Codes	CloudError	HTTP 400 (Requête incorrecte) : la définition de service donnée n’est pas valide ou vous avez tenté de modifier une propriété immuable. Pour plus d’informations, consultez le code d’erreur et le message dans la réponse. HTTP 404 (introuvable) : l’abonnement ou le groupe de ressources est introuvable. HTTP 409 (Conflit) : l’abonnement spécifié est désactivé.

Sécurité

azure_auth

Spécifie un flux d’octroi implicite, tel qu’il est pris en charge sur la plateforme Microsoft Identity.

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

SearchUpdateService

SearchUpdateServiceAuthOptions

SearchUpdateServiceDisableLocalAuth

SearchUpdateServiceToAllowAccessFromPrivateEndpoints

SearchUpdateServiceToAllowAccessFromPublicCustomIPs

SearchUpdateServiceToAllowAccessFromPublicCustomIPsAndBypass

SearchUpdateServiceToRemoveIdentity

SearchUpdateServiceWithCmkEnforcement

SearchUpdateServiceWithDataExfiltration

SearchUpdateServiceWithSemanticSearch

SearchUpdateServiceWithSku

SearchUpdateService

Exemple de requête

HTTP

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2025-02-01-preview

{
  "tags": {
    "app-name": "My e-commerce app",
    "new-tag": "Adding a new tag"
  },
  "properties": {
    "replicaCount": 2
  }
}

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",
    "new-tag": "Adding a new tag"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 2,
    "partitionCount": 1,
    "endpoint": "https://mysearchservice.search.windows.net/",
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "computeType": "default",
    "provisioningState": "Provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": [],
    "upgradeAvailable": false,
    "serviceUpgradeDate": null
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "[email protected]",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}

SearchUpdateServiceAuthOptions

Exemple de requête

HTTP

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2025-02-01-preview

{
  "tags": {
    "app-name": "My e-commerce app",
    "new-tag": "Adding a new tag"
  },
  "properties": {
    "replicaCount": 2,
    "authOptions": {
      "aadOrApiKey": {
        "aadAuthFailureMode": "http401WithBearerChallenge"
      }
    }
  }
}

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",
    "new-tag": "Adding a new tag"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 2,
    "partitionCount": 1,
    "endpoint": "https://mysearchservice.search.windows.net/",
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "computeType": "default",
    "provisioningState": "Provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "authOptions": {
      "aadOrApiKey": {
        "aadAuthFailureMode": "http401WithBearerChallenge"
      }
    },
    "disabledDataExfiltrationOptions": [],
    "upgradeAvailable": false,
    "serviceUpgradeDate": null
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "[email protected]",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}

SearchUpdateServiceDisableLocalAuth

Exemple de requête

HTTP

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2025-02-01-preview

{
  "tags": {
    "app-name": "My e-commerce app",
    "new-tag": "Adding a new tag"
  },
  "properties": {
    "replicaCount": 2,
    "disableLocalAuth": true
  }
}

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",
    "new-tag": "Adding a new tag"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 2,
    "partitionCount": 1,
    "endpoint": "https://mysearchservice.search.windows.net/",
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "computeType": "default",
    "provisioningState": "Provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": true,
    "authOptions": null,
    "disabledDataExfiltrationOptions": [],
    "upgradeAvailable": false,
    "serviceUpgradeDate": null
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "[email protected]",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}

SearchUpdateServiceToAllowAccessFromPrivateEndpoints

Exemple de requête

HTTP

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2025-02-01-preview

{
  "properties": {
    "replicaCount": 1,
    "partitionCount": 1,
    "publicNetworkAccess": "disabled"
  }
}

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",
    "new-tag": "Adding a new tag"
  },
  "sku": {
    "name": "basic"
  },
  "properties": {
    "replicaCount": 1,
    "partitionCount": 1,
    "endpoint": "https://mysearchservice.search.windows.net/",
    "status": "running",
    "statusDetails": "",
    "hostingMode": "default",
    "computeType": "default",
    "provisioningState": "Succeeded",
    "publicNetworkAccess": "disabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": [],
    "upgradeAvailable": false,
    "serviceUpgradeDate": null
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "[email protected]",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}

SearchUpdateServiceToAllowAccessFromPublicCustomIPs

Exemple de requête

HTTP

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2025-02-01-preview

{
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "123.4.5.6"
        },
        {
          "value": "123.4.6.0/18"
        }
      ]
    }
  }
}

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",
    "new-tag": "Adding a new tag"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "endpoint": "https://mysearchservice.search.windows.net/",
    "status": "running",
    "statusDetails": "",
    "hostingMode": "default",
    "computeType": "default",
    "provisioningState": "Succeeded",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "10.2.3.4"
        }
      ]
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": [],
    "upgradeAvailable": false,
    "serviceUpgradeDate": null
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "[email protected]",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}

SearchUpdateServiceToAllowAccessFromPublicCustomIPsAndBypass

Exemple de requête

HTTP

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2025-02-01-preview

{
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "123.4.5.6"
        },
        {
          "value": "123.4.6.0/18"
        }
      ],
      "bypass": "AzurePortal"
    }
  }
}

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",
    "new-tag": "Adding a new tag"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "endpoint": "https://mysearchservice.search.windows.net/",
    "status": "running",
    "statusDetails": "",
    "hostingMode": "default",
    "computeType": "default",
    "provisioningState": "Succeeded",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "10.2.3.4"
        }
      ],
      "bypass": "AzurePortal"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": [],
    "upgradeAvailable": false,
    "serviceUpgradeDate": null
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "[email protected]",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}

SearchUpdateServiceToRemoveIdentity

Exemple de requête

HTTP

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2025-02-01-preview

{
  "sku": {
    "name": "standard"
  },
  "identity": {
    "type": "None"
  }
}

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": {},
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "endpoint": "https://mysearchservice.search.windows.net/",
    "status": "running",
    "statusDetails": "",
    "hostingMode": "default",
    "computeType": "default",
    "provisioningState": "Succeeded",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": [],
    "upgradeAvailable": false,
    "serviceUpgradeDate": null
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "[email protected]",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}

SearchUpdateServiceWithCmkEnforcement

Exemple de requête

HTTP

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2025-02-01-preview

{
  "tags": {
    "app-name": "My e-commerce app",
    "new-tag": "Adding a new tag"
  },
  "properties": {
    "replicaCount": 2,
    "encryptionWithCmk": {
      "enforcement": "Enabled"
    }
  }
}

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",
    "new-tag": "Adding a new tag"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 2,
    "partitionCount": 1,
    "endpoint": "https://mysearchservice.search.windows.net/",
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "computeType": "default",
    "provisioningState": "Provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Enabled",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": [],
    "upgradeAvailable": false,
    "serviceUpgradeDate": null
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "[email protected]",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}

SearchUpdateServiceWithDataExfiltration

Exemple de requête

HTTP

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2025-02-01-preview

{
  "tags": {
    "app-name": "My e-commerce app",
    "new-tag": "Adding a new tag"
  },
  "properties": {
    "replicaCount": 2,
    "disabledDataExfiltrationOptions": [
      "All"
    ]
  }
}

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",
    "new-tag": "Adding a new tag"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 2,
    "partitionCount": 1,
    "endpoint": "https://mysearchservice.search.windows.net/",
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "computeType": "default",
    "provisioningState": "Provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": [
      "All"
    ],
    "upgradeAvailable": false,
    "serviceUpgradeDate": null
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "[email protected]",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}

SearchUpdateServiceWithSemanticSearch

Exemple de requête

HTTP

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2025-02-01-preview

{
  "tags": {
    "app-name": "My e-commerce app",
    "new-tag": "Adding a new tag"
  },
  "properties": {
    "replicaCount": 2,
    "semanticSearch": "standard"
  }
}

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",
    "new-tag": "Adding a new tag"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 2,
    "partitionCount": 1,
    "endpoint": "https://mysearchservice.search.windows.net/",
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "computeType": "default",
    "provisioningState": "Provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": [],
    "semanticSearch": "standard",
    "upgradeAvailable": false,
    "serviceUpgradeDate": null
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "[email protected]",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}

SearchUpdateServiceWithSku

Exemple de requête

HTTP

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2025-02-01-preview

{
  "tags": {
    "app-name": "My e-commerce app",
    "new-tag": "Adding a new tag"
  },
  "sku": {
    "name": "standard2"
  }
}

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",
    "new-tag": "Adding a new tag"
  },
  "sku": {
    "name": "standard2"
  },
  "properties": {
    "replicaCount": 1,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "Provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": [],
    "upgradeAvailable": false,
    "serviceUpgradeDate": null
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "[email protected]",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}

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.
ComputeType	Configurez cette propriété pour prendre en charge le service de recherche à l’aide du calcul par défaut ou du calcul confidentiel Azure.
createdByType	Type d’identité qui a créé la ressource.
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 au sein du service de recherche doivent être chiffrées avec des clés gérées par le client.
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	Détails sur l’identité du service de recherche. Une valeur Null indique que le service de recherche n’a pas d’identité affectée.
IdentityType	Type d’identité utilisé pour la ressource. Le type « SystemAssigned, UserAssigned » inclut à la fois une identité créée par le système et un ensemble d’identités affectées par l’utilisateur. Le type « None » supprime toutes les identités du service.
IpRule	Règle de restriction IP du service Recherche d’IA Azure.
NetworkRuleSet	Règles spécifiques au réseau qui déterminent la façon dont le service Recherche d’IA Azure 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 Recherche d’IA Azure.
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 La mise à jour, la suppression, l’échec, la réussite, l’annulation ou l’annulation.
PrivateLinkServiceConnectionState	Décrit l’état actuel d’une connexion de service Azure Private Link existante au point de terminaison privé.
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.
SearchBypass	Origines possibles du trafic entrant qui peut contourner les règles définies dans la section « ipRules ».
SearchDisabledDataExfiltrationOption	Liste des scénarios d’exfiltration de données qui sont explicitement interdits pour le service de recherche. Actuellement, la seule valeur prise en charge est « All » pour désactiver tous les scénarios d’exportation de données possibles avec des contrôles plus précis prévus pour l’avenir.
SearchEncryptionComplianceStatus	Retourne l’état de conformité du service de recherche par rapport aux objets non chiffrés CMK. Si un service a plusieurs objets non chiffrés et que l’application est activée, le service est marqué comme non conforme.
SearchEncryptionWithCmk	Décrit comment un service de recherche doit appliquer la conformité s’il trouve des objets qui ne sont pas chiffrés avec la clé gérée 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 Azure AI Search dans certains emplacements.
SearchService	Décrit un service Recherche d’IA Azure 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. 'arrêté' : le service de recherche se trouve dans un abonnement désactivé. Si votre service se trouve dans les états détériorés, désactivés ou d’erreur, cela signifie que l’équipe Recherche d’IA Azure 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.
SearchServiceUpdate	Paramètres utilisés pour mettre à jour un service Recherche d’IA Azure.
SharedPrivateLinkResource	Décrit une ressource de liaison privée partagée gérée par le service Recherche d’IA Azure.
SharedPrivateLinkResourceProperties	Décrit les propriétés d’une ressource de liaison privée partagée existante gérée par le service Recherche d’IA Azure.
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.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.
UserAssignedManagedIdentity	Détails de l’identité managée affectée par l’utilisateur affectée au service de recherche.

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
http403	Indique que les demandes qui ont échoué l’authentification doivent être présentées avec un code d’état HTTP de 403 (Interdit).
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.

ApiKeyOnly

Objet

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

CloudError

Objet

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.
message	string	Brève description de l’erreur qui indique ce qui s’est passé (pour plus d’informations/débogage, reportez-vous à la propriété « error.message »).

CloudErrorBody

Objet

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

ComputeType

Énumération

Configurez cette propriété pour prendre en charge le service de recherche à l’aide du calcul par défaut ou du calcul confidentiel Azure.

Valeur	Description
default	Créez le service avec le calcul par défaut.
confidential	Créez le service avec Le calcul confidentiel Azure.

createdByType

Énumération

Type d’identité qui a créé la ressource.

Valeur	Description
User
Application
ManagedIdentity
Key

DataPlaneAadOrApiKeyAuthOption

Objet

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

Objet

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

Objet

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

Nom	Type	Description
encryptionComplianceStatus	SearchEncryptionComplianceStatus	Retourne l’état de conformité du service de recherche par rapport aux objets non chiffrés CMK. Si un service a plusieurs objets non chiffrés et que l’application est activée, le service est marqué comme non conforme.
enforcement	SearchEncryptionWithCmk	Décrit comment un service de recherche doit appliquer la conformité s’il trouve des objets qui ne sont pas chiffrés avec la clé gérée 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

Objet

Détails sur l’identité du service de recherche. Une valeur Null indique que le service de recherche n’a pas d’identité affectée.

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é utilisé pour la ressource. Le type « SystemAssigned, UserAssigned » inclut à la fois une identité créée par le système et un ensemble d’identités affectées par l’utilisateur. Le type « None » supprime toutes les identités du service.
userAssignedIdentities	<string, UserAssignedManagedIdentity>	Liste des identités utilisateur associées à la ressource. Les références de clé de dictionnaire d’identité utilisateur seront des ID de ressource ARM sous la forme : « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ».

IdentityType

Énumération

Type d’identité utilisé pour la ressource. Le type « SystemAssigned, UserAssigned » inclut à la fois une identité créée par le système et un ensemble d’identités affectées par l’utilisateur. Le type « None » supprime toutes les identités du service.

Valeur	Description
None	Indique que toute identité associée au service de recherche doit être supprimée.
SystemAssigned	Indique que l’identité affectée par le système pour le service de recherche est activée.
UserAssigned	Indique qu’une ou plusieurs identités affectées par l’utilisateur seront affectées au service de recherche.
SystemAssigned, UserAssigned	Indique que l’identité affectée par le système pour le service de recherche est activée, ainsi que l’attribution d’une ou plusieurs identités affectées par l’utilisateur.

IpRule

Objet

Règle de restriction IP du service Recherche d’IA Azure.

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

Objet

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

Nom	Type	Description
bypass	SearchBypass	Origines possibles du trafic entrant qui peut contourner les règles définies dans la section « ipRules ».
ipRules	IpRule[]	Liste des règles de restriction IP qui définissent le ou les réseaux entrants avec l’autorisation d’accès au point de terminaison du service de recherche. En attendant, tous les autres réseaux IP publics sont bloqués par le pare-feu. Ces règles de restriction sont appliquées uniquement lorsque le « publicNetworkAccess » du service de recherche est « activé » ; sinon, le trafic via l’interface publique n’est pas autorisé même avec des règles d’adresse IP publiques, et les connexions de point de terminaison privé seraient la méthode d’accès exclusive.

PrivateEndpoint

Objet

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

Objet

Décrit une connexion de point de terminaison privé existante au service Recherche d’IA Azure.

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 Recherche d’IA Azure.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

PrivateEndpointConnectionProperties

Objet

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 de la ressource Azure pour laquelle le service de liaison privée est destiné.
privateEndpoint	PrivateEndpoint	Ressource de point de terminaison privé du fournisseur Microsoft.Network.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Décrit l’état actuel d’une connexion de service Azure Private Link existante au point de terminaison privé.
provisioningState	PrivateLinkServiceConnectionProvisioningState	État d’approvisionnement de la connexion de service de liaison privée. Les valeurs valides sont La mise à jour, la suppression, l’échec, la réussite, l’annulation ou l’annulation.

PrivateLinkServiceConnectionProvisioningState

Énumération

État d’approvisionnement de la connexion de service de liaison privée. Les valeurs valides sont La mise à jour, la suppression, l’échec, la réussite, l’annulation ou l’annulation.

Valeur	Description
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.
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.
Succeeded	La connexion de service de liaison privée a terminé l’approvisionnement et est prête à être approuvé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é.
Canceled	La demande d’approvisionnement de la ressource de connexion de service de liaison privée a été annulée.

PrivateLinkServiceConnectionState

Objet

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

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
Pending	La connexion de point de terminaison privé a été créée et est en attente d’approbation.
Approved	La connexion de point de terminaison privé est approuvée et prête à être utilisée.
Rejected	La connexion de point de terminaison privé a été rejetée et ne peut pas être utilisée.
Disconnected	La connexion de point de terminaison privé a été supprimée du service.

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
Succeeded	La dernière opération d’approvisionnement s’est terminée avec succès.
Provisioning	Le service de recherche est approvisionné ou mis à l’échelle vers le haut ou vers le bas.
Failed	La dernière opération d’approvisionnement a échoué.

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
enabled	Le service de recherche est accessible à partir du trafic provenant de l’Internet public.
disabled	Le service de recherche n’est pas accessible à partir du trafic provenant de l’Internet public. L’accès n’est autorisé que sur les connexions de point de terminaison privé approuvées.

SearchBypass

Énumération

Origines possibles du trafic entrant qui peut contourner les règles définies dans la section « ipRules ».

Valeur	Description
None	Indique qu’aucune origine ne peut contourner les règles définies dans la section « ipRules ». Il s’agit de la valeur par défaut.
AzurePortal	Indique que les requêtes provenant du portail Azure peuvent contourner les règles définies dans la section « ipRules ».
AzureServices	Indique que les requêtes provenant des services approuvés Azure peuvent contourner les règles définies dans la section « ipRules ».

SearchDisabledDataExfiltrationOption

Énumération

Liste des scénarios d’exfiltration de données qui sont explicitement interdits pour le service de recherche. Actuellement, la seule valeur prise en charge est « All » pour désactiver tous les scénarios d’exportation de données possibles avec des contrôles plus précis prévus pour l’avenir.

Valeur	Description
All	Indique que tous les scénarios d’exfiltration de données sont désactivés.

SearchEncryptionComplianceStatus

Énumération

Retourne l’état de conformité du service de recherche par rapport aux objets non chiffrés CMK. Si un service a plusieurs objets non chiffrés et que l’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 d’objets non chiffrés par CMK est égal à zéro ou que l’application est désactivée.
NonCompliant	Indique que le service de recherche possède plusieurs objets non chiffrés par CMK.

SearchEncryptionWithCmk

Énumération

Décrit comment un service de recherche doit appliquer la conformité s’il trouve des objets qui ne sont pas chiffrés avec la clé gérée par le client.

Valeur	Description
Disabled	Aucune application du chiffrement de clé gérée par le client n’est effectuée. Seul le chiffrement intégré géré par le service est utilisé.
Enabled	Le service de recherche est marqué comme non conforme si un ou plusieurs objets ne sont pas chiffrés avec une clé gérée 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 Azure AI Search dans certains emplacements.

Valeur	Description
disabled	Indique que le réécriture sémantique est désactivé pour le service de recherche. Il s’agit de la valeur par défaut.
free	Active le reclassement sémantique sur un service de recherche et indique qu’il doit être utilisé dans les limites du plan gratuit. Le plan gratuit 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 reclassement 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 reclassées sémantiquement.

SearchService

Objet

Décrit un service Recherche d’IA Azure 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.computeType	ComputeType		Configurez cette propriété pour prendre en charge le service de recherche à l’aide du calcul par défaut ou du calcul confidentiel Azure.
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.disabledDataExfiltrationOptions	SearchDisabledDataExfiltrationOption[]		Liste des scénarios d’exfiltration de données qui sont explicitement interdits pour le service de recherche. Actuellement, la seule valeur prise en charge est « All » pour désactiver tous les scénarios d’exportation de données possibles avec des contrôles plus précis prévus pour l’avenir.
properties.eTag	string		Propriété générée par le système représentant l’etag du service qui peut être destinée au contrôle d’accès concurrentiel optimiste pendant les mises à jour.
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.endpoint	string (uri)		Point de terminaison du service Recherche d’IA Azure.
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 Recherche d’IA Azure 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 Recherche d’IA Azure.
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 Azure AI Search dans certains emplacements.
properties.serviceUpgradeDate	string (date-time)		Date et heure de la dernière mise à niveau du service de recherche. Ce champ est null jusqu’à ce que le service soit mis à niveau pour la première fois.
properties.sharedPrivateLinkResources	SharedPrivateLinkResource[]		Liste des ressources de liaison privée partagées gérées par le service Recherche d’IA Azure.
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. 'arrêté' : le service de recherche se trouve dans un abonnement désactivé. Si votre service se trouve dans les états détériorés, désactivés ou d’erreur, cela signifie que l’équipe Recherche d’IA Azure 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.
properties.upgradeAvailable	boolean		Indique si le service de recherche dispose ou non d’une mise à niveau disponible.
sku	Sku		Référence SKU du service de recherche, qui détermine le niveau tarifaire et les limites de capacité. Cette propriété est requise lors de la création d’un service de recherche.
systemData	systemData		Métadonnées Azure Resource Manager du service de recherche contenant les informations createdBy et modifiedBy.
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. 'arrêté' : le service de recherche se trouve dans un abonnement désactivé. Si votre service se trouve dans les états détériorés, désactivés ou d’erreur, cela signifie que l’équipe Recherche d’IA Azure 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
running	Le service de recherche est en cours d’exécution et aucune opération d’approvisionnement n’est en cours.
provisioning	Le service de recherche est approvisionné ou mis à l’échelle vers le haut ou vers le bas.
deleting	Le service de recherche est en cours de suppression.
degraded	Le service de recherche est détérioré, car les unités de recherche sous-jacentes ne sont pas saines.
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.
stopped	Le service de recherche se trouve dans un abonnement désactivé.

SearchServiceUpdate

Objet

Paramètres utilisés pour mettre à jour un service Recherche d’IA Azure.

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		Détails sur l’identité du service de recherche. Une valeur Null indique que le service de recherche n’a pas d’identité affectée.
location	string		Emplacement géographique de la ressource. Il doit s’agir de l’une des régions géographiques Azure prises en charge et inscrites (par exemple, USA Ouest, USA Est, Asie Sud-Est, etc.). Cette propriété est requise lors de la création d’une 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.computeType	ComputeType		Configurez cette propriété pour prendre en charge le service de recherche à l’aide du calcul par défaut ou du calcul confidentiel Azure.
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.disabledDataExfiltrationOptions	SearchDisabledDataExfiltrationOption[]		Liste des scénarios d’exfiltration de données qui sont explicitement interdits pour le service de recherche. Actuellement, la seule valeur prise en charge est « All » pour désactiver tous les scénarios d’exportation de données possibles avec des contrôles plus précis prévus pour l’avenir.
properties.eTag	string		Propriété générée par le système représentant l’etag du service qui peut être destinée au contrôle d’accès concurrentiel optimiste pendant les mises à jour.
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.endpoint	string (uri)		Point de terminaison du service Recherche d’IA Azure.
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 Recherche d’IA Azure 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 Recherche d’IA Azure.
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 Azure AI Search dans certains emplacements.
properties.serviceUpgradeDate	string (date-time)		Date et heure de la dernière mise à niveau du service de recherche. Ce champ est null jusqu’à ce que le service soit mis à niveau pour la première fois.
properties.sharedPrivateLinkResources	SharedPrivateLinkResource[]		Liste des ressources de liaison privée partagées gérées par le service Recherche d’IA Azure.
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. 'arrêté' : le service de recherche se trouve dans un abonnement désactivé. Si votre service se trouve dans les états détériorés, désactivés ou d’erreur, cela signifie que l’équipe Recherche d’IA Azure 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.
properties.upgradeAvailable	boolean		Indique si le service de recherche dispose ou non d’une mise à niveau disponible.
sku	Sku		Référence SKU du service de recherche, qui détermine le niveau tarifaire et les limites de capacité. Cette propriété est requise lors de la création d’un service de recherche.
systemData	systemData		Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.
tags	object		Balises pour aider à catégoriser la ressource dans le portail Azure.
type	string		Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

SharedPrivateLinkResource

Objet

Décrit une ressource de liaison privée partagée gérée par le service Recherche d’IA Azure.

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 Recherche d’IA Azure.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

SharedPrivateLinkResourceProperties

Objet

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

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	Optional. Peut être utilisé pour spécifier l’emplacement Azure Resource Manager de la ressource pour laquelle une liaison privée partagée est en cours de création. 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
Updating	La ressource de liaison privée partagée est en cours de création avec d’autres ressources pour qu’elle soit entièrement fonctionnelle.
Deleting	La ressource de liaison privée partagée est en cours de suppression.
Failed	La ressource de liaison privée partagée n’a pas pu être provisionnée ou supprimée.
Succeeded	La ressource de liaison privée partagée a terminé l’approvisionnement et est prête à être approuvée.
Incomplete	La demande d’approvisionnement de la ressource de liaison privée partagée a été acceptée, mais le processus de création n’a pas encore commencé.

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
Pending	La ressource de liaison privée partagée a été créée et est en attente d’approbation.
Approved	La ressource de liaison privée partagée est approuvée et prête à être utilisée.
Rejected	La ressource de liaison privée partagée a été rejetée et ne peut pas être utilisée.
Disconnected	La ressource de liaison privée partagée a été supprimée du service.

Sku

Objet

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
free	Niveau gratuit, sans garantie sla et sous-ensemble des fonctionnalités proposées sur les niveaux facturables.
basic	Niveau facturable pour un service dédié ayant jusqu’à 3 réplicas.
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.

systemData

Objet

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string (date-time)	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string (date-time)	Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.

UserAssignedManagedIdentity

Objet

Détails de l’identité managée affectée par l’utilisateur affectée au service de recherche.

Nom	Type	Description
clientId	string	ID client de l’identité affectée par l’utilisateur.
principalId	string	ID principal de l’identité affectée par l’utilisateur.