Microsoft. Search searchServices 2022-09-01
Definizione di risorsa Bicep
Il tipo di risorsa searchServices può essere distribuito con operazioni destinate a:
- Gruppi di risorse - Vedere i comandi di distribuzione dei gruppi di risorse
Per un elenco delle proprietà modificate in ogni versione dell'API, vedere Log delle modifiche.
Formato di risorsa
Per creare un microsoft. Search/searchServices risorsa aggiungere il bicep seguente al modello.
resource symbolicname 'Microsoft.Search/searchServices@2022-09-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
}
}
Valori delle proprietà
searchServices
| Nome | Descrizione | valore |
|---|---|---|
| name | Nome della risorsa | stringa (obbligatorio) |
| posizione | Posizione geografica in cui risiede la risorsa | stringa (obbligatorio) |
| tags | Tag delle risorse. | Dizionario di nomi e valori di tag. Vedere Tag nei modelli |
| sku | SKU del servizio Search, che determina i limiti di livello prezzo e capacità. Questa proprietà è necessaria quando si crea un nuovo servizio di Search. | Sku |
| identity | Identità della risorsa. | Identità |
| properties | Proprietà del servizio di ricerca. | SearchServiceProperties |
Identità
| Nome | Descrizione | Valore |
|---|---|---|
| tipo | Tipo di identità. | 'Nessuno' 'SystemAssigned' (obbligatorio) |
SearchServiceProperties
| Nome | Descrizione | Valore |
|---|---|---|
| authOptions | Definisce le opzioni per il modo in cui l'API del piano dati di un servizio di ricerca autentica le richieste. Questa impostazione non può essere impostata se 'disableLocalAuth' è impostato su true. | DataPlaneAuthOptions |
| disableLocalAuth | Se impostato su true, le chiamate al servizio di ricerca non saranno autorizzate a usare le chiavi API per l'autenticazione. Questa impostazione non può essere impostata su true se sono definiti "dataPlaneAuthOptions". | bool |
| encryptionWithCmk | Specifica i criteri relativi alla crittografia delle risorse (ad esempio gli indici) usando le chiavi del customer manager all'interno di un servizio di ricerca. | EncryptionWithCmk |
| hostingMode | Applicabile solo per lo SKU Standard3. È possibile impostare questa proprietà per abilitare fino a 3 partizioni ad alta densità che consentono fino a 1000 indici, che sono molto più elevati rispetto agli indici massimi consentiti per qualsiasi altro SKU. Per lo SKU standard3, il valore è "default" o "highDensity". Per tutti gli altri SKU, questo valore deve essere 'default'. | 'default' 'highDensity' |
| networkRuleSet | Regole specifiche della rete che determinano la modalità di raggiungimento del servizio Ricerca cognitiva di Azure. | NetworkRuleSet |
| partitionCount | Numero di partizioni nel servizio di ricerca; se specificato, può essere 1, 2, 3, 4, 6 o 12. I valori maggiori di 1 sono validi solo per gli SKU standard. Per i servizi 'standard3' con hostingMode impostato su 'highDensity', i valori consentiti sono compresi tra 1 e 3. | INT Vincoli: Valore minimo = 1 Valore massimo = 12 |
| publicNetworkAccess | Questo valore può essere impostato su "abilitato" per evitare modifiche di rilievo nelle risorse e nei modelli dei clienti esistenti. Se impostato su "disabilitato", il traffico sull'interfaccia pubblica non è consentito e le connessioni endpoint private saranno il metodo di accesso esclusivo. | 'disabled' 'enabled' |
| replicaCount | Numero di repliche nel servizio di ricerca. Se specificato, deve essere un valore compreso tra 1 e 12 inclusi per GLI SKU standard o compreso tra 1 e 3 inclusi per lo SKU basic. | INT Vincoli: Valore minimo = 1 Valore massimo = 12 |
DataPlaneAuthOptions
| Nome | Descrizione | Valore |
|---|---|---|
| aadOrApiKey | Indica che la chiave API o un token di accesso da Azure Active Directory può essere usata per l'autenticazione. | DataPlaneAadOrApiKeyAuthOption |
| apiKeyOnly | Indica che solo la chiave API deve essere usata per l'autenticazione. | Per Bicep è possibile usare la funzione any(). |
DataPlaneAadOrApiKeyAuthOption
| Nome | Descrizione | Valore |
|---|---|---|
| aadAuthFailureMode | Descrive la risposta che l'API del piano dati di un servizio di ricerca invia per le richieste che non sono riuscite nell'autenticazione. | 'http401WithBearerChallenge' 'http403' |
EncryptionWithCmk
| Nome | Descrizione | Valore |
|---|---|---|
| rinforzo | Descrive il modo in cui un servizio di ricerca deve applicare una o più risorse crittografate dal cliente. | 'Disabilitato' 'Enabled' 'Non specificato' |
NetworkRuleSet
| Nome | Descrizione | Valore |
|---|---|---|
| ipRules | Elenco delle regole di restrizione IP che definisce le reti in ingresso con la possibilità di accedere all'endpoint del servizio di ricerca. Nel frattempo, tutte le altre reti IP pubbliche vengono bloccate dal firewall. Queste regole di restrizione vengono applicate solo quando il 'publicNetworkAccess' del servizio di ricerca è 'abilitato'; in caso contrario, il traffico sull'interfaccia pubblica non è consentito anche con le regole IP pubbliche e le connessioni endpoint private sarebbero il metodo di accesso esclusivo. | IpRule[] |
IpRule
| Nome | Descrizione | Valore |
|---|---|---|
| Valore | Valore corrispondente a un singolo indirizzo IPv4 (ad esempio, 123.1.2.3) o un intervallo IP in formato CIDR (ad esempio, 123.1.2.3/24) da consentire. | string |
Sku
| Nome | Descrizione | valore |
|---|---|---|
| name | SKU del servizio di ricerca. I valori validi includono: 'free': Servizio condiviso. 'basic': servizio dedicato con un massimo di 3 repliche. 'standard': servizio dedicato con un massimo di 12 partizioni e 12 repliche. 'standard2': simile allo standard, ma con una maggiore capacità per ogni unità di ricerca. 'standard3': la più grande offerta Standard con un massimo di 12 partizioni e 12 repliche (o fino a 3 partizioni con più indici se si imposta anche la proprietà hostingMode su 'highDensity'). 'storage_optimized_l1': supporta 1 TB per partizione, fino a 12 partizioni. 'storage_optimized_l2': supporta 2 TB per partizione, fino a 12 partizioni. | 'basic' 'free' 'standard' 'standard2' 'standard3' 'storage_optimized_l1' 'storage_optimized_l2' |
Modelli di avvio rapido
I modelli di avvio rapido seguenti distribuiscono questo tipo di risorsa.
| Modello | Descrizione |
|---|---|
App Web con un database SQL, Azure Cosmos DB, Azure Search |
Questo modello esegue il provisioning di un'app Web, un database SQL, Azure Cosmos DB, Azure Search e Application Insights. |
| servizio Ricerca cognitiva di Azure |
Questo modello crea un servizio Ricerca cognitiva di Azure |
| Ricerca cognitiva di Azure servizio con endpoint privato |
Questo modello crea un servizio Ricerca cognitiva di Azure con un endpoint privato. |
Definizione della risorsa modello di Resource Manager
Il tipo di risorsa searchServices può essere distribuito con operazioni destinate:
- Gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse
Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.
Formato di risorsa
Per creare un Microsoft. Search/searchServices risorsa, aggiungere il codice JSON seguente al modello.
{
"type": "Microsoft.Search/searchServices",
"apiVersion": "2022-09-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"
}
}
Valori delle proprietà
searchServices
| Nome | Descrizione | Valore |
|---|---|---|
| tipo | Tipo di risorsa | 'Microsoft. Search/searchServices' |
| apiVersion | Versione dell'API risorsa | '2022-09-01' |
| name | Nome della risorsa | stringa (obbligatoria) |
| posizione | Posizione geografica in cui vive la risorsa | stringa (obbligatoria) |
| tags | Tag di risorse. | Dizionario dei nomi e dei valori dei tag. Vedere Tag nei modelli |
| sku | SKU del servizio Search, che determina i limiti di prezzo e capacità. Questa proprietà è necessaria quando si crea un nuovo servizio di Search. | Sku |
| identity | Identità della risorsa. | Identità |
| properties | Proprietà del servizio di ricerca. | SearchServiceProperties |
Identità
| Nome | Descrizione | Valore |
|---|---|---|
| tipo | Tipo di identità. | 'Nessuno' 'SystemAssigned' (obbligatorio) |
SearchServiceProperties
| Nome | Descrizione | Valore |
|---|---|---|
| authOptions | Definisce le opzioni per il modo in cui l'API del piano dati di un servizio di ricerca autentica le richieste. Impossibile impostare se 'disableLocalAuth' è impostato su true. | DataPlaneAuthOptions |
| disableLocalAuth | Se impostato su true, le chiamate al servizio di ricerca non saranno consentite per l'uso delle chiavi API per l'autenticazione. Impossibile impostare su true se sono definiti 'dataPlaneAuthOptions'. | bool |
| crittografiaWithCmk | Specifica tutti i criteri relativi alla crittografia delle risorse (ad esempio gli indici) usando le chiavi del customer manager all'interno di un servizio di ricerca. | EncryptionWithCmk |
| hostingMode | Applicabile solo per lo SKU standard3. È possibile impostare questa proprietà per abilitare fino a 3 partizioni ad alta densità che consentono fino a 1000 indici, che sono molto superiori agli indici massimi consentiti per qualsiasi altro SKU. Per lo SKU standard3, il valore è "predefinito" o "highDensity". Per tutti gli altri SKU, questo valore deve essere "predefinito". | 'default' 'highDensity' |
| networkRuleSet | Regole specifiche di rete che determinano la modalità di raggiungimento del servizio Ricerca cognitiva di Azure. | NetworkRuleSet |
| partitionCount | Numero di partizioni nel servizio di ricerca; se specificato, può essere 1, 2, 3, 4, 6 o 12. I valori maggiori di 1 sono validi solo per SKU standard. Per i servizi 'standard3' con hostingMode impostato su 'highDensity', i valori consentiti sono compresi tra 1 e 3. | INT Vincoli: Valore minimo = 1 Valore massimo = 12 |
| publicNetworkAccess | Questo valore può essere impostato su "abilitato" per evitare modifiche di rilievo sulle risorse e i modelli dei clienti esistenti. Se impostato su "disabilitato", il traffico sull'interfaccia pubblica non è consentito e le connessioni endpoint private sarebbero il metodo di accesso esclusivo. | 'disabilitato' 'enabled' |
| replicaCount | Numero di repliche nel servizio di ricerca. Se specificato, deve essere un valore compreso tra 1 e 12 inclusi per SKU standard o tra 1 e 3 inclusi per SKU di base. | INT Vincoli: Valore minimo = 1 Valore massimo = 12 |
DataPlaneAuthOptions
| Nome | Descrizione | Valore |
|---|---|---|
| aadOrApiKey | Indica che la chiave API o un token di accesso da Azure Active Directory può essere usata per l'autenticazione. | DataPlaneAadOrApiKeyAuthOption |
| apiKeyOnly | Indica che solo la chiave API deve essere usata per l'autenticazione. |
DataPlaneAadOrApiKeyAuthOption
| Nome | Descrizione | Valore |
|---|---|---|
| aadAuthFailureMode | Descrive la risposta che l'API del piano dati di un servizio di ricerca invia per le richieste che non sono riuscite nell'autenticazione. | 'http401WithBearerChallenge' 'http403' |
EncryptionWithCmk
| Nome | Descrizione | Valore |
|---|---|---|
| rinforzo | Descrive il modo in cui un servizio di ricerca deve applicare una o più risorse crittografate dal cliente. | 'Disabilitato' 'Enabled' 'Non specificato' |
NetworkRuleSet
| Nome | Descrizione | Valore |
|---|---|---|
| ipRules | Elenco delle regole di restrizione IP che definisce le reti in ingresso con la possibilità di accedere all'endpoint del servizio di ricerca. Nel frattempo, tutte le altre reti IP pubbliche vengono bloccate dal firewall. Queste regole di restrizione vengono applicate solo quando il 'publicNetworkAccess' del servizio di ricerca è 'abilitato'; in caso contrario, il traffico sull'interfaccia pubblica non è consentito anche con le regole IP pubbliche e le connessioni endpoint private sarebbero il metodo di accesso esclusivo. | IpRule[] |
IpRule
| Nome | Descrizione | Valore |
|---|---|---|
| Valore | Valore corrispondente a un singolo indirizzo IPv4 (ad esempio, 123.1.2.3) o a un intervallo IP in formato CIDR (ad esempio, 123.1.2.3/24) da consentire. | string |
Sku
| Nome | Descrizione | valore |
|---|---|---|
| name | SKU del servizio di ricerca. I valori validi includono: 'free': Servizio condiviso. 'basic': servizio dedicato con un massimo di 3 repliche. 'standard': servizio dedicato con un massimo di 12 partizioni e 12 repliche. 'standard2': simile allo standard, ma con una maggiore capacità per ogni unità di ricerca. 'standard3': la più grande offerta Standard con un massimo di 12 partizioni e 12 repliche (o fino a 3 partizioni con più indici se si imposta anche la proprietà hostingMode su 'highDensity'). 'storage_optimized_l1': supporta 1 TB per partizione, fino a 12 partizioni. 'storage_optimized_l2': supporta 2 TB per partizione, fino a 12 partizioni". | 'basic' 'free' 'standard' 'standard2' 'standard3' 'storage_optimized_l1' 'storage_optimized_l2' |
Modelli di avvio rapido
I modelli di avvio rapido seguenti distribuiscono questo tipo di risorsa.
| Modello | Descrizione |
|---|---|
| App Web con un database SQL, Azure Cosmos DB, Azure Search |
Questo modello effettua il provisioning di un'app Web, un database SQL, Azure Cosmos DB, Azure Search e Application Insights. |
| servizio Ricerca cognitiva di Azure |
Questo modello crea un servizio Ricerca cognitiva di Azure |
| servizio Ricerca cognitiva di Azure con endpoint privato |
Questo modello crea un servizio Ricerca cognitiva di Azure con un endpoint privato. |
Definizione della risorsa Terraform (provider AzAPI)
Il tipo di risorsa searchServices può essere distribuito con operazioni destinate a:
- Gruppi di risorse
Per un elenco delle proprietà modificate in ogni versione dell'API, vedere Log delle modifiche.
Formato di risorsa
Per creare un microsoft. Search/searchServices risorsa, aggiungere il codice Terraform seguente al modello.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Search/searchServices@2022-09-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
}
sku = {
name = "string"
}
})
}
Valori delle proprietà
searchServices
| Nome | Descrizione | Valore |
|---|---|---|
| tipo | Tipo di risorsa | "Microsoft. Search/searchServices@2022-09-01" |
| name | Nome della risorsa | stringa (obbligatorio) |
| posizione | Posizione geografica in cui risiede la risorsa | stringa (obbligatorio) |
| parent_id | Per eseguire la distribuzione in un gruppo di risorse, usare l'ID del gruppo di risorse. | stringa (obbligatorio) |
| tags | Tag delle risorse. | Dizionario di nomi e valori di tag. |
| sku | SKU del servizio Search, che determina i limiti di livello prezzo e capacità. Questa proprietà è necessaria quando si crea un nuovo servizio di Search. | Sku |
| identity | Identità della risorsa. | Identità |
| properties | Proprietà del servizio di ricerca. | SearchServiceProperties |
Identità
| Nome | Descrizione | Valore |
|---|---|---|
| tipo | Tipo di identità. | "SystemAssigned" (obbligatorio) |
SearchServiceProperties
| Nome | Descrizione | Valore |
|---|---|---|
| authOptions | Definisce le opzioni per il modo in cui l'API del piano dati di un servizio di ricerca autentica le richieste. Questa impostazione non può essere impostata se 'disableLocalAuth' è impostato su true. | DataPlaneAuthOptions |
| disableLocalAuth | Se impostato su true, le chiamate al servizio di ricerca non saranno autorizzate a usare le chiavi API per l'autenticazione. Questa impostazione non può essere impostata su true se sono definiti "dataPlaneAuthOptions". | bool |
| encryptionWithCmk | Specifica i criteri relativi alla crittografia delle risorse (ad esempio gli indici) usando le chiavi del customer manager all'interno di un servizio di ricerca. | EncryptionWithCmk |
| hostingMode | Applicabile solo per lo SKU Standard3. È possibile impostare questa proprietà per abilitare fino a 3 partizioni ad alta densità che consentono fino a 1000 indici, che sono molto superiori agli indici massimi consentiti per qualsiasi altro SKU. Per lo SKU standard3, il valore è "predefinito" o "highDensity". Per tutti gli altri SKU, questo valore deve essere "predefinito". | "default" "highDensity" |
| networkRuleSet | Regole specifiche di rete che determinano la modalità di raggiungimento del servizio Ricerca cognitiva di Azure. | NetworkRuleSet |
| partitionCount | Numero di partizioni nel servizio di ricerca; se specificato, può essere 1, 2, 3, 4, 6 o 12. I valori maggiori di 1 sono validi solo per SKU standard. Per i servizi 'standard3' con hostingMode impostato su 'highDensity', i valori consentiti sono compresi tra 1 e 3. | INT Vincoli: Valore minimo = 1 Valore massimo = 12 |
| publicNetworkAccess | Questo valore può essere impostato su "abilitato" per evitare modifiche di rilievo sulle risorse e i modelli dei clienti esistenti. Se impostato su "disabilitato", il traffico sull'interfaccia pubblica non è consentito e le connessioni endpoint private sarebbero il metodo di accesso esclusivo. | "disabilitato" "abilitato" |
| replicaCount | Numero di repliche nel servizio di ricerca. Se specificato, deve essere un valore compreso tra 1 e 12 inclusi per SKU standard o tra 1 e 3 inclusi per SKU di base. | INT Vincoli: Valore minimo = 1 Valore massimo = 12 |
DataPlaneAuthOptions
| Nome | Descrizione | Valore |
|---|---|---|
| aadOrApiKey | Indica che la chiave API o un token di accesso da Azure Active Directory può essere usata per l'autenticazione. | DataPlaneAadOrApiKeyAuthOption |
| apiKeyOnly | Indica che solo la chiave API deve essere usata per l'autenticazione. |
DataPlaneAadOrApiKeyAuthOption
| Nome | Descrizione | Valore |
|---|---|---|
| aadAuthFailureMode | Descrive la risposta che l'API del piano dati di un servizio di ricerca invia per le richieste che non sono riuscite nell'autenticazione. | "http401WithBearerChallenge" "http403" |
EncryptionWithCmk
| Nome | Descrizione | Valore |
|---|---|---|
| rinforzo | Descrive il modo in cui un servizio di ricerca deve applicare una o più risorse crittografate dal cliente. | "Disabilitato" "Abilitato" "Non specificato" |
NetworkRuleSet
| Nome | Descrizione | Valore |
|---|---|---|
| ipRules | Elenco delle regole di restrizione IP che definisce le reti in ingresso con la possibilità di accedere all'endpoint del servizio di ricerca. Nel frattempo, tutte le altre reti IP pubbliche vengono bloccate dal firewall. Queste regole di restrizione vengono applicate solo quando il 'publicNetworkAccess' del servizio di ricerca è 'abilitato'; in caso contrario, il traffico sull'interfaccia pubblica non è consentito anche con le regole IP pubbliche e le connessioni endpoint private sarebbero il metodo di accesso esclusivo. | IpRule[] |
IpRule
| Nome | Descrizione | Valore |
|---|---|---|
| Valore | Valore corrispondente a un singolo indirizzo IPv4 (ad esempio, 123.1.2.3) o un intervallo IP in formato CIDR (ad esempio, 123.1.2.3/24) da consentire. | string |
Sku
| Nome | Descrizione | valore |
|---|---|---|
| name | SKU del servizio di ricerca. I valori validi includono: 'free': Servizio condiviso. 'basic': servizio dedicato con un massimo di 3 repliche. 'standard': servizio dedicato con un massimo di 12 partizioni e 12 repliche. 'standard2': simile allo standard, ma con una maggiore capacità per ogni unità di ricerca. 'standard3': la più grande offerta Standard con un massimo di 12 partizioni e 12 repliche (o fino a 3 partizioni con più indici se si imposta anche la proprietà hostingMode su 'highDensity'). 'storage_optimized_l1': supporta 1 TB per partizione, fino a 12 partizioni. 'storage_optimized_l2': supporta 2 TB per partizione, fino a 12 partizioni. | "basic" "gratuito" "standard" "standard2" "standard3" "storage_optimized_l1" "storage_optimized_l2" |