Services - Update

Uppdateringar en befintlig söktjänst i den angivna resursgruppen.

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

URI-parametrar

Name I Obligatorisk Typ Description
resourceGroupName
path True

string

Namnet på resursgruppen i den aktuella prenumerationen. Du kan hämta det här värdet från Azure Resource Manager-API:et eller portalen.

searchServiceName
path True

string

Namnet på söktjänsten som ska uppdateras.

subscriptionId
path True

string

Den unika identifieraren för en Microsoft Azure-prenumeration. Du kan hämta det här värdet från Azure Resource Manager API, kommandoradsverktyg eller portalen.

api-version
query True

string

DEN API-version som ska användas för varje begäran.

Begärandehuvud

Name Obligatorisk Typ Description
x-ms-client-request-id

string

uuid

Ett klientgenererat GUID-värde som identifierar den här begäran. Om detta anges inkluderas detta i svarsinformationen som ett sätt att spåra begäran.

Begärandetext

Name Typ Description
identity

Identity

Resursens identitet.

location

string

Resursens geografiska plats. Detta måste vara en av de azure-georegioner som stöds och registreras (till exempel USA, västra, USA, östra, Asien, sydöstra och så vidare). Den här egenskapen krävs när du skapar en ny resurs.

properties.authOptions

DataPlaneAuthOptions

Definierar alternativen för hur api:et för dataplanet för en söktjänst autentiserar begäranden. Det går inte att ange detta om "disableLocalAuth" är inställt på true.

properties.disableLocalAuth

boolean

När värdet är true tillåts inte anrop till söktjänsten att använda API-nycklar för autentisering. Detta kan inte anges till sant om "dataPlaneAuthOptions" har definierats.

properties.encryptionWithCmk

EncryptionWithCmk

Anger alla principer för kryptering av resurser (till exempel index) med hjälp av kundhanterarnycklar i en söktjänst.

properties.hostingMode

HostingMode

Gäller endast för standard3-SKU:n. Du kan ange den här egenskapen för att aktivera upp till 3 högdensitetspartitioner som tillåter upp till 1 000 index, vilket är mycket högre än det högsta antalet index som tillåts för andra SKU:er. För standard3-SKU:n är värdet antingen "default" eller "highDensity". För alla andra SKU:er måste det här värdet vara "default".

properties.networkRuleSet

NetworkRuleSet

Nätverksspecifika regler som avgör hur söktjänsten kan nås.

properties.partitionCount

integer

Antalet partitioner i söktjänsten. Om det anges kan det vara 1, 2, 3, 4, 6 eller 12. Värden större än 1 är endast giltiga för standard-SKU:er. För "standard3"-tjänster med hostingMode inställt på "highDensity" är de tillåtna värdena mellan 1 och 3.

properties.publicNetworkAccess

PublicNetworkAccess

Det här värdet kan anges till "aktiverat" för att undvika icke-bakåtkompatibla ändringar av befintliga kundresurser och mallar. Om värdet är "inaktiverat" tillåts inte trafik via offentligt gränssnitt, och privata slutpunktsanslutningar skulle vara metoden för exklusiv åtkomst.

properties.replicaCount

integer

Antalet repliker i söktjänsten. Om det anges måste det vara ett värde mellan 1 och 12 inklusivt för standard-SKU:er eller mellan 1 och 3 för grundläggande SKU.

properties.semanticSearch

SearchSemanticSearch

Anger alternativ som styr tillgängligheten för semantisk sökning. Den här konfigurationen är endast möjlig för vissa sök-SKU:er på vissa platser.

sku

Sku

SKU:n för söktjänsten, som bestämmer faktureringshastigheten och kapacitetsgränserna. Den här egenskapen krävs när du skapar en ny söktjänst.

tags

object

Taggar som hjälper dig att kategorisera resursen i Azure Portal.

Svar

Name Typ Description
200 OK

SearchService

Den befintliga tjänstdefinitionen har uppdaterats. Om du har ändrat antalet repliker eller partitioner sker skalningsåtgärden asynkront. Du kan regelbundet hämta tjänstdefinitionen och övervaka förloppet via egenskapen provisioningState.

Other Status Codes

CloudError

HTTP 400 (felaktig begäran): Den angivna tjänstdefinitionen är ogiltig eller så försökte du ändra en egenskap som inte kan ändras. Mer information finns i felkoden och meddelandet i svaret. HTTP 404 (hittades inte): Det gick inte att hitta prenumerationen eller resursgruppen. HTTP 409 (konflikt): Den angivna prenumerationen är inaktiverad.

Säkerhet

azure_auth

Microsoft Entra ID OAuth2-auktoriseringsflöde.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

SearchUpdateService
SearchUpdateServiceAuthOptions
SearchUpdateServiceDisableLocalAuth
SearchUpdateServiceToAllowAccessFromPrivateEndpoints
SearchUpdateServiceToAllowAccessFromPublicCustomIPs
SearchUpdateServiceToRemoveIdentity
SearchUpdateServiceWithCmkEnforcement
SearchUpdateServiceWithSemanticSearch

SearchUpdateService

Exempelbegäran

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2023-11-01

{
  "tags": {
    "app-name": "My e-commerce app",
    "new-tag": "Adding a new tag"
  },
  "properties": {
    "replicaCount": 2
  }
}

Exempelsvar

{
  "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": []
    },
    "privateEndpointConnections": []
  }
}

SearchUpdateServiceAuthOptions

Exempelbegäran

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2023-11-01

{
  "tags": {
    "app-name": "My e-commerce app",
    "new-tag": "Adding a new tag"
  },
  "properties": {
    "replicaCount": 2,
    "authOptions": {
      "aadOrApiKey": {
        "aadAuthFailureMode": "http401WithBearerChallenge"
      }
    }
  }
}

Exempelsvar

{
  "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": []
    },
    "authOptions": {
      "aadOrApiKey": {
        "aadAuthFailureMode": "http401WithBearerChallenge"
      }
    }
  }
}

SearchUpdateServiceDisableLocalAuth

Exempelbegäran

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2023-11-01

{
  "tags": {
    "app-name": "My e-commerce app",
    "new-tag": "Adding a new tag"
  },
  "properties": {
    "replicaCount": 2,
    "disableLocalAuth": true
  }
}

Exempelsvar

{
  "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": []
    },
    "disableLocalAuth": true,
    "authOptions": null
  }
}

SearchUpdateServiceToAllowAccessFromPrivateEndpoints

Exempelbegäran

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2023-11-01

{
  "properties": {
    "replicaCount": 1,
    "partitionCount": 1,
    "publicNetworkAccess": "disabled"
  }
}

Exempelsvar

{
  "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": []
    },
    "privateEndpointConnections": []
  }
}

SearchUpdateServiceToAllowAccessFromPublicCustomIPs

Exempelbegäran

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2023-11-01

{
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "123.4.5.6"
        },
        {
          "value": "123.4.6.0/18"
        }
      ]
    }
  }
}

Exempelsvar

{
  "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": []
  }
}

SearchUpdateServiceToRemoveIdentity

Exempelbegäran

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2023-11-01

{
  "sku": {
    "name": "standard"
  },
  "identity": {
    "type": "None"
  }
}

Exempelsvar

{
  "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": []
    },
    "privateEndpointConnections": []
  },
  "identity": {
    "type": "None"
  }
}

SearchUpdateServiceWithCmkEnforcement

Exempelbegäran

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2023-11-01

{
  "tags": {
    "app-name": "My e-commerce app",
    "new-tag": "Adding a new tag"
  },
  "properties": {
    "replicaCount": 2,
    "encryptionWithCmk": {
      "enforcement": "Enabled"
    }
  }
}

Exempelsvar

{
  "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": []
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Enabled",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    }
  }
}

SearchUpdateServiceWithSemanticSearch

Exempelbegäran

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2023-11-01

{
  "tags": {
    "app-name": "My e-commerce app",
    "new-tag": "Adding a new tag"
  },
  "properties": {
    "replicaCount": 2,
    "semanticSearch": "standard"
  }
}

Exempelsvar

{
  "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": []
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "semanticSearch": "standard"
  }
}

Definitioner

Name Description
AadAuthFailureMode

Beskriver vilket svar dataplans-API:et för en söktjänst skulle skicka för begäranden som misslyckades med autentiseringen.

ApiKeyOnly

Anger att endast API-nyckeln kan användas för autentisering.

CloudError

Innehåller information om ett API-fel.

CloudErrorBody

Beskriver ett visst API-fel med en felkod och ett meddelande.

DataPlaneAadOrApiKeyAuthOption

Anger att antingen API-nyckeln eller en åtkomsttoken från en Microsoft Entra ID klientorganisation kan användas för autentisering.

DataPlaneAuthOptions

Definierar alternativen för hur söktjänsten autentiserar en dataplansbegäran. Det går inte att ange detta om "disableLocalAuth" är inställt på true.

EncryptionWithCmk

Beskriver en princip som bestämmer hur resurser i söktjänsten ska krypteras med kund=hanterade nycklar.

HostingMode

Gäller endast för standard3 SKU. Du kan ange den här egenskapen för att aktivera upp till 3 partitioner med hög densitet som tillåter upp till 1 000 index, vilket är mycket högre än de högsta index som tillåts för andra SKU:er. För standard3 SKU är värdet antingen "default" eller "highDensity". För alla andra SKU:er måste det här värdet vara "standard".

Identity

Identitet för resursen.

IdentityType

Identitetstypen.

IpRule

IP-begränsningsregeln för söktjänsten.

NetworkRuleSet

Nätverksspecifika regler som bestämmer hur söktjänsten kan nås.

PrivateEndpoint

Den privata slutpunktsresursen från Microsoft.Network-providern.

PrivateEndpointConnection

Beskriver en befintlig privat slutpunktsanslutning till söktjänsten.

PrivateEndpointConnectionProperties

Beskriver egenskaperna för en befintlig privat slutpunktsanslutning till söktjänsten.

PrivateLinkServiceConnectionProvisioningState

Etableringstillståndet för den privata länktjänstanslutningen. Giltiga värden är Uppdatera, Ta bort, Misslyckades, Lyckades eller Ofullständig

PrivateLinkServiceConnectionState

Beskriver det aktuella tillståndet för en befintlig Private Link Service-anslutning till den privata Azure-slutpunkten.

PrivateLinkServiceConnectionStatus

Status för private link-tjänstanslutningen. Giltiga värden är Väntar, Godkänd, Avvisad eller Frånkopplad.

ProvisioningState

Tillståndet för den senaste etableringsåtgärden som utfördes på söktjänsten. Etablering är ett mellanliggande tillstånd som inträffar medan tjänstkapaciteten upprättas. När kapaciteten har konfigurerats ändras provisioningState till antingen "succeeded" eller "failed". Klientprogram kan avsöka etableringsstatus (det rekommenderade avsökningsintervallet är från 30 sekunder till en minut) med hjälp av åtgärden Hämta söktjänst för att se när en åtgärd har slutförts. Om du använder den kostnadsfria tjänsten tenderar det här värdet att komma tillbaka som "lyckades" direkt i anropet till Skapa söktjänst. Det beror på att den kostnadsfria tjänsten använder kapacitet som redan har konfigurerats.

PublicNetworkAccess

Det här värdet kan anges till "aktiverat" för att undvika icke-bakåtkompatibla ändringar av befintliga kundresurser och mallar. Om inställningen är "inaktiverad" tillåts inte trafik via det offentliga gränssnittet och privata slutpunktsanslutningar är den exklusiva åtkomstmetoden.

SearchEncryptionComplianceStatus

Beskriver om söktjänsten är kompatibel eller inte när det gäller att ha icke-kundkrypterade resurser. Om en tjänst har mer än en icke-kundkrypterad resurs och "Enforcement" är "aktiverad" markeras tjänsten som "icke-kompatibel".

SearchEncryptionWithCmk

Beskriver hur en söktjänst ska framtvinga att ha en eller flera icke-kundkrypterade resurser.

SearchSemanticSearch

Anger alternativ som styr tillgängligheten för semantisk sökning. Den här konfigurationen är endast möjlig för vissa sök-SKU:er på vissa platser.

SearchService

Beskriver en söktjänst och dess aktuella tillstånd.

SearchServiceStatus

Status för söktjänsten. Möjliga värden är: "körs": Söktjänsten körs och inga etableringsåtgärder pågår. Etablering: Söktjänsten etableras eller skalas upp eller ned. "ta bort": Söktjänsten tas bort. "degraderad": Söktjänsten är degraderad. Detta kan inträffa när de underliggande sökenheterna inte är felfria. Söktjänsten är troligen i drift, men prestandan kan vara långsam och vissa begäranden kan tas bort. "disabled": Söktjänsten är inaktiverad. I det här tillståndet avvisar tjänsten alla API-begäranden. "error": Söktjänsten är i ett feltillstånd. Om tjänsten är i degraderat, inaktiverat eller feltillstånd undersöker Microsoft aktivt det underliggande problemet. Dedikerade tjänster i dessa tillstånd kan fortfarande debiteras baserat på antalet etablerade sökenheter.

SearchServiceUpdate

Parametrarna som används för att uppdatera en söktjänst.

SharedPrivateLinkResource

Beskriver en delad Private Link resurs som hanteras av söktjänsten.

SharedPrivateLinkResourceProperties

Beskriver egenskaperna för en befintlig delad Private Link resurs som hanteras av söktjänsten.

SharedPrivateLinkResourceProvisioningState

Etableringstillståndet för resursen för delad privat länk. Giltiga värden är Uppdatera, Ta bort, Misslyckades, Lyckades eller Ofullständig.

SharedPrivateLinkResourceStatus

Status för resursen för delad privat länk. Giltiga värden är Väntar, Godkänd, Avvisad eller Frånkopplad.

Sku

Definierar SKU:n för en söktjänst, som avgör faktureringshastighet och kapacitetsgränser.

SkuName

SKU:n för söktjänsten. Giltiga värden är: "kostnadsfri": Delad tjänst. "basic": Dedikerad tjänst med upp till 3 repliker. Standard: Dedikerad tjänst med upp till 12 partitioner och 12 repliker. "standard2": Liknar standard, men med mer kapacitet per sökenhet. "standard3": Det största standarderbjudandet med upp till 12 partitioner och 12 repliker (eller upp till 3 partitioner med fler index om du också ställer in egenskapen hostingMode till "highDensity"). "storage_optimized_l1": Stöder 1 TB per partition, upp till 12 partitioner. "storage_optimized_l2": Stöder 2 TB per partition, upp till 12 partitioner.

AadAuthFailureMode

Beskriver vilket svar dataplans-API:et för en söktjänst skulle skicka för begäranden som misslyckades med autentiseringen.

Name Typ Description
http401WithBearerChallenge

string

Anger att begäranden om misslyckad autentisering ska visas med http-statuskoden 401 (obehörig) och presentera en ägarutmaning.

http403

string

Anger att begäranden om misslyckad autentisering ska visas med HTTP-statuskoden 403 (Förbjuden).

ApiKeyOnly

Anger att endast API-nyckeln kan användas för autentisering.

CloudError

Innehåller information om ett API-fel.

Name Typ Description
error

CloudErrorBody

Beskriver ett visst API-fel med en felkod och ett meddelande.

CloudErrorBody

Beskriver ett visst API-fel med en felkod och ett meddelande.

Name Typ Description
code

string

En felkod som beskriver feltillståndet mer exakt än en HTTP-statuskod. Kan användas för att programmatiskt hantera specifika felfall.

details

CloudErrorBody[]

Innehåller kapslade fel som är relaterade till det här felet.

message

string

Ett meddelande som beskriver felet i detalj och innehåller felsökningsinformation.

target

string

Målet för det specifika felet (till exempel namnet på egenskapen i fel).

DataPlaneAadOrApiKeyAuthOption

Anger att antingen API-nyckeln eller en åtkomsttoken från en Microsoft Entra ID klientorganisation kan användas för autentisering.

Name Typ Description
aadAuthFailureMode

AadAuthFailureMode

Beskriver vilket svar dataplanets API för en söktjänst skulle skicka för begäranden som misslyckades med autentiseringen.

DataPlaneAuthOptions

Definierar alternativen för hur söktjänsten autentiserar en dataplansbegäran. Det går inte att ange detta om "disableLocalAuth" är inställt på true.

Name Typ Description
aadOrApiKey

DataPlaneAadOrApiKeyAuthOption

Anger att antingen API-nyckeln eller en åtkomsttoken från en Microsoft Entra ID klientorganisation kan användas för autentisering.

apiKeyOnly

ApiKeyOnly

Anger att endast API-nyckeln kan användas för autentisering.

EncryptionWithCmk

Beskriver en princip som bestämmer hur resurser i söktjänsten ska krypteras med kund=hanterade nycklar.

Name Typ Description
encryptionComplianceStatus

SearchEncryptionComplianceStatus

Beskriver om söktjänsten är kompatibel eller inte när det gäller icke-kundkrypterade resurser. Om en tjänst har mer än en icke-kundkrypterad resurs och "Tvingande" är "aktiverad" markeras tjänsten som "nonCompliant".

enforcement

SearchEncryptionWithCmk

Beskriver hur en söktjänst ska framtvinga att ha en eller flera icke-kundkrypterade resurser.

HostingMode

Gäller endast för standard3 SKU. Du kan ange den här egenskapen för att aktivera upp till 3 partitioner med hög densitet som tillåter upp till 1 000 index, vilket är mycket högre än de högsta index som tillåts för andra SKU:er. För standard3 SKU är värdet antingen "default" eller "highDensity". För alla andra SKU:er måste det här värdet vara "standard".

Name Typ Description
default

string

Gränsen för antalet index bestäms av standardgränserna för SKU:n.

highDensity

string

Endast program för Standard3 SKU, där söktjänsten kan ha upp till 1 000 index.

Identity

Identitet för resursen.

Name Typ Description
principalId

string

Huvud-ID för söktjänstens systemtilldelade identitet.

tenantId

string

Klientorganisations-ID för söktjänstens systemtilldelade identitet.

type

IdentityType

Identitetstypen.

IdentityType

Identitetstypen.

Name Typ Description
None

string

SystemAssigned

string

IpRule

IP-begränsningsregeln för söktjänsten.

Name Typ Description
value

string

Värde som motsvarar en enda IPv4-adress (till exempel 123.1.2.3) eller ett IP-intervall i CIDR-format (till exempel 123.1.2.3/24) som ska tillåtas.

NetworkRuleSet

Nätverksspecifika regler som bestämmer hur söktjänsten kan nås.

Name Typ Description
ipRules

IpRule[]

En lista över IP-begränsningsregler som används för en IP-brandvägg. Ip-adresser som inte matchar reglerna blockeras av brandväggen. Dessa regler tillämpas endast när "publicNetworkAccess" för söktjänsten är "aktiverad".

PrivateEndpoint

Den privata slutpunktsresursen från Microsoft.Network-providern.

Name Typ Description
id

string

Resurs-ID för den privata slutpunktsresursen från Microsoft.Network-providern.

PrivateEndpointConnection

Beskriver en befintlig privat slutpunktsanslutning till söktjänsten.

Name Typ Description
id

string

Fullständigt kvalificerat resurs-ID för resursen. Exempel – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Namnet på resursen

properties

PrivateEndpointConnectionProperties

Beskriver egenskaperna för en befintlig privat slutpunktsanslutning till söktjänsten.

type

string

Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProperties

Beskriver egenskaperna för en befintlig privat slutpunktsanslutning till söktjänsten.

Name Typ Description
groupId

string

Grupp-ID:t från resursprovidern som den privata länktjänstanslutningen är till för.

privateEndpoint

PrivateEndpoint

Den privata slutpunktsresursen från Microsoft.Network-providern.

privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Beskriver det aktuella tillståndet för en befintlig Private Link Service-anslutning till den privata Azure-slutpunkten.

provisioningState

PrivateLinkServiceConnectionProvisioningState

Etableringstillståndet för den privata länktjänstens anslutning. Giltiga värden är Uppdatera, Ta bort, Misslyckades, Lyckades eller Ofullständig

PrivateLinkServiceConnectionProvisioningState

Etableringstillståndet för den privata länktjänstanslutningen. Giltiga värden är Uppdatera, Ta bort, Misslyckades, Lyckades eller Ofullständig

Name Typ Description
Canceled

string

Etableringsbegäran för anslutningsresursen för private link-tjänsten har avbrutits

Deleting

string

Anslutningen till tjänsten Private Link håller på att tas bort.

Failed

string

Det gick inte att etablera eller ta bort den privata länktjänstanslutningen.

Incomplete

string

Etableringsbegäran för anslutningsresursen för private link-tjänsten har accepterats, men processen för att skapa har inte påbörjats ännu.

Succeeded

string

Private Link-tjänstanslutningen har slutfört etableringen och är klar för godkännande.

Updating

string

Anslutningen till tjänsten private link håller på att skapas tillsammans med andra resurser för att den ska fungera fullt ut.

PrivateLinkServiceConnectionState

Beskriver det aktuella tillståndet för en befintlig Private Link Service-anslutning till den privata Azure-slutpunkten.

Name Typ Standardvärde Description
actionsRequired

string

None

En beskrivning av eventuella extra åtgärder som kan krävas.

description

string

Beskrivning av anslutningstillståndet för tjänsten Private Link.

status

PrivateLinkServiceConnectionStatus

Status för private link-tjänstanslutningen. Giltiga värden är Väntar, Godkänd, Avvisad eller Frånkopplad.

PrivateLinkServiceConnectionStatus

Status för private link-tjänstanslutningen. Giltiga värden är Väntar, Godkänd, Avvisad eller Frånkopplad.

Name Typ Description
Approved

string

Den privata slutpunktsanslutningen har godkänts och är klar att användas.

Disconnected

string

Den privata slutpunktsanslutningen har tagits bort från tjänsten.

Pending

string

Den privata slutpunktsanslutningen har skapats och väntar på godkännande.

Rejected

string

Den privata slutpunktsanslutningen har avvisats och kan inte användas.

ProvisioningState

Tillståndet för den senaste etableringsåtgärden som utfördes på söktjänsten. Etablering är ett mellanliggande tillstånd som inträffar medan tjänstkapaciteten upprättas. När kapaciteten har konfigurerats ändras provisioningState till antingen "succeeded" eller "failed". Klientprogram kan avsöka etableringsstatus (det rekommenderade avsökningsintervallet är från 30 sekunder till en minut) med hjälp av åtgärden Hämta söktjänst för att se när en åtgärd har slutförts. Om du använder den kostnadsfria tjänsten tenderar det här värdet att komma tillbaka som "lyckades" direkt i anropet till Skapa söktjänst. Det beror på att den kostnadsfria tjänsten använder kapacitet som redan har konfigurerats.

Name Typ Description
failed

string

Den senaste etableringsåtgärden misslyckades.

provisioning

string

Söktjänsten etableras eller skalas upp eller ned.

succeeded

string

Den senaste etableringsåtgärden har slutförts.

PublicNetworkAccess

Det här värdet kan anges till "aktiverat" för att undvika icke-bakåtkompatibla ändringar av befintliga kundresurser och mallar. Om inställningen är "inaktiverad" tillåts inte trafik via det offentliga gränssnittet och privata slutpunktsanslutningar är den exklusiva åtkomstmetoden.

Name Typ Description
disabled

string

enabled

string

SearchEncryptionComplianceStatus

Beskriver om söktjänsten är kompatibel eller inte när det gäller att ha icke-kundkrypterade resurser. Om en tjänst har mer än en icke-kundkrypterad resurs och "Enforcement" är "aktiverad" markeras tjänsten som "icke-kompatibel".

Name Typ Description
Compliant

string

Anger att söktjänsten är kompatibel, antingen på grund av att antalet icke-kundkrypterade resurser är noll eller att tvingande är inaktiverat.

NonCompliant

string

Anger att söktjänsten har fler än en icke-kundkrypterad resurs.

SearchEncryptionWithCmk

Beskriver hur en söktjänst ska framtvinga att ha en eller flera icke-kundkrypterade resurser.

Name Typ Description
Disabled

string

Ingen tillämpning görs och söktjänsten kan ha icke-kundkrypterade resurser.

Enabled

string

tjänsten Search markeras som icke-kompatibla om det finns en eller flera icke-kundkrypterade resurser.

Unspecified

string

Tvingande princip anges inte uttryckligen, där beteendet är detsamma som om det hade angetts till "Inaktiverad".

SearchSemanticSearch

Anger alternativ som styr tillgängligheten för semantisk sökning. Den här konfigurationen är endast möjlig för vissa sök-SKU:er på vissa platser.

Name Typ Description
disabled

string

Anger att semantisk rangordning är inaktiverat för söktjänsten.

free

string

Aktiverar semantisk rangordning för en söktjänst och anger att den ska användas inom gränserna för den kostnadsfria nivån. Detta skulle begränsa volymen av semantiska rankningsförfrågningar och erbjuds utan extra kostnad. Detta är standard för nyligen etablerade söktjänster.

standard

string

Aktiverar semantisk rangordning för en söktjänst som en fakturerbar funktion, med högre dataflöde och volym av semantiska rangordningsbegäranden.

SearchService

Beskriver en söktjänst och dess aktuella tillstånd.

Name Typ Standardvärde Description
id

string

Fullständigt kvalificerat resurs-ID för resursen. Exempel – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

Identity

Resursens identitet.

location

string

Den geo-plats där resursen finns

name

string

Namnet på resursen

properties.authOptions

DataPlaneAuthOptions

Definierar alternativen för hur api:et för dataplanet för en söktjänst autentiserar begäranden. Det går inte att ange detta om "disableLocalAuth" är inställt på true.

properties.disableLocalAuth

boolean

När värdet är true tillåts inte anrop till söktjänsten att använda API-nycklar för autentisering. Detta kan inte anges till sant om "dataPlaneAuthOptions" har definierats.

properties.encryptionWithCmk

EncryptionWithCmk

Anger alla principer för kryptering av resurser (till exempel index) med hjälp av kundhanterarnycklar i en söktjänst.

properties.hostingMode

HostingMode

default

Gäller endast för standard3-SKU:n. Du kan ange den här egenskapen för att aktivera upp till 3 högdensitetspartitioner som tillåter upp till 1 000 index, vilket är mycket högre än det högsta antalet index som tillåts för andra SKU:er. För standard3-SKU:n är värdet antingen "default" eller "highDensity". För alla andra SKU:er måste det här värdet vara "default".

properties.networkRuleSet

NetworkRuleSet

Nätverksspecifika regler som avgör hur söktjänsten kan nås.

properties.partitionCount

integer

1

Antalet partitioner i söktjänsten. Om det anges kan det vara 1, 2, 3, 4, 6 eller 12. Värden större än 1 är endast giltiga för standard-SKU:er. För "standard3"-tjänster med hostingMode inställt på "highDensity" är de tillåtna värdena mellan 1 och 3.

properties.privateEndpointConnections

PrivateEndpointConnection[]

Listan över privata slutpunktsanslutningar till söktjänsten.

properties.provisioningState

ProvisioningState

Tillståndet för den senaste etableringsåtgärden som utfördes på söktjänsten. Etablering är ett mellanliggande tillstånd som inträffar medan tjänstkapaciteten upprättas. När kapaciteten har konfigurerats ändras provisioningState till antingen "succeeded" eller "failed". Klientprogram kan avsöka etableringsstatus (det rekommenderade avsökningsintervallet är från 30 sekunder till en minut) med hjälp av åtgärden Hämta söktjänst för att se när en åtgärd har slutförts. Om du använder den kostnadsfria tjänsten tenderar det här värdet att komma tillbaka som "lyckades" direkt i anropet till Skapa söktjänst. Det beror på att den kostnadsfria tjänsten använder kapacitet som redan har konfigurerats.

properties.publicNetworkAccess

PublicNetworkAccess

enabled

Det här värdet kan anges till "aktiverat" för att undvika icke-bakåtkompatibla ändringar av befintliga kundresurser och mallar. Om värdet är "inaktiverat" tillåts inte trafik via offentligt gränssnitt, och privata slutpunktsanslutningar skulle vara metoden för exklusiv åtkomst.

properties.replicaCount

integer

1

Antalet repliker i söktjänsten. Om det anges måste det vara ett värde mellan 1 och 12 inklusivt för standard-SKU:er eller mellan 1 och 3 för grundläggande SKU.

properties.semanticSearch

SearchSemanticSearch

Anger alternativ som styr tillgängligheten för semantisk sökning. Den här konfigurationen är endast möjlig för vissa sök-SKU:er på vissa platser.

properties.sharedPrivateLinkResources

SharedPrivateLinkResource[]

Listan över delade privata länkresurser som hanteras av söktjänsten.

properties.status

SearchServiceStatus

Status för söktjänsten. Möjliga värden är: "körs": Söktjänsten körs och inga etableringsåtgärder pågår. Etablering: Söktjänsten etableras eller skalas upp eller ned. "ta bort": Söktjänsten tas bort. "degraderad": Söktjänsten är degraderad. Detta kan inträffa när de underliggande sökenheterna inte är felfria. Söktjänsten är troligen i drift, men prestandan kan vara långsam och vissa begäranden kan tas bort. "disabled": Söktjänsten är inaktiverad. I det här tillståndet avvisar tjänsten alla API-begäranden. "error": Söktjänsten är i ett feltillstånd. Om tjänsten är i degraderat, inaktiverat eller feltillstånd undersöker Microsoft aktivt det underliggande problemet. Dedikerade tjänster i dessa tillstånd kan fortfarande debiteras baserat på antalet etablerade sökenheter.

properties.statusDetails

string

Information om söktjänstens status.

sku

Sku

SKU:n för söktjänsten, som avgör faktureringsfrekvens och kapacitetsbegränsningar. Den här egenskapen krävs när du skapar en ny söktjänst.

tags

object

Resurstaggar.

type

string

Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

SearchServiceStatus

Status för söktjänsten. Möjliga värden är: "körs": Söktjänsten körs och inga etableringsåtgärder pågår. Etablering: Söktjänsten etableras eller skalas upp eller ned. "ta bort": Söktjänsten tas bort. "degraderad": Söktjänsten är degraderad. Detta kan inträffa när de underliggande sökenheterna inte är felfria. Söktjänsten är troligen i drift, men prestandan kan vara långsam och vissa begäranden kan tas bort. "disabled": Söktjänsten är inaktiverad. I det här tillståndet avvisar tjänsten alla API-begäranden. "error": Söktjänsten är i ett feltillstånd. Om tjänsten är i degraderat, inaktiverat eller feltillstånd undersöker Microsoft aktivt det underliggande problemet. Dedikerade tjänster i dessa tillstånd kan fortfarande debiteras baserat på antalet etablerade sökenheter.

Name Typ Description
degraded

string

Söktjänsten har nedgraderats eftersom underliggande sökenheter inte är felfria.

deleting

string

Söktjänsten tas bort.

disabled

string

Söktjänsten är inaktiverad och alla API-begäranden avvisas.

error

string

Söktjänsten är i feltillstånd, vilket indikerar antingen att det inte gick att etablera eller att den skulle tas bort.

provisioning

string

Söktjänsten etableras eller skalas upp eller ned.

running

string

Söktjänsten körs och inga etableringsåtgärder pågår.

SearchServiceUpdate

Parametrarna som används för att uppdatera en söktjänst.

Name Typ Standardvärde Description
id

string

Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

Identity

Resursens identitet.

location

string

Resursens geografiska plats. Detta måste vara en av de azure-georegioner som stöds och registreras (till exempel USA, västra, USA, östra, Asien, sydöstra och så vidare). Den här egenskapen krävs när du skapar en ny resurs.

name

string

Namnet på resursen

properties.authOptions

DataPlaneAuthOptions

Definierar alternativen för hur dataplanets API för en söktjänst autentiserar begäranden. Det går inte att ange om "disableLocalAuth" är inställt på true.

properties.disableLocalAuth

boolean

När värdet är true tillåts inte anrop till söktjänsten att använda API-nycklar för autentisering. Detta kan inte anges till sant om "dataPlaneAuthOptions" har definierats.

properties.encryptionWithCmk

EncryptionWithCmk

Anger alla principer för kryptering av resurser (till exempel index) med hjälp av kundhanterarnycklar i en söktjänst.

properties.hostingMode

HostingMode

default

Gäller endast för standard3 SKU. Du kan ange den här egenskapen för att aktivera upp till 3 partitioner med hög densitet som tillåter upp till 1 000 index, vilket är mycket högre än de högsta index som tillåts för andra SKU:er. För standard3 SKU är värdet antingen "default" eller "highDensity". För alla andra SKU:er måste det här värdet vara "standard".

properties.networkRuleSet

NetworkRuleSet

Nätverksspecifika regler som avgör hur söktjänsten kan nås.

properties.partitionCount

integer

1

Antalet partitioner i söktjänsten. om det anges kan det vara 1, 2, 3, 4, 6 eller 12. Värden som är större än 1 är endast giltiga för standard-SKU:er. För "standard3"-tjänster med hostingMode inställt på "highDensity" är de tillåtna värdena mellan 1 och 3.

properties.privateEndpointConnections

PrivateEndpointConnection[]

Listan över privata slutpunktsanslutningar till söktjänsten.

properties.provisioningState

ProvisioningState

Tillståndet för den senaste etableringsåtgärden som utfördes på söktjänsten. Etablering är ett mellanliggande tillstånd som inträffar när tjänstkapaciteten upprättas. När kapaciteten har konfigurerats ändras provisioningState till antingen "succeeded" eller "failed". Klientprogram kan avsöka etableringsstatus (det rekommenderade avsökningsintervallet är från 30 sekunder till en minut) med hjälp av åtgärden Hämta söktjänst för att se när en åtgärd har slutförts. Om du använder den kostnadsfria tjänsten tenderar det här värdet att komma tillbaka som "lyckades" direkt i anropet till Skapa söktjänst. Det beror på att den kostnadsfria tjänsten använder kapacitet som redan har konfigurerats.

properties.publicNetworkAccess

PublicNetworkAccess

enabled

Det här värdet kan anges till "aktiverat" för att undvika icke-bakåtkompatibla ändringar av befintliga kundresurser och mallar. Om inställningen är "inaktiverad" tillåts inte trafik via det offentliga gränssnittet och privata slutpunktsanslutningar är den exklusiva åtkomstmetoden.

properties.replicaCount

integer

1

Antalet repliker i söktjänsten. Om det anges måste det vara ett värde mellan 1 och 12 för standard-SKU:er eller mellan 1 och 3 för grundläggande SKU.

properties.semanticSearch

SearchSemanticSearch

Anger alternativ som styr tillgängligheten för semantisk sökning. Den här konfigurationen är endast möjlig för vissa sök-SKU:er på vissa platser.

properties.sharedPrivateLinkResources

SharedPrivateLinkResource[]

Listan över delade privata länkresurser som hanteras av söktjänsten.

properties.status

SearchServiceStatus

Söktjänstens status. Möjliga värden är: "körs": Söktjänsten körs och inga etableringsåtgärder pågår. "etablering": Söktjänsten etableras eller skalas upp eller ned. "ta bort": Söktjänsten tas bort. "degraderad": Söktjänsten är degraderad. Detta kan inträffa när de underliggande sökenheterna inte är felfria. Söktjänsten är troligen i drift, men prestandan kan vara långsam och vissa begäranden kan tas bort. "disabled": Söktjänsten är inaktiverad. I det här tillståndet avvisar tjänsten alla API-begäranden. "error": Söktjänsten är i ett feltillstånd. Om tjänsten är i degraderat, inaktiverat eller feltillstånd undersöker Microsoft aktivt det underliggande problemet. Dedikerade tjänster i dessa tillstånd kan fortfarande debiteras baserat på antalet etablerade sökenheter.

properties.statusDetails

string

Information om söktjänstens status.

sku

Sku

SKU:n för söktjänsten, som bestämmer faktureringshastigheten och kapacitetsgränserna. Den här egenskapen krävs när du skapar en ny söktjänst.

tags

object

Taggar som hjälper dig att kategorisera resursen i Azure Portal.

type

string

Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

SharedPrivateLinkResource

Beskriver en delad Private Link resurs som hanteras av söktjänsten.

Name Typ Description
id

string

Fullständigt kvalificerat resurs-ID för resursen. Exempel – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Namnet på resursen

properties

SharedPrivateLinkResourceProperties

Beskriver egenskaperna för en delad Private Link resurs som hanteras av söktjänsten.

type

string

Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

SharedPrivateLinkResourceProperties

Beskriver egenskaperna för en befintlig delad Private Link resurs som hanteras av söktjänsten.

Name Typ Description
groupId

string

Grupp-ID:t från resursprovidern som den delade privata länkresursen är till för.

privateLinkResourceId

string

Resurs-ID:t för resursen som den delade privata länkresursen är till för.

provisioningState

SharedPrivateLinkResourceProvisioningState

Etableringstillståndet för resursen för den delade privata länken. Giltiga värden är Uppdatera, Ta bort, Misslyckades, Lyckades eller Ofullständig.

requestMessage

string

Begärandemeddelandet för att begära godkännande av resursen för delad privat länk.

resourceRegion

string

Valfritt. Kan användas för att ange azure-Resource Manager plats för resursen som en delad privat länk ska skapas till. Detta krävs endast för de resurser vars DNS-konfiguration är regional (till exempel Azure Kubernetes Service).

status

SharedPrivateLinkResourceStatus

Status för resursen för den delade privata länken. Giltiga värden är Väntande, Godkänd, Avvisad eller Frånkopplad.

SharedPrivateLinkResourceProvisioningState

Etableringstillståndet för resursen för delad privat länk. Giltiga värden är Uppdatera, Ta bort, Misslyckades, Lyckades eller Ofullständig.

Name Typ Description
Deleting

string

Failed

string

Incomplete

string

Succeeded

string

Updating

string

SharedPrivateLinkResourceStatus

Status för resursen för delad privat länk. Giltiga värden är Väntar, Godkänd, Avvisad eller Frånkopplad.

Name Typ Description
Approved

string

Disconnected

string

Pending

string

Rejected

string

Sku

Definierar SKU:n för en söktjänst, som avgör faktureringshastighet och kapacitetsgränser.

Name Typ Description
name

SkuName

SKU:n för söktjänsten. Giltiga värden är: "kostnadsfri": Delad tjänst. "basic": Dedikerad tjänst med upp till 3 repliker. Standard: Dedikerad tjänst med upp till 12 partitioner och 12 repliker. "standard2": Liknar standard, men med mer kapacitet per sökenhet. "standard3": Det största standarderbjudandet med upp till 12 partitioner och 12 repliker (eller upp till 3 partitioner med fler index om du också ställer in egenskapen hostingMode på "highDensity"). "storage_optimized_l1": Stöder 1 TB per partition, upp till 12 partitioner. "storage_optimized_l2": Stöder 2 TB per partition, upp till 12 partitioner."

SkuName

SKU:n för söktjänsten. Giltiga värden är: "kostnadsfri": Delad tjänst. "basic": Dedikerad tjänst med upp till 3 repliker. Standard: Dedikerad tjänst med upp till 12 partitioner och 12 repliker. "standard2": Liknar standard, men med mer kapacitet per sökenhet. "standard3": Det största standarderbjudandet med upp till 12 partitioner och 12 repliker (eller upp till 3 partitioner med fler index om du också ställer in egenskapen hostingMode till "highDensity"). "storage_optimized_l1": Stöder 1 TB per partition, upp till 12 partitioner. "storage_optimized_l2": Stöder 2 TB per partition, upp till 12 partitioner.

Name Typ Description
basic

string

Fakturerbar nivå för en dedikerad tjänst med upp till 3 repliker.

free

string

Kostnadsfri nivå, utan SLA-garantier och en delmängd av de funktioner som erbjuds på fakturerbara nivåer.

standard

string

Fakturerbar nivå för en dedikerad tjänst med upp till 12 partitioner och 12 repliker.

standard2

string

Liknar "standard", men med mer kapacitet per sökenhet.

standard3

string

Det största standarderbjudandet med upp till 12 partitioner och 12 repliker (eller upp till 3 partitioner med fler index om du också ställer in egenskapen hostingMode till "highDensity").

storage_optimized_l1

string

Fakturerbar nivå för en dedikerad tjänst som stöder 1 TB per partition, upp till 12 partitioner.

storage_optimized_l2

string

Fakturerbar nivå för en dedikerad tjänst som stöder 2 TB per partition, upp till 12 partitioner.