Microsoft.Search searchServices
Bicep-resourcedefinitie
Het resourcetype searchServices kan worden geïmplementeerd met bewerkingen die zijn gericht op:
- Resourcegroepen - Zie opdrachten voor resourcegroepimplementatie
Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.
Resource-indeling
Als u een Microsoft.Search/searchServices-resource wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.
resource symbolicname 'Microsoft.Search/searchServices@2023-11-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
sku: {
name: 'string'
}
identity: {
type: 'string'
}
properties: {
authOptions: {
aadOrApiKey: {
aadAuthFailureMode: 'string'
}
apiKeyOnly: any()
}
disableLocalAuth: bool
encryptionWithCmk: {
enforcement: 'string'
}
hostingMode: 'string'
networkRuleSet: {
ipRules: [
{
value: 'string'
}
]
}
partitionCount: int
publicNetworkAccess: 'string'
replicaCount: int
semanticSearch: 'string'
}
}
Eigenschapswaarden
searchServices
| Naam | Description | Waarde |
|---|---|---|
| naam | De resourcenaam | tekenreeks (vereist) |
| location | De geografische locatie waar de resource zich bevindt | tekenreeks (vereist) |
| tags | Resourcetags. | Woordenlijst met tagnamen en -waarden. Tags in sjablonen bekijken |
| sku | De SKU van de zoekservice, die de factureringssnelheid en capaciteitslimieten bepaalt. Deze eigenschap is vereist bij het maken van een nieuwe zoekservice. | SKU |
| identity | De identiteit van de resource. | Identiteit |
| properties | Eigenschappen van de zoekservice. | SearchServiceProperties |
Identiteit
| Naam | Description | Waarde |
|---|---|---|
| type | Het identiteitstype. | 'Geen' 'SystemAssigned' (vereist) |
SearchServiceProperties
| Naam | Description | Waarde |
|---|---|---|
| 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. | DataPlaneAuthOptions |
| disableLocalAuth | 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. | booleaans |
| encryptionWithCmk | Hiermee geeft u elk beleid met betrekking tot het versleutelen van resources (zoals indexen) met behulp van klantmanagersleutels binnen een zoekservice. | EncryptionWithCmk |
| 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 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. | 'default' 'highDensity' |
| networkRuleSet | Netwerkspecifieke regels die bepalen hoe de zoekservice kan worden bereikt. | NetworkRuleSet |
| partitionCount | 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. | int Beperkingen: Minimumwaarde = 1 Maximumwaarde = 12 |
| publicNetworkAccess | Deze waarde kan worden ingesteld op 'ingeschakeld' om te voorkomen dat wijzigingen in bestaande klantresources en sjablonen fouten veroorzaken. Als deze optie is ingesteld op uitgeschakeld, is verkeer via de openbare interface niet toegestaan en zijn privé-eindpuntverbindingen de exclusieve toegangsmethode. | 'uitgeschakeld' 'ingeschakeld' |
| replicaCount | 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 de Basis-SKU. | int Beperkingen: Minimumwaarde = 1 Maximumwaarde = 12 |
| semanticSearch | Hiermee stelt u opties in die de beschikbaarheid van semantisch zoeken bepalen. Deze configuratie is alleen mogelijk voor bepaalde zoek-SKU's op bepaalde locaties. | 'uitgeschakeld' 'gratis' 'standaard' |
DataPlaneAuthOptions
| Naam | Description | Waarde |
|---|---|---|
| aadOrApiKey | Geeft aan dat de API-sleutel of een toegangstoken van een Microsoft Entra ID tenant kan worden gebruikt voor verificatie. | DataPlaneAadOrApiKeyAuthOption |
| apiKeyOnly | Geeft aan dat alleen de API-sleutel kan worden gebruikt voor verificatie. | Voor Bicep kunt u de functie any() gebruiken. |
DataPlaneAadOrApiKeyAuthOption
| Naam | Description | Waarde |
|---|---|---|
| aadAuthFailureMode | Hierin wordt beschreven welk antwoord de gegevensvlak-API van een zoekservice verzendt voor aanvragen waarvoor de verificatie is mislukt. | 'http401WithBearerChallenge' 'http403' |
EncryptionWithCmk
| Naam | Description | Waarde |
|---|---|---|
| Handhaving | Hierin wordt beschreven hoe een zoekservice het gebruik van een of meer niet door de klant versleutelde resources moet afdwingen. | 'Uitgeschakeld' Ingeschakeld 'Niet opgegeven' |
NetworkRuleSet
| Naam | Description | Waarde |
|---|---|---|
| ipRules | Een lijst met IP-beperkingsregels die worden gebruikt voor een IP-firewall. IP-adressen die niet overeenkomen met de regels, worden geblokkeerd door de firewall. Deze regels worden alleen toegepast wanneer de 'publicNetworkAccess' van de zoekservice 'ingeschakeld' is. | IpRule[] |
IpRule
| Naam | Description | Waarde |
|---|---|---|
| waarde | 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) dat moet worden toegestaan. | tekenreeks |
Sku
| Naam | Description | Waarde |
|---|---|---|
| naam | 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.' | 'basic' 'gratis' 'standaard' 'standard2' 'standard3' 'storage_optimized_l1' 'storage_optimized_l2' |
Snelstartsjablonen
Met de volgende snelstartsjablonen wordt dit resourcetype geïmplementeerd.
| Template | Beschrijving |
|---|---|
Web-app met een SQL Database, Azure Cosmos DB, Azure Search |
Met deze sjabloon richt u een web-app, een SQL Database, Azure Cosmos DB, Azure Search en Application Insights in. |
| Azure Cognitive Search service |
Met deze sjabloon wordt een Azure Cognitive Search-service gemaakt |
| Azure Cognitive Search service met privé-eindpunt |
Met deze sjabloon maakt u een Azure Cognitive Search service met een privé-eindpunt. |
Resourcedefinitie van ARM-sjabloon
Het resourcetype searchServices kan worden geïmplementeerd met bewerkingen die zijn gericht op:
- Resourcegroepen - Zie opdrachten voor resourcegroepimplementatie
Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.
Resource-indeling
Als u een Microsoft.Search/searchServices-resource wilt maken, voegt u de volgende JSON toe aan uw sjabloon.
{
"type": "Microsoft.Search/searchServices",
"apiVersion": "2023-11-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"sku": {
"name": "string"
},
"identity": {
"type": "string"
},
"properties": {
"authOptions": {
"aadOrApiKey": {
"aadAuthFailureMode": "string"
},
"apiKeyOnly": {}
},
"disableLocalAuth": "bool",
"encryptionWithCmk": {
"enforcement": "string"
},
"hostingMode": "string",
"networkRuleSet": {
"ipRules": [
{
"value": "string"
}
]
},
"partitionCount": "int",
"publicNetworkAccess": "string",
"replicaCount": "int",
"semanticSearch": "string"
}
}
Eigenschapswaarden
searchServices
| Naam | Description | Waarde |
|---|---|---|
| type | Het resourcetype | 'Microsoft.Search/searchServices' |
| apiVersion | De resource-API-versie | '2023-11-01' |
| naam | De resourcenaam | tekenreeks (vereist) |
| location | De geografische locatie waar de resource zich bevindt | tekenreeks (vereist) |
| tags | Resourcetags. | Woordenlijst met tagnamen en -waarden. Tags in sjablonen bekijken |
| sku | De SKU van de zoekservice, die de factureringssnelheid en capaciteitslimieten bepaalt. Deze eigenschap is vereist bij het maken van een nieuwe zoekservice. | SKU |
| identity | De identiteit van de resource. | Identiteit |
| properties | Eigenschappen van de zoekservice. | SearchServiceProperties |
Identiteit
| Naam | Description | Waarde |
|---|---|---|
| type | Het identiteitstype. | 'Geen' 'SystemAssigned' (vereist) |
SearchServiceProperties
| Naam | Description | Waarde |
|---|---|---|
| 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. | DataPlaneAuthOptions |
| disableLocalAuth | 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. | booleaans |
| encryptionWithCmk | Hiermee geeft u elk beleid met betrekking tot het versleutelen van resources (zoals indexen) met behulp van klantmanagersleutels binnen een zoekservice. | EncryptionWithCmk |
| 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 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. | 'default' 'highDensity' |
| networkRuleSet | Netwerkspecifieke regels die bepalen hoe de zoekservice kan worden bereikt. | NetworkRuleSet |
| partitionCount | 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. | int Beperkingen: Minimumwaarde = 1 Maximumwaarde = 12 |
| publicNetworkAccess | Deze waarde kan worden ingesteld op 'ingeschakeld' om te voorkomen dat wijzigingen in bestaande klantresources en sjablonen fouten veroorzaken. Als deze optie is ingesteld op uitgeschakeld, is verkeer via de openbare interface niet toegestaan en zijn privé-eindpuntverbindingen de exclusieve toegangsmethode. | 'uitgeschakeld' 'ingeschakeld' |
| replicaCount | 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 de Basis-SKU. | int Beperkingen: Minimumwaarde = 1 Maximumwaarde = 12 |
| semanticSearch | Hiermee stelt u opties in die de beschikbaarheid van semantisch zoeken bepalen. Deze configuratie is alleen mogelijk voor bepaalde zoek-SKU's op bepaalde locaties. | 'uitgeschakeld' 'gratis' 'standaard' |
DataPlaneAuthOptions
| Naam | Description | Waarde |
|---|---|---|
| aadOrApiKey | Geeft aan dat de API-sleutel of een toegangstoken van een Microsoft Entra ID tenant kan worden gebruikt voor verificatie. | DataPlaneAadOrApiKeyAuthOption |
| apiKeyOnly | Geeft aan dat alleen de API-sleutel kan worden gebruikt voor verificatie. |
DataPlaneAadOrApiKeyAuthOption
| Naam | Description | Waarde |
|---|---|---|
| aadAuthFailureMode | Beschrijft welk antwoord de gegevensvlak-API van een zoekservice verzendt voor aanvragen waarvoor de verificatie is mislukt. | 'http401WithBearerChallenge' 'http403' |
EncryptionWithCmk
| Naam | Description | Waarde |
|---|---|---|
| Handhaving | Hierin wordt beschreven hoe een zoekservice het gebruik van een of meer niet door de klant versleutelde resources moet afdwingen. | 'Uitgeschakeld' Ingeschakeld 'Niet opgegeven' |
NetworkRuleSet
| Naam | Description | Waarde |
|---|---|---|
| ipRules | Een lijst met IP-beperkingsregels die worden gebruikt voor een IP-firewall. IP-adressen die niet overeenkomen met de regels, worden geblokkeerd door de firewall. Deze regels worden alleen toegepast wanneer de 'publicNetworkAccess' van de zoekservice 'ingeschakeld' is. | IpRule[] |
IpRule
| Naam | Description | Waarde |
|---|---|---|
| waarde | 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) dat moet worden toegestaan. | tekenreeks |
Sku
| Naam | Description | Waarde |
|---|---|---|
| naam | 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.' | 'basic' 'gratis' 'standaard' 'standard2' 'standard3' 'storage_optimized_l1' 'storage_optimized_l2' |
Snelstartsjablonen
Met de volgende snelstartsjablonen wordt dit resourcetype geïmplementeerd.
| Template | Beschrijving |
|---|---|
| Web-app met een SQL Database, Azure Cosmos DB, Azure Search |
Met deze sjabloon richt u een web-app, een SQL Database, Azure Cosmos DB, Azure Search en Application Insights in. |
| Azure Cognitive Search service |
Met deze sjabloon wordt een Azure Cognitive Search-service gemaakt |
| Azure Cognitive Search service met privé-eindpunt |
Met deze sjabloon maakt u een Azure Cognitive Search service met een privé-eindpunt. |
Terraform-resourcedefinitie (AzAPI-provider)
Het resourcetype searchServices kan worden geïmplementeerd met bewerkingen die zijn gericht op:
- Resourcegroepen
Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.
Resource-indeling
Als u een Microsoft.Search/searchServices-resource wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Search/searchServices@2023-11-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "SystemAssigned"
}
body = jsonencode({
properties = {
authOptions = {
aadOrApiKey = {
aadAuthFailureMode = "string"
}
}
disableLocalAuth = bool
encryptionWithCmk = {
enforcement = "string"
}
hostingMode = "string"
networkRuleSet = {
ipRules = [
{
value = "string"
}
]
}
partitionCount = int
publicNetworkAccess = "string"
replicaCount = int
semanticSearch = "string"
}
sku = {
name = "string"
}
})
}
Eigenschapswaarden
searchServices
| Naam | Description | Waarde |
|---|---|---|
| type | Het resourcetype | "Microsoft.Search/searchServices@2023-11-01" |
| naam | De resourcenaam | tekenreeks (vereist) |
| location | De geografische locatie waar de resource zich bevindt | tekenreeks (vereist) |
| parent_id | Als u wilt implementeren in een resourcegroep, gebruikt u de id van die resourcegroep. | tekenreeks (vereist) |
| tags | Resourcetags. | Woordenlijst met tagnamen en -waarden. |
| sku | De SKU van de zoekservice, die de factureringssnelheid en capaciteitslimieten bepaalt. Deze eigenschap is vereist bij het maken van een nieuwe zoekservice. | SKU |
| identity | De identiteit van de resource. | Identiteit |
| properties | Eigenschappen van de zoekservice. | SearchServiceProperties |
Identiteit
| Naam | Description | Waarde |
|---|---|---|
| type | Het identiteitstype. | "SystemAssigned" (vereist) |
SearchServiceProperties
| Naam | Description | Waarde |
|---|---|---|
| authOptions | 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. | DataPlaneAuthOptions |
| disableLocalAuth | 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. | booleaans |
| encryptionWithCmk | Hiermee geeft u beleidsregels op met betrekking tot het versleutelen van resources (zoals indexen) met behulp van customer manager-sleutels binnen een zoekservice. | EncryptionWithCmk |
| 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. | "standaard" "highDensity" |
| networkRuleSet | Netwerkspecifieke regels die bepalen hoe de zoekservice kan worden bereikt. | NetworkRuleSet |
| partitionCount | 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. | int Beperkingen: Minimumwaarde = 1 Maximale waarde = 12 |
| 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. | "uitgeschakeld" "ingeschakeld" |
| replicaCount | 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. | int Beperkingen: Minimumwaarde = 1 Maximale waarde = 12 |
| semanticSearch | Hiermee stelt u opties in waarmee de beschikbaarheid van semantisch zoeken wordt ingesteld. Deze configuratie is alleen mogelijk voor bepaalde zoek-SKU's op bepaalde locaties. | "uitgeschakeld" "gratis" "standaard" |
DataPlaneAuthOptions
| Naam | Description | Waarde |
|---|---|---|
| aadOrApiKey | Geeft aan dat de API-sleutel of een toegangstoken van een Microsoft Entra ID tenant kan worden gebruikt voor verificatie. | DataPlaneAadOrApiKeyAuthOption |
| apiKeyOnly | Geeft aan dat alleen de API-sleutel kan worden gebruikt voor verificatie. |
DataPlaneAadOrApiKeyAuthOption
| Naam | Description | Waarde |
|---|---|---|
| aadAuthFailureMode | Hierin wordt beschreven welk antwoord de gegevensvlak-API van een zoekservice verzendt voor aanvragen waarvoor de verificatie is mislukt. | "http401WithBearerChallenge" "http403" |
EncryptionWithCmk
| Naam | Description | Waarde |
|---|---|---|
| Handhaving | Hierin wordt beschreven hoe een zoekservice het gebruik van een of meer niet door de klant versleutelde resources moet afdwingen. | "Uitgeschakeld" "Ingeschakeld" "Niet opgegeven" |
NetworkRuleSet
| Naam | Description | Waarde |
|---|---|---|
| ipRules | Een lijst met IP-beperkingsregels die worden gebruikt voor een IP-firewall. IP-adressen die niet overeenkomen met de regels, worden geblokkeerd door de firewall. Deze regels worden alleen toegepast wanneer de 'publicNetworkAccess' van de zoekservice 'ingeschakeld' is. | IpRule[] |
IpRule
| Naam | Description | Waarde |
|---|---|---|
| waarde | 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) dat moet worden toegestaan. | tekenreeks |
Sku
| Naam | Description | Waarde |
|---|---|---|
| naam | 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.' | "basic" "gratis" "standaard" "standard2" "standard3" "storage_optimized_l1" "storage_optimized_l2" |
Feedback
Binnenkort beschikbaar: In de loop van 2024 zullen we GitHub Issues geleidelijk uitfaseren als het feedbackmechanisme voor inhoud. Het wordt vervangen door een nieuw feedbacksysteem. Zie voor meer informatie: https://aka.ms/ContentUserFeedback.
Feedback verzenden en weergeven voor