Delen via

Services - Update

  • Referentie
Service:
Search Management
API-versie:
2024-03-01-preview

Updates een bestaande zoekservice in de opgegeven resourcegroep.

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

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 moet worden bijgewerkt.
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 de antwoordinformatie als een manier om de aanvraag bij te houden.

Aanvraagbody

Name Type Description
identity

Identity

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

string

De geografische locatie van de resource. Dit moet een van de ondersteunde en geregistreerde Azure-geografische regio's zijn (bijvoorbeeld VS - west, VS - oost, Azië - zuidoost, enzovoort). Deze eigenschap is vereist bij het maken van een nieuwe resource.
properties.authOptions

DataPlaneAuthOptions

Hiermee definieert u 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.disableLocalAuth

boolean

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

SearchDisabledDataExfiltrationOption[]

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

EncryptionWithCmk

Hiermee geeft u beleidsregels op met betrekking tot het versleutelen van resources (zoals indexen) met behulp van customer manager-sleutels binnen een zoekservice.
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. Dit is veel hoger dan het maximum aantal indexen dat is toegestaan voor een andere SKU. Voor de standard3-SKU is de waarde 'default' 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

Het aantal partities in de zoekservice; indien opgegeven, kan dit 1, 2, 3, 4, 6 of 12 zijn. Waarden groter 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 wijzigingen in bestaande klantresources en sjablonen te voorkomen. Als deze optie is ingesteld op uitgeschakeld, is verkeer via de openbare interface niet toegestaan en zijn privé-eindpuntverbindingen de exclusieve toegangsmethode.
properties.replicaCount

integer

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

SearchSemanticSearch

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

Sku

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

object

Tags voor het categoriseren van de resource in de Azure Portal.

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 van een Get Service-aanvraag.
Other Status Codes

CloudError

HTTP 400 (ongeldige aanvraag): de opgegeven servicedefinitie is ongeldig of u hebt geprobeerd een eigenschap te wijzigen die onveranderbaar is. Zie de foutcode en het bericht in het antwoord voor meer informatie. HTTP 404 (niet gevonden): het abonnement of de resourcegroep kan niet worden 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

SearchUpdateService
SearchUpdateServiceAuthOptions
SearchUpdateServiceDisableLocalAuth
SearchUpdateServiceToAllowAccessFromPrivateEndpoints
SearchUpdateServiceToAllowAccessFromPublicCustomIPs
SearchUpdateServiceToAllowAccessFromPublicCustomIPsAndBypass
SearchUpdateServiceToRemoveIdentity
SearchUpdateServiceWithCmkEnforcement
SearchUpdateServiceWithDataExfiltration
SearchUpdateServiceWithSemanticSearch

SearchUpdateService

Voorbeeldaanvraag

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
  }
}

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",
    "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

Voorbeeldaanvraag

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"
      }
    }
  }
}

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",
    "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

Voorbeeldaanvraag

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
  }
}

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",
    "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

Voorbeeldaanvraag

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"
  }
}

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",
    "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

Voorbeeldaanvraag

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"
        }
      ]
    }
  }
}

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",
    "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

Voorbeeldaanvraag

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"
    }
  }
}

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",
    "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

Voorbeeldaanvraag

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"
  }
}

Voorbeeldrespons

Statuscode:
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

Voorbeeldaanvraag

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"
    }
  }
}

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",
    "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

Voorbeeldaanvraag

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"
    ]
  }
}

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",
    "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

Voorbeeldaanvraag

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"
  }
}

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",
    "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"
  }
}

Definities

Name Description
AadAuthFailureMode

Hierin wordt beschreven welk antwoord de gegevensvlak-API van een zoekservice verzendt voor aanvragen waarvoor de verificatie is mislukt.
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.
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 de wijze waarop 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. Dit is veel hoger dan het maximum aantal indexen dat is toegestaan voor een andere SKU. Voor de standard3-SKU is de waarde 'default' 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 er geen identiteit is toegewezen aan de zoekservice.
IdentityType

Het type identiteit dat voor de resource wordt gebruikt. Het type 'SystemAssigned, UserAssigned' omvat zowel een identiteit die door het systeem is gemaakt als een set door de gebruiker toegewezen identiteiten. Met het type 'Geen' 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 is uitgevoerd op de zoekservice. Inrichting is een tussenliggende status die optreedt terwijl de servicecapaciteit tot stand wordt gebracht. Nadat de capaciteit is ingesteld, wordt provisioningState gewijzigd in 'succeeded' of 'failed'. Clienttoepassingen kunnen de inrichtingsstatus peilen (het aanbevolen polling-interval is van 30 seconden tot één minuut) door de bewerking Zoekservice ophalen te gebruiken 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 Zoekservice maken. Dit komt doordat de gratis service gebruikmaakt van capaciteit die al is ingesteld.
PublicNetworkAccess

Deze waarde kan worden ingesteld op 'ingeschakeld' om wijzigingen in bestaande klantresources en sjablonen te voorkomen. Als deze optie is ingesteld op uitgeschakeld, is verkeer via de 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'.
SearchDisabledDataExfiltrationOption

Een lijst met scenario's voor gegevensexfiltratie die expliciet niet zijn toegestaan voor de zoekservice. Momenteel is de enige ondersteunde waarde 'Alle' 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 afdwingen is ingeschakeld, wordt de service gemarkeerd als niet-compatibel.
SearchEncryptionWithCmk

Hierin wordt beschreven 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 semantisch zoeken 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: 'actief': de zoekservice wordt uitgevoerd en er worden geen inrichtingsbewerkingen uitgevoerd. 'inrichten': 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. 'disabled': 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 status gedegradeerd, uitgeschakeld of fout heeft, betekent dit dat het Azure AI Search-team het onderliggende probleem actief onderzoekt. Toegewezen services in deze statussen worden nog steeds in rekening gebracht op basis van het aantal ingerichte zoekeenheden.
SearchServiceUpdate

De parameters die worden gebruikt om een Azure AI-Search-service bij te werken.
SharedPrivateLinkResource

Beschrijft een gedeelde privékoppelingsresource die wordt beheerd door de Azure AI-Search-service.
SharedPrivateLinkResourceProperties

Hierin worden de eigenschappen beschreven van een bestaande gedeelde privékoppelingsresource 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

Hiermee definieert u de SKU van een zoekservice, waarmee de factureringssnelheid 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.'
UserAssignedManagedIdentity

De details van de door de gebruiker toegewezen beheerde identiteit die is toegewezen aan de zoekservice.

AadAuthFailureMode

Hierin wordt beschreven welk antwoord de gegevensvlak-API van een zoekservice verzendt voor aanvragen waarvoor de verificatie is mislukt.

Name Type Description
http401WithBearerChallenge

string

Geeft aan dat aanvragen waarvoor de verificatie is mislukt, moeten worden gepresenteerd met de HTTP-statuscode 401 (Niet geautoriseerd) en een Bearer Challenge moeten presenteren.
http403

string

Geeft aan dat aanvragen waarvoor de verificatie is mislukt, moeten worden weergegeven met de HTTP-statuscode 403 (verboden).

ApiKeyOnly

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

CloudError

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 aandukt wat er mis is gegaan (raadpleeg de eigenschap 'error.message' voor meer informatie over foutopsporing).

CloudErrorBody

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 voor het programmatisch afhandelen van specifieke foutgevallen.
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).

DataPlaneAadOrApiKeyAuthOption

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

Hierin wordt beschreven welk antwoord de gegevensvlak-API van een zoekservice verzendt voor aanvragen waarvoor de verificatie is mislukt.

DataPlaneAuthOptions

Definieert de opties voor de wijze waarop 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

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 afdwingen is ingeschakeld, wordt de service gemarkeerd als niet-compatibel.
enforcement

SearchEncryptionWithCmk

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

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. Dit is veel hoger dan het maximum aantal indexen dat is toegestaan voor een andere SKU. Voor de standard3-SKU is de waarde 'default' of 'highDensity'. Voor alle andere SKU's moet deze waarde 'standaard' zijn.

Name Type Description
default

string

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

string

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

Identity

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

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 voor de resource wordt gebruikt. Het type 'SystemAssigned, UserAssigned' omvat zowel een identiteit die door het systeem is gemaakt als een set door de gebruiker toegewezen identiteiten. Met het type 'Geen' worden alle identiteiten uit de service verwijderd.
userAssignedIdentities

<string,  UserAssignedManagedIdentity>

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

IdentityType

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

Name Type Description
None

string

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

string

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

string

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

string

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

IpRule

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

Name Type Description
value

string

De 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) moet worden toegestaan.

NetworkRuleSet

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 netwerken worden gedefinieerd met toegang tot het eindpunt van de zoekservice. In de tussentijd 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 de openbare interface niet toegestaan, zelfs niet met openbare IP-regels en zijn privé-eindpuntverbindingen de exclusieve toegangsmethode.

PrivateEndpoint

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

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

Name Type Description
id

string

Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{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.
type

string

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

PrivateEndpointConnectionProperties

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

De inrichtingsstatus van de private link-serviceverbinding. Geldige waarden zijn Bijwerken, Verwijderen, Mislukt, Geslaagd, Onvolledig of Geannuleerd.

Name Type Description
Canceled

string

De inrichtingsaanvraag voor de privékoppeling-serviceverbindingsresource is geannuleerd.
Deleting

string

De privékoppelingsserviceverbinding wordt momenteel verwijderd.
Failed

string

De privékoppelingsserviceverbinding is niet ingericht of verwijderd.
Incomplete

string

De inrichtingsaanvraag voor de verbindingsresource van de Private Link-service is geaccepteerd, maar het proces van maken is nog niet gestart.
Succeeded

string

De private link-serviceverbinding is klaar met het inrichten en is klaar voor goedkeuring.
Updating

string

De private link-serviceverbinding wordt samen met andere resources gemaakt om deze volledig functioneel te maken.

PrivateLinkServiceConnectionState

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

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

Name Type Description
Approved

string

De privé-eindpuntverbinding is goedgekeurd en is klaar voor gebruik.
Disconnected

string

De privé-eindpuntverbinding is verwijderd uit de service.
Pending

string

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

string

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

ProvisioningState

De status van de laatste inrichtingsbewerking die is uitgevoerd op de zoekservice. Inrichting is een tussenliggende status die optreedt terwijl de servicecapaciteit tot stand wordt gebracht. Nadat de capaciteit is ingesteld, wordt provisioningState gewijzigd in 'succeeded' of 'failed'. Clienttoepassingen kunnen de inrichtingsstatus peilen (het aanbevolen polling-interval is van 30 seconden tot één minuut) door de bewerking Zoekservice ophalen te gebruiken 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 Zoekservice maken. Dit komt doordat de gratis service gebruikmaakt van capaciteit die al is ingesteld.

Name Type Description
failed

string

De laatste inrichtingsbewerking is mislukt.
provisioning

string

De zoekservice wordt ingericht of omhoog of omlaag geschaald.
succeeded

string

De laatste inrichtingsbewerking is voltooid.

PublicNetworkAccess

Deze waarde kan worden ingesteld op 'ingeschakeld' om wijzigingen in bestaande klantresources en sjablonen te voorkomen. Als deze optie is ingesteld op uitgeschakeld, is verkeer via de openbare interface niet toegestaan en zijn privé-eindpuntverbindingen de exclusieve toegangsmethode.

Name Type Description
disabled

string

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

string

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

SearchBypass

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

Name Type Description
AzurePortal

string

Geeft aan dat aanvragen die afkomstig zijn van de Azure Portal de regels kunnen omzeilen die zijn gedefinieerd in de sectie 'ipRules'.
None

string

Geeft aan dat geen enkele origin de regels kan omzeilen die zijn gedefinieerd in de sectie 'ipRules'. Dit is de standaardinstelling.

SearchDisabledDataExfiltrationOption

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

Name Type Description
All

string

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

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 afdwingen is ingeschakeld, wordt de service gemarkeerd als niet-compatibel.

Name Type Description
Compliant

string

Hiermee wordt aangegeven dat de zoekservice compatibel is, omdat het aantal niet-CMK-versleutelde objecten nul is of omdat afdwingen is uitgeschakeld.
NonCompliant

string

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

SearchEncryptionWithCmk

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

Name Type Description
Disabled

string

Er wordt geen door de klant beheerde sleutelversleuteling afgedwongen. Alleen de ingebouwde door de service beheerde versleuteling wordt gebruikt.
Enabled

string

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

string

Afdwingingsbeleid is niet expliciet opgegeven, waarbij het gedrag hetzelfde is als wanneer het is ingesteld op Uitgeschakeld.

SearchSemanticSearch

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

Name Type Description
disabled

string

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

string

Hiermee schakelt u een semantische reranker 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 aantal semantische classificatieaanvragen beperken en wordt gratis aangeboden. Dit is de standaardinstelling voor nieuw ingerichte zoekservices.
standard

string

Hiermee schakelt u een semantische rerankerfunctie in op een zoekservice als factureerbare functie, met een hogere doorvoer en een hogere hoeveelheid semantisch opnieuw gerangschikte query's.

SearchService

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

Name Type Default value Description
id

string

Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{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

Hiermee definieert u 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.disableLocalAuth

boolean

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

SearchDisabledDataExfiltrationOption[]

Een lijst met scenario's voor gegevensexfiltratie die expliciet niet zijn toegestaan voor de zoekservice. Momenteel is de enige ondersteunde waarde 'Alle' om alle mogelijke scenario's voor gegevensexport uit te schakelen met meer verfijnde besturingselementen die voor de toekomst zijn gepland.
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 beleidsregels op met betrekking tot het versleutelen van resources (zoals indexen) met behulp van customer manager-sleutels binnen een zoekservice.
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. Dit is veel hoger dan het maximum aantal indexen dat is toegestaan voor een andere SKU. Voor de standard3-SKU is de waarde 'default' 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

1

Het aantal partities in de zoekservice; indien opgegeven, kan dit 1, 2, 3, 4, 6 of 12 zijn. Waarden groter 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 is uitgevoerd op de zoekservice. Inrichting is een tussenliggende status die optreedt terwijl de servicecapaciteit tot stand wordt gebracht. Nadat de capaciteit is ingesteld, wordt provisioningState gewijzigd in 'succeeded' of 'failed'. Clienttoepassingen kunnen de inrichtingsstatus peilen (het aanbevolen polling-interval is van 30 seconden tot één minuut) door de bewerking Zoekservice ophalen te gebruiken 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 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 wijzigingen in bestaande klantresources en sjablonen te voorkomen. Als deze optie is ingesteld op uitgeschakeld, is verkeer via de openbare interface niet toegestaan en zijn privé-eindpuntverbindingen de exclusieve toegangsmethode.
properties.replicaCount

integer

1

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

SearchSemanticSearch

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

SharedPrivateLinkResource[]

De lijst met gedeelde privékoppelingsresources die worden beheerd door de Azure AI-Search-service.
properties.status

SearchServiceStatus

De status van de zoekservice. Mogelijke waarden zijn: 'actief': de zoekservice wordt uitgevoerd en er worden geen inrichtingsbewerkingen uitgevoerd. 'inrichten': 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. 'disabled': 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 status gedegradeerd, uitgeschakeld of fout heeft, betekent dit dat het Azure AI Search-team het onderliggende probleem actief onderzoekt. Toegewezen services in deze statussen worden nog steeds in rekening gebracht op basis van het aantal ingerichte zoekeenheden.
properties.statusDetails

string

De details van de zoekservicestatus.
sku

Sku

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

object

Resourcetags.
type

string

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

SearchServiceStatus

De status van de zoekservice. Mogelijke waarden zijn: 'actief': de zoekservice wordt uitgevoerd en er worden geen inrichtingsbewerkingen uitgevoerd. 'inrichten': 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. 'disabled': 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 status gedegradeerd, uitgeschakeld of fout heeft, betekent dit dat het Azure AI Search-team het onderliggende probleem actief onderzoekt. Toegewezen services in deze statussen worden nog steeds in rekening gebracht op basis van het aantal ingerichte zoekeenheden.

Name Type Description
degraded

string

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

string

De zoekservice wordt verwijderd.
disabled

string

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

string

De zoekservice heeft een foutstatus, wat aangeeft dat het inrichten of verwijderen is mislukt.
provisioning

string

De zoekservice wordt ingericht of omhoog of omlaag geschaald.
running

string

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

string

De zoekservice bevindt zich in een abonnement dat is uitgeschakeld.

SearchServiceUpdate

De parameters die worden gebruikt om een Azure AI-Search-service bij te werken.

Name Type Default value Description
id

string

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

Identity

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

string

De geografische locatie van de resource. Dit moet een van de ondersteunde en geregistreerde Azure-geografische regio's zijn (bijvoorbeeld VS - west, VS - oost, Azië - zuidoost, enzovoort). Deze eigenschap is vereist bij het maken van een nieuwe resource.
name

string

De naam van de resource
properties.authOptions

DataPlaneAuthOptions

Hiermee definieert u 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.disableLocalAuth

boolean

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

SearchDisabledDataExfiltrationOption[]

Een lijst met scenario's voor gegevensexfiltratie die expliciet niet zijn toegestaan voor de zoekservice. Momenteel is de enige ondersteunde waarde 'Alle' om alle mogelijke scenario's voor gegevensexport uit te schakelen met meer verfijnde besturingselementen die voor de toekomst zijn gepland.
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 beleidsregels op met betrekking tot het versleutelen van resources (zoals indexen) met behulp van customer manager-sleutels binnen een zoekservice.
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. Dit is veel hoger dan het maximum aantal indexen dat is toegestaan voor een andere SKU. Voor de standard3-SKU is de waarde 'default' 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

1

Het aantal partities in de zoekservice; indien opgegeven, kan dit 1, 2, 3, 4, 6 of 12 zijn. Waarden groter 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 is uitgevoerd op de zoekservice. Inrichting is een tussenliggende status die optreedt terwijl de servicecapaciteit tot stand wordt gebracht. Nadat de capaciteit is ingesteld, wordt provisioningState gewijzigd in 'succeeded' of 'failed'. Clienttoepassingen kunnen de inrichtingsstatus peilen (het aanbevolen polling-interval is van 30 seconden tot één minuut) door de bewerking Zoekservice ophalen te gebruiken 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 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 wijzigingen in bestaande klantresources en sjablonen te voorkomen. Als deze optie is ingesteld op uitgeschakeld, is verkeer via de openbare interface niet toegestaan en zijn privé-eindpuntverbindingen de exclusieve toegangsmethode.
properties.replicaCount

integer

1

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

SearchSemanticSearch

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

SharedPrivateLinkResource[]

De lijst met gedeelde privékoppelingsresources die worden beheerd door de Azure AI-Search-service.
properties.status

SearchServiceStatus

De status van de zoekservice. Mogelijke waarden zijn: 'actief': de zoekservice wordt uitgevoerd en er worden geen inrichtingsbewerkingen uitgevoerd. 'inrichten': 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. 'disabled': 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 status gedegradeerd, uitgeschakeld of fout heeft, betekent dit dat het Azure AI Search-team het onderliggende probleem actief onderzoekt. Toegewezen services in deze statussen worden nog steeds in rekening gebracht op basis van het aantal ingerichte zoekeenheden.
properties.statusDetails

string

De details van de zoekservicestatus.
sku

Sku

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

object

Tags voor het categoriseren van de resource in de Azure Portal.
type

string

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

SharedPrivateLinkResource

Beschrijft een gedeelde privékoppelingsresource die wordt beheerd door de Azure AI-Search-service.

Name Type Description
id

string

Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{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.
type

string

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

SharedPrivateLinkResourceProperties

Hierin worden de eigenschappen beschreven van een bestaande gedeelde privékoppelingsresource 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 shared 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 privékoppelingsresource.
resourceRegion

string

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

De inrichtingsstatus van de gedeelde Private Link-resource. Geldige waarden zijn Bijwerken, Verwijderen, Mislukt, Geslaagd of Onvolledig.

Name Type Description
Deleting

string

De gedeelde privékoppelingsresource wordt verwijderd.
Failed

string

De gedeelde Private Link-resource is niet ingericht of verwijderd.
Incomplete

string

Inrichtingsaanvraag voor de gedeelde Private Link-resource is geaccepteerd, maar het proces van maken is nog niet gestart.
Succeeded

string

De gedeelde Private Link-resource is klaar met inrichten en is klaar voor goedkeuring.
Updating

string

De gedeelde Private Link-resource wordt samen met andere resources gemaakt om deze volledig functioneel te maken.

SharedPrivateLinkResourceStatus

Status van de gedeelde Private Link-resource. Geldige waarden zijn In behandeling, Goedgekeurd, Geweigerd of Verbroken.

Name Type Description
Approved

string

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

string

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

string

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

string

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

Sku

Hiermee definieert u de SKU van een zoekservice, waarmee de factureringssnelheid 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

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

Name Type Description
basic

string

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

string

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

string

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

string

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

string

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

string

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

string

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

UserAssignedManagedIdentity

De details van de door de gebruiker toegewezen beheerde identiteit die is toegewezen aan de zoekservice.

Name Type Description
clientId

string

De client-id van de door de gebruiker toegewezen identiteit.
principalId

string

De principal-id van de door de gebruiker toegewezen identiteit.