Delen via

Services - Create Or Update

Service:
Search Management
API-versie:
2025-05-01

Hiermee maakt of werkt u een zoekservice in de opgegeven resourcegroep bij. Als de zoekservice al bestaat, worden alle eigenschappen bijgewerkt met de opgegeven waarden.

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

URI-parameters

Name In Vereist Type Description
resourceGroupName
 path True

string

De naam van de resourcegroep binnen het huidige abonnement. U kunt deze waarde verkrijgen via de Azure Resource Manager-API of de portal.
searchServiceName
 path True

string

De naam van de Azure AI Search-service die moet worden gemaakt of bijgewerkt. Namen van zoekservices mogen alleen kleine letters, cijfers of streepjes bevatten, mogen geen streepje gebruiken als de eerste twee of laatste tekens, mogen geen opeenvolgende streepjes bevatten en moeten tussen de 2 en 60 tekens lang zijn. Namen van zoekservices moeten uniek zijn, aangezien ze deel uitmaken van de service-URI (https://< naam.search.windows.net>). U kunt de servicenaam niet wijzigen nadat de service is gemaakt.
subscriptionId
 path True

string

De unieke id voor een Microsoft Azure-abonnement. U kunt deze waarde verkrijgen via de Azure Resource Manager-API of de portal.
api-version
 query True

string

De API-versie die voor elke aanvraag moet worden gebruikt.

Aanvraagkoptekst

Name Vereist Type Description
x-ms-client-request-id

string (uuid)

Een door de client gegenereerde GUID-waarde die deze aanvraag identificeert. Indien opgegeven, wordt dit opgenomen in antwoordinformatie als een manier om de aanvraag bij te houden.

Aanvraagbody

Name Vereist Type Description
location True

string

De geografische locatie waar de resource zich bevindt
identity

Identity

De identiteit van de resource.
properties.authOptions

DataPlaneAuthOptions

Definieert de opties voor de wijze waarop de gegevensvlak-API van een zoekservice aanvragen verifieert. Dit kan niet worden ingesteld als 'disableLocalAuth' is ingesteld op true.
properties.computeType

ComputeType

Configureer deze eigenschap om de zoekservice te ondersteunen met behulp van de standaard compute of Azure Confidential Compute.
properties.dataExfiltrationProtections

SearchDataExfiltrationProtection[]

Een lijst met scenario's voor gegevensexfiltratie die expliciet zijn toegestaan voor de zoekservice. Momenteel is de enige ondersteunde waarde 'Alles' om alle mogelijke scenario's voor gegevensexport uit te schakelen met meer verfijnde besturingselementen die voor de toekomst zijn gepland.
properties.disableLocalAuth

boolean

Als deze is ingesteld op true, kunnen aanroepen naar de zoekservice geen API-sleutels gebruiken voor verificatie. Dit kan niet worden ingesteld op true als 'dataPlaneAuthOptions' is gedefinieerd.
properties.encryptionWithCmk

EncryptionWithCmk

Hiermee geeft u een beleid met betrekking tot de versleuteling van resources (zoals indexen) met behulp van customer manager-sleutels binnen een zoekservice.
properties.endpoint

string (uri)

Het eindpunt van de Azure AI Search-service.
properties.hostingMode

HostingMode

Alleen van toepassing op de standard3-SKU. U kunt deze eigenschap instellen om maximaal 3 high-densitypartities in te schakelen die maximaal 1000 indexen toestaan, wat veel hoger is dan de maximumindexen die zijn toegestaan voor elke andere SKU. Voor de standard3-SKU is de waarde 'standaard' of 'highDensity'. Voor alle andere SKU's moet deze waarde 'standaard' zijn.
properties.networkRuleSet

NetworkRuleSet

Netwerkspecifieke regels die bepalen hoe de Azure AI Search-service kan worden bereikt.
properties.partitionCount

integer (int32)

minimum: 1
maximum: 12

Het aantal partities in de zoekservice; indien opgegeven, kan dit 1, 2, 3, 4, 6 of 12 zijn. Waarden die groter zijn dan 1 zijn alleen geldig voor standaard-SKU's. Voor 'standard3'-services waarbij hostingMode is ingesteld op 'highDensity', liggen de toegestane waarden tussen 1 en 3.
properties.publicNetworkAccess

PublicNetworkAccess

Deze waarde kan worden ingesteld op 'ingeschakeld' om te voorkomen dat bestaande klantbronnen en sjablonen fouten veroorzaken. Als deze optie is ingesteld op Uitgeschakeld, is verkeer via openbare interface niet toegestaan en zijn privé-eindpuntverbindingen de exclusieve toegangsmethode.
properties.replicaCount

integer (int32)

minimum: 1
maximum: 12

Het aantal replica's in de zoekservice. Indien opgegeven, moet deze een waarde tussen 1 en 12 inclusief zijn voor standaard-SKU's of tussen 1 en 3 inclusief voor de basis-SKU.
properties.semanticSearch

SearchSemanticSearch

Hiermee stelt u opties in waarmee de beschikbaarheid van semantische zoekopdrachten wordt ingesteld. Deze configuratie is alleen mogelijk voor bepaalde Azure AI Search-SKU's op bepaalde locaties.
properties.upgradeAvailable

UpgradeAvailable

Geeft aan of er een upgrade beschikbaar is voor de zoekservice.
sku

Sku

De SKU van de zoekservice, die de prijscategorie en capaciteitslimieten bepaalt. Deze eigenschap is vereist bij het maken van een nieuwe zoekservice.
tags

object

Resourcetags.

Antwoorden

Name Type Description
200 OK

SearchService

De bestaande servicedefinitie is bijgewerkt. Als u het aantal replica's of partities hebt gewijzigd, wordt de schaalbewerking asynchroon uitgevoerd. U kunt de status van een schaalbewerking controleren via de eigenschap provisioningState die wordt geretourneerd in het antwoord op een Get Service-aanvraag.
201 Created

SearchService

Als u het maken van een gratis zoekservice hebt aangevraagd, is de service nu ingericht en klaar voor gebruik, afhankelijk van de vertraging van DNS-doorgifte. Voor andere SKU-typen vindt inrichting asynchroon plaats. U kunt de status van een schaalbewerking controleren via de eigenschap provisioningState die wordt geretourneerd in het antwoord op een Get Service-aanvraag.
Other Status Codes

CloudError

HTTP 400 (ongeldige aanvraag): de opgegeven servicenaam of servicedefinitie is ongeldig. Zie de foutcode en het bericht in het antwoord voor meer informatie. HTTP 404 (niet gevonden): het abonnement of de resourcegroep is niet gevonden. HTTP 409 (conflict): het opgegeven abonnement is uitgeschakeld.

Beveiliging

azure_auth

Hiermee geeft u een impliciete toekenningsstroom op, zoals ondersteund op het Microsoft Identity-platform.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name Description
user_impersonation Uw gebruikersaccount imiteren

Voorbeelden

SearchCreateOrUpdateService
SearchCreateOrUpdateServiceAuthOptions
SearchCreateOrUpdateServiceDisableLocalAuth
SearchCreateOrUpdateServiceToAllowAccessFromPrivateEndpoints
SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPs
SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPsAndBypass
SearchCreateOrUpdateServiceWithCmkEnforcement
SearchCreateOrUpdateServiceWithDataExfiltration
SearchCreateOrUpdateServiceWithIdentity
SearchCreateOrUpdateWithSemanticSearch

SearchCreateOrUpdateService

Voorbeeldaanvraag

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

{
  "location": "westus",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "hostingMode": "default",
    "computeType": "default"
  }
}

Voorbeeldrespons

Statuscode:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "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": {}
    },
    "dataExfiltrationProtections": [],
    "upgradeAvailable": "notAvailable",
    "serviceUpgradedAt": null
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}
Statuscode:
201 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "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": {}
    },
    "dataExfiltrationProtections": [],
    "upgradeAvailable": "notAvailable",
    "serviceUpgradedAt": null
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}

SearchCreateOrUpdateServiceAuthOptions

Voorbeeldaanvraag

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

{
  "location": "westus",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "hostingMode": "default",
    "computeType": "default",
    "authOptions": {
      "aadOrApiKey": {
        "aadAuthFailureMode": "http401WithBearerChallenge"
      }
    }
  }
}

Voorbeeldrespons

Statuscode:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "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"
      }
    },
    "dataExfiltrationProtections": [],
    "upgradeAvailable": "notAvailable",
    "serviceUpgradedAt": null
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}
Statuscode:
201 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "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"
      }
    },
    "dataExfiltrationProtections": [],
    "upgradeAvailable": "notAvailable",
    "serviceUpgradedAt": null
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}

SearchCreateOrUpdateServiceDisableLocalAuth

Voorbeeldaanvraag

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

{
  "location": "westus",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "hostingMode": "default",
    "computeType": "default",
    "disableLocalAuth": true
  }
}

Voorbeeldrespons

Statuscode:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "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,
    "dataExfiltrationProtections": [],
    "upgradeAvailable": "notAvailable",
    "serviceUpgradedAt": null
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}
Statuscode:
201 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "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,
    "dataExfiltrationProtections": [],
    "upgradeAvailable": "notAvailable",
    "serviceUpgradedAt": null
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}

SearchCreateOrUpdateServiceToAllowAccessFromPrivateEndpoints

Voorbeeldaanvraag

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

{
  "location": "westus",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "publicNetworkAccess": "disabled",
    "hostingMode": "default",
    "computeType": "default"
  }
}

Voorbeeldrespons

Statuscode:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "endpoint": "https://mysearchservice.search.windows.net/",
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "computeType": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "disabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "dataExfiltrationProtections": [],
    "upgradeAvailable": "notAvailable",
    "serviceUpgradedAt": null
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}
Statuscode:
201 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "endpoint": "https://mysearchservice.search.windows.net/",
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "computeType": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "disabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "dataExfiltrationProtections": [],
    "upgradeAvailable": "notAvailable",
    "serviceUpgradedAt": null
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}

SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPs

Voorbeeldaanvraag

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

{
  "location": "westus",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 1,
    "partitionCount": 1,
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "123.4.5.6"
        },
        {
          "value": "123.4.6.0/18"
        }
      ]
    },
    "hostingMode": "default",
    "computeType": "default"
  }
}

Voorbeeldrespons

Statuscode:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 1,
    "partitionCount": 1,
    "endpoint": "https://mysearchservice.search.windows.net/",
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "computeType": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "123.4.5.6"
        },
        {
          "value": "123.4.6.0/18"
        }
      ]
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "dataExfiltrationProtections": [],
    "upgradeAvailable": "notAvailable",
    "serviceUpgradedAt": null
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}
Statuscode:
201 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 1,
    "partitionCount": 1,
    "endpoint": "https://mysearchservice.search.windows.net/",
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "computeType": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "123.4.5.6"
        },
        {
          "value": "123.4.6.0/18"
        }
      ]
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "dataExfiltrationProtections": [],
    "upgradeAvailable": "notAvailable",
    "serviceUpgradedAt": null
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}

SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPsAndBypass

Voorbeeldaanvraag

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

{
  "location": "westus",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 1,
    "partitionCount": 1,
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "123.4.5.6"
        },
        {
          "value": "123.4.6.0/18"
        }
      ],
      "bypass": "AzureServices"
    },
    "hostingMode": "default",
    "computeType": "default"
  }
}

Voorbeeldrespons

Statuscode:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 1,
    "partitionCount": 1,
    "endpoint": "https://mysearchservice.search.windows.net/",
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "computeType": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "123.4.5.6"
        },
        {
          "value": "123.4.6.0/18"
        }
      ],
      "bypass": "AzureServices"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "dataExfiltrationProtections": [],
    "upgradeAvailable": "notAvailable",
    "serviceUpgradedAt": null
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}
Statuscode:
201 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 1,
    "partitionCount": 1,
    "endpoint": "https://mysearchservice.search.windows.net/",
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "computeType": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "123.4.5.6"
        },
        {
          "value": "123.4.6.0/18"
        }
      ],
      "bypass": "AzureServices"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "dataExfiltrationProtections": [],
    "upgradeAvailable": "notAvailable",
    "serviceUpgradedAt": null
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}

SearchCreateOrUpdateServiceWithCmkEnforcement

Voorbeeldaanvraag

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

{
  "location": "westus",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "hostingMode": "default",
    "computeType": "default",
    "encryptionWithCmk": {
      "enforcement": "Enabled"
    }
  }
}

Voorbeeldrespons

Statuscode:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "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": {}
    },
    "dataExfiltrationProtections": [],
    "upgradeAvailable": "notAvailable",
    "serviceUpgradedAt": null
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}
Statuscode:
201 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "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": {}
    },
    "dataExfiltrationProtections": [],
    "upgradeAvailable": "notAvailable",
    "serviceUpgradedAt": null
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}

SearchCreateOrUpdateServiceWithDataExfiltration

Voorbeeldaanvraag

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

{
  "location": "westus",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "hostingMode": "default",
    "computeType": "default",
    "dataExfiltrationProtections": [
      "BlockAll"
    ]
  }
}

Voorbeeldrespons

Statuscode:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "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": {}
    },
    "dataExfiltrationProtections": [
      "BlockAll"
    ],
    "upgradeAvailable": "notAvailable",
    "serviceUpgradedAt": null
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}
Statuscode:
201 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "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": {}
    },
    "dataExfiltrationProtections": [
      "BlockAll"
    ],
    "upgradeAvailable": "notAvailable",
    "serviceUpgradedAt": null
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}

SearchCreateOrUpdateServiceWithIdentity

Voorbeeldaanvraag

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

{
  "location": "westus",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "hostingMode": "default",
    "computeType": "default"
  },
  "identity": {
    "type": "SystemAssigned, UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/user-mi": {}
    }
  }
}

Voorbeeldrespons

Statuscode:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "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": {}
    },
    "dataExfiltrationProtections": [],
    "upgradeAvailable": "notAvailable",
    "serviceUpgradedAt": null
  },
  "identity": {
    "type": "SystemAssigned, UserAssigned",
    "principalId": "9d1e1f18-2122-4988-a11c-878782e40a5c",
    "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/user-mi": {
        "clientId": "cd1dcac8-82dd-45b5-9aed-76795d529f6b",
        "principalId": "24e07a75-1286-41e5-a15d-ded85ec3acd7"
      }
    }
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}
Statuscode:
201 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "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": {}
    },
    "dataExfiltrationProtections": [],
    "upgradeAvailable": "notAvailable",
    "serviceUpgradedAt": null
  },
  "identity": {
    "type": "SystemAssigned, UserAssigned",
    "principalId": "9d1e1f18-2122-4988-a11c-878782e40a5c",
    "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/user-mi": {
        "clientId": "cd1dcac8-82dd-45b5-9aed-76795d529f6b",
        "principalId": "24e07a75-1286-41e5-a15d-ded85ec3acd7"
      }
    }
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}

SearchCreateOrUpdateWithSemanticSearch

Voorbeeldaanvraag

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

{
  "location": "westus",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "hostingMode": "default",
    "computeType": "default",
    "semanticSearch": "free"
  }
}

Voorbeeldrespons

Statuscode:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "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": {}
    },
    "dataExfiltrationProtections": [],
    "semanticSearch": "free",
    "upgradeAvailable": "notAvailable",
    "serviceUpgradedAt": null
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}
Statuscode:
201 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "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": {}
    },
    "dataExfiltrationProtections": [],
    "semanticSearch": "free",
    "upgradeAvailable": "notAvailable",
    "serviceUpgradedAt": null
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}

Definities

Name Description
AadAuthFailureMode

Beschrijft welke reactie de gegevensvlak-API van een zoekservice zou verzenden naar aanvragen die mislukte verificatie hebben.
ApiKeyOnly

Geeft aan dat alleen de API-sleutel kan worden gebruikt voor verificatie.
CloudError

Bevat informatie over een API-fout.
CloudErrorBody

Beschrijft een bepaalde API-fout met een foutcode en een bericht.
ComputeType

Configureer deze eigenschap om de zoekservice te ondersteunen met behulp van de standaard compute of Azure Confidential Compute.
createdByType

Het type identiteit waarmee de resource is gemaakt.
DataPlaneAadOrApiKeyAuthOption

Geeft aan dat de API-sleutel of een toegangstoken van een Microsoft Entra ID-tenant kan worden gebruikt voor verificatie.
DataPlaneAuthOptions

Definieert de opties voor hoe de zoekservice een aanvraag voor een gegevensvlak verifieert. Dit kan niet worden ingesteld als 'disableLocalAuth' is ingesteld op true.
EncryptionWithCmk

Beschrijft een beleid dat bepaalt hoe resources binnen de zoekservice moeten worden versleuteld met door de klant beheerde sleutels.
HostingMode

Alleen van toepassing op de standard3-SKU. U kunt deze eigenschap instellen om maximaal 3 high-densitypartities in te schakelen die maximaal 1000 indexen toestaan, wat veel hoger is dan de maximumindexen die zijn toegestaan voor elke andere SKU. Voor de standard3-SKU is de waarde 'standaard' of 'highDensity'. Voor alle andere SKU's moet deze waarde 'standaard' zijn.
Identity

Details over de identiteit van de zoekservice. Een null-waarde geeft aan dat aan de zoekservice geen identiteit is toegewezen.
IdentityType

Het type identiteit dat wordt gebruikt voor de resource. Het type SystemAssigned, UserAssigned bevat zowel een identiteit die door het systeem is gemaakt als een set door de gebruiker toegewezen identiteiten. Met het type None worden alle identiteiten uit de service verwijderd.
IpRule

De IP-beperkingsregel van de Azure AI Search-service.
NetworkRuleSet

Netwerkspecifieke regels die bepalen hoe de Azure AI Search-service kan worden bereikt.
PrivateEndpoint

De privé-eindpuntresource van de Microsoft.Network-provider.
PrivateEndpointConnection

Beschrijft een bestaande privé-eindpuntverbinding met de Azure AI Search-service.
PrivateEndpointConnectionProperties

Beschrijft de eigenschappen van een bestaande privé-eindpuntverbinding met de zoekservice.
PrivateLinkServiceConnectionProvisioningState

De inrichtingsstatus van de private link-serviceverbinding. Geldige waarden zijn bijwerken, verwijderen, mislukt, geslaagd, onvolledig of geannuleerd.
PrivateLinkServiceConnectionState

Beschrijft de huidige status van een bestaande Azure Private Link-serviceverbinding met het privé-eindpunt.
PrivateLinkServiceConnectionStatus

Status van de private link-serviceverbinding. Geldige waarden zijn In behandeling, Goedgekeurd, Geweigerd of Verbroken.
ProvisioningState

De status van de laatste inrichtingsbewerking die wordt uitgevoerd op de zoekservice. Inrichten is een tussenliggende status die zich voordoet terwijl de servicecapaciteit tot stand wordt gebracht. Nadat de capaciteit is ingesteld, wordt provisioningState gewijzigd in Geslaagd of Mislukt. Clienttoepassingen kunnen de inrichtingsstatus peilen (het aanbevolen polling-interval is van 30 seconden tot één minuut) met behulp van de bewerking Zoekservice ophalen om te zien wanneer een bewerking is voltooid. Als u de gratis service gebruikt, komt deze waarde meestal rechtstreeks terug als Geslaagd in de aanroep van de zoekservice maken. Dit komt doordat de gratis service gebruikmaakt van capaciteit die al is ingesteld.
PublicNetworkAccess

Deze waarde kan worden ingesteld op 'ingeschakeld' om te voorkomen dat bestaande klantbronnen en sjablonen fouten veroorzaken. Als deze optie is ingesteld op Uitgeschakeld, is verkeer via openbare interface niet toegestaan en zijn privé-eindpuntverbindingen de exclusieve toegangsmethode.
SearchBypass

Mogelijke oorsprongen van binnenkomend verkeer dat de regels kan omzeilen die zijn gedefinieerd in de sectie ipRules.
SearchDataExfiltrationProtection

Een lijst met scenario's voor gegevensexfiltratie die expliciet zijn toegestaan voor de zoekservice. Momenteel is de enige ondersteunde waarde 'Alles' om alle mogelijke scenario's voor gegevensexport uit te schakelen met meer verfijnde besturingselementen die voor de toekomst zijn gepland.
SearchEncryptionComplianceStatus

Retourneert de status van de naleving van de zoekservice met betrekking tot niet-CMK-versleutelde objecten. Als een service meer dan één niet-versleuteld object heeft en afdwinging is ingeschakeld, wordt de service gemarkeerd als niet-compatibel.
SearchEncryptionWithCmk

Beschrijft hoe een zoekservice naleving moet afdwingen als er objecten worden gevonden die niet zijn versleuteld met de door de klant beheerde sleutel.
SearchSemanticSearch

Hiermee stelt u opties in waarmee de beschikbaarheid van semantische zoekopdrachten wordt ingesteld. Deze configuratie is alleen mogelijk voor bepaalde Azure AI Search-SKU's op bepaalde locaties.
SearchService

Beschrijft een Azure AI Search-service en de huidige status.
SearchServiceStatus

De status van de zoekservice. Mogelijke waarden zijn: 'wordt uitgevoerd': de zoekservice wordt uitgevoerd en er worden geen inrichtingsbewerkingen uitgevoerd. 'inrichting': de zoekservice wordt ingericht of omhoog of omlaag geschaald. 'verwijderen': de zoekservice wordt verwijderd. 'gedegradeerd': de zoekservice is gedegradeerd. Dit kan gebeuren wanneer de onderliggende zoekeenheden niet in orde zijn. De zoekservice is waarschijnlijk operationeel, maar de prestaties kunnen traag zijn en sommige aanvragen kunnen worden verwijderd. 'uitgeschakeld': de zoekservice is uitgeschakeld. In deze status weigert de service alle API-aanvragen. 'error': de zoekservice heeft een foutstatus. 'gestopt': de zoekservice bevindt zich in een abonnement dat is uitgeschakeld. Als uw service de gedegradeerde, uitgeschakelde of foutstatussen heeft, betekent dit dat het Azure AI Search-team het onderliggende probleem actief onderzoekt. Toegewezen services in deze statussen zijn nog steeds in rekening gebracht op basis van het aantal ingerichte zoekeenheden.
SharedPrivateLinkResource

Beschrijft een gedeelde private link-resource die wordt beheerd door de Azure AI Search-service.
SharedPrivateLinkResourceProperties

Beschrijft de eigenschappen van een bestaande gedeelde private link-resource die wordt beheerd door de Azure AI Search-service.
SharedPrivateLinkResourceProvisioningState

De inrichtingsstatus van de gedeelde private link-resource. Geldige waarden zijn bijwerken, verwijderen, mislukt, geslaagd of onvolledig.
SharedPrivateLinkResourceStatus

Status van de gedeelde private link-resource. Geldige waarden zijn in behandeling, goedgekeurd, geweigerd of verbroken.
Sku

Definieert de SKU van een zoekservice, waarmee de factureringsfrequentie en capaciteitslimieten worden bepaald.
SkuName

De SKU van de zoekservice. Geldige waarden zijn: 'gratis': Gedeelde service. 'basic': toegewezen service met maximaal 3 replica's. 'standaard': toegewezen service met maximaal 12 partities en 12 replica's. 'standard2': vergelijkbaar met standaard, maar met meer capaciteit per zoekeenheid. 'standard3': de grootste Standard-aanbieding met maximaal 12 partities en 12 replica's (of maximaal 3 partities met meer indexen als u ook de eigenschap hostingMode instelt op 'highDensity'). 'storage_optimized_l1': ondersteunt 1 TB per partitie, maximaal 12 partities. 'storage_optimized_l2': ondersteunt 2 TB per partitie, maximaal 12 partities.'
systemData

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.
UpgradeAvailable

Geeft aan of er een upgrade beschikbaar is voor de zoekservice.
UserAssignedIdentity

Door de gebruiker toegewezen identiteitseigenschappen

AadAuthFailureMode

Inventarisatie

Beschrijft welke reactie de gegevensvlak-API van een zoekservice zou verzenden naar aanvragen die mislukte verificatie hebben.

Waarde Description
http403

Geeft aan dat aanvragen die mislukte verificatie moeten worden weergegeven met een HTTP-statuscode van 403 (verboden).
http401WithBearerChallenge

Geeft aan dat aanvragen die mislukte verificatie moeten worden weergegeven met een HTTP-statuscode van 401 (niet geautoriseerd) en een Bearer-uitdaging presenteren.

ApiKeyOnly

Object

Geeft aan dat alleen de API-sleutel kan worden gebruikt voor verificatie.

CloudError

Object

Bevat informatie over een API-fout.

Name Type Description
error

CloudErrorBody

Beschrijft een bepaalde API-fout met een foutcode en een bericht.
message

string

Een korte beschrijving van de fout die aangeeft wat er fout is gegaan (voor informatie over details/foutopsporing raadpleegt u de eigenschap 'error.message').

CloudErrorBody

Object

Beschrijft een bepaalde API-fout met een foutcode en een bericht.

Name Type Description
code

string

Een foutcode die de foutvoorwaarde nauwkeuriger beschrijft dan een HTTP-statuscode. Kan worden gebruikt om programmatisch specifieke foutcases af te handelen.
details

CloudErrorBody[]

Bevat geneste fouten die betrekking hebben op deze fout.
message

string

Een bericht met een gedetailleerde beschrijving van de fout en informatie over foutopsporing.
target

string

Het doel van de specifieke fout (bijvoorbeeld de naam van de eigenschap in fout).

ComputeType

Inventarisatie

Configureer deze eigenschap om de zoekservice te ondersteunen met behulp van de standaard compute of Azure Confidential Compute.

Waarde Description
default

Maak de service met de standaardrekenfunctie.
confidential

Maak de service met Azure Confidential Compute.

createdByType

Inventarisatie

Het type identiteit waarmee de resource is gemaakt.

Waarde Description
User
Application
ManagedIdentity
Key

DataPlaneAadOrApiKeyAuthOption

Object

Geeft aan dat de API-sleutel of een toegangstoken van een Microsoft Entra ID-tenant kan worden gebruikt voor verificatie.

Name Type Description
aadAuthFailureMode

AadAuthFailureMode

Beschrijft welke reactie de gegevensvlak-API van een zoekservice zou verzenden naar aanvragen die mislukte verificatie hebben.

DataPlaneAuthOptions

Object

Definieert de opties voor hoe de zoekservice een aanvraag voor een gegevensvlak verifieert. Dit kan niet worden ingesteld als 'disableLocalAuth' is ingesteld op true.

Name Type Description
aadOrApiKey

DataPlaneAadOrApiKeyAuthOption

Geeft aan dat de API-sleutel of een toegangstoken van een Microsoft Entra ID-tenant kan worden gebruikt voor verificatie.
apiKeyOnly

ApiKeyOnly

Geeft aan dat alleen de API-sleutel kan worden gebruikt voor verificatie.

EncryptionWithCmk

Object

Beschrijft een beleid dat bepaalt hoe resources binnen de zoekservice moeten worden versleuteld met door de klant beheerde sleutels.

Name Type Description
encryptionComplianceStatus

SearchEncryptionComplianceStatus

Retourneert de status van de naleving van de zoekservice met betrekking tot niet-CMK-versleutelde objecten. Als een service meer dan één niet-versleuteld object heeft en afdwinging is ingeschakeld, wordt de service gemarkeerd als niet-compatibel.
enforcement

SearchEncryptionWithCmk

Beschrijft hoe een zoekservice naleving moet afdwingen als er objecten worden gevonden die niet zijn versleuteld met de door de klant beheerde sleutel.

HostingMode

Inventarisatie

Alleen van toepassing op de standard3-SKU. U kunt deze eigenschap instellen om maximaal 3 high-densitypartities in te schakelen die maximaal 1000 indexen toestaan, wat veel hoger is dan de maximumindexen die zijn toegestaan voor elke andere SKU. Voor de standard3-SKU is de waarde 'standaard' of 'highDensity'. Voor alle andere SKU's moet deze waarde 'standaard' zijn.

Waarde Description
default

De limiet voor het aantal indexen wordt bepaald door de standaardlimieten voor de SKU.
highDensity

Alleen toepassing voor standard3-SKU, waarbij de zoekservice maximaal 1000 indexen kan bevatten.

Identity

Object

Details over de identiteit van de zoekservice. Een null-waarde geeft aan dat aan de zoekservice geen identiteit is toegewezen.

Name Type Description
principalId

string

De principal-id van de door het systeem toegewezen identiteit van de zoekservice.
tenantId

string

De tenant-id van de door het systeem toegewezen identiteit van de zoekservice.
type

IdentityType

Het type identiteit dat wordt gebruikt voor de resource. Het type SystemAssigned, UserAssigned bevat zowel een identiteit die door het systeem is gemaakt als een set door de gebruiker toegewezen identiteiten. Met het type None worden alle identiteiten uit de service verwijderd.
userAssignedIdentities

<string,  UserAssignedIdentity>

De lijst met gebruikersidentiteiten die zijn gekoppeld aan de resource. De sleutelverwijzingen voor de gebruikersidentiteitswoordenlijst zijn ARM-resource-id's in de vorm: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.

IdentityType

Inventarisatie

Het type identiteit dat wordt gebruikt voor de resource. Het type SystemAssigned, UserAssigned bevat zowel een identiteit die door het systeem is gemaakt als een set door de gebruiker toegewezen identiteiten. Met het type None worden alle identiteiten uit de service verwijderd.

Waarde Description
None

Geeft aan dat elke identiteit die is gekoppeld aan de zoekservice moet worden verwijderd.
SystemAssigned

Geeft aan dat door het systeem toegewezen identiteit voor de zoekservice wordt ingeschakeld.
UserAssigned

Geeft aan dat een of meer door de gebruiker toegewezen identiteiten worden toegewezen aan de zoekservice.
SystemAssigned, UserAssigned

Geeft aan dat door het systeem toegewezen identiteit voor de zoekservice wordt ingeschakeld, samen met de toewijzing van een of meer door de gebruiker toegewezen identiteiten.

IpRule

Object

De IP-beperkingsregel van de Azure AI Search-service.

Name Type Description
value

string

Waarde die overeenkomt met één IPv4-adres (bijvoorbeeld 123.1.2.3) of een IP-bereik in CIDR-indeling (bijvoorbeeld 123.1.2.3/24).

NetworkRuleSet

Object

Netwerkspecifieke regels die bepalen hoe de Azure AI Search-service kan worden bereikt.

Name Type Description
bypass

SearchBypass

Mogelijke oorsprongen van binnenkomend verkeer dat de regels kan omzeilen die zijn gedefinieerd in de sectie ipRules.
ipRules

IpRule[]

Een lijst met IP-beperkingsregels waarmee de binnenkomende netwerk(en) worden gedefinieerd met toegang tot het eindpunt van de zoekservice. Ondertussen worden alle andere openbare IP-netwerken geblokkeerd door de firewall. Deze beperkingsregels worden alleen toegepast wanneer de 'publicNetworkAccess' van de zoekservice 'ingeschakeld' is; anders is verkeer via openbare interface niet toegestaan, zelfs niet met openbare IP-regels en zijn privé-eindpuntverbindingen de exclusieve toegangsmethode.

PrivateEndpoint

Object

De privé-eindpuntresource van de Microsoft.Network-provider.

Name Type Description
id

string

De resource-id van de privé-eindpuntresource van de Microsoft.Network-provider.

PrivateEndpointConnection

Object

Beschrijft een bestaande privé-eindpuntverbinding met de Azure AI Search-service.

Name Type Description
id

string (arm-id)

Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceType}/{resourceName}"
name

string

De naam van de resource
properties

PrivateEndpointConnectionProperties

Beschrijft de eigenschappen van een bestaande privé-eindpuntverbinding met de Azure AI Search-service.
systemData

systemData

Azure Resource Manager-metagegevens met createdBy- en modifiedBy-gegevens.
type

string

Het type bron. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

PrivateEndpointConnectionProperties

Object

Beschrijft de eigenschappen van een bestaande privé-eindpuntverbinding met de zoekservice.

Name Type Description
groupId

string

De groeps-id van de Azure-resource waarvoor de Private Link-service is bedoeld.
privateEndpoint

PrivateEndpoint

De privé-eindpuntresource van de Microsoft.Network-provider.
privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Beschrijft de huidige status van een bestaande Azure Private Link-serviceverbinding met het privé-eindpunt.
provisioningState

PrivateLinkServiceConnectionProvisioningState

De inrichtingsstatus van de private link-serviceverbinding. Geldige waarden zijn bijwerken, verwijderen, mislukt, geslaagd, onvolledig of geannuleerd.

PrivateLinkServiceConnectionProvisioningState

Inventarisatie

De inrichtingsstatus van de private link-serviceverbinding. Geldige waarden zijn bijwerken, verwijderen, mislukt, geslaagd, onvolledig of geannuleerd.

Waarde Description
Updating

De private link-serviceverbinding wordt in het proces gemaakt, samen met andere resources, zodat deze volledig functioneel is.
Deleting

De private link-serviceverbinding wordt verwijderd.
Failed

De private link-serviceverbinding kan niet worden ingericht of verwijderd.
Succeeded

De private link-serviceverbinding is ingericht en is gereed voor goedkeuring.
Incomplete

De inrichtingsaanvraag voor de private link-serviceverbindingsresource is geaccepteerd, maar het proces van maken is nog niet gestart.
Canceled

De inrichtingsaanvraag voor de private link-serviceverbindingsresource is geannuleerd.

PrivateLinkServiceConnectionState

Object

Beschrijft de huidige status van een bestaande Azure Private Link-serviceverbinding met het privé-eindpunt.

Name Type Default value Description
actionsRequired

string

None

Een beschrijving van eventuele extra acties die nodig kunnen zijn.
description

string

De beschrijving voor de verbindingsstatus van de Private Link-service.
status

PrivateLinkServiceConnectionStatus

Status van de private link-serviceverbinding. Geldige waarden zijn In behandeling, Goedgekeurd, Geweigerd of Verbroken.

PrivateLinkServiceConnectionStatus

Inventarisatie

Status van de private link-serviceverbinding. Geldige waarden zijn In behandeling, Goedgekeurd, Geweigerd of Verbroken.

Waarde Description
Pending

De privé-eindpuntverbinding is gemaakt en wacht op goedkeuring.
Approved

De verbinding met het privé-eindpunt is goedgekeurd en kan worden gebruikt.
Rejected

De privé-eindpuntverbinding is geweigerd en kan niet worden gebruikt.
Disconnected

De privé-eindpuntverbinding is verwijderd uit de service.

ProvisioningState

Inventarisatie

De status van de laatste inrichtingsbewerking die wordt uitgevoerd op de zoekservice. Inrichten is een tussenliggende status die zich voordoet terwijl de servicecapaciteit tot stand wordt gebracht. Nadat de capaciteit is ingesteld, wordt provisioningState gewijzigd in Geslaagd of Mislukt. Clienttoepassingen kunnen de inrichtingsstatus peilen (het aanbevolen polling-interval is van 30 seconden tot één minuut) met behulp van de bewerking Zoekservice ophalen om te zien wanneer een bewerking is voltooid. Als u de gratis service gebruikt, komt deze waarde meestal rechtstreeks terug als Geslaagd in de aanroep van de zoekservice maken. Dit komt doordat de gratis service gebruikmaakt van capaciteit die al is ingesteld.

Waarde Description
succeeded

De laatste inrichtingsbewerking is voltooid.
provisioning

De zoekservice wordt ingericht of omhoog of omlaag geschaald.
failed

De laatste inrichtingsbewerking is mislukt.

PublicNetworkAccess

Inventarisatie

Deze waarde kan worden ingesteld op 'ingeschakeld' om te voorkomen dat bestaande klantbronnen en sjablonen fouten veroorzaken. Als deze optie is ingesteld op Uitgeschakeld, is verkeer via openbare interface niet toegestaan en zijn privé-eindpuntverbindingen de exclusieve toegangsmethode.

Waarde Description
enabled

De zoekservice is toegankelijk vanuit verkeer dat afkomstig is van het openbare internet.
disabled

De zoekservice is niet toegankelijk vanuit verkeer dat afkomstig is van het openbare internet. Toegang is alleen toegestaan via goedgekeurde privé-eindpuntverbindingen.

SearchBypass

Inventarisatie

Mogelijke oorsprongen van binnenkomend verkeer dat de regels kan omzeilen die zijn gedefinieerd in de sectie ipRules.

Waarde Description
None

Hiermee wordt aangegeven dat geen oorsprong de regels kan omzeilen die zijn gedefinieerd in de sectie ipRules. Dit is de standaardwaarde.
AzureServices

Geeft aan dat aanvragen die afkomstig zijn van vertrouwde Azure-services, de regels kunnen omzeilen die zijn gedefinieerd in de sectie ipRules.

SearchDataExfiltrationProtection

Inventarisatie

Een lijst met scenario's voor gegevensexfiltratie die expliciet zijn toegestaan voor de zoekservice. Momenteel is de enige ondersteunde waarde 'Alles' om alle mogelijke scenario's voor gegevensexport uit te schakelen met meer verfijnde besturingselementen die voor de toekomst zijn gepland.

Waarde Description
BlockAll

Geeft aan dat alle scenario's voor gegevensexfiltratie zijn uitgeschakeld.

SearchEncryptionComplianceStatus

Inventarisatie

Retourneert de status van de naleving van de zoekservice met betrekking tot niet-CMK-versleutelde objecten. Als een service meer dan één niet-versleuteld object heeft en afdwinging is ingeschakeld, wordt de service gemarkeerd als niet-compatibel.

Waarde Description
Compliant

Geeft aan dat de zoekservice compatibel is, omdat het aantal niet-CMK-versleutelde objecten nul is of wordt afgedwongen.
NonCompliant

Geeft aan dat de zoekservice meer dan één niet-CMK-versleutelde objecten heeft.

SearchEncryptionWithCmk

Inventarisatie

Beschrijft hoe een zoekservice naleving moet afdwingen als er objecten worden gevonden die niet zijn versleuteld met de door de klant beheerde sleutel.

Waarde Description
Disabled

Er wordt geen afdwinging van door de klant beheerde sleutelversleuteling uitgevoerd. Alleen de ingebouwde door de service beheerde versleuteling wordt gebruikt.
Enabled

De zoekservice wordt gemarkeerd als niet-compatibel als een of meer objecten niet zijn versleuteld met een door de klant beheerde sleutel.
Unspecified

Afdwingingsbeleid wordt niet expliciet opgegeven, waarbij het gedrag hetzelfde is als als 'Uitgeschakeld'.

SearchSemanticSearch

Inventarisatie

Hiermee stelt u opties in waarmee de beschikbaarheid van semantische zoekopdrachten wordt ingesteld. Deze configuratie is alleen mogelijk voor bepaalde Azure AI Search-SKU's op bepaalde locaties.

Waarde Description
disabled

Geeft aan dat de semantische reranker is uitgeschakeld voor de zoekservice. Dit is de standaardwaarde.
free

Hiermee schakelt u een semantische rerankeerfunctie in voor een zoekservice en geeft u aan dat deze moet worden gebruikt binnen de grenzen van het gratis abonnement. Het gratis abonnement zou het volume van semantische rangschikkingsaanvragen beperken en wordt gratis aangeboden. Dit is de standaardinstelling voor nieuw ingerichte zoekservices.
standard

Hiermee schakelt u een semantische rerankeerfunctie in voor een zoekservice als factureerbare functie, met een hogere doorvoer en een hoger volume aan semantisch gererankeerde query's.

SearchService

Object

Beschrijft een Azure AI Search-service en de huidige status.

Name Type Default value Description
id

string (arm-id)

Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceType}/{resourceName}"
identity

Identity

De identiteit van de resource.
location

string

De geografische locatie waar de resource zich bevindt
name

string

De naam van de resource
properties.authOptions

DataPlaneAuthOptions

Definieert de opties voor de wijze waarop de gegevensvlak-API van een zoekservice aanvragen verifieert. Dit kan niet worden ingesteld als 'disableLocalAuth' is ingesteld op true.
properties.computeType

ComputeType

Configureer deze eigenschap om de zoekservice te ondersteunen met behulp van de standaard compute of Azure Confidential Compute.
properties.dataExfiltrationProtections

SearchDataExfiltrationProtection[]

Een lijst met scenario's voor gegevensexfiltratie die expliciet zijn toegestaan voor de zoekservice. Momenteel is de enige ondersteunde waarde 'Alles' om alle mogelijke scenario's voor gegevensexport uit te schakelen met meer verfijnde besturingselementen die voor de toekomst zijn gepland.
properties.disableLocalAuth

boolean

Als deze is ingesteld op true, kunnen aanroepen naar de zoekservice geen API-sleutels gebruiken voor verificatie. Dit kan niet worden ingesteld op true als 'dataPlaneAuthOptions' is gedefinieerd.
properties.eTag

string

Een door het systeem gegenereerde eigenschap die de etag van de service vertegenwoordigt die kan worden gebruikt voor optimistisch gelijktijdigheidsbeheer tijdens updates.
properties.encryptionWithCmk

EncryptionWithCmk

Hiermee geeft u een beleid met betrekking tot de versleuteling van resources (zoals indexen) met behulp van customer manager-sleutels binnen een zoekservice.
properties.endpoint

string (uri)

Het eindpunt van de Azure AI Search-service.
properties.hostingMode

HostingMode

default

Alleen van toepassing op de standard3-SKU. U kunt deze eigenschap instellen om maximaal 3 high-densitypartities in te schakelen die maximaal 1000 indexen toestaan, wat veel hoger is dan de maximumindexen die zijn toegestaan voor elke andere SKU. Voor de standard3-SKU is de waarde 'standaard' of 'highDensity'. Voor alle andere SKU's moet deze waarde 'standaard' zijn.
properties.networkRuleSet

NetworkRuleSet

Netwerkspecifieke regels die bepalen hoe de Azure AI Search-service kan worden bereikt.
properties.partitionCount

integer (int32)

minimum: 1
maximum: 12 		1

Het aantal partities in de zoekservice; indien opgegeven, kan dit 1, 2, 3, 4, 6 of 12 zijn. Waarden die groter zijn dan 1 zijn alleen geldig voor standaard-SKU's. Voor 'standard3'-services waarbij hostingMode is ingesteld op 'highDensity', liggen de toegestane waarden tussen 1 en 3.
properties.privateEndpointConnections

PrivateEndpointConnection[]

De lijst met privé-eindpuntverbindingen met de Azure AI Search-service.
properties.provisioningState

ProvisioningState

De status van de laatste inrichtingsbewerking die wordt uitgevoerd op de zoekservice. Inrichten is een tussenliggende status die zich voordoet terwijl de servicecapaciteit tot stand wordt gebracht. Nadat de capaciteit is ingesteld, wordt provisioningState gewijzigd in Geslaagd of Mislukt. Clienttoepassingen kunnen de inrichtingsstatus peilen (het aanbevolen polling-interval is van 30 seconden tot één minuut) met behulp van de bewerking Zoekservice ophalen om te zien wanneer een bewerking is voltooid. Als u de gratis service gebruikt, komt deze waarde meestal rechtstreeks terug als Geslaagd in de aanroep van de zoekservice maken. Dit komt doordat de gratis service gebruikmaakt van capaciteit die al is ingesteld.
properties.publicNetworkAccess

PublicNetworkAccess

enabled

Deze waarde kan worden ingesteld op 'ingeschakeld' om te voorkomen dat bestaande klantbronnen en sjablonen fouten veroorzaken. Als deze optie is ingesteld op Uitgeschakeld, is verkeer via openbare interface niet toegestaan en zijn privé-eindpuntverbindingen de exclusieve toegangsmethode.
properties.replicaCount

integer (int32)

minimum: 1
maximum: 12 		1

Het aantal replica's in de zoekservice. Indien opgegeven, moet deze een waarde tussen 1 en 12 inclusief zijn voor standaard-SKU's of tussen 1 en 3 inclusief voor de basis-SKU.
properties.semanticSearch

SearchSemanticSearch

Hiermee stelt u opties in waarmee de beschikbaarheid van semantische zoekopdrachten wordt ingesteld. Deze configuratie is alleen mogelijk voor bepaalde Azure AI Search-SKU's op bepaalde locaties.
properties.serviceUpgradedAt

string (date-time)

De datum en tijd waarop de zoekservice voor het laatst is bijgewerkt. Dit veld is null totdat de service voor het eerst wordt bijgewerkt.
properties.sharedPrivateLinkResources

SharedPrivateLinkResource[]

De lijst met gedeelde private link-resources die worden beheerd door de Azure AI Search-service.
properties.status

SearchServiceStatus

De status van de zoekservice. Mogelijke waarden zijn: 'wordt uitgevoerd': de zoekservice wordt uitgevoerd en er worden geen inrichtingsbewerkingen uitgevoerd. 'inrichting': de zoekservice wordt ingericht of omhoog of omlaag geschaald. 'verwijderen': de zoekservice wordt verwijderd. 'gedegradeerd': de zoekservice is gedegradeerd. Dit kan gebeuren wanneer de onderliggende zoekeenheden niet in orde zijn. De zoekservice is waarschijnlijk operationeel, maar de prestaties kunnen traag zijn en sommige aanvragen kunnen worden verwijderd. 'uitgeschakeld': de zoekservice is uitgeschakeld. In deze status weigert de service alle API-aanvragen. 'error': de zoekservice heeft een foutstatus. 'gestopt': de zoekservice bevindt zich in een abonnement dat is uitgeschakeld. Als uw service de gedegradeerde, uitgeschakelde of foutstatussen heeft, betekent dit dat het Azure AI Search-team het onderliggende probleem actief onderzoekt. Toegewezen services in deze statussen zijn nog steeds in rekening gebracht op basis van het aantal ingerichte zoekeenheden.
properties.statusDetails

string

De details van de status van de zoekservice.
properties.upgradeAvailable

UpgradeAvailable

Geeft aan of er een upgrade beschikbaar is voor de zoekservice.
sku

Sku

De SKU van de zoekservice, die de prijscategorie en capaciteitslimieten bepaalt. Deze eigenschap is vereist bij het maken van een nieuwe zoekservice.
systemData

systemData

Azure Resource Manager-metagegevens van de zoekservice met createdBy- en modifiedBy-gegevens.
tags

object

Resourcetags.
type

string

Het type bron. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

SearchServiceStatus

Inventarisatie

De status van de zoekservice. Mogelijke waarden zijn: 'wordt uitgevoerd': de zoekservice wordt uitgevoerd en er worden geen inrichtingsbewerkingen uitgevoerd. 'inrichting': de zoekservice wordt ingericht of omhoog of omlaag geschaald. 'verwijderen': de zoekservice wordt verwijderd. 'gedegradeerd': de zoekservice is gedegradeerd. Dit kan gebeuren wanneer de onderliggende zoekeenheden niet in orde zijn. De zoekservice is waarschijnlijk operationeel, maar de prestaties kunnen traag zijn en sommige aanvragen kunnen worden verwijderd. 'uitgeschakeld': de zoekservice is uitgeschakeld. In deze status weigert de service alle API-aanvragen. 'error': de zoekservice heeft een foutstatus. 'gestopt': de zoekservice bevindt zich in een abonnement dat is uitgeschakeld. Als uw service de gedegradeerde, uitgeschakelde of foutstatussen heeft, betekent dit dat het Azure AI Search-team het onderliggende probleem actief onderzoekt. Toegewezen services in deze statussen zijn nog steeds in rekening gebracht op basis van het aantal ingerichte zoekeenheden.

Waarde Description
running

De zoekservice wordt uitgevoerd en er worden geen inrichtingsbewerkingen uitgevoerd.
provisioning

De zoekservice wordt ingericht of omhoog of omlaag geschaald.
deleting

De zoekservice wordt verwijderd.
degraded

De zoekservice is gedegradeerd omdat onderliggende zoekeenheden niet in orde zijn.
disabled

De zoekservice is uitgeschakeld en alle API-aanvragen worden geweigerd.
error

De zoekservice heeft de foutstatus, wat aangeeft dat er een fout is opgetreden bij het inrichten of verwijderen.
stopped

De zoekservice bevindt zich in een abonnement dat is uitgeschakeld.

SharedPrivateLinkResource

Object

Beschrijft een gedeelde private link-resource die wordt beheerd door de Azure AI Search-service.

Name Type Description
id

string (arm-id)

Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceType}/{resourceName}"
name

string

De naam van de resource
properties

SharedPrivateLinkResourceProperties

Beschrijft de eigenschappen van een gedeelde private link-resource die wordt beheerd door de Azure AI Search-service.
systemData

systemData

Azure Resource Manager-metagegevens met createdBy- en modifiedBy-gegevens.
type

string

Het type bron. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

SharedPrivateLinkResourceProperties

Object

Beschrijft de eigenschappen van een bestaande gedeelde private link-resource die wordt beheerd door de Azure AI Search-service.

Name Type Description
groupId

string

De groeps-id van de provider van de resource waarvoor de gedeelde private link-resource is bedoeld.
privateLinkResourceId

string

De resource-id van de resource waarvoor de gedeelde private link-resource is bedoeld.
provisioningState

SharedPrivateLinkResourceProvisioningState

De inrichtingsstatus van de gedeelde private link-resource. Geldige waarden zijn bijwerken, verwijderen, mislukt, geslaagd of onvolledig.
requestMessage

string

Het bericht voor het aanvragen van goedkeuring van de gedeelde private link-resource.
resourceRegion

string

Facultatief. Kan worden gebruikt om de Azure Resource Manager-locatie op te geven van de resource waarvoor een gedeelde privékoppeling wordt gemaakt. Dit is alleen vereist voor de resources waarvan de DNS-configuratie regionaal is (zoals Azure Kubernetes Service).
status

SharedPrivateLinkResourceStatus

Status van de gedeelde private link-resource. Geldige waarden zijn in behandeling, goedgekeurd, geweigerd of verbroken.

SharedPrivateLinkResourceProvisioningState

Inventarisatie

De inrichtingsstatus van de gedeelde private link-resource. Geldige waarden zijn bijwerken, verwijderen, mislukt, geslaagd of onvolledig.

Waarde Description
Updating

De gedeelde private link-resource wordt samen met andere resources gemaakt, zodat deze volledig functioneel is.
Deleting

De gedeelde private link-resource wordt verwijderd.
Failed

De gedeelde private link-resource kan niet worden ingericht of verwijderd.
Succeeded

De gedeelde private link-resource is ingericht en is gereed voor goedkeuring.
Incomplete

De inrichtingsaanvraag voor de gedeelde private link-resource is geaccepteerd, maar het maken is nog niet gestart.

SharedPrivateLinkResourceStatus

Inventarisatie

Status van de gedeelde private link-resource. Geldige waarden zijn in behandeling, goedgekeurd, geweigerd of verbroken.

Waarde Description
Pending

De gedeelde private link-resource is gemaakt en wacht op goedkeuring.
Approved

De gedeelde private link-resource is goedgekeurd en is klaar voor gebruik.
Rejected

De gedeelde private link-resource is geweigerd en kan niet worden gebruikt.
Disconnected

De gedeelde private link-resource is verwijderd uit de service.

Sku

Object

Definieert de SKU van een zoekservice, waarmee de factureringsfrequentie en capaciteitslimieten worden bepaald.

Name Type Description
name

SkuName

De SKU van de zoekservice. Geldige waarden zijn: 'gratis': Gedeelde service. 'basic': toegewezen service met maximaal 3 replica's. 'standaard': toegewezen service met maximaal 12 partities en 12 replica's. 'standard2': vergelijkbaar met standaard, maar met meer capaciteit per zoekeenheid. 'standard3': de grootste Standard-aanbieding met maximaal 12 partities en 12 replica's (of maximaal 3 partities met meer indexen als u ook de eigenschap hostingMode instelt op 'highDensity'). 'storage_optimized_l1': ondersteunt 1 TB per partitie, maximaal 12 partities. 'storage_optimized_l2': ondersteunt 2 TB per partitie, maximaal 12 partities.'

SkuName

Inventarisatie

De SKU van de zoekservice. Geldige waarden zijn: 'gratis': Gedeelde service. 'basic': toegewezen service met maximaal 3 replica's. 'standaard': toegewezen service met maximaal 12 partities en 12 replica's. 'standard2': vergelijkbaar met standaard, maar met meer capaciteit per zoekeenheid. 'standard3': de grootste Standard-aanbieding met maximaal 12 partities en 12 replica's (of maximaal 3 partities met meer indexen als u ook de eigenschap hostingMode instelt op 'highDensity'). 'storage_optimized_l1': ondersteunt 1 TB per partitie, maximaal 12 partities. 'storage_optimized_l2': ondersteunt 2 TB per partitie, maximaal 12 partities.'

Waarde Description
free

Gratis laag, zonder SLA-garanties en een subset van de functies die worden aangeboden voor factureerbare lagen.
basic

Factureerbare laag voor een toegewezen service met maximaal 3 replica's.
standard

Factureerbare laag voor een toegewezen service met maximaal 12 partities en 12 replica's.
standard2

Vergelijkbaar met 'standaard', maar met meer capaciteit per zoekeenheid.
standard3

De grootste Standard-aanbieding met maximaal 12 partities en 12 replica's (of maximaal 3 partities met meer indexen als u ook de eigenschap hostingMode instelt op 'highDensity').
storage_optimized_l1

Factureerbare laag voor een toegewezen service die 1 TB per partitie ondersteunt, maximaal 12 partities.
storage_optimized_l2

Factureerbare laag voor een toegewezen service die 2 TB per partitie ondersteunt, maximaal 12 partities.

systemData

Object

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name Type Description
createdAt

string (date-time)

De tijdstempel van het maken van resources (UTC).
createdBy

string

De identiteit waarmee de resource is gemaakt.
createdByType

createdByType

Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt

string (date-time)

De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy

string

De identiteit die de resource voor het laatst heeft gewijzigd.
lastModifiedByType

createdByType

Het type identiteit dat de resource voor het laatst heeft gewijzigd.

UpgradeAvailable

Inventarisatie

Geeft aan of er een upgrade beschikbaar is voor de zoekservice.

Waarde Description
notAvailable

Er is momenteel geen upgrade beschikbaar voor de service.
available

Er is een upgrade beschikbaar voor de service.

UserAssignedIdentity

Object

Door de gebruiker toegewezen identiteitseigenschappen

Name Type Description
clientId

string (uuid)

De client-id van de toegewezen identiteit.
principalId

string (uuid)

De principal-id van de toegewezen identiteit.