Dela via

Services - Create Or Update

  • Referens
Tjänst:
Search Management
API-version:
2024-03-01-preview

Skapar eller uppdaterar en söktjänst i den angivna resursgruppen. Om söktjänsten redan finns uppdateras alla egenskaper med de angivna värdena.

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

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å Azure AI-tjänsten Search att skapa eller uppdatera. tjänsten Search namn får bara innehålla gemener, siffror eller bindestreck, kan inte använda bindestreck som de två första eller sista tecknen, får inte innehålla på varandra följande bindestreck och måste vara mellan 2 och 60 tecken långt. tjänsten Search namn måste vara globalt unika eftersom de ingår i tjänstens URI (https://.search.windows.net). Du kan inte ändra tjänstnamnet när tjänsten har skapats.
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:et 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 Obligatorisk Typ Description
location True

string

Den geo-plats där resursen finns
identity

Identity

Resursens identitet.
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.disabledDataExfiltrationOptions

SearchDisabledDataExfiltrationOption[]

En lista över dataexfiltreringsscenarier som uttryckligen inte tillåts för söktjänsten. För närvarande är det enda värdet som stöds "Alla" för att inaktivera alla möjliga dataexportscenarier med mer detaljerade kontroller som planeras för framtiden.
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. 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 Azure AI-tjänsten Search 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 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.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 inställningen är "inaktiverad" tillåts inte trafik via det offentliga gränssnittet och privata slutpunktsanslutningar är den exklusiva åtkomstmetoden.
properties.replicaCount

integer

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 Azure AI Search-SKU:er på vissa platser.
sku

Sku

SKU:n för söktjänsten, som avgör prisnivå och kapacitetsgränser. Den här egenskapen krävs när du skapar en ny söktjänst.
tags

object

Resurstaggar.

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 kontrollera statusen för en skalningsåtgärd via egenskapen provisioningState för en Get Service-begäran.
201 Created

SearchService

Om du begärde att en kostnadsfri söktjänst skulle skapas är tjänsten nu etablerad och redo att användas, med förbehåll för DNS-spridningsfördröjning. För andra SKU-typer sker etablering asynkront. Du kan kontrollera statusen för en skalningsåtgärd via egenskapen provisioningState för en Get Service-begäran.
Other Status Codes

CloudError

HTTP 400 (felaktig begäran): Det angivna tjänstnamnet eller tjänstdefinitionen är ogiltig. 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

Anger ett implicit beviljandeflöde som stöds på Microsoft Identity-plattformen.

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

Omfattningar

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

SearchCreateOrUpdateService
SearchCreateOrUpdateServiceAuthOptions
SearchCreateOrUpdateServiceDisableLocalAuth
SearchCreateOrUpdateServiceToAllowAccessFromPrivateEndpoints
SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPs
SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPsAndBypass
SearchCreateOrUpdateServiceWithCmkEnforcement
SearchCreateOrUpdateServiceWithDataExfiltration
SearchCreateOrUpdateServiceWithIdentity
SearchCreateOrUpdateWithSemanticSearch

SearchCreateOrUpdateService

Exempelbegäran

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2024-03-01-preview

{
  "location": "westus",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "hostingMode": "default"
  }
}

Exempelsvar

Statuskod:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  }
}
Statuskod:
201 
{
  "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": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  }
}

SearchCreateOrUpdateServiceAuthOptions

Exempelbegäran

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2024-03-01-preview

{
  "location": "westus",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "hostingMode": "default",
    "authOptions": {
      "aadOrApiKey": {
        "aadAuthFailureMode": "http401WithBearerChallenge"
      }
    }
  }
}

Exempelsvar

Statuskod:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "authOptions": {
      "aadOrApiKey": {
        "aadAuthFailureMode": "http401WithBearerChallenge"
      }
    },
    "disabledDataExfiltrationOptions": []
  }
}
Statuskod:
201 
{
  "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": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "authOptions": {
      "aadOrApiKey": {
        "aadAuthFailureMode": "http401WithBearerChallenge"
      }
    },
    "disabledDataExfiltrationOptions": []
  }
}

SearchCreateOrUpdateServiceDisableLocalAuth

Exempelbegäran

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2024-03-01-preview

{
  "location": "westus",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "hostingMode": "default",
    "disableLocalAuth": true
  }
}

Exempelsvar

Statuskod:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": true,
    "authOptions": null,
    "disabledDataExfiltrationOptions": []
  }
}
Statuskod:
201 
{
  "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": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": true,
    "authOptions": null,
    "disabledDataExfiltrationOptions": []
  }
}

SearchCreateOrUpdateServiceToAllowAccessFromPrivateEndpoints

Exempelbegäran

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2024-03-01-preview

{
  "location": "westus",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "publicNetworkAccess": "disabled",
    "hostingMode": "default"
  }
}

Exempelsvar

Statuskod:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "disabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  }
}
Statuskod:
201 
{
  "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": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "disabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  }
}

SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPs

Exempelbegäran

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2024-03-01-preview

{
  "location": "westus",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 1,
    "partitionCount": 1,
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "123.4.5.6"
        },
        {
          "value": "123.4.6.0/18"
        }
      ]
    },
    "hostingMode": "default"
  }
}

Exempelsvar

Statuskod:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 1,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "123.4.5.6"
        },
        {
          "value": "123.4.6.0/18"
        }
      ]
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  }
}
Statuskod:
201 
{
  "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": 1,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "123.4.5.6"
        },
        {
          "value": "123.4.6.0/18"
        }
      ]
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  }
}

SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPsAndBypass

Exempelbegäran

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2024-03-01-preview

{
  "location": "westus",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 1,
    "partitionCount": 1,
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "123.4.5.6"
        },
        {
          "value": "123.4.6.0/18"
        }
      ],
      "bypass": "AzurePortal"
    },
    "hostingMode": "default"
  }
}

Exempelsvar

Statuskod:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 1,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "123.4.5.6"
        },
        {
          "value": "123.4.6.0/18"
        }
      ],
      "bypass": "AzurePortal"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  }
}
Statuskod:
201 
{
  "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": 1,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "123.4.5.6"
        },
        {
          "value": "123.4.6.0/18"
        }
      ],
      "bypass": "AzurePortal"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  }
}

SearchCreateOrUpdateServiceWithCmkEnforcement

Exempelbegäran

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2024-03-01-preview

{
  "location": "westus",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "hostingMode": "default",
    "encryptionWithCmk": {
      "enforcement": "Enabled"
    }
  }
}

Exempelsvar

Statuskod:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Enabled",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  }
}
Statuskod:
201 
{
  "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": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Enabled",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  }
}

SearchCreateOrUpdateServiceWithDataExfiltration

Exempelbegäran

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2024-03-01-preview

{
  "location": "westus",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "hostingMode": "default",
    "disabledDataExfiltrationOptions": [
      "All"
    ]
  }
}

Exempelsvar

Statuskod:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": [
      "All"
    ]
  }
}
Statuskod:
201 
{
  "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": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": [
      "All"
    ]
  }
}

SearchCreateOrUpdateServiceWithIdentity

Exempelbegäran

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2024-03-01-preview

{
  "location": "westus",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "hostingMode": "default"
  },
  "identity": {
    "type": "SystemAssigned, UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/user-mi": {}
    }
  }
}

Exempelsvar

Statuskod:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  },
  "identity": {
    "type": "SystemAssigned, UserAssigned",
    "principalId": "9d1e1f18-2122-4988-a11c-878782e40a5c",
    "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/user-mi": {
        "clientId": "cd1dcac8-82dd-45b5-9aed-76795d529f6b",
        "principalId": "24e07a75-1286-41e5-a15d-ded85ec3acd7"
      }
    }
  }
}
Statuskod:
201 
{
  "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": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": []
  },
  "identity": {
    "type": "SystemAssigned, UserAssigned",
    "principalId": "9d1e1f18-2122-4988-a11c-878782e40a5c",
    "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd",
    "userAssignedIdentities": {
      "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/user-mi": {
        "clientId": "cd1dcac8-82dd-45b5-9aed-76795d529f6b",
        "principalId": "24e07a75-1286-41e5-a15d-ded85ec3acd7"
      }
    }
  }
}

SearchCreateOrUpdateWithSemanticSearch

Exempelbegäran

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2024-03-01-preview

{
  "location": "westus",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "hostingMode": "default",
    "semanticSearch": "free"
  }
}

Exempelsvar

Statuskod:
200 
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": [],
    "semanticSearch": "free"
  }
}
Statuskod:
201 
{
  "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": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": [],
    "semanticSearch": "free"
  }
}

Definitioner

Name Description
AadAuthFailureMode

Beskriver vilket svar dataplanets API 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 kundhanterade nycklar.
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".
Identity

Information om söktjänstens identitet. Ett null-värde anger att söktjänsten inte har någon tilldelad identitet.
IdentityType

Den typ av identitet som används för resursen. Typen "SystemAssigned, UserAssigned" innehåller både en identitet som skapats av systemet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter från tjänsten.
IpRule

IP-begränsningsregeln för Azure AI-tjänsten Search.
NetworkRuleSet

Nätverksspecifika regler som avgör hur Azure AI-tjänsten Search kan nås.
PrivateEndpoint

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

Beskriver en befintlig privat slutpunktsanslutning till Azure AI-tjänsten Search.
PrivateEndpointConnectionProperties

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

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

Beskriver det aktuella tillståndet för en befintlig Azure Private Link tjänstanslutning till den privata slutpunkten.
PrivateLinkServiceConnectionStatus

Status för den privata länktjänstens anslutning. Giltiga värden är Väntande, 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 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.
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.
SearchBypass

Möjliga ursprung för inkommande trafik som kan kringgå de regler som definieras i avsnittet "ipRules".
SearchDisabledDataExfiltrationOption

En lista över dataexfiltreringsscenarier som uttryckligen inte tillåts för söktjänsten. För närvarande är det enda värde som stöds "Alla" för att inaktivera alla möjliga dataexportscenarier med mer detaljerade kontroller som planeras för framtiden.
SearchEncryptionComplianceStatus

Returnerar status för söktjänstens kompatibilitet med avseende på objekt som inte är CMK-krypterade. Om en tjänst har fler än ett okrypterat objekt och framtvingande är aktiverat markeras tjänsten som inkompatibel.
SearchEncryptionWithCmk

Beskriver hur en söktjänst ska framtvinga efterlevnad om den hittar objekt som inte är krypterade med den kundhanterade nyckeln.
SearchSemanticSearch

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

Beskriver en Azure AI-tjänsten Search 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. "stoppad": Söktjänsten finns i en prenumeration som är inaktiverad. Om tjänsten har degraderats, inaktiverats eller feltillståndet innebär det att Azure AI Search-teamet aktivt undersöker det underliggande problemet. Dedikerade tjänster i dessa tillstånd kan fortfarande debiteras baserat på antalet etablerade sökenheter.
SharedPrivateLinkResource

Beskriver en resurs för delad privat länk som hanteras av Azure AI-tjänsten Search.
SharedPrivateLinkResourceProperties

Beskriver egenskaperna för en befintlig delad privat länkresurs som hanteras av Azure AI-tjänsten Search.
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.
SharedPrivateLinkResourceStatus

Status för resursen för den delade privata länken. Giltiga värden är Väntande, 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 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."
UserAssignedManagedIdentity

Information om den användartilldelade hanterade identiteten som tilldelats söktjänsten.

AadAuthFailureMode

Beskriver vilket svar dataplanets API 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 en HTTP-statuskod på 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.
message

string

En kort beskrivning av felet som antyder vad som gick fel (information/felsökningsinformation finns i egenskapen "error.message").

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 dataplans-API:et 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 kundhanterade nycklar.

Name Typ Description
encryptionComplianceStatus

SearchEncryptionComplianceStatus

Returnerar status för söktjänstens kompatibilitet med avseende på objekt som inte är CMK-krypterade. Om en tjänst har fler än ett okrypterat objekt och framtvingande är aktiverat markeras tjänsten som inkompatibel.
enforcement

SearchEncryptionWithCmk

Beskriver hur en söktjänst ska framtvinga efterlevnad om den hittar objekt som inte är krypterade med den kundhanterade nyckeln.

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

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

Information om söktjänstens identitet. Ett null-värde anger att söktjänsten inte har någon tilldelad identitet.

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

Den typ av identitet som används för resursen. Typen "SystemAssigned, UserAssigned" innehåller både en identitet som skapats av systemet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter från tjänsten.
userAssignedIdentities

<string,  UserAssignedManagedIdentity>

Listan över användaridentiteter som är associerade med resursen. Nyckelreferenserna för användaridentitetsordlistan är ARM-resurs-ID:er i formatet: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

IdentityType

Den typ av identitet som används för resursen. Typen "SystemAssigned, UserAssigned" innehåller både en identitet som skapats av systemet och en uppsättning användartilldelade identiteter. Typen "Ingen" tar bort alla identiteter från tjänsten.

Name Typ Description
None

string

Anger att alla identiteter som är associerade med söktjänsten måste tas bort.
SystemAssigned

string

Anger att den systemtilldelade identiteten för söktjänsten ska aktiveras.
SystemAssigned, UserAssigned

string

Anger att systemtilldelad identitet för söktjänsten aktiveras tillsammans med tilldelningen av en eller flera användartilldelade identiteter.
UserAssigned

string

Anger att en eller flera användartilldelade identiteter kommer att tilldelas till söktjänsten.

IpRule

IP-begränsningsregeln för Azure AI-tjänsten Search.

Name Typ Description
value

string

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

NetworkRuleSet

Nätverksspecifika regler som avgör hur Azure AI-tjänsten Search kan nås.

Name Typ Description
bypass

SearchBypass

Möjliga ursprung för inkommande trafik som kan kringgå de regler som definieras i avsnittet "ipRules".
ipRules

IpRule[]

En lista över IP-begränsningsregler som definierar de inkommande nätverken med åtkomst till söktjänstens slutpunkt. Under tiden blockeras alla andra offentliga IP-nätverk av brandväggen. Dessa begränsningsregler tillämpas endast när "publicNetworkAccess" för söktjänsten är "aktiverad". Annars tillåts inte trafik via offentligt gränssnitt ens med några offentliga IP-regler, och privata slutpunktsanslutningar skulle vara metoden för exklusiv åtkomst.

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 Azure AI-tjänsten Search.

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 Azure AI-tjänsten Search.
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 för Den Azure-resurs som tjänsten private link ä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 Azure Private Link-tjänstanslutning till den privata slutpunkten.
provisioningState

PrivateLinkServiceConnectionProvisioningState

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

PrivateLinkServiceConnectionProvisioningState

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

Name Typ Description
Canceled

string

Etableringsbegäran för den privata länktjänstens anslutningsresurs har avbrutits.
Deleting

string

Den privata länktjänstanslutningen håller på att tas bort.
Failed

string

Det gick inte att etablera eller ta bort den privata länktjänstens anslutning.
Incomplete

string

Etableringsbegäran för den privata länktjänstens anslutningsresurs har accepterats, men processen för att skapa har inte påbörjats ännu.
Succeeded

string

Den privata länktjänstanslutningen har slutfört etableringen och är klar för godkännande.
Updating

string

Den privata länktjänstanslutningen 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 Azure Private Link tjänstanslutning till den privata slutpunkten.

Name Typ Standardvärde Description
actionsRequired

string

None

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

string

Beskrivningen av anslutningstillståndet för tjänsten private link.
status

PrivateLinkServiceConnectionStatus

Status för den privata länktjänstens anslutning. Giltiga värden är Väntande, Godkänd, Avvisad eller Frånkopplad.

PrivateLinkServiceConnectionStatus

Status för den privata länktjänstens anslutning. Giltiga värden är Väntande, Godkänd, Avvisad eller Frånkopplad.

Name Typ Description
Approved

string

Den privata slutpunktsanslutningen är godkänd och är redo 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 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.

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 värdet är "inaktiverat" tillåts inte trafik via offentligt gränssnitt, och privata slutpunktsanslutningar skulle vara metoden för exklusiv åtkomst.

Name Typ Description
disabled

string

Söktjänsten är inte tillgänglig från trafik som kommer från det offentliga Internet. Åtkomst tillåts endast via godkända privata slutpunktsanslutningar.
enabled

string

Söktjänsten är tillgänglig från trafik som kommer från det offentliga Internet.

SearchBypass

Möjliga ursprung för inkommande trafik som kan kringgå de regler som definieras i avsnittet "ipRules".

Name Typ Description
AzurePortal

string

Anger att begäranden som kommer från Azure Portal kan kringgå de regler som definieras i avsnittet "ipRules".
None

string

Anger att inget ursprung kan kringgå reglerna som definieras i avsnittet "ipRules". Det här är standardinställningen.

SearchDisabledDataExfiltrationOption

En lista över dataexfiltreringsscenarier som uttryckligen inte tillåts för söktjänsten. För närvarande är det enda värde som stöds "Alla" för att inaktivera alla möjliga dataexportscenarier med mer detaljerade kontroller som planeras för framtiden.

Name Typ Description
All

string

Anger att alla scenarier för dataexfiltrering är inaktiverade.

SearchEncryptionComplianceStatus

Returnerar status för söktjänstens kompatibilitet med avseende på objekt som inte är CMK-krypterade. Om en tjänst har fler än ett okrypterat objekt och framtvingande är aktiverat markeras tjänsten som inkompatibel.

Name Typ Description
Compliant

string

Anger att söktjänsten är kompatibel, antingen på grund av att antalet icke-CMK-krypterade objekt är noll eller att framtvingande är inaktiverat.
NonCompliant

string

Anger att söktjänsten har fler än ett icke-CMK-krypterat objekt.

SearchEncryptionWithCmk

Beskriver hur en söktjänst ska framtvinga efterlevnad om den hittar objekt som inte är krypterade med den kundhanterade nyckeln.

Name Typ Description
Disabled

string

Ingen tillämpning av kundhanterad nyckelkryptering görs. Endast den inbyggda tjänsthanterade krypteringen används.
Enabled

string

tjänsten Search markeras som icke-kompatibla om ett eller flera objekt inte krypteras med en kundhanterad nyckel.
Unspecified

string

Tvingande princip har inte uttryckligen angetts, och 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 Azure AI Search-SKU:er på vissa platser.

Name Typ Description
disabled

string

Anger att semantisk reranker är inaktiverad för söktjänsten. Det här är standardinställningen.
free

string

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

string

Aktiverar semantisk reranker i en söktjänst som en fakturerbar funktion, med högre dataflöde och volym med semantiskt rangordnade frågor.

SearchService

Beskriver en Azure AI-tjänsten Search 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.disabledDataExfiltrationOptions

SearchDisabledDataExfiltrationOption[]

En lista över dataexfiltreringsscenarier som uttryckligen inte tillåts för söktjänsten. För närvarande är det enda värde som stöds "Alla" för att inaktivera alla möjliga dataexportscenarier med mer detaljerade kontroller som planeras för framtiden.
properties.eTag

string

En systemgenererad egenskap som representerar tjänstens etag som kan vara för optimistisk samtidighetskontroll under uppdateringar.
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 Azure AI-tjänsten Search 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 Azure AI-tjänsten Search.
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 SKU:er för Azure AI Search på vissa platser.
properties.sharedPrivateLinkResources

SharedPrivateLinkResource[]

Listan över delade privata länkresurser som hanteras av Azure AI-tjänsten Search.
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. "stoppad": Söktjänsten finns i en prenumeration som är inaktiverad. Om tjänsten har degraderats, inaktiverats eller feltillståndet innebär det att Azure AI Search-teamet aktivt undersöker 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 prisnivå och kapacitetsgränser. 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. "stoppad": Söktjänsten finns i en prenumeration som är inaktiverad. Om tjänsten har degraderats, inaktiverats eller feltillståndet innebär det att Azure AI Search-teamet aktivt undersöker 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.
stopped

string

Söktjänsten finns i en prenumeration som är inaktiverad.

SharedPrivateLinkResource

Beskriver en resurs för delad privat länk som hanteras av Azure AI-tjänsten Search.

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 privat länkresurs som hanteras av Azure AI-tjänsten Search.
type

string

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

SharedPrivateLinkResourceProperties

Beskriver egenskaperna för en befintlig delad privat länkresurs som hanteras av Azure AI-tjänsten Search.

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 delad privat länk. Giltiga värden är Uppdatera, Ta bort, Misslyckades, Lyckades eller Ofullständig.
requestMessage

string

Meddelandet 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 skapas för. 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 delad privat länk. Giltiga värden är Väntar, Godkänd, Avvisad eller Frånkopplad.

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.

Name Typ Description
Deleting

string

Resursen för den delade privata länken håller på att tas bort.
Failed

string

Resursen för den delade privata länken kunde inte etableras eller tas bort.
Incomplete

string

Etableringsbegäran för resursen för den delade privata länken har accepterats, men processen för att skapa har inte påbörjats ännu.
Succeeded

string

Den delade privata länkresursen har slutfört etableringen och är redo för godkännande.
Updating

string

Den delade privata länkresursen håller på att skapas tillsammans med andra resurser för att den ska fungera fullt ut.

SharedPrivateLinkResourceStatus

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

Name Typ Description
Approved

string

Resursen för den delade privata länken är godkänd och är redo att användas.
Disconnected

string

Resursen för den delade privata länken har tagits bort från tjänsten.
Pending

string

Resursen för den delade privata länken har skapats och väntar på godkännande.
Rejected

string

Resursen för den delade privata länken har avvisats och kan inte användas.

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

Name Typ Description
basic

string

Fakturerbar nivå för en dedikerad tjänst som har 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 som har 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å anger 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.

UserAssignedManagedIdentity

Information om den användartilldelade hanterade identiteten som tilldelats söktjänsten.

Name Typ Description
clientId

string

Klient-ID för användartilldelad identitet.
principalId

string

Huvud-ID för användartilldelad identitet.