Services - Get
Hiermee haalt u de zoekservice op met de opgegeven naam in de opgegeven resourcegroep.
GET 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 |
---|---|---|---|---|
resource
|
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. |
search
|
path | True |
string pattern: ^(?=.{2,60}$)[a-z0-9][a-z0-9]+(-[a-z0-9]+)*$ |
De naam van de Azure AI Search-service die is gekoppeld aan de opgegeven resourcegroep. |
subscription
|
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. |
Antwoorden
Name | Type | Description |
---|---|---|
200 OK |
De definitie van de zoekservice is opgehaald en staat in het antwoord. Als u zoekt naar de voltooiing van een inrichtings- of schaalbewerking, kunt u de status ervan controleren via de eigenschap provisioningState. |
|
Other Status Codes |
HTTP 404 (niet gevonden): de naam van het abonnement, de resourcegroep of de zoekservice is niet gevonden. |
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
SearchGetService
Voorbeeldaanvraag
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2024-03-01-preview
Voorbeeldrespons
{
"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,
"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": []
}
}
Definities
Name | Description |
---|---|
Aad |
Beschrijft welke reactie de gegevensvlak-API van een zoekservice zou verzenden naar aanvragen die mislukte verificatie hebben. |
Api |
Geeft aan dat alleen de API-sleutel kan worden gebruikt voor verificatie. |
Cloud |
Bevat informatie over een API-fout. |
Cloud |
Beschrijft een bepaalde API-fout met een foutcode en een bericht. |
Data |
Geeft aan dat de API-sleutel of een toegangstoken van een Microsoft Entra ID-tenant kan worden gebruikt voor verificatie. |
Data |
Definieert de opties voor hoe de zoekservice een aanvraag voor een gegevensvlak verifieert. Dit kan niet worden ingesteld als 'disableLocalAuth' is ingesteld op true. |
Encryption |
Beschrijft een beleid dat bepaalt hoe resources binnen de zoekservice moeten worden versleuteld met door de klant beheerde sleutels. |
Hosting |
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. |
Identity |
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. |
Ip |
De IP-beperkingsregel van de Azure AI Search-service. |
Network |
Netwerkspecifieke regels die bepalen hoe de Azure AI Search-service kan worden bereikt. |
Private |
De privé-eindpuntresource van de Microsoft.Network-provider. |
Private |
Beschrijft een bestaande privé-eindpuntverbinding met de Azure AI Search-service. |
Private |
Beschrijft de eigenschappen van een bestaande privé-eindpuntverbinding met de zoekservice. |
Private |
De inrichtingsstatus van de private link-serviceverbinding. Geldige waarden zijn bijwerken, verwijderen, mislukt, geslaagd, onvolledig of geannuleerd. |
Private |
Beschrijft de huidige status van een bestaande Azure Private Link-serviceverbinding met het privé-eindpunt. |
Private |
Status van de private link-serviceverbinding. Geldige waarden zijn In behandeling, Goedgekeurd, Geweigerd of Verbroken. |
Provisioning |
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, verandert provisioningState in 'succeeded' of 'failed'. 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. |
Public |
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. |
Search |
Mogelijke oorsprongen van binnenkomend verkeer dat de regels kan omzeilen die zijn gedefinieerd in de sectie ipRules. |
Search |
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. |
Search |
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. |
Search |
Beschrijft hoe een zoekservice naleving moet afdwingen als er objecten worden gevonden die niet zijn versleuteld met de door de klant beheerde sleutel. |
Search |
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. |
Search |
Beschrijft een Azure AI Search-service en de huidige status. |
Search |
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. |
Shared |
Beschrijft een gedeelde private link-resource die wordt beheerd door de Azure AI Search-service. |
Shared |
Beschrijft de eigenschappen van een bestaande gedeelde private link-resource die wordt beheerd door de Azure AI Search-service. |
Shared |
De inrichtingsstatus van de gedeelde private link-resource. Geldige waarden zijn bijwerken, verwijderen, mislukt, geslaagd of onvolledig. |
Shared |
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. |
Sku |
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.' |
User |
De details van de door de gebruiker toegewezen beheerde identiteit die is toegewezen aan de zoekservice. |
AadAuthFailureMode
Beschrijft welke reactie de gegevensvlak-API van een zoekservice zou verzenden naar aanvragen die mislukte verificatie hebben.
Waarde | Description |
---|---|
http401WithBearerChallenge |
Geeft aan dat aanvragen die mislukte verificatie moeten worden weergegeven met een HTTP-statuscode van 401 (niet geautoriseerd) en een Bearer-uitdaging presenteren. |
http403 |
Geeft aan dat aanvragen die mislukte verificatie moeten worden weergegeven met een HTTP-statuscode van 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 |
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
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 |
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 |
Beschrijft welke reactie de gegevensvlak-API van een zoekservice zou verzenden naar aanvragen die mislukte verificatie hebben. |
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.
Name | Type | Description |
---|---|---|
aadOrApiKey |
Geeft aan dat de API-sleutel of een toegangstoken van een Microsoft Entra ID-tenant kan worden gebruikt voor verificatie. |
|
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 |
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 |
Beschrijft 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, 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
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 |
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,
User |
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
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. |
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. |
UserAssigned |
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 |
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
Netwerkspecifieke regels die bepalen hoe de Azure AI Search-service kan worden bereikt.
Name | Type | Description |
---|---|---|
bypass |
Mogelijke oorsprongen van binnenkomend verkeer dat de regels kan omzeilen die zijn gedefinieerd in de sectie ipRules. |
|
ipRules |
Ip |
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
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 |
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 |
De privé-eindpuntresource van de Microsoft.Network-provider. |
|
privateLinkServiceConnectionState |
Beschrijft de huidige status van een bestaande Azure Private Link-serviceverbinding met het privé-eindpunt. |
|
provisioningState |
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.
Waarde | Description |
---|---|
Canceled |
De inrichtingsaanvraag voor de private link-serviceverbindingsresource is geannuleerd. |
Deleting |
De private link-serviceverbinding wordt verwijderd. |
Failed |
De private link-serviceverbinding kan niet worden ingericht of verwijderd. |
Incomplete |
De inrichtingsaanvraag voor de private link-serviceverbindingsresource is geaccepteerd, maar het proces van maken is nog niet gestart. |
Succeeded |
De private link-serviceverbinding is ingericht en is gereed voor goedkeuring. |
Updating |
De private link-serviceverbinding wordt in het proces gemaakt, samen met andere resources, zodat deze volledig functioneel is. |
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 |
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.
Waarde | Description |
---|---|
Approved |
De verbinding met het privé-eindpunt is goedgekeurd en kan worden gebruikt. |
Disconnected |
De privé-eindpuntverbinding is verwijderd uit de service. |
Pending |
De privé-eindpuntverbinding is gemaakt en wacht op goedkeuring. |
Rejected |
De privé-eindpuntverbinding is geweigerd en kan niet worden gebruikt. |
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, verandert provisioningState in 'succeeded' of 'failed'. 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 |
---|---|
failed |
De laatste inrichtingsbewerking is mislukt. |
provisioning |
De zoekservice wordt ingericht of omhoog of omlaag geschaald. |
succeeded |
De laatste inrichtingsbewerking is voltooid. |
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.
Waarde | Description |
---|---|
disabled |
De zoekservice is niet toegankelijk vanuit verkeer dat afkomstig is van het openbare internet. Toegang is alleen toegestaan via goedgekeurde privé-eindpuntverbindingen. |
enabled |
De zoekservice is toegankelijk vanuit 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.
Waarde | Description |
---|---|
AzurePortal |
Geeft aan dat aanvragen die afkomstig zijn van Azure Portal, de regels kunnen omzeilen die zijn gedefinieerd in de sectie ipRules. |
None |
Hiermee wordt aangegeven dat geen oorsprong de regels kan omzeilen die zijn gedefinieerd in de sectie ipRules. Dit is de standaardwaarde. |
SearchDisabledDataExfiltrationOption
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 |
---|---|
All |
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 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
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
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
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 |
De identiteit van de resource. |
||
location |
string |
De geografische locatie waar de resource zich bevindt |
|
name |
string |
De naam van de resource |
|
properties.authOptions |
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.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.disabledDataExfiltrationOptions |
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.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 |
Hiermee geeft u een beleid met betrekking tot de versleuteling van resources (zoals indexen) met behulp van customer manager-sleutels binnen een zoekservice. |
||
properties.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 |
Netwerkspecifieke regels die bepalen hoe de Azure AI Search-service kan worden bereikt. |
||
properties.partitionCount |
integer (int32) minimum: 1maximum: 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 |
De lijst met privé-eindpuntverbindingen met de Azure AI Search-service. |
||
properties.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, verandert provisioningState in 'succeeded' of 'failed'. 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 | 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: 1maximum: 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 |
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.sharedPrivateLinkResources |
De lijst met gedeelde private link-resources die worden beheerd door de Azure AI Search-service. |
||
properties.status |
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. |
|
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. |
|
type |
string |
Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts' |
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.
Waarde | Description |
---|---|
degraded |
De zoekservice is gedegradeerd omdat onderliggende zoekeenheden niet in orde zijn. |
deleting |
De zoekservice wordt verwijderd. |
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. |
provisioning |
De zoekservice wordt ingericht of omhoog of omlaag geschaald. |
running |
De zoekservice wordt uitgevoerd en er worden geen inrichtingsbewerkingen uitgevoerd. |
stopped |
De zoekservice bevindt zich in een abonnement dat is uitgeschakeld. |
SharedPrivateLinkResource
Beschrijft een gedeelde private link-resource 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 |
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
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 |
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 |
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.
Waarde | Description |
---|---|
Deleting |
De gedeelde private link-resource wordt verwijderd. |
Failed |
De gedeelde private link-resource kan niet worden ingericht of verwijderd. |
Incomplete |
De inrichtingsaanvraag voor de gedeelde private link-resource is geaccepteerd, maar het maken is nog niet gestart. |
Succeeded |
De gedeelde private link-resource is ingericht en is gereed voor goedkeuring. |
Updating |
De gedeelde private link-resource wordt samen met andere resources gemaakt, zodat deze volledig functioneel is. |
SharedPrivateLinkResourceStatus
Status van de gedeelde private link-resource. Geldige waarden zijn in behandeling, goedgekeurd, geweigerd of verbroken.
Waarde | Description |
---|---|
Approved |
De gedeelde private link-resource is goedgekeurd en is klaar voor gebruik. |
Disconnected |
De gedeelde private link-resource is verwijderd uit de service. |
Pending |
De gedeelde private link-resource is gemaakt en wacht op goedkeuring. |
Rejected |
De gedeelde private link-resource is geweigerd en kan niet worden gebruikt. |
Sku
Definieert de SKU van een zoekservice, waarmee de factureringsfrequentie en capaciteitslimieten worden bepaald.
Name | Type | Description |
---|---|---|
name |
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.'
Waarde | Description |
---|---|
basic |
Factureerbare laag voor een toegewezen service met maximaal 3 replica's. |
free |
Gratis laag, zonder SLA-garanties en een subset van de functies die worden aangeboden voor factureerbare lagen. |
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. |
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. |