Partager via

Services - Update

  • Référence
Service:
Search Management
API Version:
2024-03-01-preview

Mises à 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=2024-03-01-preview

Paramètres URI

Nom Dans Obligatoire Type Description
resourceGroupName
 path True

string

Nom du groupe de ressources au sein de l’abonnement actuel. Vous pouvez obtenir cette valeur à partir de l’API Azure Resource Manager ou du portail.
searchServiceName
 path True

string

Nom du service Search Azure AI à 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 demande. S’il est spécifié, cela sera inclus dans les informations de réponse afin 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 aucune 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. Cette valeur ne peut pas être définie si « disableLocalAuth » a la valeur true.
properties.disableLocalAuth

boolean

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.
properties.disabledDataExfiltrationOptions

SearchDisabledDataExfiltrationOption[]

Liste des scénarios d’exfiltration de données 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 affinés 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 customer Manager au sein d’un service de recherche.
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 « default ».
properties.networkRuleSet

NetworkRuleSet

Règles spécifiques au réseau qui déterminent comment le service Search Azure AI peut être atteint.
properties.partitionCount

integer

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.
properties.publicNetworkAccess

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.
properties.replicaCount

integer

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.
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 Recherche Azure AI à certains emplacements.
sku

Sku

Référence SKU du service de recherche, qui détermine le niveau de prix et les limites de capacité. Cette propriété est requise lors de la création d’un service de recherche.
tags

object

Étiquettes pour aider à classer 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 produira de manière asynchrone. Vous pouvez case activée la status d’une opération de mise à l’échelle via la propriété provisioningState d’une demande 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 que pris en charge sur la plateforme Microsoft Identity.

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

Scopes

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

Exemples

SearchUpdateService
SearchUpdateServiceAuthOptions
SearchUpdateServiceDisableLocalAuth
SearchUpdateServiceToAllowAccessFromPrivateEndpoints
SearchUpdateServiceToAllowAccessFromPublicCustomIPs
SearchUpdateServiceToAllowAccessFromPublicCustomIPsAndBypass
SearchUpdateServiceToRemoveIdentity
SearchUpdateServiceWithCmkEnforcement
SearchUpdateServiceWithDataExfiltration
SearchUpdateServiceWithSemanticSearch

SearchUpdateService

Sample Request

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

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

Sample Response

Status code:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app",
    "new-tag": "Adding a new tag"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 2,
    "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": []
  }
}

SearchUpdateServiceAuthOptions

Sample Request

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

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

Sample Response

Status code:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app",
    "new-tag": "Adding a new tag"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 2,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "authOptions": {
      "aadOrApiKey": {
        "aadAuthFailureMode": "http401WithBearerChallenge"
      }
    },
    "disabledDataExfiltrationOptions": []
  }
}

SearchUpdateServiceDisableLocalAuth

Sample Request

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

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

Sample Response

Status code:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app",
    "new-tag": "Adding a new tag"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 2,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": true,
    "authOptions": null,
    "disabledDataExfiltrationOptions": []
  }
}

SearchUpdateServiceToAllowAccessFromPrivateEndpoints

Sample Request

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

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

Sample Response

Status code:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app",
    "new-tag": "Adding a new tag"
  },
  "sku": {
    "name": "basic"
  },
  "properties": {
    "replicaCount": 1,
    "partitionCount": 1,
    "status": "running",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "succeeded",
    "publicNetworkAccess": "disabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  }
}

SearchUpdateServiceToAllowAccessFromPublicCustomIPs

Sample Request

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

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

Sample Response

Status code:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app",
    "new-tag": "Adding a new tag"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "running",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "succeeded",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "10.2.3.4"
        }
      ]
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  }
}

SearchUpdateServiceToAllowAccessFromPublicCustomIPsAndBypass

Sample Request

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

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

Sample Response

Status code:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app",
    "new-tag": "Adding a new tag"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "running",
    "statusDetails": "",
    "hostingMode": "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": []
  }
}

SearchUpdateServiceToRemoveIdentity

Sample Request

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

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

Sample Response

Status code:
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,
    "status": "running",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "succeeded",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  }
}

SearchUpdateServiceWithCmkEnforcement

Sample Request

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

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

Sample Response

Status code:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app",
    "new-tag": "Adding a new tag"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 2,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Enabled",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  }
}

SearchUpdateServiceWithDataExfiltration

Sample Request

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

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

Sample Response

Status code:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app",
    "new-tag": "Adding a new tag"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 2,
    "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": [
      "All"
    ]
  }
}

SearchUpdateServiceWithSemanticSearch

Sample Request

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

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

Sample Response

Status code:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app",
    "new-tag": "Adding a new tag"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 2,
    "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": [],
    "semanticSearch": "standard"
  }
}

Définitions

Nom Description
AadAuthFailureMode

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

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

Contient des informations sur une erreur d’API.
CloudErrorBody

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

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

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

Décrit une stratégie qui détermine comment les ressources du service de recherche doivent être chiffrées avec des clés gérées par le client.
HostingMode

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

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

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

Règle de restriction IP de l’service Search Azure AI.
NetworkRuleSet

Règles spécifiques au réseau qui déterminent la façon dont les service Search Azure AI peuvent être atteintes.
PrivateEndpoint

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

Décrit une connexion de point de terminaison privé existante à l’service Search Azure AI.
PrivateEndpointConnectionProperties

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

État d’approvisionnement de la connexion au service private link. Les valeurs valides sont Mise à jour, Suppression, Échec, Réussi, Incomplet ou Annulé.
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 au service de liaison privée. Les valeurs valides sont En attente, Approuvé, Rejeté ou Déconnecté.
ProvisioningState

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

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

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

Liste des scénarios d’exfiltration de données 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 à l’avenir.
SearchEncryptionComplianceStatus

Retourne le status de conformité du service de recherche en ce qui concerne les objets non chiffrés par 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 Search Azure AI et son état actuel.
SearchServiceStatus

Status du service de recherche. Les valeurs possibles sont les suivantes : « running » : le service de recherche est en cours d’exécution et aucune opération d’approvisionnement n’est en cours. « provisionnement » : le service de recherche est en cours d’approvisionnement ou de scale-up ou de scale-down. « suppression » : le service de recherche est en cours de suppression. « détérioré » : le service de recherche est détérioré. Cela peut se produire lorsque les unités de recherche sous-jacentes ne sont pas saines. Le service de recherche est probablement opérationnel, mais les performances peuvent être lentes et certaines demandes peuvent être supprimées. « disabled » : le service de recherche est désactivé. Dans cet état, le service rejette toutes les demandes d’API. « erreur » : le service de recherche est dans un état d’erreur. « arrêté » : le service de recherche se trouve dans un abonnement qui est désactivé. Si votre service est dans l’état détérioré, désactivé ou d’erreur, cela signifie que l’équipe Azure AI Search étudie activement le problème sous-jacent. Les services dédiés indiquant ces états peuvent faire l’objet d’une facturation en fonction du nombre d’unités de recherche déployées.
SearchServiceUpdate

Paramètres utilisés pour mettre à jour un service Search Azure AI.
SharedPrivateLinkResource

Décrit une ressource de liaison privée partagée gérée par le service Search Azure AI.
SharedPrivateLinkResourceProperties

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

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

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

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

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

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

AadAuthFailureMode

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

Nom Type Description
http401WithBearerChallenge

string

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

string

Indique que les demandes qui ont échoué à l’authentification doivent être présentées avec un code http status 403 (Interdit).

ApiKeyOnly

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

CloudError

Contient des informations sur une erreur d’API.

Nom Type Description
error

CloudErrorBody

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

string

Une brève description de l’erreur qui indique ce qui s’est passé (pour plus d’informations/informations de débogage, reportez-vous à la propriété « error.message »).

CloudErrorBody

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

Nom Type Description
code

string

Code d’erreur qui décrit la condition d’erreur plus précisément qu’un code status HTTP. Peut être utilisé pour gérer par programmation des cas d’erreur spécifiques.
details

CloudErrorBody[]

Contient des erreurs imbriquées liées à cette erreur.
message

string

Message qui décrit l’erreur en détail et fournit des informations de débogage.
target

string

Cible de l’erreur particulière (par exemple, le nom de la propriété dans l’erreur).

DataPlaneAadOrApiKeyAuthOption

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

Nom Type Description
aadAuthFailureMode

AadAuthFailureMode

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

DataPlaneAuthOptions

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

Nom Type Description
aadOrApiKey

DataPlaneAadOrApiKeyAuthOption

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

ApiKeyOnly

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

EncryptionWithCmk

Décrit une stratégie qui détermine comment les ressources du service de recherche doivent être chiffrées avec des clés gérées par le client.

Nom Type Description
encryptionComplianceStatus

SearchEncryptionComplianceStatus

Retourne le status de conformité du service de recherche en ce qui concerne les objets non chiffrés par 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

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

Nom Type Description
default

string

La limite du nombre d’index est déterminée par les limites par défaut de la référence SKU.
highDensity

string

Application uniquement pour la référence SKU Standard3, où le service de recherche peut avoir jusqu’à 1 000 index.

Identity

Détails sur l’identité du service de recherche. Une valeur Null indique que le service de recherche n’a aucune 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 » comprend à la fois une identité créée par le système et un ensemble d’identités attribué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 sont des ID de ressource ARM au format « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ».

IdentityType

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

Nom Type Description
None

string

Indique que toute identité associée au service de recherche doit être supprimée.
SystemAssigned

string

Indique que l’identité affectée par le système pour le service de recherche sera activée.
SystemAssigned, UserAssigned

string

Indique que l’identité affectée par le système pour le service de recherche sera activée avec l’attribution d’une ou plusieurs identités affectées par l’utilisateur.
UserAssigned

string

Indique qu’une ou plusieurs identités affectées par l’utilisateur seront affectées au service de recherche.

IpRule

Règle de restriction IP de l’service Search Azure AI.

Nom Type Description
value

string

Valeur correspondant à une adresse IPv4 unique (par exemple, 123.1.2.3) ou à une plage d’adresses IP au format CIDR (par exemple, 123.1.2.3/24) à autoriser.

NetworkRuleSet

Règles spécifiques au réseau qui déterminent la façon dont les service Search Azure AI peuvent être atteintes.

Nom Type Description
bypass

SearchBypass

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

IpRule[]

Liste des règles de restriction IP qui définit 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 « 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 publique, et les connexions de point de terminaison privé seraient la méthode d’accès exclusif.

PrivateEndpoint

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

Nom Type Description
id

string

ID de ressource de la ressource de point de terminaison privé du fournisseur Microsoft.Network.

PrivateEndpointConnection

Décrit une connexion de point de terminaison privé existante à l’service Search Azure AI.

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 à l’service Search Azure AI.
type

string

Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

PrivateEndpointConnectionProperties

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

Nom Type Description
groupId

string

ID de groupe de la ressource Azure pour laquelle le service private link 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 au service private link. Les valeurs valides sont Mise à jour, Suppression, Échec, Réussi, Incomplet ou Annulé.

PrivateLinkServiceConnectionProvisioningState

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

Nom Type Description
Canceled

string

La demande d’approvisionnement pour la ressource de connexion de service private link a été annulée.
Deleting

string

La connexion au service de liaison privée est en cours de suppression.
Failed

string

La connexion au service de liaison privée n’a pas pu être provisionnée ou supprimée.
Incomplete

string

La demande d’approvisionnement pour la ressource de connexion de service private link a été acceptée, mais le processus de création n’a pas encore commencé.
Succeeded

string

La connexion au service de liaison privée a terminé l’approvisionnement et est prête à être approuvée.
Updating

string

La connexion de service de liaison privée est en cours de création avec d’autres ressources pour qu’elle soit entièrement fonctionnelle.

PrivateLinkServiceConnectionState

Décrit l’état actuel d’une connexion 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 private link.
status

PrivateLinkServiceConnectionStatus

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

PrivateLinkServiceConnectionStatus

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

Nom Type Description
Approved

string

La connexion de point de terminaison privé est approuvée et prête à être utilisée.
Disconnected

string

La connexion de point de terminaison privé a été supprimée du service.
Pending

string

La connexion de point de terminaison privé a été créée et est en attente d’approbation.
Rejected

string

La connexion de point de terminaison privé a été rejetée et ne peut pas être utilisée.

ProvisioningState

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

Nom Type Description
failed

string

La dernière opération d’approvisionnement a échoué.
provisioning

string

Le service de recherche est en cours d’approvisionnement ou de scale-up ou de scale-down.
succeeded

string

La dernière opération d’approvisionnement s’est terminée avec succès.

PublicNetworkAccess

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

Nom Type Description
disabled

string

Le service de recherche n’est pas accessible à partir du trafic provenant de l’Internet public. L’accès est autorisé uniquement sur les connexions de point de terminaison privé approuvées.
enabled

string

Le service de recherche est accessible à partir du trafic provenant de l’Internet public.

SearchBypass

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

Nom Type Description
AzurePortal

string

Indique que les demandes provenant du Portail Azure peuvent contourner les règles définies dans la section « ipRules ».
None

string

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.

SearchDisabledDataExfiltrationOption

Liste des scénarios d’exfiltration de données 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 à l’avenir.

Nom Type Description
All

string

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

SearchEncryptionComplianceStatus

Retourne le status de conformité du service de recherche en ce qui concerne les objets non chiffrés par CMK. Si un service a plusieurs objets non chiffrés et que l’application est activée, le service est marqué comme non conforme.

Nom Type Description
Compliant

string

Indique que le service de recherche est conforme, soit parce que le nombre d’objets non chiffrés par CMK est égal à zéro, soit parce que l’application est désactivée.
NonCompliant

string

Indique que le service de recherche a plusieurs objets non chiffrés par CMK.

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.

Nom Type Description
Disabled

string

Aucune application du chiffrement de clé gérée par le client n’est effectuée. Seul le chiffrement géré par le service intégré est utilisé.
Enabled

string

service Search seront marqués comme non conformes si un ou plusieurs objets ne sont pas chiffrés avec une clé gérée par le client.
Unspecified

string

La stratégie d’application n’est pas spécifiée explicitement, le comportement étant le même que s’il était défini sur « Désactivé ».

SearchSemanticSearch

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

Nom Type Description
disabled

string

Indique que le reranker sémantique est désactivé pour le service de recherche. Il s’agit de la valeur par défaut.
free

string

Active le reclasseur sémantique sur un service de recherche et indique qu’il doit être utilisé dans les limites du plan gratuit. Le plan gratuit limiterait le volume des demandes de classement sémantique et est proposé sans frais supplémentaires. Il s’agit de la valeur par défaut pour les services de recherche nouvellement provisionnés.
standard

string

Active le reclasseur 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 sémantiquement reclassées.

SearchService

Décrit un service Search Azure AI et son état actuel.

Nom Type Valeur par défaut Description
id

string

ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity

Identity

Identité de la ressource.
location

string

Emplacement géographique où réside la ressource
name

string

nom de la ressource.
properties.authOptions

DataPlaneAuthOptions

Définit les options pour la façon dont l’API de plan de données d’un service de recherche authentifie les demandes. Cette valeur ne peut pas être définie si « disableLocalAuth » a la valeur true.
properties.disableLocalAuth

boolean

Lorsque la valeur est true, les appels au service de recherche ne sont pas autorisés à utiliser des clés API pour l’authentification. Cette valeur ne peut pas être définie sur true si « dataPlaneAuthOptions » est défini.
properties.disabledDataExfiltrationOptions

SearchDisabledDataExfiltrationOption[]

Liste des scénarios d’exfiltration de données 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 à l’avenir.
properties.eTag

string

Propriété générée par le système représentant l’etag du service qui peut servir à un contrôle d’accès concurrentiel optimiste pendant les mises à jour.
properties.encryptionWithCmk

EncryptionWithCmk

Spécifie toute stratégie concernant le chiffrement des ressources (comme les index) à l’aide de clés customer manager au sein d’un service de recherche.
properties.hostingMode

HostingMode

default

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

NetworkRuleSet

Règles spécifiques au réseau qui déterminent la façon dont les service Search Azure AI peuvent être atteintes.
properties.partitionCount

integer

1

Nombre de partitions dans le service de recherche ; s’il est spécifié, il peut s’agir de 1, 2, 3, 4, 6 ou 12. Les valeurs supérieures à 1 sont uniquement valides pour les références SKU standard. Pour les services « standard3 » avec hostingMode défini sur « highDensity », les valeurs autorisées sont comprises entre 1 et 3.
properties.privateEndpointConnections

PrivateEndpointConnection[]

Liste des connexions de point de terminaison privé à l’service Search Azure AI.
properties.provisioningState

ProvisioningState

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

PublicNetworkAccess

enabled

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

integer

1

Nombre de réplicas dans le service de recherche. Si elle est spécifiée, il doit s’agir d’une valeur comprise entre 1 et 12 inclusive pour les références SKU standard ou comprise entre 1 et 3 inclus pour la référence SKU de base.
properties.semanticSearch

SearchSemanticSearch

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

SharedPrivateLinkResource[]

Liste des ressources de liaison privée partagées gérées par le service Search Azure AI.
properties.status

SearchServiceStatus

Status du service de recherche. Les valeurs possibles sont les suivantes : « running » : le service de recherche est en cours d’exécution et aucune opération d’approvisionnement n’est en cours. « provisionnement » : le service de recherche est en cours d’approvisionnement ou de scale-up ou de scale-down. « suppression » : le service de recherche est en cours de suppression. « détérioré » : le service de recherche est détérioré. Cela peut se produire lorsque les unités de recherche sous-jacentes ne sont pas saines. Le service de recherche est probablement opérationnel, mais les performances peuvent être lentes et certaines demandes peuvent être supprimées. « disabled » : le service de recherche est désactivé. Dans cet état, le service rejette toutes les demandes d’API. « erreur » : le service de recherche est dans un état d’erreur. « arrêté » : le service de recherche se trouve dans un abonnement qui est désactivé. Si votre service est dans l’état détérioré, désactivé ou d’erreur, cela signifie que l’équipe Azure AI Search étudie activement le problème sous-jacent. Les services dédiés indiquant ces états peuvent faire l’objet d’une facturation en fonction du nombre d’unités de recherche déployées.
properties.statusDetails

string

Détails du service de recherche status.
sku

Sku

Référence SKU du service de recherche, qui détermine le niveau de prix et les limites de capacité. Cette propriété est requise lors de la création d’un service de recherche.
tags

object

Balises de ressource.
type

string

Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

SearchServiceStatus

Status du service de recherche. Les valeurs possibles sont les suivantes : « running » : le service de recherche est en cours d’exécution et aucune opération d’approvisionnement n’est en cours. « provisionnement » : le service de recherche est en cours d’approvisionnement ou de scale-up ou de scale-down. « suppression » : le service de recherche est en cours de suppression. « détérioré » : le service de recherche est détérioré. Cela peut se produire lorsque les unités de recherche sous-jacentes ne sont pas saines. Le service de recherche est probablement opérationnel, mais les performances peuvent être lentes et certaines demandes peuvent être supprimées. « disabled » : le service de recherche est désactivé. Dans cet état, le service rejette toutes les demandes d’API. « erreur » : le service de recherche est dans un état d’erreur. « arrêté » : le service de recherche se trouve dans un abonnement qui est désactivé. Si votre service est dans l’état détérioré, désactivé ou d’erreur, cela signifie que l’équipe Azure AI Search étudie activement le problème sous-jacent. Les services dédiés indiquant ces états peuvent faire l’objet d’une facturation en fonction du nombre d’unités de recherche déployées.

Nom Type Description
degraded

string

Le service de recherche est dégradé, car les unités de recherche sous-jacentes ne sont pas saines.
deleting

string

Le service de recherche est en cours de suppression.
disabled

string

Le service de recherche est désactivé et toutes les demandes d’API sont rejetées.
error

string

Le service de recherche est à l’état d’erreur, ce qui indique un échec d’approvisionnement ou de suppression.
provisioning

string

Le service de recherche est en cours d’approvisionnement ou de scale-up ou de scale-down.
running

string

Le service de recherche est en cours d’exécution et aucune opération d’approvisionnement n’est en cours.
stopped

string

Le service de recherche se trouve dans un abonnement qui est désactivé.

SearchServiceUpdate

Paramètres utilisés pour mettre à jour un service Search Azure AI.

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 aucune 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. Cette valeur ne peut pas être définie si « disableLocalAuth » a la valeur true.
properties.disableLocalAuth

boolean

Lorsque la valeur est true, les appels au service de recherche ne sont pas autorisés à utiliser des clés API pour l’authentification. Cette valeur ne peut pas être définie sur true si « dataPlaneAuthOptions » est défini.
properties.disabledDataExfiltrationOptions

SearchDisabledDataExfiltrationOption[]

Liste des scénarios d’exfiltration de données 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 à l’avenir.
properties.eTag

string

Propriété générée par le système représentant l’etag du service qui peut servir à un contrôle d’accès concurrentiel optimiste pendant les mises à jour.
properties.encryptionWithCmk

EncryptionWithCmk

Spécifie toute stratégie concernant le chiffrement des ressources (comme les index) à l’aide de clés customer manager au sein d’un service de recherche.
properties.hostingMode

HostingMode

default

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

NetworkRuleSet

Règles spécifiques au réseau qui déterminent la façon dont les service Search Azure AI peuvent être atteintes.
properties.partitionCount

integer

1

Nombre de partitions dans le service de recherche ; s’il est spécifié, il peut s’agir de 1, 2, 3, 4, 6 ou 12. Les valeurs supérieures à 1 sont uniquement valides pour les références SKU standard. Pour les services « standard3 » avec hostingMode défini sur « highDensity », les valeurs autorisées sont comprises entre 1 et 3.
properties.privateEndpointConnections

PrivateEndpointConnection[]

Liste des connexions de point de terminaison privé à l’service Search Azure AI.
properties.provisioningState

ProvisioningState

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

PublicNetworkAccess

enabled

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

integer

1

Nombre de réplicas dans le service de recherche. Si elle est spécifiée, il doit s’agir d’une valeur comprise entre 1 et 12 inclusive pour les références SKU standard ou comprise entre 1 et 3 inclus pour la référence SKU de base.
properties.semanticSearch

SearchSemanticSearch

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

SharedPrivateLinkResource[]

Liste des ressources de liaison privée partagées gérées par le service Search Azure AI.
properties.status

SearchServiceStatus

Status du service de recherche. Les valeurs possibles sont les suivantes : « running » : le service de recherche est en cours d’exécution et aucune opération d’approvisionnement n’est en cours. « provisionnement » : le service de recherche est en cours d’approvisionnement ou de scale-up ou de scale-down. « suppression » : le service de recherche est en cours de suppression. « détérioré » : le service de recherche est détérioré. Cela peut se produire lorsque les unités de recherche sous-jacentes ne sont pas saines. Le service de recherche est probablement opérationnel, mais les performances peuvent être lentes et certaines demandes peuvent être supprimées. « disabled » : le service de recherche est désactivé. Dans cet état, le service rejette toutes les demandes d’API. « erreur » : le service de recherche est dans un état d’erreur. « arrêté » : le service de recherche se trouve dans un abonnement qui est désactivé. Si votre service est dans l’état détérioré, désactivé ou d’erreur, cela signifie que l’équipe Azure AI Search étudie activement le problème sous-jacent. Les services dédiés indiquant ces états peuvent faire l’objet d’une facturation en fonction du nombre d’unités de recherche déployées.
properties.statusDetails

string

Détails du service de recherche status.
sku

Sku

Référence SKU du service de recherche, qui détermine le niveau de prix et les limites de capacité. Cette propriété est requise lors de la création d’un service de recherche.
tags

object

Étiquettes permettant de classer la ressource dans le Portail Azure.
type

string

Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

SharedPrivateLinkResource

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

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 Search Azure AI.
type

string

Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

SharedPrivateLinkResourceProperties

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

Nom Type Description
groupId

string

ID de groupe du fournisseur de la ressource pour laquelle la ressource de liaison privée partagée est destinée.
privateLinkResourceId

string

ID de ressource de la ressource pour laquelle la ressource de liaison privée partagée est destinée.
provisioningState

SharedPrivateLinkResourceProvisioningState

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

string

Message de demande d’approbation de la ressource de liaison privée partagée.
resourceRegion

string

facultatif. Peut être utilisé pour spécifier l’emplacement azure Resource Manager de la ressource pour laquelle une liaison privée partagée est en cours de création. Cela est nécessaire uniquement pour les ressources dont la configuration DNS est régionale (par exemple, Azure Kubernetes Service).
status

SharedPrivateLinkResourceStatus

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

SharedPrivateLinkResourceProvisioningState

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

Nom Type Description
Deleting

string

La ressource de liaison privée partagée est en cours de suppression.
Failed

string

La ressource de liaison privée partagée n’a pas pu être provisionnée ou supprimée.
Incomplete

string

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

string

La ressource de liaison privée partagée a terminé l’approvisionnement et est prête pour approbation.
Updating

string

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.

SharedPrivateLinkResourceStatus

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

Nom Type Description
Approved

string

La ressource de liaison privée partagée est approuvée et prête à être utilisée.
Disconnected

string

La ressource de liaison privée partagée a été supprimée du service.
Pending

string

La ressource de liaison privée partagée a été créée et est en attente d’approbation.
Rejected

string

La ressource de liaison privée partagée a été rejetée et ne peut pas être utilisée.

Sku

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

Nom Type Description
name

SkuName

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

SkuName

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

Nom Type Description
basic

string

Niveau facturable pour un service dédié ayant jusqu’à 3 réplicas.
free

string

Niveau gratuit, sans garantie sla et un sous-ensemble des fonctionnalités proposées sur les niveaux facturables.
standard

string

Niveau facturable pour un service dédié ayant jusqu’à 12 partitions et 12 réplicas.
standard2

string

Similaire à « standard », mais avec plus de capacité par unité de recherche.
standard3

string

La plus grande offre Standard avec jusqu’à 12 partitions et 12 réplicas (ou jusqu’à 3 partitions avec plus d’index si vous définissez également la propriété hostingMode sur « highDensity »).
storage_optimized_l1

string

Niveau facturable pour un service dédié qui prend en charge 1 To par partition, jusqu’à 12 partitions.
storage_optimized_l2

string

Niveau facturable pour un service dédié qui prend en charge 2 To par partition, jusqu’à 12 partitions.

UserAssignedManagedIdentity

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.