Services - Create Or Update

Tworzy lub aktualizuje usługę wyszukiwania w danej grupie zasobów. Jeśli usługa wyszukiwania już istnieje, wszystkie właściwości zostaną zaktualizowane przy użyciu podanych wartości.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
resourceGroupName
path True

string

Nazwa grupy zasobów w ramach bieżącej subskrypcji. Tę wartość można uzyskać z interfejsu API Resource Manager platformy Azure lub portalu.

searchServiceName
path True

string

Nazwa usługi wyszukiwania do utworzenia lub zaktualizowania. usługa wyszukiwania nazwy muszą zawierać tylko małe litery, cyfry lub kreski, nie mogą używać kreski jako pierwszych dwóch lub ostatnich znaków, nie mogą zawierać kolejnych kreski i muszą mieć długość od 2 do 60 znaków. usługa wyszukiwania nazwy muszą być globalnie unikatowe, ponieważ są częścią identyfikatora URI usługi (https://.search.windows.net). Nie można zmienić nazwy usługi po utworzeniu usługi.

subscriptionId
path True

string

Unikatowy identyfikator subskrypcji platformy Microsoft Azure. Tę wartość można uzyskać z interfejsu API usługi Azure Resource Manager, narzędzi wiersza polecenia lub portalu.

api-version
query True

string

Wersja interfejsu API do użycia dla każdego żądania.

Nagłówek żądania

Nazwa Wymagane Typ Opis
x-ms-client-request-id

string

uuid

Wartość identyfikatora GUID wygenerowana przez klienta, która identyfikuje to żądanie. Jeśli zostanie określony, zostanie to uwzględnione w informacjach o odpowiedzi jako sposób śledzenia żądania.

Treść żądania

Nazwa Wymagane Typ Opis
location True

string

Lokalizacja geograficzna, w której znajduje się zasób

identity

Identity

Tożsamość zasobu.

properties.authOptions

DataPlaneAuthOptions

Definiuje opcje sposobu uwierzytelniania żądań przez interfejs API płaszczyzny danych usługi wyszukiwania. Nie można ustawić tego ustawienia, jeśli wartość "disableLocalAuth" ma wartość true.

properties.disableLocalAuth

boolean

Po ustawieniu wartości true wywołania usługi wyszukiwania nie będą mogły korzystać z kluczy interfejsu API do uwierzytelniania. Nie można ustawić wartości true, jeśli zdefiniowano wartość "dataPlaneAuthOptions".

properties.encryptionWithCmk

EncryptionWithCmk

Określa wszelkie zasady dotyczące szyfrowania zasobów (takich jak indeksy) przy użyciu kluczy menedżera klienta w usłudze wyszukiwania.

properties.hostingMode

HostingMode

Dotyczy tylko jednostki SKU w warstwie Standardowa3. Tę właściwość można ustawić tak, aby umożliwić maksymalnie 3 partycje o wysokiej gęstości, które umożliwiają maksymalnie 1000 indeksów, co jest znacznie wyższe niż maksymalne indeksy dozwolone dla dowolnej innej jednostki SKU. W przypadku jednostki SKU w warstwie Standardowa3 wartość to "default" lub "highDensity". Dla wszystkich innych jednostek SKU ta wartość musi być "domyślna".

properties.networkRuleSet

NetworkRuleSet

Reguły specyficzne dla sieci, które określają, jak można osiągnąć usługę wyszukiwania.

properties.partitionCount

integer

Liczba partycji w usłudze wyszukiwania; jeśli zostanie określony, może to być 1, 2, 3, 4, 6 lub 12. Wartości większe niż 1 są prawidłowe tylko dla standardowych jednostek SKU. W przypadku usług "standard3" z hostMode ustawionym na wartość "highDensity" dozwolone wartości to od 1 do 3.

properties.publicNetworkAccess

PublicNetworkAccess

Tę wartość można ustawić na "włączone", aby uniknąć zmian powodujących niezgodność istniejących zasobów i szablonów klientów. Jeśli ustawiono wartość "disabled", ruch za pośrednictwem interfejsu publicznego jest niedozwolony, a prywatne połączenia punktu końcowego będą metodą wyłącznego dostępu.

properties.replicaCount

integer

Liczba replik w usłudze wyszukiwania. W przypadku określenia musi to być wartość z zakresu od 1 do 12 włącznie dla standardowych jednostek SKU lub od 1 do 3 włącznie dla podstawowej jednostki SKU.

properties.semanticSearch

SearchSemanticSearch

Ustawia opcje kontrolujące dostępność wyszukiwania semantycznego. Ta konfiguracja jest możliwa tylko dla niektórych jednostek SKU wyszukiwania w określonych lokalizacjach.

sku

Sku

Jednostka SKU usługi wyszukiwania, która określa szybkość rozliczeń i limity pojemności. Ta właściwość jest wymagana podczas tworzenia nowej usługi wyszukiwania.

tags

object

Tagi zasobów.

Odpowiedzi

Nazwa Typ Opis
200 OK

SearchService

Istniejąca definicja usługi została pomyślnie zaktualizowana. Jeśli zmienisz liczbę replik lub partycji, operacja skalowania będzie wykonywana asynchronicznie. Możesz okresowo pobierać definicję usługi i monitorować postęp za pośrednictwem właściwości provisioningState.

201 Created

SearchService

Jeśli zażądano utworzenia bezpłatnej usługi wyszukiwania, usługa jest teraz aprowizowana i gotowa do użycia, z zastrzeżeniem opóźnienia propagacji DNS. W przypadku innych typów jednostek SKU aprowizowanie odbywa się asynchronicznie. Możesz okresowo pobierać definicję usługi i monitorować postęp za pośrednictwem właściwości provisioningState.

Other Status Codes

CloudError

HTTP 400 (Nieprawidłowe żądanie): podana nazwa usługi lub definicja usługi jest nieprawidłowa; Aby uzyskać szczegółowe informacje, zobacz kod błędu i komunikat w odpowiedzi. HTTP 404 (Nie znaleziono): nie można odnaleźć subskrypcji lub grupy zasobów. HTTP 409 (konflikt): określona subskrypcja jest wyłączona.

Zabezpieczenia

azure_auth

Tożsamość Microsoft Entra przepływ autoryzacji OAuth2.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

SearchCreateOrUpdateService
SearchCreateOrUpdateServiceAuthOptions
SearchCreateOrUpdateServiceDisableLocalAuth
SearchCreateOrUpdateServiceToAllowAccessFromPrivateEndpoints
SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPs
SearchCreateOrUpdateServiceWithCmkEnforcement
SearchCreateOrUpdateServiceWithIdentity
SearchCreateOrUpdateWithSemanticSearch

SearchCreateOrUpdateService

Sample Request

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

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

Sample Response

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

SearchCreateOrUpdateServiceAuthOptions

Sample Request

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

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

Sample Response

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

SearchCreateOrUpdateServiceDisableLocalAuth

Sample Request

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

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

Sample Response

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

SearchCreateOrUpdateServiceToAllowAccessFromPrivateEndpoints

Sample Request

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

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

Sample Response

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

SearchCreateOrUpdateServiceToAllowAccessFromPublicCustomIPs

Sample Request

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

{
  "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"
  }
}

Sample Response

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

SearchCreateOrUpdateServiceWithCmkEnforcement

Sample Request

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

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

Sample Response

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

SearchCreateOrUpdateServiceWithIdentity

Sample Request

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

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

Sample Response

{
  "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": []
    },
    "privateEndpointConnections": []
  },
  "identity": {
    "type": "SystemAssigned",
    "principalId": "9d1e1f18-2122-4988-a11c-878782e40a5c",
    "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd"
  }
}
{
  "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": []
    },
    "privateEndpointConnections": []
  },
  "identity": {
    "type": "SystemAssigned",
    "principalId": "9d1e1f18-2122-4988-a11c-878782e40a5c",
    "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd"
  }
}

SearchCreateOrUpdateWithSemanticSearch

Sample Request

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

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

Sample Response

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

Definicje

Nazwa Opis
AadAuthFailureMode

Opisuje odpowiedź interfejsu API płaszczyzny danych usługi wyszukiwania wysyłanej dla żądań, które zakończyły się niepowodzeniem uwierzytelniania.

ApiKeyOnly

Wskazuje, że do uwierzytelniania może być używany tylko klucz interfejsu API.

CloudError

Zawiera informacje o błędzie interfejsu API.

CloudErrorBody

Opisuje określony błąd interfejsu API z kodem błędu i komunikatem.

DataPlaneAadOrApiKeyAuthOption

Wskazuje, że do uwierzytelniania można użyć klucza interfejsu API lub tokenu dostępu z dzierżawy Tożsamość Microsoft Entra.

DataPlaneAuthOptions

Definiuje opcje sposobu uwierzytelniania żądania płaszczyzny danych przez usługę wyszukiwania. Nie można ustawić tego ustawienia, jeśli wartość "disableLocalAuth" ma wartość true.

EncryptionWithCmk

Opisuje zasady określające sposób szyfrowania zasobów w usłudze wyszukiwania przy użyciu kluczy zarządzanych customer=managed.

HostingMode

Dotyczy tylko jednostki SKU w warstwie Standardowa3. Tę właściwość można ustawić tak, aby umożliwić maksymalnie 3 partycje o wysokiej gęstości, które umożliwiają maksymalnie 1000 indeksów, co jest znacznie wyższe niż maksymalne indeksy dozwolone dla dowolnej innej jednostki SKU. W przypadku jednostki SKU w warstwie Standardowa3 wartość to "default" lub "highDensity". Dla wszystkich innych jednostek SKU ta wartość musi być "domyślna".

Identity

Tożsamość zasobu.

IdentityType

Typ tożsamości.

IpRule

Reguła ograniczenia adresu IP usługi wyszukiwania.

NetworkRuleSet

Reguły specyficzne dla sieci, które określają, jak można uzyskać dostęp do usługi wyszukiwania.

PrivateEndpoint

Zasób prywatnego punktu końcowego od dostawcy Microsoft.Network.

PrivateEndpointConnection

Opisuje istniejące połączenie prywatnego punktu końcowego z usługą wyszukiwania.

PrivateEndpointConnectionProperties

Opisuje właściwości istniejącego połączenia prywatnego punktu końcowego z usługą wyszukiwania.

PrivateLinkServiceConnectionProvisioningState

Stan aprowizacji połączenia usługi private link. Prawidłowe wartości to Aktualizowanie, usuwanie, niepowodzenie, powodzenie lub niekompletne

PrivateLinkServiceConnectionState

Opisuje bieżący stan istniejącego połączenia usługi Private Link z prywatnym punktem końcowym platformy Azure.

PrivateLinkServiceConnectionStatus

Stan połączenia usługi private link. Prawidłowe wartości to Oczekujące, Zatwierdzone, Odrzucone lub Rozłączone.

ProvisioningState

Stan ostatniej operacji aprowizacji wykonanej w usłudze wyszukiwania. Aprowizowanie jest stanem pośrednim, który występuje podczas ustanawiania pojemności usługi. Po skonfigurowaniu pojemności aprowizacjaStan zmieni się na "powodzenie" lub "niepowodzenie". Aplikacje klienckie mogą sondować stan aprowizacji (zalecany interwał sondowania wynosi od 30 sekund do jednej minuty) przy użyciu operacji Pobierz usługę wyszukiwania, aby zobaczyć, kiedy operacja została ukończona. Jeśli używasz bezpłatnej usługi, ta wartość ma tendencję do powrotu jako "powodzenie" bezpośrednio w wywołaniu do tworzenia usługi wyszukiwania. Dzieje się tak, ponieważ bezpłatna usługa używa już skonfigurowanej pojemności.

PublicNetworkAccess

Tę wartość można ustawić na "włączone", aby uniknąć zmian powodujących niezgodność istniejących zasobów i szablonów klientów. Jeśli ustawiono wartość "disabled", ruch za pośrednictwem interfejsu publicznego jest niedozwolony, a prywatne połączenia punktu końcowego będą metodą wyłącznego dostępu.

SearchEncryptionComplianceStatus

Opisuje, czy usługa wyszukiwania jest zgodna, czy nie w odniesieniu do zasobów niezaszyfrowanych przez klienta. Jeśli usługa ma więcej niż jeden zasób niezaszyfrowany przez klienta, a "Wymuszanie" jest włączone, usługa zostanie oznaczona jako "niezgodne".

SearchEncryptionWithCmk

Opisuje, jak usługa wyszukiwania powinna wymuszać posiadanie co najmniej jednego zasobu niezaszyfrowanego przez klienta.

SearchSemanticSearch

Ustawia opcje kontrolujące dostępność wyszukiwania semantycznego. Ta konfiguracja jest możliwa tylko dla niektórych jednostek SKU wyszukiwania w określonych lokalizacjach.

SearchService

Opisuje usługę wyszukiwania i jej bieżący stan.

SearchServiceStatus

Stan usługi wyszukiwania. Możliwe wartości to: "running": usługa wyszukiwania jest uruchomiona i nie są w toku żadne operacje aprowizacji. "aprowizacja": usługa wyszukiwania jest aprowizowana lub skalowana w górę lub w dół. "usuwanie": usługa wyszukiwania jest usuwana. "obniżona wydajność": usługa wyszukiwania jest obniżona. Może się to zdarzyć, gdy bazowe jednostki wyszukiwania nie są w dobrej kondycji. Usługa wyszukiwania najprawdopodobniej działa, ale wydajność może być niska, a niektóre żądania mogą zostać usunięte. "disabled": usługa wyszukiwania jest wyłączona. W tym stanie usługa odrzuci wszystkie żądania interfejsu API. "błąd": usługa wyszukiwania jest w stanie błędu. Jeśli Twoja usługa znajduje się w stanach obniżonej wydajności, wyłączenia lub błędu, firma Microsoft aktywnie bada podstawowy problem. Usługi dedykowane w tych stanach są nadal naliczane opłaty na podstawie liczby aprowizowanych jednostek wyszukiwania.

SharedPrivateLinkResource

Opisuje zasób udostępniony Private Link zarządzany przez usługę wyszukiwania.

SharedPrivateLinkResourceProperties

Opisuje właściwości istniejącego zasobu udostępnionego Private Link zarządzanego przez usługę wyszukiwania.

SharedPrivateLinkResourceProvisioningState

Stan aprowizacji zasobu udostępnionego łącza prywatnego. Prawidłowe wartości to Aktualizowanie, Usuwanie, Niepowodzenie, Powodzenie lub Niekompletne.

SharedPrivateLinkResourceStatus

Stan zasobu udostępnionego łącza prywatnego. Prawidłowe wartości to Oczekujące, Zatwierdzone, Odrzucone lub Rozłączone.

Sku

Definiuje jednostkę SKU usługi wyszukiwania, która określa szybkość rozliczeń i limity pojemności.

SkuName

Jednostka SKU usługi wyszukiwania. Prawidłowe wartości to: "bezpłatna": usługa udostępniona. "basic": Dedykowana usługa z maksymalnie 3 replikami. "Standardowa": Dedykowana usługa z maksymalnie 12 partycjami i 12 replikami. "standard2": podobnie jak w warstwie Standardowa, ale z większą pojemnością na jednostkę wyszukiwania. "standard3": największa oferta w warstwie Standardowa z maksymalnie 12 partycjami i 12 replikami (lub maksymalnie 3 partycje o większej godzinie, jeśli ustawisz również właściwość hostingMode na "highDensity"). "storage_optimized_l1": obsługuje 1 TB na partycję, maksymalnie 12 partycji. "storage_optimized_l2": obsługuje 2 TB na partycję, do 12 partycji.

AadAuthFailureMode

Opisuje odpowiedź interfejsu API płaszczyzny danych usługi wyszukiwania wysyłanej dla żądań, które zakończyły się niepowodzeniem uwierzytelniania.

Nazwa Typ Opis
http401WithBearerChallenge

string

Wskazuje, że żądania, które nie powiodło się uwierzytelnianie, powinny zostać wyświetlone z kodem stanu HTTP 401 (Brak autoryzacji) i przedstawić wyzwanie elementu nośnego.

http403

string

Wskazuje, że żądania, które nie powiodło się uwierzytelnianie, powinny być wyświetlane z kodem stanu HTTP 403 (Zabronione).

ApiKeyOnly

Wskazuje, że do uwierzytelniania może być używany tylko klucz interfejsu API.

CloudError

Zawiera informacje o błędzie interfejsu API.

Nazwa Typ Opis
error

CloudErrorBody

Opisuje określony błąd interfejsu API z kodem błędu i komunikatem.

CloudErrorBody

Opisuje określony błąd interfejsu API z kodem błędu i komunikatem.

Nazwa Typ Opis
code

string

Kod błędu opisujący warunek błędu dokładniej niż kod stanu HTTP. Może służyć do programowego obsługi określonych przypadków błędów.

details

CloudErrorBody[]

Zawiera zagnieżdżone błędy związane z tym błędem.

message

string

Komunikat opisujący szczegółowo błąd i zawierający informacje dotyczące debugowania.

target

string

Element docelowy określonego błędu (na przykład nazwa właściwości w błędzie).

DataPlaneAadOrApiKeyAuthOption

Wskazuje, że do uwierzytelniania można użyć klucza interfejsu API lub tokenu dostępu z dzierżawy Tożsamość Microsoft Entra.

Nazwa Typ Opis
aadAuthFailureMode

AadAuthFailureMode

Opisuje odpowiedź interfejsu API płaszczyzny danych usługi wyszukiwania wysyłanej dla żądań, które zakończyły się niepowodzeniem uwierzytelniania.

DataPlaneAuthOptions

Definiuje opcje sposobu uwierzytelniania żądania płaszczyzny danych przez usługę wyszukiwania. Nie można ustawić tego ustawienia, jeśli wartość "disableLocalAuth" ma wartość true.

Nazwa Typ Opis
aadOrApiKey

DataPlaneAadOrApiKeyAuthOption

Wskazuje, że do uwierzytelniania można użyć klucza interfejsu API lub tokenu dostępu z dzierżawy Tożsamość Microsoft Entra.

apiKeyOnly

ApiKeyOnly

Wskazuje, że do uwierzytelniania może być używany tylko klucz interfejsu API.

EncryptionWithCmk

Opisuje zasady określające sposób szyfrowania zasobów w usłudze wyszukiwania przy użyciu kluczy zarządzanych customer=managed.

Nazwa Typ Opis
encryptionComplianceStatus

SearchEncryptionComplianceStatus

Opisuje, czy usługa wyszukiwania jest zgodna, czy nie w odniesieniu do zasobów niezaszyfrowanych przez klienta. Jeśli usługa ma więcej niż jeden zasób niezaszyfrowany przez klienta, a "Wymuszanie" jest włączone, usługa zostanie oznaczona jako "niezgodne".

enforcement

SearchEncryptionWithCmk

Opisuje, jak usługa wyszukiwania powinna wymuszać posiadanie co najmniej jednego zasobu niezaszyfrowanego przez klienta.

HostingMode

Dotyczy tylko jednostki SKU w warstwie Standardowa3. Tę właściwość można ustawić tak, aby umożliwić maksymalnie 3 partycje o wysokiej gęstości, które umożliwiają maksymalnie 1000 indeksów, co jest znacznie wyższe niż maksymalne indeksy dozwolone dla dowolnej innej jednostki SKU. W przypadku jednostki SKU w warstwie Standardowa3 wartość to "default" lub "highDensity". Dla wszystkich innych jednostek SKU ta wartość musi być "domyślna".

Nazwa Typ Opis
default

string

Limit liczby indeksów jest określany przez domyślne limity dla jednostki SKU.

highDensity

string

Tylko aplikacja dla jednostki SKU w warstwie Standardowa3, w której usługa wyszukiwania może mieć maksymalnie 1000 indeksów.

Identity

Tożsamość zasobu.

Nazwa Typ Opis
principalId

string

Identyfikator podmiotu zabezpieczeń przypisanej przez system tożsamości usługi wyszukiwania.

tenantId

string

Identyfikator dzierżawy przypisanej przez system tożsamości usługi wyszukiwania.

type

IdentityType

Typ tożsamości.

IdentityType

Typ tożsamości.

Nazwa Typ Opis
None

string

SystemAssigned

string

IpRule

Reguła ograniczenia adresu IP usługi wyszukiwania.

Nazwa Typ Opis
value

string

Wartość odpowiadająca pojedynczemu adresowi IPv4 (na przykład 123.1.2.3) lub zakresowi adresów IP w formacie CIDR (na przykład 123.1.2.3/24) może być dozwolona.

NetworkRuleSet

Reguły specyficzne dla sieci, które określają, jak można uzyskać dostęp do usługi wyszukiwania.

Nazwa Typ Opis
ipRules

IpRule[]

Lista reguł ograniczeń adresów IP używanych dla zapory adresów IP. Wszystkie adresy IP, które nie są zgodne z regułami, są blokowane przez zaporę. Te reguły są stosowane tylko wtedy, gdy "publicNetworkAccess" usługi wyszukiwania jest "włączone".

PrivateEndpoint

Zasób prywatnego punktu końcowego od dostawcy Microsoft.Network.

Nazwa Typ Opis
id

string

Identyfikator zasobu prywatnego punktu końcowego od dostawcy Microsoft.Network.

PrivateEndpointConnection

Opisuje istniejące połączenie prywatnego punktu końcowego z usługą wyszukiwania.

Nazwa Typ Opis
id

string

W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex — /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Nazwa zasobu

properties

PrivateEndpointConnectionProperties

Opisuje właściwości istniejącego połączenia prywatnego punktu końcowego z usługą wyszukiwania.

type

string

Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProperties

Opisuje właściwości istniejącego połączenia prywatnego punktu końcowego z usługą wyszukiwania.

Nazwa Typ Opis
groupId

string

Identyfikator grupy od dostawcy zasobu jest przeznaczony dla połączenia usługi private link.

privateEndpoint

PrivateEndpoint

Zasób prywatnego punktu końcowego od dostawcy Microsoft.Network.

privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Opisuje bieżący stan istniejącego połączenia usługi Private Link z prywatnym punktem końcowym platformy Azure.

provisioningState

PrivateLinkServiceConnectionProvisioningState

Stan aprowizacji połączenia usługi private link. Prawidłowe wartości to Aktualizowanie, usuwanie, niepowodzenie, powodzenie lub niekompletne

PrivateLinkServiceConnectionProvisioningState

Stan aprowizacji połączenia usługi private link. Prawidłowe wartości to Aktualizowanie, usuwanie, niepowodzenie, powodzenie lub niekompletne

Nazwa Typ Opis
Canceled

string

Żądanie aprowizacji zasobu połączenia usługi private link zostało anulowane

Deleting

string

Połączenie usługi private link jest w trakcie usuwania.

Failed

string

Nie można aprowizować ani usunąć połączenia usługi łącza prywatnego.

Incomplete

string

Żądanie aprowizacji zasobu połączenia usługi private link zostało zaakceptowane, ale proces tworzenia nie został jeszcze rozpoczęty.

Succeeded

string

Połączenie usługi private link zakończyło aprowizację i jest gotowe do zatwierdzenia.

Updating

string

Połączenie usługi private link jest w trakcie tworzenia wraz z innymi zasobami, które mają być w pełni funkcjonalne.

PrivateLinkServiceConnectionState

Opisuje bieżący stan istniejącego połączenia usługi Private Link z prywatnym punktem końcowym platformy Azure.

Nazwa Typ Wartość domyślna Opis
actionsRequired

string

None

Opis wszelkich dodatkowych akcji, które mogą być wymagane.

description

string

Opis stanu połączenia usługi private link.

status

PrivateLinkServiceConnectionStatus

Stan połączenia usługi private link. Prawidłowe wartości to Oczekujące, Zatwierdzone, Odrzucone lub Rozłączone.

PrivateLinkServiceConnectionStatus

Stan połączenia usługi private link. Prawidłowe wartości to Oczekujące, Zatwierdzone, Odrzucone lub Rozłączone.

Nazwa Typ Opis
Approved

string

Połączenie prywatnego punktu końcowego jest zatwierdzone i jest gotowe do użycia.

Disconnected

string

Połączenie prywatnego punktu końcowego zostało usunięte z usługi.

Pending

string

Połączenie prywatnego punktu końcowego zostało utworzone i oczekuje na zatwierdzenie.

Rejected

string

Połączenie prywatnego punktu końcowego zostało odrzucone i nie można go użyć.

ProvisioningState

Stan ostatniej operacji aprowizacji wykonanej w usłudze wyszukiwania. Aprowizowanie jest stanem pośrednim, który występuje podczas ustanawiania pojemności usługi. Po skonfigurowaniu pojemności aprowizacjaStan zmieni się na "powodzenie" lub "niepowodzenie". Aplikacje klienckie mogą sondować stan aprowizacji (zalecany interwał sondowania wynosi od 30 sekund do jednej minuty) przy użyciu operacji Pobierz usługę wyszukiwania, aby zobaczyć, kiedy operacja została ukończona. Jeśli używasz bezpłatnej usługi, ta wartość ma tendencję do powrotu jako "powodzenie" bezpośrednio w wywołaniu do tworzenia usługi wyszukiwania. Dzieje się tak, ponieważ bezpłatna usługa używa już skonfigurowanej pojemności.

Nazwa Typ Opis
failed

string

Ostatnia operacja aprowizacji nie powiodła się.

provisioning

string

Usługa wyszukiwania jest aprowizowana lub skalowana w górę lub w dół.

succeeded

string

Ostatnia operacja aprowizacji zakończyła się pomyślnie.

PublicNetworkAccess

Tę wartość można ustawić na "włączone", aby uniknąć zmian powodujących niezgodność istniejących zasobów i szablonów klientów. Jeśli ustawiono wartość "disabled", ruch za pośrednictwem interfejsu publicznego jest niedozwolony, a prywatne połączenia punktu końcowego będą metodą wyłącznego dostępu.

Nazwa Typ Opis
disabled

string

enabled

string

SearchEncryptionComplianceStatus

Opisuje, czy usługa wyszukiwania jest zgodna, czy nie w odniesieniu do zasobów niezaszyfrowanych przez klienta. Jeśli usługa ma więcej niż jeden zasób niezaszyfrowany przez klienta, a "Wymuszanie" jest włączone, usługa zostanie oznaczona jako "niezgodne".

Nazwa Typ Opis
Compliant

string

Wskazuje, że usługa wyszukiwania jest zgodna, ponieważ liczba zasobów niezaszyfrowanych przez klienta jest zerowa lub wymuszanie jest wyłączone.

NonCompliant

string

Wskazuje, że usługa wyszukiwania ma więcej niż jeden nieszyfrowany przez klienta zasobów.

SearchEncryptionWithCmk

Opisuje, jak usługa wyszukiwania powinna wymuszać posiadanie co najmniej jednego zasobu niezaszyfrowanego przez klienta.

Nazwa Typ Opis
Disabled

string

Nie zostanie wykonane żadne wymuszanie, a usługa wyszukiwania może mieć zasoby niezaszyfrowane przez klienta.

Enabled

string

usługa wyszukiwania zostaną oznaczone jako niezgodne, jeśli istnieje co najmniej jeden niezaszyfrowany przez klienta zasobów.

Unspecified

string

Zasady wymuszania nie są jawnie określone, a zachowanie jest takie samo jak w przypadku ustawienia "Wyłączone".

SearchSemanticSearch

Ustawia opcje kontrolujące dostępność wyszukiwania semantycznego. Ta konfiguracja jest możliwa tylko dla niektórych jednostek SKU wyszukiwania w określonych lokalizacjach.

Nazwa Typ Opis
disabled

string

Wskazuje, że klasyfikacja semantyczna jest wyłączona dla usługi wyszukiwania.

free

string

Włącza klasyfikację semantyczną w usłudze wyszukiwania i wskazuje, że ma być używana w granicach warstwy Bezpłatna. Spowoduje to ograniczenie liczby semantycznych żądań klasyfikacji i jest oferowane bez dodatkowych opłat. Jest to ustawienie domyślne dla nowo aprowizowanych usług wyszukiwania.

standard

string

Umożliwia semantyczne klasyfikowanie w usłudze wyszukiwania jako funkcji rozliczanej z większą przepływnością i ilością żądań klasyfikacji semantycznej.

SearchService

Opisuje usługę wyszukiwania i jej bieżący stan.

Nazwa Typ Wartość domyślna Opis
id

string

W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex — /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

Identity

Tożsamość zasobu.

location

string

Lokalizacja geograficzna, w której znajduje się zasób

name

string

Nazwa zasobu

properties.authOptions

DataPlaneAuthOptions

Definiuje opcje sposobu uwierzytelniania żądań przez interfejs API płaszczyzny danych usługi wyszukiwania. Nie można ustawić tego ustawienia, jeśli wartość "disableLocalAuth" ma wartość true.

properties.disableLocalAuth

boolean

Po ustawieniu wartości true wywołania usługi wyszukiwania nie będą mogły korzystać z kluczy interfejsu API do uwierzytelniania. Nie można ustawić wartości true, jeśli zdefiniowano wartość "dataPlaneAuthOptions".

properties.encryptionWithCmk

EncryptionWithCmk

Określa wszelkie zasady dotyczące szyfrowania zasobów (takich jak indeksy) przy użyciu kluczy menedżera klienta w usłudze wyszukiwania.

properties.hostingMode

HostingMode

default

Dotyczy tylko jednostki SKU w warstwie Standardowa3. Tę właściwość można ustawić tak, aby umożliwić maksymalnie 3 partycje o wysokiej gęstości, które umożliwiają maksymalnie 1000 indeksów, co jest znacznie wyższe niż maksymalne indeksy dozwolone dla dowolnej innej jednostki SKU. W przypadku jednostki SKU w warstwie Standardowa3 wartość to "default" lub "highDensity". Dla wszystkich innych jednostek SKU ta wartość musi być "domyślna".

properties.networkRuleSet

NetworkRuleSet

Reguły specyficzne dla sieci, które określają, jak można osiągnąć usługę wyszukiwania.

properties.partitionCount

integer

1

Liczba partycji w usłudze wyszukiwania; jeśli zostanie określony, może to być 1, 2, 3, 4, 6 lub 12. Wartości większe niż 1 są prawidłowe tylko dla standardowych jednostek SKU. W przypadku usług "standard3" z hostMode ustawionym na wartość "highDensity" dozwolone wartości to od 1 do 3.

properties.privateEndpointConnections

PrivateEndpointConnection[]

Lista połączeń prywatnego punktu końcowego z usługą wyszukiwania.

properties.provisioningState

ProvisioningState

Stan ostatniej operacji aprowizacji wykonanej w usłudze wyszukiwania. Aprowizowanie jest stanem pośrednim, który występuje podczas ustanawiania pojemności usługi. Po skonfigurowaniu pojemności aprowizacjaStan zmieni się na "powodzenie" lub "niepowodzenie". Aplikacje klienckie mogą sondować stan aprowizacji (zalecany interwał sondowania wynosi od 30 sekund do jednej minuty) przy użyciu operacji Pobierz usługę wyszukiwania, aby zobaczyć, kiedy operacja została ukończona. Jeśli używasz bezpłatnej usługi, ta wartość ma tendencję do powrotu jako "powodzenie" bezpośrednio w wywołaniu do tworzenia usługi wyszukiwania. Dzieje się tak, ponieważ bezpłatna usługa używa już skonfigurowanej pojemności.

properties.publicNetworkAccess

PublicNetworkAccess

enabled

Tę wartość można ustawić na "włączone", aby uniknąć zmian powodujących niezgodność istniejących zasobów i szablonów klientów. Jeśli ustawiono wartość "disabled", ruch za pośrednictwem interfejsu publicznego jest niedozwolony, a prywatne połączenia punktu końcowego będą metodą wyłącznego dostępu.

properties.replicaCount

integer

1

Liczba replik w usłudze wyszukiwania. W przypadku określenia musi to być wartość z zakresu od 1 do 12 włącznie dla standardowych jednostek SKU lub od 1 do 3 włącznie dla podstawowej jednostki SKU.

properties.semanticSearch

SearchSemanticSearch

Ustawia opcje kontrolujące dostępność wyszukiwania semantycznego. Ta konfiguracja jest możliwa tylko dla niektórych jednostek SKU wyszukiwania w określonych lokalizacjach.

properties.sharedPrivateLinkResources

SharedPrivateLinkResource[]

Lista udostępnionych zasobów linków prywatnych zarządzanych przez usługę wyszukiwania.

properties.status

SearchServiceStatus

Stan usługi wyszukiwania. Możliwe wartości to: "running": usługa wyszukiwania jest uruchomiona i nie są w toku żadne operacje aprowizacji. "aprowizacja": usługa wyszukiwania jest aprowizowana lub skalowana w górę lub w dół. "usuwanie": usługa wyszukiwania jest usuwana. "obniżona wydajność": usługa wyszukiwania jest obniżona. Może się to zdarzyć, gdy bazowe jednostki wyszukiwania nie są w dobrej kondycji. Usługa wyszukiwania najprawdopodobniej działa, ale wydajność może być niska, a niektóre żądania mogą zostać usunięte. "disabled": usługa wyszukiwania jest wyłączona. W tym stanie usługa odrzuci wszystkie żądania interfejsu API. "błąd": usługa wyszukiwania jest w stanie błędu. Jeśli Twoja usługa znajduje się w stanach obniżonej wydajności, wyłączenia lub błędu, firma Microsoft aktywnie bada podstawowy problem. Usługi dedykowane w tych stanach są nadal naliczane opłaty na podstawie liczby aprowizowanych jednostek wyszukiwania.

properties.statusDetails

string

Szczegóły stanu usługi wyszukiwania.

sku

Sku

Jednostka SKU usługi wyszukiwania, która określa szybkość rozliczeń i limity pojemności. Ta właściwość jest wymagana podczas tworzenia nowej usługi wyszukiwania.

tags

object

Tagi zasobów.

type

string

Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

SearchServiceStatus

Stan usługi wyszukiwania. Możliwe wartości to: "running": usługa wyszukiwania jest uruchomiona i nie są w toku żadne operacje aprowizacji. "aprowizacja": usługa wyszukiwania jest aprowizowana lub skalowana w górę lub w dół. "usuwanie": usługa wyszukiwania jest usuwana. "obniżona wydajność": usługa wyszukiwania jest obniżona. Może się to zdarzyć, gdy bazowe jednostki wyszukiwania nie są w dobrej kondycji. Usługa wyszukiwania najprawdopodobniej działa, ale wydajność może być niska, a niektóre żądania mogą zostać usunięte. "disabled": usługa wyszukiwania jest wyłączona. W tym stanie usługa odrzuci wszystkie żądania interfejsu API. "błąd": usługa wyszukiwania jest w stanie błędu. Jeśli Twoja usługa znajduje się w stanach obniżonej wydajności, wyłączenia lub błędu, firma Microsoft aktywnie bada podstawowy problem. Usługi dedykowane w tych stanach są nadal naliczane opłaty na podstawie liczby aprowizowanych jednostek wyszukiwania.

Nazwa Typ Opis
degraded

string

Usługa wyszukiwania jest obniżona, ponieważ bazowe jednostki wyszukiwania nie są w dobrej kondycji.

deleting

string

Usługa wyszukiwania jest usuwana.

disabled

string

Usługa wyszukiwania jest wyłączona, a wszystkie żądania interfejsu API zostaną odrzucone.

error

string

Usługa wyszukiwania jest w stanie błędu wskazującym niepowodzenie aprowizacji lub usunięcie.

provisioning

string

Usługa wyszukiwania jest aprowizowana lub skalowana w górę lub w dół.

running

string

Usługa wyszukiwania jest uruchomiona i nie są w toku żadne operacje aprowizacji.

SharedPrivateLinkResource

Opisuje zasób udostępniony Private Link zarządzany przez usługę wyszukiwania.

Nazwa Typ Opis
id

string

W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex — /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Nazwa zasobu

properties

SharedPrivateLinkResourceProperties

Opisuje właściwości udostępnionego zasobu Private Link zarządzanego przez usługę wyszukiwania.

type

string

Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

SharedPrivateLinkResourceProperties

Opisuje właściwości istniejącego zasobu udostępnionego Private Link zarządzanego przez usługę wyszukiwania.

Nazwa Typ Opis
groupId

string

Identyfikator grupy od dostawcy zasobu, dla których znajduje się udostępniony zasób łącza prywatnego.

privateLinkResourceId

string

Identyfikator zasobu zasobu, dla których znajduje się udostępniony zasób łącza prywatnego.

provisioningState

SharedPrivateLinkResourceProvisioningState

Stan aprowizacji zasobu udostępnionego łącza prywatnego. Prawidłowe wartości to Aktualizowanie, Usuwanie, Niepowodzenie, Powodzenie lub Niekompletne.

requestMessage

string

Komunikat żądania dotyczący żądania zatwierdzenia udostępnionego zasobu łącza prywatnego.

resourceRegion

string

Opcjonalny. Można użyć do określenia lokalizacji Resource Manager platformy Azure zasobu, do którego ma zostać utworzone udostępnione łącze prywatne. Jest to wymagane tylko dla tych zasobów, których konfiguracja DNS jest regionalna (na przykład Azure Kubernetes Service).

status

SharedPrivateLinkResourceStatus

Stan zasobu udostępnionego łącza prywatnego. Prawidłowe wartości to Oczekujące, Zatwierdzone, Odrzucone lub Rozłączone.

SharedPrivateLinkResourceProvisioningState

Stan aprowizacji zasobu udostępnionego łącza prywatnego. Prawidłowe wartości to Aktualizowanie, Usuwanie, Niepowodzenie, Powodzenie lub Niekompletne.

Nazwa Typ Opis
Deleting

string

Failed

string

Incomplete

string

Succeeded

string

Updating

string

SharedPrivateLinkResourceStatus

Stan zasobu udostępnionego łącza prywatnego. Prawidłowe wartości to Oczekujące, Zatwierdzone, Odrzucone lub Rozłączone.

Nazwa Typ Opis
Approved

string

Disconnected

string

Pending

string

Rejected

string

Sku

Definiuje jednostkę SKU usługi wyszukiwania, która określa szybkość rozliczeń i limity pojemności.

Nazwa Typ Opis
name

SkuName

Jednostka SKU usługi wyszukiwania. Prawidłowe wartości to: "bezpłatna": usługa udostępniona. "basic": Dedykowana usługa z maksymalnie 3 replikami. "Standardowa": Dedykowana usługa z maksymalnie 12 partycjami i 12 replikami. "standard2": podobnie jak w warstwie Standardowa, ale z większą pojemnością na jednostkę wyszukiwania. "standard3": największa oferta w warstwie Standardowa z maksymalnie 12 partycjami i 12 replikami (lub maksymalnie 3 partycje o większej godzinie, jeśli ustawisz również właściwość hostingMode na "highDensity"). "storage_optimized_l1": obsługuje 1 TB na partycję, maksymalnie 12 partycji. "storage_optimized_l2": obsługuje 2 TB na partycję, do 12 partycji.

SkuName

Jednostka SKU usługi wyszukiwania. Prawidłowe wartości to: "bezpłatna": usługa udostępniona. "basic": Dedykowana usługa z maksymalnie 3 replikami. "Standardowa": Dedykowana usługa z maksymalnie 12 partycjami i 12 replikami. "standard2": podobnie jak w warstwie Standardowa, ale z większą pojemnością na jednostkę wyszukiwania. "standard3": największa oferta w warstwie Standardowa z maksymalnie 12 partycjami i 12 replikami (lub maksymalnie 3 partycje o większej godzinie, jeśli ustawisz również właściwość hostingMode na "highDensity"). "storage_optimized_l1": obsługuje 1 TB na partycję, maksymalnie 12 partycji. "storage_optimized_l2": obsługuje 2 TB na partycję, do 12 partycji.

Nazwa Typ Opis
basic

string

Warstwa rozliczana dla dedykowanej usługi z maksymalnie 3 replikami.

free

string

Warstwa Bezpłatna bez gwarancji umowy SLA i podzbiór funkcji oferowanych w warstwach rozliczanych.

standard

string

Warstwa rozliczana dla dedykowanej usługi z maksymalnie 12 partycjami i 12 replikami.

standard2

string

Podobnie jak w przypadku warstwy "Standardowa", ale z większą pojemnością na jednostkę wyszukiwania.

standard3

string

Największa oferta w warstwie Standardowa z maksymalnie 12 partycjami i 12 replikami (lub maksymalnie 3 partycje z większą liczbą, jeśli ustawisz również właściwość hostingMode na "highDensity").

storage_optimized_l1

string

Warstwa rozliczana dla dedykowanej usługi, która obsługuje 1 TB na partycję, do 12 partycji.

storage_optimized_l2

string

Warstwa rozliczana dla dedykowanej usługi, która obsługuje 2 TB na partycję, do 12 partycji.