Services - Update

Aktualizuje existující vyhledávací službu v dané skupině prostředků.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
resourceGroupName
path True

string

Název skupiny prostředků v aktuálním předplatném. Tuto hodnotu můžete získat z rozhraní API Azure Resource Manageru nebo portálu.

searchServiceName
path True

string

Název služby Azure AI Search, která se má aktualizovat.

subscriptionId
path True

string

Jedinečný identifikátor předplatného Microsoft Azure. Tuto hodnotu můžete získat z rozhraní API Azure Resource Manageru nebo portálu.

api-version
query True

string

Verze rozhraní API, která se má použít pro každý požadavek.

Hlavička požadavku

Name Vyžadováno Typ Description
x-ms-client-request-id

string (uuid)

Hodnota GUID vygenerovaná klientem, která identifikuje tento požadavek. Pokud je zadáno, budou tyto informace zahrnuty do informací o odpovědích jako způsob, jak sledovat požadavek.

Text požadavku

Name Typ Description
identity

Identity

Podrobnosti o identitě vyhledávací služby Hodnota null označuje, že vyhledávací služba nemá přiřazenou žádnou identitu.

location

string

Zeměpisné umístění prostředku. Musí to být jedna z podporovaných a registrovaných geografických oblastí Azure (například USA – západ, USA – východ, Jihovýchodní Asie atd.). Tato vlastnost se vyžaduje při vytváření nového prostředku.

properties.authOptions

DataPlaneAuthOptions

Definuje možnosti, jak rozhraní API roviny dat vyhledávací služby ověřuje požadavky. Tuto možnost nelze nastavit, pokud je možnost disableLocalAuth nastavená na hodnotu true.

properties.computeType

ComputeType

Nakonfigurujte tuto vlastnost tak, aby podporovala vyhledávací službu pomocí výchozího výpočetního prostředí nebo služby Azure Confidential Compute.

properties.disableLocalAuth

boolean

Pokud je nastavená hodnota true, nebudou volání vyhledávací služby povolena k ověřování pomocí klíčů rozhraní API. Tuto hodnotu nelze nastavit na hodnotu true, pokud jsou definovány hodnoty dataPlaneAuthOptions.

properties.disabledDataExfiltrationOptions

SearchDisabledDataExfiltrationOption[]

Seznamscénářůch V současné době je jedinou podporovanou hodnotou "Vše", která zakáže všechny možné scénáře exportu dat s jemněji odstupňovanými ovládacími prvky plánovanými pro budoucnost.

properties.encryptionWithCmk

EncryptionWithCmk

Určuje všechny zásady týkající se šifrování prostředků (například indexů) pomocí klíčů správce zákazníků v rámci vyhledávací služby.

properties.endpoint

string (uri)

Koncový bod služby Azure AI Search.

properties.hostingMode

HostingMode

Platí pouze pro skladovou položku Standard3. Tuto vlastnost můžete nastavit tak, aby umožňovala až 3 oddíly s vysokou hustotou, které umožňují až 1 000 indexů, což je mnohem vyšší než maximální povolený počet indexů pro jakoukoli jinou skladovou položku. U skladové položky Standard3 je tato hodnota buď výchozí, nebo highDensity. Pro všechny ostatní skladové položky musí být tato hodnota výchozí.

properties.networkRuleSet

NetworkRuleSet

Pravidla specifická pro síť, která určují, jak může být dosaženo služby Azure AI Search.

properties.partitionCount

integer (int32)

minimum: 1
maximum: 12

Počet oddílů ve vyhledávací službě; pokud je zadaný, může to být 1, 2, 3, 4, 6 nebo 12. Hodnoty větší než 1 jsou platné pouze pro standardní skladové položky. Pro služby standard3 s hostingMode nastaveným na highDensity jsou povolené hodnoty mezi 1 a 3.

properties.publicNetworkAccess

PublicNetworkAccess

Tuto hodnotu je možné nastavit na povoleno, aby nedocházelo k zásadním změnám stávajících prostředků a šablon zákazníků. Pokud je tato možnost nastavená na zakázáno, provoz přes veřejné rozhraní není povolený a připojení privátního koncového bodu by byla výhradní metodou přístupu.

properties.replicaCount

integer (int32)

minimum: 1
maximum: 12

Počet replik ve vyhledávací službě. Pokud je zadáno, musí být hodnota mezi 1 a 12 včetně pro standardní skladové položky nebo mezi 1 a 3 včetně pro základní skladovou položku.

properties.semanticSearch

SearchSemanticSearch

Nastaví možnosti, které řídí dostupnost sémantického vyhledávání. Tato konfigurace je možná jenom pro určité skladové položky služby Azure AI Search v určitých umístěních.

sku

Sku

Skladová položka vyhledávací služby, která určuje cenové úrovně a limity kapacity. Tato vlastnost se vyžaduje při vytváření nové vyhledávací služby.

tags

object

Značky, které pomáhají kategorizovat prostředek na webu Azure Portal.

Odpovědi

Name Typ Description
200 OK

SearchService

Stávající definice služby byla úspěšně aktualizována. Pokud jste změnili počet replik nebo oddílů, operace škálování proběhne asynchronně. Stav operace škálování můžete zkontrolovat pomocí vlastnosti provisioningState požadavku Get Service.

Other Status Codes

CloudError

HTTP 400 (Chybný požadavek): Daná definice služby je neplatná nebo jste se pokusili změnit vlastnost, která je neměnná. Podrobnosti najdete v kódu chyby a zprávě v odpovědi. HTTP 404 (Nenalezena): Nepodařilo se najít předplatné nebo skupinu prostředků. HTTP 409 (konflikt): Zadané předplatné je zakázané.

Zabezpečení

azure_auth

Určuje implicitní tok udělení, který se podporuje na platformě Microsoft Identity Platform.

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name Description
user_impersonation zosobnění uživatelského účtu

Příklady

SearchUpdateService
SearchUpdateServiceAuthOptions
SearchUpdateServiceDisableLocalAuth
SearchUpdateServiceToAllowAccessFromPrivateEndpoints
SearchUpdateServiceToAllowAccessFromPublicCustomIPs
SearchUpdateServiceToAllowAccessFromPublicCustomIPsAndBypass
SearchUpdateServiceToRemoveIdentity
SearchUpdateServiceWithCmkEnforcement
SearchUpdateServiceWithDataExfiltration
SearchUpdateServiceWithSemanticSearch
SearchUpdateServiceWithSku

SearchUpdateService

Ukázkový požadavek

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

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

Ukázková odpověď

{
  "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,
    "endpoint": "https://mysearchservice.search.windows.net/",
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "computeType": "default",
    "provisioningState": "Provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": [],
    "upgradeAvailable": false,
    "serviceUpgradeDate": null
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}

SearchUpdateServiceAuthOptions

Ukázkový požadavek

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

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

Ukázková odpověď

{
  "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,
    "endpoint": "https://mysearchservice.search.windows.net/",
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "computeType": "default",
    "provisioningState": "Provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "authOptions": {
      "aadOrApiKey": {
        "aadAuthFailureMode": "http401WithBearerChallenge"
      }
    },
    "disabledDataExfiltrationOptions": [],
    "upgradeAvailable": false,
    "serviceUpgradeDate": null
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}

SearchUpdateServiceDisableLocalAuth

Ukázkový požadavek

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

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

Ukázková odpověď

{
  "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,
    "endpoint": "https://mysearchservice.search.windows.net/",
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "computeType": "default",
    "provisioningState": "Provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": true,
    "authOptions": null,
    "disabledDataExfiltrationOptions": [],
    "upgradeAvailable": false,
    "serviceUpgradeDate": null
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}

SearchUpdateServiceToAllowAccessFromPrivateEndpoints

Ukázkový požadavek

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

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

Ukázková odpověď

{
  "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,
    "endpoint": "https://mysearchservice.search.windows.net/",
    "status": "running",
    "statusDetails": "",
    "hostingMode": "default",
    "computeType": "default",
    "provisioningState": "Succeeded",
    "publicNetworkAccess": "disabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": [],
    "upgradeAvailable": false,
    "serviceUpgradeDate": null
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}

SearchUpdateServiceToAllowAccessFromPublicCustomIPs

Ukázkový požadavek

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

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

Ukázková odpověď

{
  "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,
    "endpoint": "https://mysearchservice.search.windows.net/",
    "status": "running",
    "statusDetails": "",
    "hostingMode": "default",
    "computeType": "default",
    "provisioningState": "Succeeded",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "10.2.3.4"
        }
      ]
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": [],
    "upgradeAvailable": false,
    "serviceUpgradeDate": null
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}

SearchUpdateServiceToAllowAccessFromPublicCustomIPsAndBypass

Ukázkový požadavek

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

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

Ukázková odpověď

{
  "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,
    "endpoint": "https://mysearchservice.search.windows.net/",
    "status": "running",
    "statusDetails": "",
    "hostingMode": "default",
    "computeType": "default",
    "provisioningState": "Succeeded",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [
        {
          "value": "10.2.3.4"
        }
      ],
      "bypass": "AzurePortal"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": [],
    "upgradeAvailable": false,
    "serviceUpgradeDate": null
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}

SearchUpdateServiceToRemoveIdentity

Ukázkový požadavek

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

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

Ukázková odpověď

{
  "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,
    "endpoint": "https://mysearchservice.search.windows.net/",
    "status": "running",
    "statusDetails": "",
    "hostingMode": "default",
    "computeType": "default",
    "provisioningState": "Succeeded",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": [],
    "upgradeAvailable": false,
    "serviceUpgradeDate": null
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}

SearchUpdateServiceWithCmkEnforcement

Ukázkový požadavek

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

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

Ukázková odpověď

{
  "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,
    "endpoint": "https://mysearchservice.search.windows.net/",
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "computeType": "default",
    "provisioningState": "Provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Enabled",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": [],
    "upgradeAvailable": false,
    "serviceUpgradeDate": null
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}

SearchUpdateServiceWithDataExfiltration

Ukázkový požadavek

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

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

Ukázková odpověď

{
  "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,
    "endpoint": "https://mysearchservice.search.windows.net/",
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "computeType": "default",
    "provisioningState": "Provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": [
      "All"
    ],
    "upgradeAvailable": false,
    "serviceUpgradeDate": null
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}

SearchUpdateServiceWithSemanticSearch

Ukázkový požadavek

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

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

Ukázková odpověď

{
  "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,
    "endpoint": "https://mysearchservice.search.windows.net/",
    "status": "provisioning",
    "statusDetails": "",
    "hostingMode": "default",
    "computeType": "default",
    "provisioningState": "Provisioning",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": [],
      "bypass": "None"
    },
    "privateEndpointConnections": [],
    "sharedPrivateLinkResources": [],
    "encryptionWithCmk": {
      "enforcement": "Unspecified",
      "encryptionComplianceStatus": "Compliant"
    },
    "disableLocalAuth": false,
    "authOptions": {
      "apiKeyOnly": {}
    },
    "disabledDataExfiltrationOptions": [],
    "semanticSearch": "standard",
    "upgradeAvailable": false,
    "serviceUpgradeDate": null
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}

SearchUpdateServiceWithSku

Ukázkový požadavek

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

{
  "tags": {
    "app-name": "My e-commerce app",
    "new-tag": "Adding a new tag"
  },
  "sku": {
    "name": "standard2"
  }
}

Ukázková odpověď

{
  "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": "standard2"
  },
  "properties": {
    "replicaCount": 1,
    "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": [],
    "upgradeAvailable": false,
    "serviceUpgradeDate": null
  },
  "systemData": {
    "createdBy": "My e-commerce app",
    "createdByType": "Application",
    "createdAt": "2024-01-01T00:00:00Z",
    "lastModifiedBy": "fakeuser@contoso.com",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-11-01T00:00:00Z"
  }
}

Definice

Name Description
AadAuthFailureMode

Popisuje, jaká odpověď rozhraní API roviny dat vyhledávací služby by odeslala požadavky, které selhaly při ověřování.

ApiKeyOnly

Označuje, že k ověřování je možné použít pouze klíč rozhraní API.

CloudError

Obsahuje informace o chybě rozhraní API.

CloudErrorBody

Popisuje konkrétní chybu rozhraní API s kódem chyby a zprávou.

ComputeType

Nakonfigurujte tuto vlastnost tak, aby podporovala vyhledávací službu pomocí výchozího výpočetního prostředí nebo služby Azure Confidential Compute.

createdByType

Typ identity, která prostředek vytvořila.

DataPlaneAadOrApiKeyAuthOption

Označuje, že k ověřování je možné použít klíč rozhraní API nebo přístupový token z tenanta Microsoft Entra ID.

DataPlaneAuthOptions

Definuje možnosti, jak vyhledávací služba ověřuje požadavek roviny dat. Tuto možnost nelze nastavit, pokud je možnost disableLocalAuth nastavená na hodnotu true.

EncryptionWithCmk

Popisuje zásadu, která určuje, jak se mají prostředky ve vyhledávací službě šifrovat pomocí klíčů spravovaných zákazníkem.

HostingMode

Platí pouze pro skladovou položku Standard3. Tuto vlastnost můžete nastavit tak, aby umožňovala až 3 oddíly s vysokou hustotou, které umožňují až 1 000 indexů, což je mnohem vyšší než maximální povolený počet indexů pro jakoukoli jinou skladovou položku. U skladové položky Standard3 je tato hodnota buď výchozí, nebo highDensity. Pro všechny ostatní skladové položky musí být tato hodnota výchozí.

Identity

Podrobnosti o identitě vyhledávací služby Hodnota null označuje, že vyhledávací služba nemá přiřazenou žádnou identitu.

IdentityType

Typ identity používané pro prostředek. Typ SystemAssigned, UserAssigned zahrnuje identitu vytvořenou systémem i sadu identit přiřazených uživatelem. Typ None odebere všechny identity ze služby.

IpRule

Pravidlo omezení IP služby Azure AI Search.

NetworkRuleSet

Pravidla specifická pro síť, která určují, jak může být dosaženo služby Azure AI Search.

PrivateEndpoint

Prostředek privátního koncového bodu od poskytovatele Microsoft.Network.

PrivateEndpointConnection

Popisuje stávající připojení privátního koncového bodu ke službě Azure AI Search.

PrivateEndpointConnectionProperties

Popisuje vlastnosti existujícího připojení privátního koncového bodu k vyhledávací službě.

PrivateLinkServiceConnectionProvisioningState

Stav zřizování připojení služby Private Link. Platné hodnoty jsou Aktualizace, Odstranění, Selhání, Úspěšné, Neúplné nebo Zrušené.

PrivateLinkServiceConnectionState

Popisuje aktuální stav existujícího připojení služby Azure Private Link k privátnímu koncovému bodu.

PrivateLinkServiceConnectionStatus

Stav připojení služby Private Link Platné hodnoty jsou Čekající, Schválené, Odmítnuté nebo Odpojené.

ProvisioningState

Stav poslední operace zřizování prováděné ve vyhledávací službě. Zřizování je zprostředkující stav, ke kterému dochází při vytváření kapacity služby. Po nastavení kapacity se stav zřizování změní na Úspěch nebo Selhání. Klientské aplikace můžou dotazovat stav zřizování (doporučený interval dotazování je od 30 sekund do jedné minuty) pomocí operace Get Search Service a zjistit, kdy je operace dokončena. Pokud používáte bezplatnou službu, tato hodnota se obvykle vrací jako úspěch přímo ve volání pro vytvoření vyhledávací služby. Důvodem je to, že bezplatná služba používá kapacitu, která je už nastavená.

PublicNetworkAccess

Tuto hodnotu je možné nastavit na povoleno, aby nedocházelo k zásadním změnám stávajících prostředků a šablon zákazníků. Pokud je tato možnost nastavená na zakázáno, provoz přes veřejné rozhraní není povolený a připojení privátního koncového bodu by byla výhradní metodou přístupu.

SearchBypass

Možný původ příchozího provozu, který může obejít pravidla definovaná v části "ipRules".

SearchDisabledDataExfiltrationOption

Seznamscénářůch V současné době je jedinou podporovanou hodnotou "Vše", která zakáže všechny možné scénáře exportu dat s jemněji odstupňovanými ovládacími prvky plánovanými pro budoucnost.

SearchEncryptionComplianceStatus

Vrátí stav dodržování předpisů vyhledávací služby s ohledem na nešifrované objekty CMK. Pokud má služba více než jeden nešifrovaný objekt a je povoleno vynucování, služba se označí jako nedodržující předpisy.

SearchEncryptionWithCmk

Popisuje, jak by vyhledávací služba měla vynutit dodržování předpisů, pokud najde objekty, které nejsou šifrované pomocí klíče spravovaného zákazníkem.

SearchSemanticSearch

Nastaví možnosti, které řídí dostupnost sémantického vyhledávání. Tato konfigurace je možná jenom pro určité skladové položky služby Azure AI Search v určitých umístěních.

SearchService

Popisuje službu Azure AI Search a její aktuální stav.

SearchServiceStatus

Stav vyhledávací služby. Mezi možné hodnoty patří: "running": Vyhledávací služba je spuštěná a neprobíhá žádné operace zřizování. Zřizování: Vyhledávací služba se zřizuje nebo škáluje nahoru nebo dolů. "odstranění": Vyhledávací služba se odstraňuje. Degradováno: Vyhledávací služba je degradovaná. K tomu může dojít v případě, že základní vyhledávací jednotky nejsou v pořádku. Vyhledávací služba je pravděpodobně funkční, ale výkon může být pomalý a některé požadavky se můžou vynechat. Zakázáno: Vyhledávací služba je zakázaná. V tomto stavu služba odmítne všechny požadavky rozhraní API. Chyba: Vyhledávací služba je ve stavu chyby. Zastaveno: Vyhledávací služba je v předplatném, které je zakázané. Pokud je vaše služba v degradovaných, zakázaných nebo chybových stavech, znamená to, že tým Azure AI Search aktivně prošetřuje základní problém. Vyhrazené služby v těchto stavech jsou stále zpoplatněné na základě počtu zřízených jednotek vyhledávání.

SearchServiceUpdate

Parametry používané k aktualizaci služby Azure AI Search.

SharedPrivateLinkResource

Popisuje sdílený prostředek privátního propojení spravovaný službou Azure AI Search.

SharedPrivateLinkResourceProperties

Popisuje vlastnosti existujícího sdíleného prostředku privátního propojení spravovaného službou Azure AI Search.

SharedPrivateLinkResourceProvisioningState

Stav zřizování sdíleného prostředku privátního propojení. Platné hodnoty jsou Aktualizace, Odstranění, Neúspěšné, Úspěšné nebo Neúplné.

SharedPrivateLinkResourceStatus

Stav sdíleného prostředku privátního propojení Platné hodnoty jsou Čekající, Schválené, Odmítnuté nebo Odpojené.

Sku

Definuje skladovou položku vyhledávací služby, která určuje fakturační sazbu a limity kapacity.

SkuName

Skladová položka vyhledávací služby. Mezi platné hodnoty patří: free: Sdílená služba. 'basic': Vyhrazená služba s až 3 replikami. Standard: Vyhrazená služba s až 12 oddíly a 12 replikami. Standard2: Podobá se standardu, ale s větší kapacitou na jednotku vyhledávání. Standard3: Největší standardní nabídka s až 12 oddíly a 12 replikami (nebo až 3 oddíly s více indexy, pokud jste také nastavili vlastnost hostingMode na highDensity). 'storage_optimized_l1': Podporuje 1 TB na oddíl, až 12 oddílů. 'storage_optimized_l2': Podporuje 2 TB na oddíl, až 12 oddílů.

systemData

Metadata týkající se vytvoření a poslední změny prostředku.

UserAssignedManagedIdentity

Podrobnosti o spravované identitě přiřazené uživatelem přiřazené vyhledávací službě

AadAuthFailureMode

Popisuje, jaká odpověď rozhraní API roviny dat vyhledávací služby by odeslala požadavky, které selhaly při ověřování.

Hodnota Description
http403

Označuje, že požadavky, které selhaly ověřování, by se měly zobrazit se stavovým kódem HTTP 403 (Zakázáno).

http401WithBearerChallenge

Označuje, že požadavky, které selhaly ověřování, by měly být prezentovány se stavovým kódem HTTP 401 (Neautorizováno) a prezentovat nosnou výzvu.

ApiKeyOnly

Označuje, že k ověřování je možné použít pouze klíč rozhraní API.

CloudError

Obsahuje informace o chybě rozhraní API.

Name Typ Description
error

CloudErrorBody

Popisuje konkrétní chybu rozhraní API s kódem chyby a zprávou.

message

string

Stručný popis chyby, která naznačuje, co se nepovedlo (podrobnosti nebo informace o ladění najdete ve vlastnosti error.message).

CloudErrorBody

Popisuje konkrétní chybu rozhraní API s kódem chyby a zprávou.

Name Typ Description
code

string

Kód chyby, který popisuje chybový stav přesněji než stavový kód HTTP. Dá se použít k programovému zpracování konkrétních případů chyb.

details

CloudErrorBody[]

Obsahuje vnořené chyby, které souvisejí s touto chybou.

message

string

Zpráva, která podrobně popisuje chybu a poskytuje informace o ladění.

target

string

Cíl konkrétní chyby (například název vlastnosti v chybě).

ComputeType

Nakonfigurujte tuto vlastnost tak, aby podporovala vyhledávací službu pomocí výchozího výpočetního prostředí nebo služby Azure Confidential Compute.

Hodnota Description
default

Vytvořte službu s výchozím výpočetním prostředím.

confidential

Vytvořte službu pomocí důvěrného výpočetního prostředí Azure.

createdByType

Typ identity, která prostředek vytvořila.

Hodnota Description
User
Application
ManagedIdentity
Key

DataPlaneAadOrApiKeyAuthOption

Označuje, že k ověřování je možné použít klíč rozhraní API nebo přístupový token z tenanta Microsoft Entra ID.

Name Typ Description
aadAuthFailureMode

AadAuthFailureMode

Popisuje, jaká odpověď rozhraní API roviny dat vyhledávací služby by odeslala požadavky, které selhaly při ověřování.

DataPlaneAuthOptions

Definuje možnosti, jak vyhledávací služba ověřuje požadavek roviny dat. Tuto možnost nelze nastavit, pokud je možnost disableLocalAuth nastavená na hodnotu true.

Name Typ Description
aadOrApiKey

DataPlaneAadOrApiKeyAuthOption

Označuje, že k ověřování je možné použít klíč rozhraní API nebo přístupový token z tenanta Microsoft Entra ID.

apiKeyOnly

ApiKeyOnly

Označuje, že k ověřování je možné použít pouze klíč rozhraní API.

EncryptionWithCmk

Popisuje zásadu, která určuje, jak se mají prostředky ve vyhledávací službě šifrovat pomocí klíčů spravovaných zákazníkem.

Name Typ Description
encryptionComplianceStatus

SearchEncryptionComplianceStatus

Vrátí stav dodržování předpisů vyhledávací služby s ohledem na nešifrované objekty CMK. Pokud má služba více než jeden nešifrovaný objekt a je povoleno vynucování, služba se označí jako nedodržující předpisy.

enforcement

SearchEncryptionWithCmk

Popisuje, jak by vyhledávací služba měla vynutit dodržování předpisů, pokud najde objekty, které nejsou šifrované pomocí klíče spravovaného zákazníkem.

HostingMode

Platí pouze pro skladovou položku Standard3. Tuto vlastnost můžete nastavit tak, aby umožňovala až 3 oddíly s vysokou hustotou, které umožňují až 1 000 indexů, což je mnohem vyšší než maximální povolený počet indexů pro jakoukoli jinou skladovou položku. U skladové položky Standard3 je tato hodnota buď výchozí, nebo highDensity. Pro všechny ostatní skladové položky musí být tato hodnota výchozí.

Hodnota Description
default

Omezení počtu indexů je určeno výchozími limity skladové položky.

highDensity

Pouze aplikace pro skladovou položku Standard3, kde vyhledávací služba může mít až 1 000 indexů.

Identity

Podrobnosti o identitě vyhledávací služby Hodnota null označuje, že vyhledávací služba nemá přiřazenou žádnou identitu.

Name Typ Description
principalId

string

ID objektu zabezpečení identity přiřazené systémem vyhledávací služby.

tenantId

string

ID tenanta identity přiřazené systémem vyhledávací služby.

type

IdentityType

Typ identity používané pro prostředek. Typ SystemAssigned, UserAssigned zahrnuje identitu vytvořenou systémem i sadu identit přiřazených uživatelem. Typ None odebere všechny identity ze služby.

userAssignedIdentities

<string,  UserAssignedManagedIdentity>

Seznam identit uživatelů přidružených k prostředku. Odkazy na klíč slovníku identit uživatele budou ID prostředků ARM ve formuláři: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}.

IdentityType

Typ identity používané pro prostředek. Typ SystemAssigned, UserAssigned zahrnuje identitu vytvořenou systémem i sadu identit přiřazených uživatelem. Typ None odebere všechny identity ze služby.

Hodnota Description
None

Označuje, že každou identitu přidruženou k vyhledávací službě je potřeba odebrat.

SystemAssigned

Označuje, že bude povolena identita přiřazená systémem pro vyhledávací službu.

UserAssigned

Označuje, že k vyhledávací službě se přiřadí jedna nebo více identit přiřazených uživatelem.

SystemAssigned, UserAssigned

Označuje, že identita přiřazená systémem pro vyhledávací službu bude povolena spolu s přiřazením jedné nebo více identit přiřazených uživatelem.

IpRule

Pravidlo omezení IP služby Azure AI Search.

Name Typ Description
value

string

Hodnota odpovídající jedné adrese IPv4 (např. 123.1.2.3) nebo rozsahu IP adres ve formátu CIDR (např. 123.1.2.3/24).

NetworkRuleSet

Pravidla specifická pro síť, která určují, jak může být dosaženo služby Azure AI Search.

Name Typ Description
bypass

SearchBypass

Možný původ příchozího provozu, který může obejít pravidla definovaná v části "ipRules".

ipRules

IpRule[]

Seznam pravidel omezení PROTOKOLU IP, která definují příchozí sítě s povolením přístupu ke koncovému bodu vyhledávací služby. Mezitím brána firewall blokuje všechny ostatní veřejné IP sítě. Tato pravidla omezení se použijí pouze v případech, kdy je povolená "publicNetworkAccess" vyhledávací služby; jinak provoz přes veřejné rozhraní není povolen ani s pravidly veřejné IP adresy a připojení privátních koncových bodů by byla výhradní metodou přístupu.

PrivateEndpoint

Prostředek privátního koncového bodu od poskytovatele Microsoft.Network.

Name Typ Description
id

string

ID prostředku prostředku privátního koncového bodu od poskytovatele Microsoft.Network.

PrivateEndpointConnection

Popisuje stávající připojení privátního koncového bodu ke službě Azure AI Search.

Name Typ Description
id

string

Plně kvalifikované ID prostředku pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Název prostředku

properties

PrivateEndpointConnectionProperties

Popisuje vlastnosti existujícího připojení privátního koncového bodu ke službě Azure AI Search.

type

string

Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

PrivateEndpointConnectionProperties

Popisuje vlastnosti existujícího připojení privátního koncového bodu k vyhledávací službě.

Name Typ Description
groupId

string

ID skupiny prostředku Azure, pro který je služba private link určená.

privateEndpoint

PrivateEndpoint

Prostředek privátního koncového bodu od poskytovatele Microsoft.Network.

privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Popisuje aktuální stav existujícího připojení služby Azure Private Link k privátnímu koncovému bodu.

provisioningState

PrivateLinkServiceConnectionProvisioningState

Stav zřizování připojení služby Private Link. Platné hodnoty jsou Aktualizace, Odstranění, Selhání, Úspěšné, Neúplné nebo Zrušené.

PrivateLinkServiceConnectionProvisioningState

Stav zřizování připojení služby Private Link. Platné hodnoty jsou Aktualizace, Odstranění, Selhání, Úspěšné, Neúplné nebo Zrušené.

Hodnota Description
Updating

Připojení služby Private Link probíhá v procesu vytváření spolu s dalšími prostředky, aby bylo plně funkční.

Deleting

Připojení služby Private Link probíhá v procesu odstranění.

Failed

Připojení služby Private Link se nepodařilo zřídit nebo odstranit.

Succeeded

Připojení služby Private Link dokončilo zřizování a je připravené ke schválení.

Incomplete

Žádost o zřízení prostředku připojení služby Private Link byla přijata, ale proces vytvoření ještě nebyl zahájen.

Canceled

Žádost o zřízení prostředku připojení služby Private Link byla zrušena.

PrivateLinkServiceConnectionState

Popisuje aktuální stav existujícího připojení služby Azure Private Link k privátnímu koncovému bodu.

Name Typ Default value Description
actionsRequired

string

None

Popis všech dodatečných akcí, které mohou být vyžadovány.

description

string

Popis stavu připojení služby Private Link.

status

PrivateLinkServiceConnectionStatus

Stav připojení služby Private Link Platné hodnoty jsou Čekající, Schválené, Odmítnuté nebo Odpojené.

PrivateLinkServiceConnectionStatus

Stav připojení služby Private Link Platné hodnoty jsou Čekající, Schválené, Odmítnuté nebo Odpojené.

Hodnota Description
Pending

Připojení privátního koncového bodu se vytvořilo a čeká na schválení.

Approved

Připojení privátního koncového bodu je schválené a je připravené k použití.

Rejected

Připojení privátního koncového bodu bylo odmítnuto a nelze ho použít.

Disconnected

Připojení privátního koncového bodu bylo ze služby odebráno.

ProvisioningState

Stav poslední operace zřizování prováděné ve vyhledávací službě. Zřizování je zprostředkující stav, ke kterému dochází při vytváření kapacity služby. Po nastavení kapacity se stav zřizování změní na Úspěch nebo Selhání. Klientské aplikace můžou dotazovat stav zřizování (doporučený interval dotazování je od 30 sekund do jedné minuty) pomocí operace Get Search Service a zjistit, kdy je operace dokončena. Pokud používáte bezplatnou službu, tato hodnota se obvykle vrací jako úspěch přímo ve volání pro vytvoření vyhledávací služby. Důvodem je to, že bezplatná služba používá kapacitu, která je už nastavená.

Hodnota Description
Succeeded

Poslední operace zřizování byla úspěšně dokončena.

Provisioning

Vyhledávací služba se zřizuje nebo škáluje nahoru nebo dolů.

Failed

Poslední operace zřizování selhala.

PublicNetworkAccess

Tuto hodnotu je možné nastavit na povoleno, aby nedocházelo k zásadním změnám stávajících prostředků a šablon zákazníků. Pokud je tato možnost nastavená na zakázáno, provoz přes veřejné rozhraní není povolený a připojení privátního koncového bodu by byla výhradní metodou přístupu.

Hodnota Description
enabled

Vyhledávací služba je přístupná z provozu pocházejícího z veřejného internetu.

disabled

Vyhledávací služba není přístupná z provozu pocházejícího z veřejného internetu. Přístup je povolený jenom přes schválená připojení privátních koncových bodů.

SearchBypass

Možný původ příchozího provozu, který může obejít pravidla definovaná v části "ipRules".

Hodnota Description
None

Označuje, že žádný zdroj nemůže obejít pravidla definovaná v části "ipRules". Toto je výchozí hodnota.

AzurePortal

Označuje, že požadavky pocházející z webu Azure Portal můžou obejít pravidla definovaná v části ipRules.

AzureServices

Označuje, že požadavky pocházející z důvěryhodných služeb Azure můžou obejít pravidla definovaná v části "ipRules".

SearchDisabledDataExfiltrationOption

Seznamscénářůch V současné době je jedinou podporovanou hodnotou "Vše", která zakáže všechny možné scénáře exportu dat s jemněji odstupňovanými ovládacími prvky plánovanými pro budoucnost.

Hodnota Description
All

Označuje, že všechny scénáře exfiltrace dat jsou zakázané.

SearchEncryptionComplianceStatus

Vrátí stav dodržování předpisů vyhledávací služby s ohledem na nešifrované objekty CMK. Pokud má služba více než jeden nešifrovaný objekt a je povoleno vynucování, služba se označí jako nedodržující předpisy.

Hodnota Description
Compliant

Označuje, že vyhledávací služba dodržuje předpisy, a to buď proto, že počet nešifrovaných objektů CMK je nula nebo je zakázáno vynucování.

NonCompliant

Označuje, že vyhledávací služba má více než jeden objekt bez šifrování CMK.

SearchEncryptionWithCmk

Popisuje, jak by vyhledávací služba měla vynutit dodržování předpisů, pokud najde objekty, které nejsou šifrované pomocí klíče spravovaného zákazníkem.

Hodnota Description
Disabled

Nebude provedeno žádné vynucování šifrování klíčů spravovaných zákazníkem. Používá se pouze integrované šifrování spravované službou.

Enabled

Vyhledávací služba se označí jako nevyhovující, pokud jeden nebo více objektů není šifrované pomocí klíče spravovaného zákazníkem.

Unspecified

Zásady vynucení nejsou explicitně zadány, přičemž chování je stejné jako v případě, že byly nastaveny na Zakázáno.

SearchSemanticSearch

Nastaví možnosti, které řídí dostupnost sémantického vyhledávání. Tato konfigurace je možná jenom pro určité skladové položky služby Azure AI Search v určitých umístěních.

Hodnota Description
disabled

Označuje, že sémantický reranker je pro vyhledávací službu zakázaný. Toto je výchozí hodnota.

free

Povolí sémantickou reranker ve vyhledávací službě a indikuje, že se má používat v rámci limitů bezplatného plánu. Bezplatný plán by limitoval objem sémantických žádostí o řazení a nabízí se bez dalších poplatků. Toto je výchozí hodnota pro nově zřízené vyhledávací služby.

standard

Umožňuje sémantické reranker ve vyhledávací službě jako fakturovatelnou funkci s vyšší propustností a objemem sémanticky přeřazených dotazů.

SearchService

Popisuje službu Azure AI Search a její aktuální stav.

Name Typ Default value Description
id

string

Plně kvalifikované ID prostředku pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

Identity

Identita prostředku.

location

string

Geografické umístění, ve kterém se nachází zdroj

name

string

Název prostředku

properties.authOptions

DataPlaneAuthOptions

Definuje možnosti, jak rozhraní API roviny dat vyhledávací služby ověřuje požadavky. Tuto možnost nelze nastavit, pokud je možnost disableLocalAuth nastavená na hodnotu true.

properties.computeType

ComputeType

Nakonfigurujte tuto vlastnost tak, aby podporovala vyhledávací službu pomocí výchozího výpočetního prostředí nebo služby Azure Confidential Compute.

properties.disableLocalAuth

boolean

Pokud je nastavená hodnota true, nebudou volání vyhledávací služby povolena k ověřování pomocí klíčů rozhraní API. Tuto hodnotu nelze nastavit na hodnotu true, pokud jsou definovány hodnoty dataPlaneAuthOptions.

properties.disabledDataExfiltrationOptions

SearchDisabledDataExfiltrationOption[]

Seznamscénářůch V současné době je jedinou podporovanou hodnotou "Vše", která zakáže všechny možné scénáře exportu dat s jemněji odstupňovanými ovládacími prvky plánovanými pro budoucnost.

properties.eTag

string

Systém vygenerovaná vlastnost představující jmenovku služby, která může být pro řízení optimistické souběžnosti během aktualizací.

properties.encryptionWithCmk

EncryptionWithCmk

Určuje všechny zásady týkající se šifrování prostředků (například indexů) pomocí klíčů správce zákazníků v rámci vyhledávací služby.

properties.endpoint

string (uri)

Koncový bod služby Azure AI Search.

properties.hostingMode

HostingMode

default

Platí pouze pro skladovou položku Standard3. Tuto vlastnost můžete nastavit tak, aby umožňovala až 3 oddíly s vysokou hustotou, které umožňují až 1 000 indexů, což je mnohem vyšší než maximální povolený počet indexů pro jakoukoli jinou skladovou položku. U skladové položky Standard3 je tato hodnota buď výchozí, nebo highDensity. Pro všechny ostatní skladové položky musí být tato hodnota výchozí.

properties.networkRuleSet

NetworkRuleSet

Pravidla specifická pro síť, která určují, jak může být dosaženo služby Azure AI Search.

properties.partitionCount

integer (int32)

minimum: 1
maximum: 12
1

Počet oddílů ve vyhledávací službě; pokud je zadaný, může to být 1, 2, 3, 4, 6 nebo 12. Hodnoty větší než 1 jsou platné pouze pro standardní skladové položky. Pro služby standard3 s hostingMode nastaveným na highDensity jsou povolené hodnoty mezi 1 a 3.

properties.privateEndpointConnections

PrivateEndpointConnection[]

Seznam připojení privátních koncových bodů ke službě Azure AI Search.

properties.provisioningState

ProvisioningState

Stav poslední operace zřizování prováděné ve vyhledávací službě. Zřizování je zprostředkující stav, ke kterému dochází při vytváření kapacity služby. Po nastavení kapacity se stav zřizování změní na Úspěch nebo Selhání. Klientské aplikace můžou dotazovat stav zřizování (doporučený interval dotazování je od 30 sekund do jedné minuty) pomocí operace Get Search Service a zjistit, kdy je operace dokončena. Pokud používáte bezplatnou službu, tato hodnota se obvykle vrací jako úspěch přímo ve volání pro vytvoření vyhledávací služby. Důvodem je to, že bezplatná služba používá kapacitu, která je už nastavená.

properties.publicNetworkAccess

PublicNetworkAccess

enabled

Tuto hodnotu je možné nastavit na povoleno, aby nedocházelo k zásadním změnám stávajících prostředků a šablon zákazníků. Pokud je tato možnost nastavená na zakázáno, provoz přes veřejné rozhraní není povolený a připojení privátního koncového bodu by byla výhradní metodou přístupu.

properties.replicaCount

integer (int32)

minimum: 1
maximum: 12
1

Počet replik ve vyhledávací službě. Pokud je zadáno, musí být hodnota mezi 1 a 12 včetně pro standardní skladové položky nebo mezi 1 a 3 včetně pro základní skladovou položku.

properties.semanticSearch

SearchSemanticSearch

Nastaví možnosti, které řídí dostupnost sémantického vyhledávání. Tato konfigurace je možná jenom pro určité skladové položky služby Azure AI Search v určitých umístěních.

properties.serviceUpgradeDate

string (date-time)

Datum a čas posledního upgradu vyhledávací služby. Toto pole bude null, dokud se služba poprvé neupgraduje.

properties.sharedPrivateLinkResources

SharedPrivateLinkResource[]

Seznam sdílených prostředků privátního propojení spravovaných službou Azure AI Search

properties.status

SearchServiceStatus

Stav vyhledávací služby. Mezi možné hodnoty patří: "running": Vyhledávací služba je spuštěná a neprobíhá žádné operace zřizování. Zřizování: Vyhledávací služba se zřizuje nebo škáluje nahoru nebo dolů. "odstranění": Vyhledávací služba se odstraňuje. Degradováno: Vyhledávací služba je degradovaná. K tomu může dojít v případě, že základní vyhledávací jednotky nejsou v pořádku. Vyhledávací služba je pravděpodobně funkční, ale výkon může být pomalý a některé požadavky se můžou vynechat. Zakázáno: Vyhledávací služba je zakázaná. V tomto stavu služba odmítne všechny požadavky rozhraní API. Chyba: Vyhledávací služba je ve stavu chyby. Zastaveno: Vyhledávací služba je v předplatném, které je zakázané. Pokud je vaše služba v degradovaných, zakázaných nebo chybových stavech, znamená to, že tým Azure AI Search aktivně prošetřuje základní problém. Vyhrazené služby v těchto stavech jsou stále zpoplatněné na základě počtu zřízených jednotek vyhledávání.

properties.statusDetails

string

Podrobnosti o stavu vyhledávací služby.

properties.upgradeAvailable

boolean

Určuje, jestli má vyhledávací služba k dispozici upgrade.

sku

Sku

Skladová položka vyhledávací služby, která určuje cenové úrovně a limity kapacity. Tato vlastnost se vyžaduje při vytváření nové vyhledávací služby.

systemData

systemData

Metadata Azure Resource Manageru vyhledávací služby obsahující informace createdBy a modifiedBy.

tags

object

Značky prostředků

type

string

Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

SearchServiceStatus

Stav vyhledávací služby. Mezi možné hodnoty patří: "running": Vyhledávací služba je spuštěná a neprobíhá žádné operace zřizování. Zřizování: Vyhledávací služba se zřizuje nebo škáluje nahoru nebo dolů. "odstranění": Vyhledávací služba se odstraňuje. Degradováno: Vyhledávací služba je degradovaná. K tomu může dojít v případě, že základní vyhledávací jednotky nejsou v pořádku. Vyhledávací služba je pravděpodobně funkční, ale výkon může být pomalý a některé požadavky se můžou vynechat. Zakázáno: Vyhledávací služba je zakázaná. V tomto stavu služba odmítne všechny požadavky rozhraní API. Chyba: Vyhledávací služba je ve stavu chyby. Zastaveno: Vyhledávací služba je v předplatném, které je zakázané. Pokud je vaše služba v degradovaných, zakázaných nebo chybových stavech, znamená to, že tým Azure AI Search aktivně prošetřuje základní problém. Vyhrazené služby v těchto stavech jsou stále zpoplatněné na základě počtu zřízených jednotek vyhledávání.

Hodnota Description
running

Vyhledávací služba je spuštěná a neprobíhá žádné operace zřizování.

provisioning

Vyhledávací služba se zřizuje nebo škáluje nahoru nebo dolů.

deleting

Vyhledávací služba se odstraňuje.

degraded

Vyhledávací služba je degradovaná, protože základní jednotky vyhledávání nejsou v pořádku.

disabled

Vyhledávací služba je zakázaná a všechny požadavky rozhraní API budou odmítnuty.

error

Vyhledávací služba je ve stavu chyby, která značí, že se nepodařilo zřídit nebo odstranit.

stopped

Vyhledávací služba je v předplatném, které je zakázané.

SearchServiceUpdate

Parametry používané k aktualizaci služby Azure AI Search.

Name Typ Default value Description
id

string

Plně kvalifikované ID prostředku pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

Identity

Podrobnosti o identitě vyhledávací služby Hodnota null označuje, že vyhledávací služba nemá přiřazenou žádnou identitu.

location

string

Zeměpisné umístění prostředku. Musí to být jedna z podporovaných a registrovaných geografických oblastí Azure (například USA – západ, USA – východ, Jihovýchodní Asie atd.). Tato vlastnost se vyžaduje při vytváření nového prostředku.

name

string

Název prostředku

properties.authOptions

DataPlaneAuthOptions

Definuje možnosti, jak rozhraní API roviny dat vyhledávací služby ověřuje požadavky. Tuto možnost nelze nastavit, pokud je možnost disableLocalAuth nastavená na hodnotu true.

properties.computeType

ComputeType

Nakonfigurujte tuto vlastnost tak, aby podporovala vyhledávací službu pomocí výchozího výpočetního prostředí nebo služby Azure Confidential Compute.

properties.disableLocalAuth

boolean

Pokud je nastavená hodnota true, nebudou volání vyhledávací služby povolena k ověřování pomocí klíčů rozhraní API. Tuto hodnotu nelze nastavit na hodnotu true, pokud jsou definovány hodnoty dataPlaneAuthOptions.

properties.disabledDataExfiltrationOptions

SearchDisabledDataExfiltrationOption[]

Seznamscénářůch V současné době je jedinou podporovanou hodnotou "Vše", která zakáže všechny možné scénáře exportu dat s jemněji odstupňovanými ovládacími prvky plánovanými pro budoucnost.

properties.eTag

string

Systém vygenerovaná vlastnost představující jmenovku služby, která může být pro řízení optimistické souběžnosti během aktualizací.

properties.encryptionWithCmk

EncryptionWithCmk

Určuje všechny zásady týkající se šifrování prostředků (například indexů) pomocí klíčů správce zákazníků v rámci vyhledávací služby.

properties.endpoint

string (uri)

Koncový bod služby Azure AI Search.

properties.hostingMode

HostingMode

default

Platí pouze pro skladovou položku Standard3. Tuto vlastnost můžete nastavit tak, aby umožňovala až 3 oddíly s vysokou hustotou, které umožňují až 1 000 indexů, což je mnohem vyšší než maximální povolený počet indexů pro jakoukoli jinou skladovou položku. U skladové položky Standard3 je tato hodnota buď výchozí, nebo highDensity. Pro všechny ostatní skladové položky musí být tato hodnota výchozí.

properties.networkRuleSet

NetworkRuleSet

Pravidla specifická pro síť, která určují, jak může být dosaženo služby Azure AI Search.

properties.partitionCount

integer (int32)

minimum: 1
maximum: 12
1

Počet oddílů ve vyhledávací službě; pokud je zadaný, může to být 1, 2, 3, 4, 6 nebo 12. Hodnoty větší než 1 jsou platné pouze pro standardní skladové položky. Pro služby standard3 s hostingMode nastaveným na highDensity jsou povolené hodnoty mezi 1 a 3.

properties.privateEndpointConnections

PrivateEndpointConnection[]

Seznam připojení privátních koncových bodů ke službě Azure AI Search.

properties.provisioningState

ProvisioningState

Stav poslední operace zřizování prováděné ve vyhledávací službě. Zřizování je zprostředkující stav, ke kterému dochází při vytváření kapacity služby. Po nastavení kapacity se stav zřizování změní na Úspěch nebo Selhání. Klientské aplikace můžou dotazovat stav zřizování (doporučený interval dotazování je od 30 sekund do jedné minuty) pomocí operace Get Search Service a zjistit, kdy je operace dokončena. Pokud používáte bezplatnou službu, tato hodnota se obvykle vrací jako úspěch přímo ve volání pro vytvoření vyhledávací služby. Důvodem je to, že bezplatná služba používá kapacitu, která je už nastavená.

properties.publicNetworkAccess

PublicNetworkAccess

enabled

Tuto hodnotu je možné nastavit na povoleno, aby nedocházelo k zásadním změnám stávajících prostředků a šablon zákazníků. Pokud je tato možnost nastavená na zakázáno, provoz přes veřejné rozhraní není povolený a připojení privátního koncového bodu by byla výhradní metodou přístupu.

properties.replicaCount

integer (int32)

minimum: 1
maximum: 12
1

Počet replik ve vyhledávací službě. Pokud je zadáno, musí být hodnota mezi 1 a 12 včetně pro standardní skladové položky nebo mezi 1 a 3 včetně pro základní skladovou položku.

properties.semanticSearch

SearchSemanticSearch

Nastaví možnosti, které řídí dostupnost sémantického vyhledávání. Tato konfigurace je možná jenom pro určité skladové položky služby Azure AI Search v určitých umístěních.

properties.serviceUpgradeDate

string (date-time)

Datum a čas posledního upgradu vyhledávací služby. Toto pole bude null, dokud se služba poprvé neupgraduje.

properties.sharedPrivateLinkResources

SharedPrivateLinkResource[]

Seznam sdílených prostředků privátního propojení spravovaných službou Azure AI Search

properties.status

SearchServiceStatus

Stav vyhledávací služby. Mezi možné hodnoty patří: "running": Vyhledávací služba je spuštěná a neprobíhá žádné operace zřizování. Zřizování: Vyhledávací služba se zřizuje nebo škáluje nahoru nebo dolů. "odstranění": Vyhledávací služba se odstraňuje. Degradováno: Vyhledávací služba je degradovaná. K tomu může dojít v případě, že základní vyhledávací jednotky nejsou v pořádku. Vyhledávací služba je pravděpodobně funkční, ale výkon může být pomalý a některé požadavky se můžou vynechat. Zakázáno: Vyhledávací služba je zakázaná. V tomto stavu služba odmítne všechny požadavky rozhraní API. Chyba: Vyhledávací služba je ve stavu chyby. Zastaveno: Vyhledávací služba je v předplatném, které je zakázané. Pokud je vaše služba v degradovaných, zakázaných nebo chybových stavech, znamená to, že tým Azure AI Search aktivně prošetřuje základní problém. Vyhrazené služby v těchto stavech jsou stále zpoplatněné na základě počtu zřízených jednotek vyhledávání.

properties.statusDetails

string

Podrobnosti o stavu vyhledávací služby.

properties.upgradeAvailable

boolean

Určuje, jestli má vyhledávací služba k dispozici upgrade.

sku

Sku

Skladová položka vyhledávací služby, která určuje cenové úrovně a limity kapacity. Tato vlastnost se vyžaduje při vytváření nové vyhledávací služby.

systemData

systemData

Metadata Azure Resource Manageru obsahující informace createdBy a modifiedBy

tags

object

Značky, které pomáhají kategorizovat prostředek na webu Azure Portal.

type

string

Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

SharedPrivateLinkResource

Popisuje sdílený prostředek privátního propojení spravovaný službou Azure AI Search.

Name Typ Description
id

string

Plně kvalifikované ID prostředku pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Název prostředku

properties

SharedPrivateLinkResourceProperties

Popisuje vlastnosti prostředku sdíleného privátního propojení spravovaného službou Azure AI Search.

type

string

Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

SharedPrivateLinkResourceProperties

Popisuje vlastnosti existujícího sdíleného prostředku privátního propojení spravovaného službou Azure AI Search.

Name Typ Description
groupId

string

ID skupiny od poskytovatele prostředku, pro který je sdílený prostředek privátního propojení určený.

privateLinkResourceId

string

ID prostředku prostředku, pro který je sdílený prostředek privátního propojení.

provisioningState

SharedPrivateLinkResourceProvisioningState

Stav zřizování sdíleného prostředku privátního propojení. Platné hodnoty jsou Aktualizace, Odstranění, Neúspěšné, Úspěšné nebo Neúplné.

requestMessage

string

Zpráva pro žádost o schválení sdíleného prostředku privátního propojení.

resourceRegion

string

Optional. Dá se použít k určení umístění prostředku Azure Resource Manageru, pro který se vytváří sdílené privátní propojení. To se vyžaduje jenom pro prostředky, jejichž konfigurace DNS je regionální (například Azure Kubernetes Service).

status

SharedPrivateLinkResourceStatus

Stav sdíleného prostředku privátního propojení Platné hodnoty jsou Čekající, Schválené, Odmítnuté nebo Odpojené.

SharedPrivateLinkResourceProvisioningState

Stav zřizování sdíleného prostředku privátního propojení. Platné hodnoty jsou Aktualizace, Odstranění, Neúspěšné, Úspěšné nebo Neúplné.

Hodnota Description
Updating

Sdílený prostředek privátního propojení probíhá při vytváření společně s dalšími prostředky, aby byl plně funkční.

Deleting

Sdílený prostředek privátního propojení probíhá v procesu odstranění.

Failed

Prostředek sdíleného privátního propojení se nepodařilo zřídit nebo odstranit.

Succeeded

Prostředek sdíleného privátního propojení dokončil zřizování a je připravený ke schválení.

Incomplete

Žádost o zřízení pro sdílený prostředek privátního propojení byla přijata, ale proces vytvoření ještě nebyl zahájen.

SharedPrivateLinkResourceStatus

Stav sdíleného prostředku privátního propojení Platné hodnoty jsou Čekající, Schválené, Odmítnuté nebo Odpojené.

Hodnota Description
Pending

Byl vytvořen sdílený prostředek privátního propojení a čeká na schválení.

Approved

Sdílený prostředek privátního propojení je schválený a je připravený k použití.

Rejected

Sdílený prostředek privátního propojení byl odmítnut a nelze jej použít.

Disconnected

Sdílený prostředek privátního propojení byl ze služby odebrán.

Sku

Definuje skladovou položku vyhledávací služby, která určuje fakturační sazbu a limity kapacity.

Name Typ Description
name

SkuName

Skladová položka vyhledávací služby. Mezi platné hodnoty patří: free: Sdílená služba. 'basic': Vyhrazená služba s až 3 replikami. Standard: Vyhrazená služba s až 12 oddíly a 12 replikami. Standard2: Podobá se standardu, ale s větší kapacitou na jednotku vyhledávání. Standard3: Největší standardní nabídka s až 12 oddíly a 12 replikami (nebo až 3 oddíly s více indexy, pokud jste také nastavili vlastnost hostingMode na highDensity). 'storage_optimized_l1': Podporuje 1 TB na oddíl, až 12 oddílů. 'storage_optimized_l2': Podporuje 2 TB na oddíl, až 12 oddílů.

SkuName

Skladová položka vyhledávací služby. Mezi platné hodnoty patří: free: Sdílená služba. 'basic': Vyhrazená služba s až 3 replikami. Standard: Vyhrazená služba s až 12 oddíly a 12 replikami. Standard2: Podobá se standardu, ale s větší kapacitou na jednotku vyhledávání. Standard3: Největší standardní nabídka s až 12 oddíly a 12 replikami (nebo až 3 oddíly s více indexy, pokud jste také nastavili vlastnost hostingMode na highDensity). 'storage_optimized_l1': Podporuje 1 TB na oddíl, až 12 oddílů. 'storage_optimized_l2': Podporuje 2 TB na oddíl, až 12 oddílů.

Hodnota Description
free

Úroveň Free bez záruk SLA a podmnožina funkcí nabízených na fakturovatelných úrovních

basic

Fakturovatelná úroveň pro vyhrazenou službu, která má až 3 repliky.

standard

Fakturovatelná úroveň pro vyhrazenou službu, která má až 12 oddílů a 12 replik.

standard2

Podobá se standardu, ale s větší kapacitou na jednotku vyhledávání.

standard3

Největší nabídka standardu s až 12 oddíly a 12 replikami (nebo až 3 oddíly s více indexy, pokud jste také nastavili vlastnost hostingMode na highDensity).

storage_optimized_l1

Fakturovatelná úroveň pro vyhrazenou službu, která podporuje 1 TB na oddíl, až 12 oddílů.

storage_optimized_l2

Fakturovatelná úroveň pro vyhrazenou službu, která podporuje 2 TB na oddíl, až 12 oddílů.

systemData

Metadata týkající se vytvoření a poslední změny prostředku.

Name Typ Description
createdAt

string (date-time)

Časové razítko vytvoření prostředku (UTC).

createdBy

string

Identita, která prostředek vytvořila.

createdByType

createdByType

Typ identity, která prostředek vytvořila.

lastModifiedAt

string (date-time)

Časové razítko poslední změny zdroje (UTC)

lastModifiedBy

string

Identita, která naposledy změnila prostředek.

lastModifiedByType

createdByType

Typ identity, která naposledy změnila prostředek.

UserAssignedManagedIdentity

Podrobnosti o spravované identitě přiřazené uživatelem přiřazené vyhledávací službě

Name Typ Description
clientId

string

ID klienta identity přiřazené uživatelem.

principalId

string

ID objektu zabezpečení identity přiřazené uživatelem.