Frissítések egy meglévő keresési szolgáltatást az adott erőforráscsoportban.
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}?api-version=2023-11-01
URI-paraméterek
| Name |
In |
Kötelező |
Típus |
Description |
|
resourceGroupName
|
path |
True
|
string
|
Az aktuális előfizetésen belüli erőforráscsoport neve. Ezt az értéket az Azure Resource Manager API-ból vagy a portálról szerezheti be.
|
|
searchServiceName
|
path |
True
|
string
|
A frissíteni kívánt keresési szolgáltatás neve.
|
|
subscriptionId
|
path |
True
|
string
|
A Microsoft Azure-előfizetés egyedi azonosítója. Ezt az értéket az Azure Resource Manager API-ból, parancssori eszközökből vagy a portálról szerezheti be.
|
|
api-version
|
query |
True
|
string
|
Az egyes kérésekhez használni kívánt API-verzió.
|
| Name |
Kötelező |
Típus |
Description |
|
x-ms-client-request-id
|
|
string
uuid
|
Egy ügyfél által létrehozott GUID-érték, amely azonosítja ezt a kérést. Ha meg van adva, ez a kérés nyomon követésének módjaként szerepelni fog a válaszinformációkban.
|
Kérelem törzse
| Name |
Típus |
Description |
|
identity
|
Identity
|
Az erőforrás identitása.
|
|
location
|
string
|
Az erőforrás földrajzi helye. Ennek a támogatott és regisztrált Azure-georégiók egyikének kell lennie (például az USA nyugati régiója, az USA keleti régiója, Délkelet-Ázsia stb.). Ez a tulajdonság új erőforrás létrehozásakor szükséges.
|
|
properties.authOptions
|
DataPlaneAuthOptions
|
Meghatározza, hogy a keresési szolgáltatás adatsík API-ja hogyan hitelesíti a kéréseket. Ez nem állítható be, ha a disableLocalAuth értéke igaz.
|
|
properties.disableLocalAuth
|
boolean
|
Ha igaz értékre van állítva, a keresési szolgáltatás hívásai nem használhatják az API-kulcsokat a hitelesítéshez. Ez nem állítható igaz értékre, ha a "dataPlaneAuthOptions" definiálva van.
|
|
properties.encryptionWithCmk
|
EncryptionWithCmk
|
Meghatározza az erőforrások (például indexek) ügyfélkezelői kulcsokkal történő titkosítására vonatkozó szabályzatokat a keresési szolgáltatáson belül.
|
|
properties.hostingMode
|
HostingMode
|
Csak a standard3 termékváltozatra alkalmazható. Ezt a tulajdonságot beállíthatja úgy, hogy legfeljebb 3 nagy sűrűségű partíciót engedélyezzen, amelyek legfeljebb 1000 indexet tesznek lehetővé, ami sokkal magasabb, mint bármely más termékváltozat esetében engedélyezett maximális indexek. A standard3 termékváltozat esetében az érték "alapértelmezett" vagy "highDensity". Az összes többi termékváltozat esetében ennek az értéknek "alapértelmezettnek" kell lennie.
|
|
properties.networkRuleSet
|
NetworkRuleSet
|
Hálózatspecifikus szabályok, amelyek meghatározzák a keresési szolgáltatás elérésének módját.
|
|
properties.partitionCount
|
integer
|
A keresési szolgáltatás partícióinak száma; ha meg van adva, 1, 2, 3, 4, 6 vagy 12 lehet. Az 1-nél nagyobb értékek csak standard termékváltozatokra érvényesek. A "standard3" szolgáltatások esetében a hostingMode értéke "highDensity", az engedélyezett értékek 1 és 3 között vannak.
|
|
properties.publicNetworkAccess
|
PublicNetworkAccess
|
Ez az érték "engedélyezve" értékre állítható, hogy elkerülje a meglévő ügyfélerőforrások és sablonok kompatibilitástörő változásait. Ha a "letiltva" értékre van állítva, a nyilvános adapteren keresztüli forgalom nem engedélyezett, és a privát végponti kapcsolatok a kizárólagos hozzáférési módszer.
|
|
properties.replicaCount
|
integer
|
A keresési szolgáltatás replikáinak száma. Ha meg van adva, akkor a standard termékváltozatok esetében 1 és 12 közötti, alapszintű termékváltozat esetén 1 és 3 közötti értéknek kell lennie.
|
|
properties.semanticSearch
|
SearchSemanticSearch
|
Beállítja a szemantikai keresés elérhetőségét szabályozó beállításokat. Ez a konfiguráció csak bizonyos keresési termékváltozatok esetében lehetséges bizonyos helyeken.
|
|
sku
|
Sku
|
A keresési szolgáltatás termékváltozata, amely meghatározza a számlázási díjat és a kapacitáskorlátokat. Ez a tulajdonság új keresési szolgáltatás létrehozásakor szükséges.
|
|
tags
|
object
|
Címkék az erőforrás kategorizálásához a Azure Portal.
|
Válaszok
| Name |
Típus |
Description |
|
200 OK
|
SearchService
|
A meglévő szolgáltatásdefiníció frissítése sikerült. Ha módosította a replikák vagy partíciók számát, a skálázási művelet aszinkron módon fog történni. Rendszeres időközönként lekérheti a szolgáltatásdefiníciót, és monitorozhatja az előrehaladást a provisioningState tulajdonságon keresztül.
|
|
Other Status Codes
|
CloudError
|
HTTP 400 (hibás kérelem): A megadott szolgáltatásdefiníció érvénytelen, vagy nem módosítható tulajdonságot próbált módosítani; A részletekért tekintse meg a hibakódot és az üzenetet a válaszban. HTTP 404 (Nem található): Az előfizetés vagy az erőforráscsoport nem található. HTTP 409 (ütközés): A megadott előfizetés le van tiltva.
|
Biztonság
azure_auth
Microsoft Entra ID OAuth2 engedélyezési folyamat.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
| Name |
Description |
|
user_impersonation
|
felhasználói fiók megszemélyesítése
|
Példák
SearchUpdateService
Sample Request
PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2023-11-01
{
"tags": {
"app-name": "My e-commerce app",
"new-tag": "Adding a new tag"
},
"properties": {
"replicaCount": 2
}
}
import com.azure.resourcemanager.search.models.SearchServiceUpdate;
import java.util.HashMap;
import java.util.Map;
/** Samples for Services Update. */
public final class Main {
/*
* x-ms-original-file:
* specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchUpdateService.json
*/
/**
* Sample code: SearchUpdateService.
*
* @param azure The entry point for accessing resource management APIs in Azure.
*/
public static void searchUpdateService(com.azure.resourcemanager.AzureResourceManager azure) {
azure.searchServices().manager().serviceClient().getServices()
.updateWithResponse("rg1", "mysearchservice", new SearchServiceUpdate()
.withTags(mapOf("app-name", "My e-commerce app", "new-tag", "Adding a new tag")).withReplicaCount(2),
null, com.azure.core.util.Context.NONE);
}
// Use "Map.of" if available
@SuppressWarnings("unchecked")
private static <T> Map<String, T> mapOf(Object... inputs) {
Map<String, T> map = new HashMap<>();
for (int i = 0; i < inputs.length; i += 2) {
String key = (String) inputs[i];
T value = (T) inputs[i + 1];
map.put(key, value);
}
return map;
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
from azure.identity import DefaultAzureCredential
from azure.mgmt.search import SearchManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-search
# USAGE
python search_update_service.py
Before run the sample, please set the values of the client ID, tenant ID and client secret
of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""
def main():
client = SearchManagementClient(
credential=DefaultAzureCredential(),
subscription_id="subid",
)
response = client.services.update(
resource_group_name="rg1",
search_service_name="mysearchservice",
service={
"properties": {"replicaCount": 2},
"tags": {"app-name": "My e-commerce app", "new-tag": "Adding a new tag"},
},
)
print(response)
# x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchUpdateService.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
package armsearch_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/search/armsearch"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7e29dd59eef13ef347d09e41a63f2585be77b3ca/specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchUpdateService.json
func ExampleServicesClient_Update_searchUpdateService() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armsearch.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewServicesClient().Update(ctx, "rg1", "mysearchservice", armsearch.ServiceUpdate{
Properties: &armsearch.ServiceProperties{
ReplicaCount: to.Ptr[int32](2),
},
Tags: map[string]*string{
"app-name": to.Ptr("My e-commerce app"),
"new-tag": to.Ptr("Adding a new tag"),
},
}, &armsearch.SearchManagementRequestOptions{ClientRequestID: nil}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.Service = armsearch.Service{
// Name: to.Ptr("mysearchservice"),
// Type: to.Ptr("Microsoft.Search/searchServices"),
// ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice"),
// Location: to.Ptr("westus"),
// Tags: map[string]*string{
// "app-name": to.Ptr("My e-commerce app"),
// "new-tag": to.Ptr("Adding a new tag"),
// },
// Properties: &armsearch.ServiceProperties{
// HostingMode: to.Ptr(armsearch.HostingModeDefault),
// NetworkRuleSet: &armsearch.NetworkRuleSet{
// IPRules: []*armsearch.IPRule{
// },
// },
// PartitionCount: to.Ptr[int32](1),
// PrivateEndpointConnections: []*armsearch.PrivateEndpointConnection{
// },
// ProvisioningState: to.Ptr(armsearch.ProvisioningStateSucceeded),
// PublicNetworkAccess: to.Ptr(armsearch.PublicNetworkAccessEnabled),
// ReplicaCount: to.Ptr[int32](2),
// Status: to.Ptr(armsearch.SearchServiceStatusProvisioning),
// StatusDetails: to.Ptr(""),
// },
// SKU: &armsearch.SKU{
// Name: to.Ptr(armsearch.SKUNameStandard),
// },
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { SearchManagementClient } = require("@azure/arm-search");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Updates an existing search service in the given resource group.
*
* @summary Updates an existing search service in the given resource group.
* x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchUpdateService.json
*/
async function searchUpdateService() {
const subscriptionId = process.env["SEARCH_SUBSCRIPTION_ID"] || "subid";
const resourceGroupName = process.env["SEARCH_RESOURCE_GROUP"] || "rg1";
const searchServiceName = "mysearchservice";
const service = {
replicaCount: 2,
tags: { appName: "My e-commerce app", newTag: "Adding a new tag" },
};
const credential = new DefaultAzureCredential();
const client = new SearchManagementClient(credential, subscriptionId);
const result = await client.services.update(resourceGroupName, searchServiceName, service);
console.log(result);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Search;
using Azure.ResourceManager.Search.Models;
// Generated from example definition: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchUpdateService.json
// this example is just showing the usage of "Services_Update" operation, for the dependent resources, they will have to be created separately.
// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);
// this example assumes you already have this SearchServiceResource created on azure
// for more information of creating SearchServiceResource, please refer to the document of SearchServiceResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string searchServiceName = "mysearchservice";
ResourceIdentifier searchServiceResourceId = SearchServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, searchServiceName);
SearchServiceResource searchService = client.GetSearchServiceResource(searchServiceResourceId);
// invoke the operation
SearchServicePatch patch = new SearchServicePatch(new AzureLocation("placeholder"))
{
ReplicaCount = 2,
Tags =
{
["app-name"] = "My e-commerce app",
["new-tag"] = "Adding a new tag",
},
};
SearchServiceResource result = await searchService.UpdateAsync(patch);
// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SearchServiceData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
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",
"new-tag": "Adding a new tag"
},
"sku": {
"name": "standard"
},
"properties": {
"replicaCount": 2,
"partitionCount": 1,
"status": "provisioning",
"statusDetails": "",
"hostingMode": "default",
"provisioningState": "provisioning",
"publicNetworkAccess": "enabled",
"networkRuleSet": {
"ipRules": []
},
"privateEndpointConnections": []
}
}
SearchUpdateServiceAuthOptions
Sample Request
PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2023-11-01
{
"tags": {
"app-name": "My e-commerce app",
"new-tag": "Adding a new tag"
},
"properties": {
"replicaCount": 2,
"authOptions": {
"aadOrApiKey": {
"aadAuthFailureMode": "http401WithBearerChallenge"
}
}
}
}
import com.azure.resourcemanager.search.models.AadAuthFailureMode;
import com.azure.resourcemanager.search.models.DataPlaneAadOrApiKeyAuthOption;
import com.azure.resourcemanager.search.models.DataPlaneAuthOptions;
import com.azure.resourcemanager.search.models.SearchServiceUpdate;
import java.util.HashMap;
import java.util.Map;
/** Samples for Services Update. */
public final class Main {
/*
* x-ms-original-file:
* specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchUpdateServiceAuthOptions.
* json
*/
/**
* Sample code: SearchUpdateServiceAuthOptions.
*
* @param azure The entry point for accessing resource management APIs in Azure.
*/
public static void searchUpdateServiceAuthOptions(com.azure.resourcemanager.AzureResourceManager azure) {
azure.searchServices().manager().serviceClient().getServices().updateWithResponse("rg1", "mysearchservice",
new SearchServiceUpdate().withTags(mapOf("app-name", "My e-commerce app", "new-tag", "Adding a new tag"))
.withReplicaCount(2)
.withAuthOptions(new DataPlaneAuthOptions().withAadOrApiKey(new DataPlaneAadOrApiKeyAuthOption()
.withAadAuthFailureMode(AadAuthFailureMode.HTTP401WITH_BEARER_CHALLENGE))),
null, com.azure.core.util.Context.NONE);
}
// Use "Map.of" if available
@SuppressWarnings("unchecked")
private static <T> Map<String, T> mapOf(Object... inputs) {
Map<String, T> map = new HashMap<>();
for (int i = 0; i < inputs.length; i += 2) {
String key = (String) inputs[i];
T value = (T) inputs[i + 1];
map.put(key, value);
}
return map;
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
from azure.identity import DefaultAzureCredential
from azure.mgmt.search import SearchManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-search
# USAGE
python search_update_service_auth_options.py
Before run the sample, please set the values of the client ID, tenant ID and client secret
of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""
def main():
client = SearchManagementClient(
credential=DefaultAzureCredential(),
subscription_id="subid",
)
response = client.services.update(
resource_group_name="rg1",
search_service_name="mysearchservice",
service={
"properties": {
"authOptions": {"aadOrApiKey": {"aadAuthFailureMode": "http401WithBearerChallenge"}},
"replicaCount": 2,
},
"tags": {"app-name": "My e-commerce app", "new-tag": "Adding a new tag"},
},
)
print(response)
# x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchUpdateServiceAuthOptions.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
package armsearch_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/search/armsearch"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7e29dd59eef13ef347d09e41a63f2585be77b3ca/specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchUpdateServiceAuthOptions.json
func ExampleServicesClient_Update_searchUpdateServiceAuthOptions() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armsearch.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewServicesClient().Update(ctx, "rg1", "mysearchservice", armsearch.ServiceUpdate{
Properties: &armsearch.ServiceProperties{
AuthOptions: &armsearch.DataPlaneAuthOptions{
AADOrAPIKey: &armsearch.DataPlaneAADOrAPIKeyAuthOption{
AADAuthFailureMode: to.Ptr(armsearch.AADAuthFailureModeHttp401WithBearerChallenge),
},
},
ReplicaCount: to.Ptr[int32](2),
},
Tags: map[string]*string{
"app-name": to.Ptr("My e-commerce app"),
"new-tag": to.Ptr("Adding a new tag"),
},
}, &armsearch.SearchManagementRequestOptions{ClientRequestID: nil}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.Service = armsearch.Service{
// Name: to.Ptr("mysearchservice"),
// Type: to.Ptr("Microsoft.Search/searchServices"),
// ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice"),
// Location: to.Ptr("westus"),
// Tags: map[string]*string{
// "app-name": to.Ptr("My e-commerce app"),
// "new-tag": to.Ptr("Adding a new tag"),
// },
// Properties: &armsearch.ServiceProperties{
// AuthOptions: &armsearch.DataPlaneAuthOptions{
// AADOrAPIKey: &armsearch.DataPlaneAADOrAPIKeyAuthOption{
// AADAuthFailureMode: to.Ptr(armsearch.AADAuthFailureModeHttp401WithBearerChallenge),
// },
// },
// HostingMode: to.Ptr(armsearch.HostingModeDefault),
// NetworkRuleSet: &armsearch.NetworkRuleSet{
// IPRules: []*armsearch.IPRule{
// },
// },
// PartitionCount: to.Ptr[int32](1),
// ProvisioningState: to.Ptr(armsearch.ProvisioningStateSucceeded),
// PublicNetworkAccess: to.Ptr(armsearch.PublicNetworkAccessEnabled),
// ReplicaCount: to.Ptr[int32](2),
// Status: to.Ptr(armsearch.SearchServiceStatusProvisioning),
// StatusDetails: to.Ptr(""),
// },
// SKU: &armsearch.SKU{
// Name: to.Ptr(armsearch.SKUNameStandard),
// },
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { SearchManagementClient } = require("@azure/arm-search");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Updates an existing search service in the given resource group.
*
* @summary Updates an existing search service in the given resource group.
* x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchUpdateServiceAuthOptions.json
*/
async function searchUpdateServiceAuthOptions() {
const subscriptionId = process.env["SEARCH_SUBSCRIPTION_ID"] || "subid";
const resourceGroupName = process.env["SEARCH_RESOURCE_GROUP"] || "rg1";
const searchServiceName = "mysearchservice";
const service = {
authOptions: {
aadOrApiKey: { aadAuthFailureMode: "http401WithBearerChallenge" },
},
replicaCount: 2,
tags: { appName: "My e-commerce app", newTag: "Adding a new tag" },
};
const credential = new DefaultAzureCredential();
const client = new SearchManagementClient(credential, subscriptionId);
const result = await client.services.update(resourceGroupName, searchServiceName, service);
console.log(result);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Search;
using Azure.ResourceManager.Search.Models;
// Generated from example definition: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchUpdateServiceAuthOptions.json
// this example is just showing the usage of "Services_Update" operation, for the dependent resources, they will have to be created separately.
// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);
// this example assumes you already have this SearchServiceResource created on azure
// for more information of creating SearchServiceResource, please refer to the document of SearchServiceResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string searchServiceName = "mysearchservice";
ResourceIdentifier searchServiceResourceId = SearchServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, searchServiceName);
SearchServiceResource searchService = client.GetSearchServiceResource(searchServiceResourceId);
// invoke the operation
SearchServicePatch patch = new SearchServicePatch(new AzureLocation("placeholder"))
{
ReplicaCount = 2,
AuthOptions = new SearchAadAuthDataPlaneAuthOptions()
{
AadAuthFailureMode = SearchAadAuthFailureMode.Http401WithBearerChallenge,
},
Tags =
{
["app-name"] = "My e-commerce app",
["new-tag"] = "Adding a new tag",
},
};
SearchServiceResource result = await searchService.UpdateAsync(patch);
// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SearchServiceData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
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",
"new-tag": "Adding a new tag"
},
"sku": {
"name": "standard"
},
"properties": {
"replicaCount": 2,
"partitionCount": 1,
"status": "provisioning",
"statusDetails": "",
"hostingMode": "default",
"provisioningState": "provisioning",
"publicNetworkAccess": "enabled",
"networkRuleSet": {
"ipRules": []
},
"authOptions": {
"aadOrApiKey": {
"aadAuthFailureMode": "http401WithBearerChallenge"
}
}
}
}
SearchUpdateServiceDisableLocalAuth
Sample Request
PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2023-11-01
{
"tags": {
"app-name": "My e-commerce app",
"new-tag": "Adding a new tag"
},
"properties": {
"replicaCount": 2,
"disableLocalAuth": true
}
}
import com.azure.resourcemanager.search.models.SearchServiceUpdate;
import java.util.HashMap;
import java.util.Map;
/** Samples for Services Update. */
public final class Main {
/*
* x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/
* SearchUpdateServiceDisableLocalAuth.json
*/
/**
* Sample code: SearchUpdateServiceDisableLocalAuth.
*
* @param azure The entry point for accessing resource management APIs in Azure.
*/
public static void searchUpdateServiceDisableLocalAuth(com.azure.resourcemanager.AzureResourceManager azure) {
azure.searchServices().manager().serviceClient().getServices().updateWithResponse("rg1", "mysearchservice",
new SearchServiceUpdate().withTags(mapOf("app-name", "My e-commerce app", "new-tag", "Adding a new tag"))
.withReplicaCount(2).withDisableLocalAuth(true),
null, com.azure.core.util.Context.NONE);
}
// Use "Map.of" if available
@SuppressWarnings("unchecked")
private static <T> Map<String, T> mapOf(Object... inputs) {
Map<String, T> map = new HashMap<>();
for (int i = 0; i < inputs.length; i += 2) {
String key = (String) inputs[i];
T value = (T) inputs[i + 1];
map.put(key, value);
}
return map;
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
from azure.identity import DefaultAzureCredential
from azure.mgmt.search import SearchManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-search
# USAGE
python search_update_service_disable_local_auth.py
Before run the sample, please set the values of the client ID, tenant ID and client secret
of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""
def main():
client = SearchManagementClient(
credential=DefaultAzureCredential(),
subscription_id="subid",
)
response = client.services.update(
resource_group_name="rg1",
search_service_name="mysearchservice",
service={
"properties": {"disableLocalAuth": True, "replicaCount": 2},
"tags": {"app-name": "My e-commerce app", "new-tag": "Adding a new tag"},
},
)
print(response)
# x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchUpdateServiceDisableLocalAuth.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
package armsearch_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/search/armsearch"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7e29dd59eef13ef347d09e41a63f2585be77b3ca/specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchUpdateServiceDisableLocalAuth.json
func ExampleServicesClient_Update_searchUpdateServiceDisableLocalAuth() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armsearch.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewServicesClient().Update(ctx, "rg1", "mysearchservice", armsearch.ServiceUpdate{
Properties: &armsearch.ServiceProperties{
DisableLocalAuth: to.Ptr(true),
ReplicaCount: to.Ptr[int32](2),
},
Tags: map[string]*string{
"app-name": to.Ptr("My e-commerce app"),
"new-tag": to.Ptr("Adding a new tag"),
},
}, &armsearch.SearchManagementRequestOptions{ClientRequestID: nil}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.Service = armsearch.Service{
// Name: to.Ptr("mysearchservice"),
// Type: to.Ptr("Microsoft.Search/searchServices"),
// ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice"),
// Location: to.Ptr("westus"),
// Tags: map[string]*string{
// "app-name": to.Ptr("My e-commerce app"),
// "new-tag": to.Ptr("Adding a new tag"),
// },
// Properties: &armsearch.ServiceProperties{
// DisableLocalAuth: to.Ptr(true),
// HostingMode: to.Ptr(armsearch.HostingModeDefault),
// NetworkRuleSet: &armsearch.NetworkRuleSet{
// IPRules: []*armsearch.IPRule{
// },
// },
// PartitionCount: to.Ptr[int32](1),
// ProvisioningState: to.Ptr(armsearch.ProvisioningStateSucceeded),
// PublicNetworkAccess: to.Ptr(armsearch.PublicNetworkAccessEnabled),
// ReplicaCount: to.Ptr[int32](2),
// Status: to.Ptr(armsearch.SearchServiceStatusProvisioning),
// StatusDetails: to.Ptr(""),
// },
// SKU: &armsearch.SKU{
// Name: to.Ptr(armsearch.SKUNameStandard),
// },
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { SearchManagementClient } = require("@azure/arm-search");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Updates an existing search service in the given resource group.
*
* @summary Updates an existing search service in the given resource group.
* x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchUpdateServiceDisableLocalAuth.json
*/
async function searchUpdateServiceDisableLocalAuth() {
const subscriptionId = process.env["SEARCH_SUBSCRIPTION_ID"] || "subid";
const resourceGroupName = process.env["SEARCH_RESOURCE_GROUP"] || "rg1";
const searchServiceName = "mysearchservice";
const service = {
disableLocalAuth: true,
replicaCount: 2,
tags: { appName: "My e-commerce app", newTag: "Adding a new tag" },
};
const credential = new DefaultAzureCredential();
const client = new SearchManagementClient(credential, subscriptionId);
const result = await client.services.update(resourceGroupName, searchServiceName, service);
console.log(result);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Search;
using Azure.ResourceManager.Search.Models;
// Generated from example definition: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchUpdateServiceDisableLocalAuth.json
// this example is just showing the usage of "Services_Update" operation, for the dependent resources, they will have to be created separately.
// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);
// this example assumes you already have this SearchServiceResource created on azure
// for more information of creating SearchServiceResource, please refer to the document of SearchServiceResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string searchServiceName = "mysearchservice";
ResourceIdentifier searchServiceResourceId = SearchServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, searchServiceName);
SearchServiceResource searchService = client.GetSearchServiceResource(searchServiceResourceId);
// invoke the operation
SearchServicePatch patch = new SearchServicePatch(new AzureLocation("placeholder"))
{
ReplicaCount = 2,
IsLocalAuthDisabled = true,
Tags =
{
["app-name"] = "My e-commerce app",
["new-tag"] = "Adding a new tag",
},
};
SearchServiceResource result = await searchService.UpdateAsync(patch);
// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SearchServiceData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
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",
"new-tag": "Adding a new tag"
},
"sku": {
"name": "standard"
},
"properties": {
"replicaCount": 2,
"partitionCount": 1,
"status": "provisioning",
"statusDetails": "",
"hostingMode": "default",
"provisioningState": "provisioning",
"publicNetworkAccess": "enabled",
"networkRuleSet": {
"ipRules": []
},
"disableLocalAuth": true,
"authOptions": null
}
}
SearchUpdateServiceToAllowAccessFromPrivateEndpoints
Sample Request
PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2023-11-01
{
"properties": {
"replicaCount": 1,
"partitionCount": 1,
"publicNetworkAccess": "disabled"
}
}
import com.azure.resourcemanager.search.models.PublicNetworkAccess;
import com.azure.resourcemanager.search.models.SearchServiceUpdate;
import java.util.HashMap;
import java.util.Map;
/** Samples for Services Update. */
public final class Main {
/*
* x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/
* SearchUpdateServiceToAllowAccessFromPrivateEndpoints.json
*/
/**
* Sample code: SearchUpdateServiceToAllowAccessFromPrivateEndpoints.
*
* @param azure The entry point for accessing resource management APIs in Azure.
*/
public static void
searchUpdateServiceToAllowAccessFromPrivateEndpoints(com.azure.resourcemanager.AzureResourceManager azure) {
azure.searchServices().manager().serviceClient().getServices()
.updateWithResponse("rg1", "mysearchservice", new SearchServiceUpdate().withReplicaCount(1)
.withPartitionCount(1).withPublicNetworkAccess(PublicNetworkAccess.DISABLED), null,
com.azure.core.util.Context.NONE);
}
// Use "Map.of" if available
@SuppressWarnings("unchecked")
private static <T> Map<String, T> mapOf(Object... inputs) {
Map<String, T> map = new HashMap<>();
for (int i = 0; i < inputs.length; i += 2) {
String key = (String) inputs[i];
T value = (T) inputs[i + 1];
map.put(key, value);
}
return map;
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
from azure.identity import DefaultAzureCredential
from azure.mgmt.search import SearchManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-search
# USAGE
python search_update_service_to_allow_access_from_private_endpoints.py
Before run the sample, please set the values of the client ID, tenant ID and client secret
of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""
def main():
client = SearchManagementClient(
credential=DefaultAzureCredential(),
subscription_id="subid",
)
response = client.services.update(
resource_group_name="rg1",
search_service_name="mysearchservice",
service={"properties": {"partitionCount": 1, "publicNetworkAccess": "disabled", "replicaCount": 1}},
)
print(response)
# x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchUpdateServiceToAllowAccessFromPrivateEndpoints.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
package armsearch_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/search/armsearch"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7e29dd59eef13ef347d09e41a63f2585be77b3ca/specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchUpdateServiceToAllowAccessFromPrivateEndpoints.json
func ExampleServicesClient_Update_searchUpdateServiceToAllowAccessFromPrivateEndpoints() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armsearch.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewServicesClient().Update(ctx, "rg1", "mysearchservice", armsearch.ServiceUpdate{
Properties: &armsearch.ServiceProperties{
PartitionCount: to.Ptr[int32](1),
PublicNetworkAccess: to.Ptr(armsearch.PublicNetworkAccessDisabled),
ReplicaCount: to.Ptr[int32](1),
},
}, &armsearch.SearchManagementRequestOptions{ClientRequestID: nil}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.Service = armsearch.Service{
// Name: to.Ptr("mysearchservice"),
// Type: to.Ptr("Microsoft.Search/searchServices"),
// ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice"),
// Location: to.Ptr("westus"),
// Tags: map[string]*string{
// "app-name": to.Ptr("My e-commerce app"),
// "new-tag": to.Ptr("Adding a new tag"),
// },
// Properties: &armsearch.ServiceProperties{
// HostingMode: to.Ptr(armsearch.HostingModeDefault),
// NetworkRuleSet: &armsearch.NetworkRuleSet{
// IPRules: []*armsearch.IPRule{
// },
// },
// PartitionCount: to.Ptr[int32](1),
// PrivateEndpointConnections: []*armsearch.PrivateEndpointConnection{
// },
// ProvisioningState: to.Ptr(armsearch.ProvisioningStateSucceeded),
// PublicNetworkAccess: to.Ptr(armsearch.PublicNetworkAccessDisabled),
// ReplicaCount: to.Ptr[int32](1),
// Status: to.Ptr(armsearch.SearchServiceStatusRunning),
// StatusDetails: to.Ptr(""),
// },
// SKU: &armsearch.SKU{
// Name: to.Ptr(armsearch.SKUNameBasic),
// },
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { SearchManagementClient } = require("@azure/arm-search");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Updates an existing search service in the given resource group.
*
* @summary Updates an existing search service in the given resource group.
* x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchUpdateServiceToAllowAccessFromPrivateEndpoints.json
*/
async function searchUpdateServiceToAllowAccessFromPrivateEndpoints() {
const subscriptionId = process.env["SEARCH_SUBSCRIPTION_ID"] || "subid";
const resourceGroupName = process.env["SEARCH_RESOURCE_GROUP"] || "rg1";
const searchServiceName = "mysearchservice";
const service = {
partitionCount: 1,
publicNetworkAccess: "disabled",
replicaCount: 1,
};
const credential = new DefaultAzureCredential();
const client = new SearchManagementClient(credential, subscriptionId);
const result = await client.services.update(resourceGroupName, searchServiceName, service);
console.log(result);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Search;
using Azure.ResourceManager.Search.Models;
// Generated from example definition: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchUpdateServiceToAllowAccessFromPrivateEndpoints.json
// this example is just showing the usage of "Services_Update" operation, for the dependent resources, they will have to be created separately.
// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);
// this example assumes you already have this SearchServiceResource created on azure
// for more information of creating SearchServiceResource, please refer to the document of SearchServiceResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string searchServiceName = "mysearchservice";
ResourceIdentifier searchServiceResourceId = SearchServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, searchServiceName);
SearchServiceResource searchService = client.GetSearchServiceResource(searchServiceResourceId);
// invoke the operation
SearchServicePatch patch = new SearchServicePatch(new AzureLocation("placeholder"))
{
ReplicaCount = 1,
PartitionCount = 1,
PublicNetworkAccess = SearchServicePublicNetworkAccess.Disabled,
};
SearchServiceResource result = await searchService.UpdateAsync(patch);
// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SearchServiceData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
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",
"new-tag": "Adding a new tag"
},
"sku": {
"name": "basic"
},
"properties": {
"replicaCount": 1,
"partitionCount": 1,
"status": "running",
"statusDetails": "",
"hostingMode": "default",
"provisioningState": "succeeded",
"publicNetworkAccess": "disabled",
"networkRuleSet": {
"ipRules": []
},
"privateEndpointConnections": []
}
}
SearchUpdateServiceToAllowAccessFromPublicCustomIPs
Sample Request
PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2023-11-01
{
"properties": {
"replicaCount": 3,
"partitionCount": 1,
"publicNetworkAccess": "enabled",
"networkRuleSet": {
"ipRules": [
{
"value": "123.4.5.6"
},
{
"value": "123.4.6.0/18"
}
]
}
}
}
import com.azure.resourcemanager.search.models.IpRule;
import com.azure.resourcemanager.search.models.NetworkRuleSet;
import com.azure.resourcemanager.search.models.PublicNetworkAccess;
import com.azure.resourcemanager.search.models.SearchServiceUpdate;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;
/** Samples for Services Update. */
public final class Main {
/*
* x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/
* SearchUpdateServiceToAllowAccessFromPublicCustomIPs.json
*/
/**
* Sample code: SearchUpdateServiceToAllowAccessFromPublicCustomIPs.
*
* @param azure The entry point for accessing resource management APIs in Azure.
*/
public static void
searchUpdateServiceToAllowAccessFromPublicCustomIPs(com.azure.resourcemanager.AzureResourceManager azure) {
azure.searchServices().manager().serviceClient().getServices().updateWithResponse("rg1", "mysearchservice",
new SearchServiceUpdate().withReplicaCount(3).withPartitionCount(1)
.withPublicNetworkAccess(PublicNetworkAccess.ENABLED)
.withNetworkRuleSet(new NetworkRuleSet().withIpRules(
Arrays.asList(new IpRule().withValue("123.4.5.6"), new IpRule().withValue("123.4.6.0/18")))),
null, com.azure.core.util.Context.NONE);
}
// Use "Map.of" if available
@SuppressWarnings("unchecked")
private static <T> Map<String, T> mapOf(Object... inputs) {
Map<String, T> map = new HashMap<>();
for (int i = 0; i < inputs.length; i += 2) {
String key = (String) inputs[i];
T value = (T) inputs[i + 1];
map.put(key, value);
}
return map;
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
from azure.identity import DefaultAzureCredential
from azure.mgmt.search import SearchManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-search
# USAGE
python search_update_service_to_allow_access_from_public_custom_ips.py
Before run the sample, please set the values of the client ID, tenant ID and client secret
of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""
def main():
client = SearchManagementClient(
credential=DefaultAzureCredential(),
subscription_id="subid",
)
response = client.services.update(
resource_group_name="rg1",
search_service_name="mysearchservice",
service={
"properties": {
"networkRuleSet": {"ipRules": [{"value": "123.4.5.6"}, {"value": "123.4.6.0/18"}]},
"partitionCount": 1,
"publicNetworkAccess": "enabled",
"replicaCount": 3,
}
},
)
print(response)
# x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchUpdateServiceToAllowAccessFromPublicCustomIPs.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
package armsearch_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/search/armsearch"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7e29dd59eef13ef347d09e41a63f2585be77b3ca/specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchUpdateServiceToAllowAccessFromPublicCustomIPs.json
func ExampleServicesClient_Update_searchUpdateServiceToAllowAccessFromPublicCustomIPs() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armsearch.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewServicesClient().Update(ctx, "rg1", "mysearchservice", armsearch.ServiceUpdate{
Properties: &armsearch.ServiceProperties{
NetworkRuleSet: &armsearch.NetworkRuleSet{
IPRules: []*armsearch.IPRule{
{
Value: to.Ptr("123.4.5.6"),
},
{
Value: to.Ptr("123.4.6.0/18"),
}},
},
PartitionCount: to.Ptr[int32](1),
PublicNetworkAccess: to.Ptr(armsearch.PublicNetworkAccessEnabled),
ReplicaCount: to.Ptr[int32](3),
},
}, &armsearch.SearchManagementRequestOptions{ClientRequestID: nil}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.Service = armsearch.Service{
// Name: to.Ptr("mysearchservice"),
// Type: to.Ptr("Microsoft.Search/searchServices"),
// ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice"),
// Location: to.Ptr("westus"),
// Tags: map[string]*string{
// "app-name": to.Ptr("My e-commerce app"),
// "new-tag": to.Ptr("Adding a new tag"),
// },
// Properties: &armsearch.ServiceProperties{
// HostingMode: to.Ptr(armsearch.HostingModeDefault),
// NetworkRuleSet: &armsearch.NetworkRuleSet{
// IPRules: []*armsearch.IPRule{
// {
// Value: to.Ptr("10.2.3.4"),
// }},
// },
// PartitionCount: to.Ptr[int32](1),
// PrivateEndpointConnections: []*armsearch.PrivateEndpointConnection{
// },
// ProvisioningState: to.Ptr(armsearch.ProvisioningStateSucceeded),
// PublicNetworkAccess: to.Ptr(armsearch.PublicNetworkAccessEnabled),
// ReplicaCount: to.Ptr[int32](3),
// Status: to.Ptr(armsearch.SearchServiceStatusRunning),
// StatusDetails: to.Ptr(""),
// },
// SKU: &armsearch.SKU{
// Name: to.Ptr(armsearch.SKUNameStandard),
// },
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { SearchManagementClient } = require("@azure/arm-search");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Updates an existing search service in the given resource group.
*
* @summary Updates an existing search service in the given resource group.
* x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchUpdateServiceToAllowAccessFromPublicCustomIPs.json
*/
async function searchUpdateServiceToAllowAccessFromPublicCustomIPs() {
const subscriptionId = process.env["SEARCH_SUBSCRIPTION_ID"] || "subid";
const resourceGroupName = process.env["SEARCH_RESOURCE_GROUP"] || "rg1";
const searchServiceName = "mysearchservice";
const service = {
networkRuleSet: {
ipRules: [{ value: "123.4.5.6" }, { value: "123.4.6.0/18" }],
},
partitionCount: 1,
publicNetworkAccess: "enabled",
replicaCount: 3,
};
const credential = new DefaultAzureCredential();
const client = new SearchManagementClient(credential, subscriptionId);
const result = await client.services.update(resourceGroupName, searchServiceName, service);
console.log(result);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Search;
using Azure.ResourceManager.Search.Models;
// Generated from example definition: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchUpdateServiceToAllowAccessFromPublicCustomIPs.json
// this example is just showing the usage of "Services_Update" operation, for the dependent resources, they will have to be created separately.
// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);
// this example assumes you already have this SearchServiceResource created on azure
// for more information of creating SearchServiceResource, please refer to the document of SearchServiceResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string searchServiceName = "mysearchservice";
ResourceIdentifier searchServiceResourceId = SearchServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, searchServiceName);
SearchServiceResource searchService = client.GetSearchServiceResource(searchServiceResourceId);
// invoke the operation
SearchServicePatch patch = new SearchServicePatch(new AzureLocation("placeholder"))
{
ReplicaCount = 3,
PartitionCount = 1,
PublicNetworkAccess = SearchServicePublicNetworkAccess.Enabled,
IPRules =
{
new SearchServiceIPRule()
{
Value = "123.4.5.6",
},new SearchServiceIPRule()
{
Value = "123.4.6.0/18",
}
},
};
SearchServiceResource result = await searchService.UpdateAsync(patch);
// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SearchServiceData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
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",
"new-tag": "Adding a new tag"
},
"sku": {
"name": "standard"
},
"properties": {
"replicaCount": 3,
"partitionCount": 1,
"status": "running",
"statusDetails": "",
"hostingMode": "default",
"provisioningState": "succeeded",
"publicNetworkAccess": "enabled",
"networkRuleSet": {
"ipRules": [
{
"value": "10.2.3.4"
}
]
},
"privateEndpointConnections": []
}
}
SearchUpdateServiceToRemoveIdentity
Sample Request
PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2023-11-01
{
"sku": {
"name": "standard"
},
"identity": {
"type": "None"
}
}
import com.azure.resourcemanager.search.models.Identity;
import com.azure.resourcemanager.search.models.IdentityType;
import com.azure.resourcemanager.search.models.SearchServiceUpdate;
import com.azure.resourcemanager.search.models.Sku;
import com.azure.resourcemanager.search.models.SkuName;
import java.util.HashMap;
import java.util.Map;
/** Samples for Services Update. */
public final class Main {
/*
* x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/
* SearchUpdateServiceToRemoveIdentity.json
*/
/**
* Sample code: SearchUpdateServiceToRemoveIdentity.
*
* @param azure The entry point for accessing resource management APIs in Azure.
*/
public static void searchUpdateServiceToRemoveIdentity(com.azure.resourcemanager.AzureResourceManager azure) {
azure.searchServices().manager().serviceClient().getServices()
.updateWithResponse("rg1", "mysearchservice", new SearchServiceUpdate()
.withSku(new Sku().withName(SkuName.STANDARD)).withIdentity(new Identity().withType(IdentityType.NONE)),
null, com.azure.core.util.Context.NONE);
}
// Use "Map.of" if available
@SuppressWarnings("unchecked")
private static <T> Map<String, T> mapOf(Object... inputs) {
Map<String, T> map = new HashMap<>();
for (int i = 0; i < inputs.length; i += 2) {
String key = (String) inputs[i];
T value = (T) inputs[i + 1];
map.put(key, value);
}
return map;
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
from azure.identity import DefaultAzureCredential
from azure.mgmt.search import SearchManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-search
# USAGE
python search_update_service_to_remove_identity.py
Before run the sample, please set the values of the client ID, tenant ID and client secret
of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""
def main():
client = SearchManagementClient(
credential=DefaultAzureCredential(),
subscription_id="subid",
)
response = client.services.update(
resource_group_name="rg1",
search_service_name="mysearchservice",
service={"identity": {"type": "None"}, "sku": {"name": "standard"}},
)
print(response)
# x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchUpdateServiceToRemoveIdentity.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
package armsearch_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/search/armsearch"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7e29dd59eef13ef347d09e41a63f2585be77b3ca/specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchUpdateServiceToRemoveIdentity.json
func ExampleServicesClient_Update_searchUpdateServiceToRemoveIdentity() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armsearch.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewServicesClient().Update(ctx, "rg1", "mysearchservice", armsearch.ServiceUpdate{
Identity: &armsearch.Identity{
Type: to.Ptr(armsearch.IdentityTypeNone),
},
SKU: &armsearch.SKU{
Name: to.Ptr(armsearch.SKUNameStandard),
},
}, &armsearch.SearchManagementRequestOptions{ClientRequestID: nil}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.Service = armsearch.Service{
// Name: to.Ptr("mysearchservice"),
// Type: to.Ptr("Microsoft.Search/searchServices"),
// ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice"),
// Location: to.Ptr("westus"),
// Tags: map[string]*string{
// },
// Identity: &armsearch.Identity{
// Type: to.Ptr(armsearch.IdentityTypeNone),
// },
// Properties: &armsearch.ServiceProperties{
// HostingMode: to.Ptr(armsearch.HostingModeDefault),
// NetworkRuleSet: &armsearch.NetworkRuleSet{
// IPRules: []*armsearch.IPRule{
// },
// },
// PartitionCount: to.Ptr[int32](1),
// PrivateEndpointConnections: []*armsearch.PrivateEndpointConnection{
// },
// ProvisioningState: to.Ptr(armsearch.ProvisioningStateSucceeded),
// PublicNetworkAccess: to.Ptr(armsearch.PublicNetworkAccessEnabled),
// ReplicaCount: to.Ptr[int32](3),
// Status: to.Ptr(armsearch.SearchServiceStatusRunning),
// StatusDetails: to.Ptr(""),
// },
// SKU: &armsearch.SKU{
// Name: to.Ptr(armsearch.SKUNameStandard),
// },
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { SearchManagementClient } = require("@azure/arm-search");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Updates an existing search service in the given resource group.
*
* @summary Updates an existing search service in the given resource group.
* x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchUpdateServiceToRemoveIdentity.json
*/
async function searchUpdateServiceToRemoveIdentity() {
const subscriptionId = process.env["SEARCH_SUBSCRIPTION_ID"] || "subid";
const resourceGroupName = process.env["SEARCH_RESOURCE_GROUP"] || "rg1";
const searchServiceName = "mysearchservice";
const service = {
identity: { type: "None" },
sku: { name: "standard" },
};
const credential = new DefaultAzureCredential();
const client = new SearchManagementClient(credential, subscriptionId);
const result = await client.services.update(resourceGroupName, searchServiceName, service);
console.log(result);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Search;
using Azure.ResourceManager.Search.Models;
// Generated from example definition: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchUpdateServiceToRemoveIdentity.json
// this example is just showing the usage of "Services_Update" operation, for the dependent resources, they will have to be created separately.
// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);
// this example assumes you already have this SearchServiceResource created on azure
// for more information of creating SearchServiceResource, please refer to the document of SearchServiceResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string searchServiceName = "mysearchservice";
ResourceIdentifier searchServiceResourceId = SearchServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, searchServiceName);
SearchServiceResource searchService = client.GetSearchServiceResource(searchServiceResourceId);
// invoke the operation
SearchServicePatch patch = new SearchServicePatch(new AzureLocation("placeholder"))
{
SkuName = SearchSkuName.Standard,
Identity = new ManagedServiceIdentity("None"),
};
SearchServiceResource result = await searchService.UpdateAsync(patch);
// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SearchServiceData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Sample Response
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
"name": "mysearchservice",
"location": "westus",
"type": "Microsoft.Search/searchServices",
"tags": {},
"sku": {
"name": "standard"
},
"properties": {
"replicaCount": 3,
"partitionCount": 1,
"status": "running",
"statusDetails": "",
"hostingMode": "default",
"provisioningState": "succeeded",
"publicNetworkAccess": "enabled",
"networkRuleSet": {
"ipRules": []
},
"privateEndpointConnections": []
},
"identity": {
"type": "None"
}
}
SearchUpdateServiceWithCmkEnforcement
Sample Request
PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2023-11-01
{
"tags": {
"app-name": "My e-commerce app",
"new-tag": "Adding a new tag"
},
"properties": {
"replicaCount": 2,
"encryptionWithCmk": {
"enforcement": "Enabled"
}
}
}
import com.azure.resourcemanager.search.models.EncryptionWithCmk;
import com.azure.resourcemanager.search.models.SearchEncryptionWithCmk;
import com.azure.resourcemanager.search.models.SearchServiceUpdate;
import java.util.HashMap;
import java.util.Map;
/** Samples for Services Update. */
public final class Main {
/*
* x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/
* SearchUpdateServiceWithCmkEnforcement.json
*/
/**
* Sample code: SearchUpdateServiceWithCmkEnforcement.
*
* @param azure The entry point for accessing resource management APIs in Azure.
*/
public static void searchUpdateServiceWithCmkEnforcement(com.azure.resourcemanager.AzureResourceManager azure) {
azure.searchServices().manager().serviceClient().getServices().updateWithResponse("rg1", "mysearchservice",
new SearchServiceUpdate().withTags(mapOf("app-name", "My e-commerce app", "new-tag", "Adding a new tag"))
.withReplicaCount(2)
.withEncryptionWithCmk(new EncryptionWithCmk().withEnforcement(SearchEncryptionWithCmk.ENABLED)),
null, com.azure.core.util.Context.NONE);
}
// Use "Map.of" if available
@SuppressWarnings("unchecked")
private static <T> Map<String, T> mapOf(Object... inputs) {
Map<String, T> map = new HashMap<>();
for (int i = 0; i < inputs.length; i += 2) {
String key = (String) inputs[i];
T value = (T) inputs[i + 1];
map.put(key, value);
}
return map;
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
from azure.identity import DefaultAzureCredential
from azure.mgmt.search import SearchManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-search
# USAGE
python search_update_service_with_cmk_enforcement.py
Before run the sample, please set the values of the client ID, tenant ID and client secret
of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""
def main():
client = SearchManagementClient(
credential=DefaultAzureCredential(),
subscription_id="subid",
)
response = client.services.update(
resource_group_name="rg1",
search_service_name="mysearchservice",
service={
"properties": {"encryptionWithCmk": {"enforcement": "Enabled"}, "replicaCount": 2},
"tags": {"app-name": "My e-commerce app", "new-tag": "Adding a new tag"},
},
)
print(response)
# x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchUpdateServiceWithCmkEnforcement.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
package armsearch_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/search/armsearch"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7e29dd59eef13ef347d09e41a63f2585be77b3ca/specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchUpdateServiceWithCmkEnforcement.json
func ExampleServicesClient_Update_searchUpdateServiceWithCmkEnforcement() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armsearch.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewServicesClient().Update(ctx, "rg1", "mysearchservice", armsearch.ServiceUpdate{
Properties: &armsearch.ServiceProperties{
EncryptionWithCmk: &armsearch.EncryptionWithCmk{
Enforcement: to.Ptr(armsearch.SearchEncryptionWithCmkEnabled),
},
ReplicaCount: to.Ptr[int32](2),
},
Tags: map[string]*string{
"app-name": to.Ptr("My e-commerce app"),
"new-tag": to.Ptr("Adding a new tag"),
},
}, &armsearch.SearchManagementRequestOptions{ClientRequestID: nil}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.Service = armsearch.Service{
// Name: to.Ptr("mysearchservice"),
// Type: to.Ptr("Microsoft.Search/searchServices"),
// ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice"),
// Location: to.Ptr("westus"),
// Tags: map[string]*string{
// "app-name": to.Ptr("My e-commerce app"),
// "new-tag": to.Ptr("Adding a new tag"),
// },
// Properties: &armsearch.ServiceProperties{
// AuthOptions: &armsearch.DataPlaneAuthOptions{
// APIKeyOnly: map[string]any{
// },
// },
// DisableLocalAuth: to.Ptr(false),
// EncryptionWithCmk: &armsearch.EncryptionWithCmk{
// EncryptionComplianceStatus: to.Ptr(armsearch.SearchEncryptionComplianceStatusCompliant),
// Enforcement: to.Ptr(armsearch.SearchEncryptionWithCmkEnabled),
// },
// HostingMode: to.Ptr(armsearch.HostingModeDefault),
// NetworkRuleSet: &armsearch.NetworkRuleSet{
// IPRules: []*armsearch.IPRule{
// },
// },
// PartitionCount: to.Ptr[int32](1),
// PrivateEndpointConnections: []*armsearch.PrivateEndpointConnection{
// },
// ProvisioningState: to.Ptr(armsearch.ProvisioningStateSucceeded),
// PublicNetworkAccess: to.Ptr(armsearch.PublicNetworkAccessEnabled),
// ReplicaCount: to.Ptr[int32](2),
// SharedPrivateLinkResources: []*armsearch.SharedPrivateLinkResource{
// },
// Status: to.Ptr(armsearch.SearchServiceStatusProvisioning),
// StatusDetails: to.Ptr(""),
// },
// SKU: &armsearch.SKU{
// Name: to.Ptr(armsearch.SKUNameStandard),
// },
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { SearchManagementClient } = require("@azure/arm-search");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Updates an existing search service in the given resource group.
*
* @summary Updates an existing search service in the given resource group.
* x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchUpdateServiceWithCmkEnforcement.json
*/
async function searchUpdateServiceWithCmkEnforcement() {
const subscriptionId = process.env["SEARCH_SUBSCRIPTION_ID"] || "subid";
const resourceGroupName = process.env["SEARCH_RESOURCE_GROUP"] || "rg1";
const searchServiceName = "mysearchservice";
const service = {
encryptionWithCmk: { enforcement: "Enabled" },
replicaCount: 2,
tags: { appName: "My e-commerce app", newTag: "Adding a new tag" },
};
const credential = new DefaultAzureCredential();
const client = new SearchManagementClient(credential, subscriptionId);
const result = await client.services.update(resourceGroupName, searchServiceName, service);
console.log(result);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Search;
using Azure.ResourceManager.Search.Models;
// Generated from example definition: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchUpdateServiceWithCmkEnforcement.json
// this example is just showing the usage of "Services_Update" operation, for the dependent resources, they will have to be created separately.
// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);
// this example assumes you already have this SearchServiceResource created on azure
// for more information of creating SearchServiceResource, please refer to the document of SearchServiceResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string searchServiceName = "mysearchservice";
ResourceIdentifier searchServiceResourceId = SearchServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, searchServiceName);
SearchServiceResource searchService = client.GetSearchServiceResource(searchServiceResourceId);
// invoke the operation
SearchServicePatch patch = new SearchServicePatch(new AzureLocation("placeholder"))
{
ReplicaCount = 2,
EncryptionWithCmk = new SearchEncryptionWithCmk()
{
Enforcement = SearchEncryptionWithCmkEnforcement.Enabled,
},
Tags =
{
["app-name"] = "My e-commerce app",
["new-tag"] = "Adding a new tag",
},
};
SearchServiceResource result = await searchService.UpdateAsync(patch);
// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SearchServiceData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
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",
"new-tag": "Adding a new tag"
},
"sku": {
"name": "standard"
},
"properties": {
"replicaCount": 2,
"partitionCount": 1,
"status": "provisioning",
"statusDetails": "",
"hostingMode": "default",
"provisioningState": "provisioning",
"publicNetworkAccess": "enabled",
"networkRuleSet": {
"ipRules": []
},
"privateEndpointConnections": [],
"sharedPrivateLinkResources": [],
"encryptionWithCmk": {
"enforcement": "Enabled",
"encryptionComplianceStatus": "Compliant"
},
"disableLocalAuth": false,
"authOptions": {
"apiKeyOnly": {}
}
}
}
SearchUpdateServiceWithSemanticSearch
Sample Request
PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2023-11-01
{
"tags": {
"app-name": "My e-commerce app",
"new-tag": "Adding a new tag"
},
"properties": {
"replicaCount": 2,
"semanticSearch": "standard"
}
}
import com.azure.resourcemanager.search.models.SearchSemanticSearch;
import com.azure.resourcemanager.search.models.SearchServiceUpdate;
import java.util.HashMap;
import java.util.Map;
/** Samples for Services Update. */
public final class Main {
/*
* x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/
* SearchUpdateServiceWithSemanticSearch.json
*/
/**
* Sample code: SearchUpdateServiceWithSemanticSearch.
*
* @param azure The entry point for accessing resource management APIs in Azure.
*/
public static void searchUpdateServiceWithSemanticSearch(com.azure.resourcemanager.AzureResourceManager azure) {
azure.searchServices().manager().serviceClient().getServices().updateWithResponse("rg1", "mysearchservice",
new SearchServiceUpdate().withTags(mapOf("app-name", "My e-commerce app", "new-tag", "Adding a new tag"))
.withReplicaCount(2).withSemanticSearch(SearchSemanticSearch.STANDARD),
null, com.azure.core.util.Context.NONE);
}
// Use "Map.of" if available
@SuppressWarnings("unchecked")
private static <T> Map<String, T> mapOf(Object... inputs) {
Map<String, T> map = new HashMap<>();
for (int i = 0; i < inputs.length; i += 2) {
String key = (String) inputs[i];
T value = (T) inputs[i + 1];
map.put(key, value);
}
return map;
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
from azure.identity import DefaultAzureCredential
from azure.mgmt.search import SearchManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-search
# USAGE
python search_update_service_with_semantic_search.py
Before run the sample, please set the values of the client ID, tenant ID and client secret
of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""
def main():
client = SearchManagementClient(
credential=DefaultAzureCredential(),
subscription_id="subid",
)
response = client.services.update(
resource_group_name="rg1",
search_service_name="mysearchservice",
service={
"properties": {"replicaCount": 2, "semanticSearch": "standard"},
"tags": {"app-name": "My e-commerce app", "new-tag": "Adding a new tag"},
},
)
print(response)
# x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchUpdateServiceWithSemanticSearch.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
package armsearch_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/search/armsearch"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7e29dd59eef13ef347d09e41a63f2585be77b3ca/specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchUpdateServiceWithSemanticSearch.json
func ExampleServicesClient_Update_searchUpdateServiceWithSemanticSearch() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armsearch.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewServicesClient().Update(ctx, "rg1", "mysearchservice", armsearch.ServiceUpdate{
Properties: &armsearch.ServiceProperties{
ReplicaCount: to.Ptr[int32](2),
SemanticSearch: to.Ptr(armsearch.SearchSemanticSearchStandard),
},
Tags: map[string]*string{
"app-name": to.Ptr("My e-commerce app"),
"new-tag": to.Ptr("Adding a new tag"),
},
}, &armsearch.SearchManagementRequestOptions{ClientRequestID: nil}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.Service = armsearch.Service{
// Name: to.Ptr("mysearchservice"),
// Type: to.Ptr("Microsoft.Search/searchServices"),
// ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice"),
// Location: to.Ptr("westus"),
// Tags: map[string]*string{
// "app-name": to.Ptr("My e-commerce app"),
// "new-tag": to.Ptr("Adding a new tag"),
// },
// Properties: &armsearch.ServiceProperties{
// AuthOptions: &armsearch.DataPlaneAuthOptions{
// APIKeyOnly: map[string]any{
// },
// },
// DisableLocalAuth: to.Ptr(false),
// EncryptionWithCmk: &armsearch.EncryptionWithCmk{
// EncryptionComplianceStatus: to.Ptr(armsearch.SearchEncryptionComplianceStatusCompliant),
// Enforcement: to.Ptr(armsearch.SearchEncryptionWithCmkUnspecified),
// },
// HostingMode: to.Ptr(armsearch.HostingModeDefault),
// NetworkRuleSet: &armsearch.NetworkRuleSet{
// IPRules: []*armsearch.IPRule{
// },
// },
// PartitionCount: to.Ptr[int32](1),
// PrivateEndpointConnections: []*armsearch.PrivateEndpointConnection{
// },
// ProvisioningState: to.Ptr(armsearch.ProvisioningStateSucceeded),
// PublicNetworkAccess: to.Ptr(armsearch.PublicNetworkAccessEnabled),
// ReplicaCount: to.Ptr[int32](2),
// SemanticSearch: to.Ptr(armsearch.SearchSemanticSearchStandard),
// SharedPrivateLinkResources: []*armsearch.SharedPrivateLinkResource{
// },
// Status: to.Ptr(armsearch.SearchServiceStatusProvisioning),
// StatusDetails: to.Ptr(""),
// },
// SKU: &armsearch.SKU{
// Name: to.Ptr(armsearch.SKUNameStandard),
// },
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { SearchManagementClient } = require("@azure/arm-search");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Updates an existing search service in the given resource group.
*
* @summary Updates an existing search service in the given resource group.
* x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchUpdateServiceWithSemanticSearch.json
*/
async function searchUpdateServiceWithSemanticSearch() {
const subscriptionId = process.env["SEARCH_SUBSCRIPTION_ID"] || "subid";
const resourceGroupName = process.env["SEARCH_RESOURCE_GROUP"] || "rg1";
const searchServiceName = "mysearchservice";
const service = {
replicaCount: 2,
semanticSearch: "standard",
tags: { appName: "My e-commerce app", newTag: "Adding a new tag" },
};
const credential = new DefaultAzureCredential();
const client = new SearchManagementClient(credential, subscriptionId);
const result = await client.services.update(resourceGroupName, searchServiceName, service);
console.log(result);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Search;
using Azure.ResourceManager.Search.Models;
// Generated from example definition: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchUpdateServiceWithSemanticSearch.json
// this example is just showing the usage of "Services_Update" operation, for the dependent resources, they will have to be created separately.
// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);
// this example assumes you already have this SearchServiceResource created on azure
// for more information of creating SearchServiceResource, please refer to the document of SearchServiceResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string searchServiceName = "mysearchservice";
ResourceIdentifier searchServiceResourceId = SearchServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, searchServiceName);
SearchServiceResource searchService = client.GetSearchServiceResource(searchServiceResourceId);
// invoke the operation
SearchServicePatch patch = new SearchServicePatch(new AzureLocation("placeholder"))
{
ReplicaCount = 2,
SemanticSearch = SearchSemanticSearch.Standard,
Tags =
{
["app-name"] = "My e-commerce app",
["new-tag"] = "Adding a new tag",
},
};
SearchServiceResource result = await searchService.UpdateAsync(patch);
// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SearchServiceData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
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",
"new-tag": "Adding a new tag"
},
"sku": {
"name": "standard"
},
"properties": {
"replicaCount": 2,
"partitionCount": 1,
"status": "provisioning",
"statusDetails": "",
"hostingMode": "default",
"provisioningState": "provisioning",
"publicNetworkAccess": "enabled",
"networkRuleSet": {
"ipRules": []
},
"privateEndpointConnections": [],
"sharedPrivateLinkResources": [],
"encryptionWithCmk": {
"enforcement": "Unspecified",
"encryptionComplianceStatus": "Compliant"
},
"disableLocalAuth": false,
"authOptions": {
"apiKeyOnly": {}
},
"semanticSearch": "standard"
}
}
Definíciók
| Name |
Description |
|
AadAuthFailureMode
|
Leírja, hogy a keresési szolgáltatás adatsík API-ja milyen választ küld a sikertelen hitelesítést igénylő kérésekre.
|
|
ApiKeyOnly
|
Azt jelzi, hogy csak az API-kulcs használható a hitelesítéshez.
|
|
CloudError
|
API-hibával kapcsolatos információkat tartalmaz.
|
|
CloudErrorBody
|
Egy adott API-hibát ír le hibakóddal és üzenettel.
|
|
DataPlaneAadOrApiKeyAuthOption
|
Azt jelzi, hogy az API-kulcs vagy egy Microsoft Entra ID-bérlő hozzáférési jogkivonata használható a hitelesítéshez.
|
|
DataPlaneAuthOptions
|
Meghatározza azokat a beállításokat, amelyekkel a keresési szolgáltatás hitelesíti az adatsík-kéréseket. Ez nem állítható be, ha a disableLocalAuth értéke igaz.
|
|
EncryptionWithCmk
|
Egy szabályzatot ír le, amely meghatározza, hogy a keresési szolgáltatás erőforrásai hogyan legyenek titkosítva ügyfél=felügyelt kulcsokkal.
|
|
HostingMode
|
Csak a standard3 termékváltozatra alkalmazható. Ezt a tulajdonságot beállíthatja úgy, hogy legfeljebb 3 nagy sűrűségű partíciót engedélyezzen, amelyek legfeljebb 1000 indexet tesznek lehetővé, ami sokkal magasabb, mint bármely más termékváltozat esetében engedélyezett maximális indexek. A standard3 termékváltozat esetében az érték "alapértelmezett" vagy "highDensity". Az összes többi termékváltozat esetében ennek az értéknek "alapértelmezettnek" kell lennie.
|
|
Identity
|
Az erőforrás identitása.
|
|
IdentityType
|
Az identitás típusa.
|
|
IpRule
|
A keresési szolgáltatás IP-korlátozási szabálya.
|
|
NetworkRuleSet
|
Hálózatspecifikus szabályok, amelyek meghatározzák, hogyan érhető el a keresési szolgáltatás.
|
|
PrivateEndpoint
|
A Microsoft.Network-szolgáltató privát végpont-erőforrása.
|
|
PrivateEndpointConnection
|
Egy meglévő privát végponti kapcsolatot ismertet a keresési szolgáltatással.
|
|
PrivateEndpointConnectionProperties
|
Egy meglévő privát végpont és a keresési szolgáltatás közötti kapcsolat tulajdonságait ismerteti.
|
|
PrivateLinkServiceConnectionProvisioningState
|
A privát kapcsolat szolgáltatáskapcsolat kiépítési állapota. Érvényes értékek: Frissítés, Törlés, Sikertelen, Sikeres vagy Hiányos
|
|
PrivateLinkServiceConnectionState
|
Egy meglévő Private Link Service-kapcsolat aktuális állapotát ismerteti az Azure Privát végponttal.
|
|
PrivateLinkServiceConnectionStatus
|
A privát kapcsolat szolgáltatáskapcsolatának állapota. Az érvényes értékek Függőben, Jóváhagyva, Elutasítva vagy Leválasztva.
|
|
ProvisioningState
|
A keresési szolgáltatásban végrehajtott utolsó kiépítési művelet állapota. A kiépítés egy köztes állapot, amely a szolgáltatáskapacitás létrehozásakor következik be. A kapacitás beállítása után a provisioningState a "sikeres" vagy a "sikertelen" értékre változik. Az ügyfélalkalmazások lekérdezhetik a kiépítési állapotot (az ajánlott lekérdezési időköz 30 másodperctől egy percig tart), a Keresési szolgáltatás lekérése művelettel ellenőrizheti, hogy mikor fejeződik be egy művelet. Ha az ingyenes szolgáltatást használja, ez az érték általában "sikeresként" jelenik meg közvetlenül a Keresési szolgáltatás létrehozása hívásban. Ennek az az oka, hogy az ingyenes szolgáltatás már beállított kapacitást használ.
|
|
PublicNetworkAccess
|
Ez az érték "engedélyezve" értékre állítható, hogy elkerülje a meglévő ügyfélerőforrások és sablonok kompatibilitástörő változásait. Ha a "letiltva" értékre van állítva, a nyilvános adapteren keresztüli forgalom nem engedélyezett, és a privát végponti kapcsolatok a kizárólagos hozzáférési módszer.
|
|
SearchEncryptionComplianceStatus
|
Azt ismerteti, hogy a keresési szolgáltatás megfelel-e a nem ügyfél által titkosított erőforrásoknak. Ha egy szolgáltatás egynél több nem ügyfél által titkosított erőforrással rendelkezik, és a "Kényszerítés" engedélyezve van, akkor a szolgáltatás "nem megfelelő" állapotúként lesz megjelölve.
|
|
SearchEncryptionWithCmk
|
Azt ismerteti, hogy a keresési szolgáltatásnak hogyan kell kikényszerítenie egy vagy több nem ügyfél által titkosított erőforrás használatát.
|
|
SearchSemanticSearch
|
Beállítja a szemantikai keresés elérhetőségét szabályozó beállításokat. Ez a konfiguráció csak bizonyos keresési termékváltozatok esetében lehetséges bizonyos helyeken.
|
|
SearchService
|
Egy keresési szolgáltatást és annak aktuális állapotát ismerteti.
|
|
SearchServiceStatus
|
A keresési szolgáltatás állapota. Lehetséges értékek: "futtatás": A keresési szolgáltatás fut, és nincs folyamatban kiépítési művelet. "kiépítés": A keresési szolgáltatás kiépítése vagy vertikális fel- vagy leskálázása folyamatban van. Törlés: A keresési szolgáltatás törlődik. "csökkentett teljesítményű": A keresési szolgáltatás csökkentett teljesítményű. Ez akkor fordulhat elő, ha a mögöttes keresési egységek nem kifogástalan állapotban vannak. A keresési szolgáltatás valószínűleg működőképes, de a teljesítmény lassú lehet, és egyes kérések elvethetők. "letiltva": A keresési szolgáltatás le van tiltva. Ebben az állapotban a szolgáltatás elutasítja az összes API-kérést. "hiba": A keresési szolgáltatás hibaállapotban van. Ha a szolgáltatás csökkentett teljesítményű, letiltott vagy hibaállapotban van, a Microsoft aktívan vizsgálja a mögöttes problémát. Ezekben az állapotokban a dedikált szolgáltatások továbbra is díjkötelesek a kiosztott keresési egységek száma alapján.
|
|
SearchServiceUpdate
|
A keresési szolgáltatás frissítéséhez használt paraméterek.
|
|
SharedPrivateLinkResource
|
A keresési szolgáltatás által felügyelt megosztott Private Link-erőforrást ismerteti.
|
|
SharedPrivateLinkResourceProperties
|
A keresési szolgáltatás által felügyelt meglévő megosztott Private Link-erőforrás tulajdonságait ismerteti.
|
|
SharedPrivateLinkResourceProvisioningState
|
A megosztott privát kapcsolati erőforrás kiépítési állapota. Az érvényes értékek: Frissítés, Törlés, Sikertelen, Sikeres vagy Hiányos.
|
|
SharedPrivateLinkResourceStatus
|
A megosztott privát kapcsolati erőforrás állapota. Az érvényes értékek Függőben, Jóváhagyva, Elutasítva vagy Leválasztva.
|
|
Sku
|
Meghatározza egy keresési szolgáltatás termékváltozatát, amely meghatározza a számlázási arányt és a kapacitáskorlátokat.
|
|
SkuName
|
A keresési szolgáltatás termékváltozata. Az érvényes értékek a következők: "ingyenes": Megosztott szolgáltatás. "alapszintű": Dedikált szolgáltatás legfeljebb 3 replikával. "standard": Dedikált szolgáltatás legfeljebb 12 partícióval és 12 replikával. "standard2": Hasonló a standardhoz, de keresési egységenként nagyobb kapacitással. "standard3": A legnagyobb standard ajánlat legfeljebb 12 partícióval és 12 replikával (vagy akár 3 partícióval, több indexkel, ha a hostingMode tulajdonságot is "highDensity" értékre állítja). "storage_optimized_l1": Partíciónként 1 TB-ot támogat, legfeljebb 12 partíciót. "storage_optimized_l2": Partíciónként 2 TB-ot támogat, legfeljebb 12 partíciót."
|
AadAuthFailureMode
Leírja, hogy a keresési szolgáltatás adatsík API-ja milyen választ küld a sikertelen hitelesítést igénylő kérésekre.
| Name |
Típus |
Description |
|
http401WithBearerChallenge
|
string
|
Azt jelzi, hogy a sikertelen hitelesítést igénylő kéréseket egy 401-es (Jogosulatlan) HTTP-állapotkóddal kell megjeleníteni, és meg kell jeleníteni a Tulajdonosi kihívást.
|
|
http403
|
string
|
Azt jelzi, hogy a sikertelen hitelesítést igénylő kéréseket 403-ás (Tiltott) HTTP-állapotkóddal kell bemutatni.
|
ApiKeyOnly
Azt jelzi, hogy csak az API-kulcs használható a hitelesítéshez.
CloudError
API-hibával kapcsolatos információkat tartalmaz.
| Name |
Típus |
Description |
|
error
|
CloudErrorBody
|
Egy adott API-hibát ír le hibakóddal és üzenettel.
|
CloudErrorBody
Egy adott API-hibát ír le hibakóddal és üzenettel.
| Name |
Típus |
Description |
|
code
|
string
|
Hibakód, amely pontosabban írja le a hibafeltételt, mint egy HTTP-állapotkód. Adott hibaesetek programozott kezelésére használható.
|
|
details
|
CloudErrorBody[]
|
Beágyazott hibákat tartalmaz, amelyek ehhez a hibához kapcsolódnak.
|
|
message
|
string
|
Egy üzenet, amely részletesen leírja a hibát, és hibakeresési információkat nyújt.
|
|
target
|
string
|
Az adott hiba célja (például a hiba tulajdonságának neve).
|
DataPlaneAadOrApiKeyAuthOption
Azt jelzi, hogy az API-kulcs vagy egy Microsoft Entra ID-bérlő hozzáférési jogkivonata használható a hitelesítéshez.
| Name |
Típus |
Description |
|
aadAuthFailureMode
|
AadAuthFailureMode
|
Leírja, hogy a keresési szolgáltatás adatsík API-ja milyen választ küld a sikertelen hitelesítést igénylő kérésekre.
|
DataPlaneAuthOptions
Meghatározza azokat a beállításokat, amelyekkel a keresési szolgáltatás hitelesíti az adatsík-kéréseket. Ez nem állítható be, ha a disableLocalAuth értéke igaz.
| Name |
Típus |
Description |
|
aadOrApiKey
|
DataPlaneAadOrApiKeyAuthOption
|
Azt jelzi, hogy az API-kulcs vagy egy Microsoft Entra ID-bérlő hozzáférési jogkivonata használható a hitelesítéshez.
|
|
apiKeyOnly
|
ApiKeyOnly
|
Azt jelzi, hogy csak az API-kulcs használható a hitelesítéshez.
|
EncryptionWithCmk
Egy szabályzatot ír le, amely meghatározza, hogy a keresési szolgáltatás erőforrásai hogyan legyenek titkosítva ügyfél=felügyelt kulcsokkal.
| Name |
Típus |
Description |
|
encryptionComplianceStatus
|
SearchEncryptionComplianceStatus
|
Azt ismerteti, hogy a keresési szolgáltatás megfelel-e a nem ügyfél által titkosított erőforrásoknak. Ha egy szolgáltatás egynél több nem ügyfél által titkosított erőforrással rendelkezik, és a "Kényszerítés" engedélyezve van, akkor a szolgáltatás "nem megfelelő" állapotúként lesz megjelölve.
|
|
enforcement
|
SearchEncryptionWithCmk
|
Azt ismerteti, hogy a keresési szolgáltatásnak hogyan kell kikényszerítenie egy vagy több nem ügyfél által titkosított erőforrás használatát.
|
HostingMode
Csak a standard3 termékváltozatra alkalmazható. Ezt a tulajdonságot beállíthatja úgy, hogy legfeljebb 3 nagy sűrűségű partíciót engedélyezzen, amelyek legfeljebb 1000 indexet tesznek lehetővé, ami sokkal magasabb, mint bármely más termékváltozat esetében engedélyezett maximális indexek. A standard3 termékváltozat esetében az érték "alapértelmezett" vagy "highDensity". Az összes többi termékváltozat esetében ennek az értéknek "alapértelmezettnek" kell lennie.
| Name |
Típus |
Description |
|
default
|
string
|
Az indexek számának korlátját a termékváltozat alapértelmezett korlátai határozzák meg.
|
|
highDensity
|
string
|
Csak standard3 termékváltozatú alkalmazás, ahol a keresési szolgáltatás legfeljebb 1000 indexet tartalmazhat.
|
Identity
Az erőforrás identitása.
| Name |
Típus |
Description |
|
principalId
|
string
|
A keresési szolgáltatás rendszer által hozzárendelt identitásának fő azonosítója.
|
|
tenantId
|
string
|
A keresési szolgáltatás rendszer által hozzárendelt identitásának bérlőazonosítója.
|
|
type
|
IdentityType
|
Az identitás típusa.
|
IdentityType
Az identitás típusa.
| Name |
Típus |
Description |
|
None
|
string
|
|
|
SystemAssigned
|
string
|
|
IpRule
A keresési szolgáltatás IP-korlátozási szabálya.
| Name |
Típus |
Description |
|
value
|
string
|
Egyetlen IPv4-címnek (például 123.1.2.3) vagy CIDR formátumú IP-címtartománynak (például 123.1.2.3/24) megfelelő érték engedélyezhető.
|
NetworkRuleSet
Hálózatspecifikus szabályok, amelyek meghatározzák, hogyan érhető el a keresési szolgáltatás.
| Name |
Típus |
Description |
|
ipRules
|
IpRule[]
|
Az IP-tűzfalhoz használt IP-korlátozási szabályok listája. A tűzfal blokkolja azokat az IP-címeket, amelyek nem felelnek meg a szabályoknak. Ezeket a szabályokat csak akkor alkalmazza a rendszer, ha a keresési szolgáltatás "publicNetworkAccess" tulajdonsága "engedélyezve" van.
|
PrivateEndpoint
A Microsoft.Network-szolgáltató privát végpont-erőforrása.
| Name |
Típus |
Description |
|
id
|
string
|
A Microsoft.Network-szolgáltató privát végponti erőforrásának erőforrás-azonosítója.
|
PrivateEndpointConnection
Egy meglévő privát végponti kapcsolatot ismertet a keresési szolgáltatással.
| Name |
Típus |
Description |
|
id
|
string
|
Az erőforrás teljes erőforrás-azonosítója. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
|
|
name
|
string
|
Az erőforrás neve
|
|
properties
|
PrivateEndpointConnectionProperties
|
Egy meglévő privát végponti kapcsolat tulajdonságait ismerteti a keresési szolgáltatással.
|
|
type
|
string
|
Az erőforrás típusa. Például "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"
|
PrivateEndpointConnectionProperties
Egy meglévő privát végpont és a keresési szolgáltatás közötti kapcsolat tulajdonságait ismerteti.
| Name |
Típus |
Description |
|
groupId
|
string
|
Annak az erőforrásnak a szolgáltatójától származó csoportazonosító, amelyre a private link szolgáltatáskapcsolat tartozik.
|
|
privateEndpoint
|
PrivateEndpoint
|
A Microsoft.Network-szolgáltató privát végpont-erőforrása.
|
|
privateLinkServiceConnectionState
|
PrivateLinkServiceConnectionState
|
Egy meglévő Private Link Service-kapcsolat aktuális állapotát ismerteti az Azure Privát végponttal.
|
|
provisioningState
|
PrivateLinkServiceConnectionProvisioningState
|
A privát kapcsolat szolgáltatáskapcsolat kiépítési állapota. Érvényes értékek: Frissítés, Törlés, Sikertelen, Sikeres vagy Hiányos
|
PrivateLinkServiceConnectionProvisioningState
A privát kapcsolat szolgáltatáskapcsolat kiépítési állapota. Érvényes értékek: Frissítés, Törlés, Sikertelen, Sikeres vagy Hiányos
| Name |
Típus |
Description |
|
Canceled
|
string
|
A privát kapcsolati szolgáltatás kapcsolati erőforrásának létesítési kérése megszakadt
|
|
Deleting
|
string
|
A privát kapcsolat szolgáltatáskapcsolat törlése folyamatban van.
|
|
Failed
|
string
|
A privát kapcsolat szolgáltatáskapcsolatot nem sikerült kiépíteni vagy törölni.
|
|
Incomplete
|
string
|
A privát kapcsolati szolgáltatás kapcsolati erőforrásának létesítési kérése elfogadva, de a létrehozási folyamat még nem kezdődött meg.
|
|
Succeeded
|
string
|
A privát kapcsolat szolgáltatáskapcsolata befejeződött, és készen áll a jóváhagyásra.
|
|
Updating
|
string
|
A privát kapcsolat szolgáltatáskapcsolat létrehozása folyamatban van más erőforrásokkal együtt, hogy teljes mértékben működőképes legyen.
|
PrivateLinkServiceConnectionState
Egy meglévő Private Link Service-kapcsolat aktuális állapotát ismerteti az Azure Privát végponttal.
| Name |
Típus |
Alapértelmezett érték |
Description |
|
actionsRequired
|
string
|
None
|
Az esetlegesen szükséges további műveletek leírása.
|
|
description
|
string
|
|
A private link szolgáltatás kapcsolati állapotának leírása.
|
|
status
|
PrivateLinkServiceConnectionStatus
|
|
A privát kapcsolat szolgáltatáskapcsolatának állapota. Az érvényes értékek Függőben, Jóváhagyva, Elutasítva vagy Leválasztva.
|
PrivateLinkServiceConnectionStatus
A privát kapcsolat szolgáltatáskapcsolatának állapota. Az érvényes értékek Függőben, Jóváhagyva, Elutasítva vagy Leválasztva.
| Name |
Típus |
Description |
|
Approved
|
string
|
A privát végponti kapcsolat jóváhagyva van, és használatra kész.
|
|
Disconnected
|
string
|
A privát végpont kapcsolata el lett távolítva a szolgáltatásból.
|
|
Pending
|
string
|
A privát végpontkapcsolat létrejött, és jóváhagyásra vár.
|
|
Rejected
|
string
|
A privát végpont kapcsolata elutasítva, és nem használható.
|
ProvisioningState
A keresési szolgáltatásban végrehajtott utolsó kiépítési művelet állapota. A kiépítés egy köztes állapot, amely a szolgáltatáskapacitás létrehozásakor következik be. A kapacitás beállítása után a provisioningState a "sikeres" vagy a "sikertelen" értékre változik. Az ügyfélalkalmazások lekérdezhetik a kiépítési állapotot (az ajánlott lekérdezési időköz 30 másodperctől egy percig tart), a Keresési szolgáltatás lekérése művelettel ellenőrizheti, hogy mikor fejeződik be egy művelet. Ha az ingyenes szolgáltatást használja, ez az érték általában "sikeresként" jelenik meg közvetlenül a Keresési szolgáltatás létrehozása hívásban. Ennek az az oka, hogy az ingyenes szolgáltatás már beállított kapacitást használ.
| Name |
Típus |
Description |
|
failed
|
string
|
Az utolsó kiépítési művelet meghiúsult.
|
|
provisioning
|
string
|
A keresési szolgáltatás kiépítése vagy vertikális fel- vagy leskálázása folyamatban van.
|
|
succeeded
|
string
|
Az utolsó kiépítési művelet sikeresen befejeződött.
|
PublicNetworkAccess
Ez az érték "engedélyezve" értékre állítható, hogy elkerülje a meglévő ügyfélerőforrások és sablonok kompatibilitástörő változásait. Ha a "letiltva" értékre van állítva, a nyilvános adapteren keresztüli forgalom nem engedélyezett, és a privát végponti kapcsolatok a kizárólagos hozzáférési módszer.
| Name |
Típus |
Description |
|
disabled
|
string
|
|
|
enabled
|
string
|
|
SearchEncryptionComplianceStatus
Azt ismerteti, hogy a keresési szolgáltatás megfelel-e a nem ügyfél által titkosított erőforrásoknak. Ha egy szolgáltatás egynél több nem ügyfél által titkosított erőforrással rendelkezik, és a "Kényszerítés" engedélyezve van, akkor a szolgáltatás "nem megfelelő" állapotúként lesz megjelölve.
| Name |
Típus |
Description |
|
Compliant
|
string
|
Azt jelzi, hogy a keresési szolgáltatás megfelelő, mert a nem ügyfél által titkosított erőforrások száma nulla, vagy a kényszerítés le van tiltva.
|
|
NonCompliant
|
string
|
Azt jelzi, hogy a keresési szolgáltatás több, nem ügyfél által titkosított erőforrással rendelkezik.
|
SearchEncryptionWithCmk
Azt ismerteti, hogy a keresési szolgáltatásnak hogyan kell kikényszerítenie egy vagy több nem ügyfél által titkosított erőforrás használatát.
| Name |
Típus |
Description |
|
Disabled
|
string
|
Nem történik kényszerítés, és a keresési szolgáltatás nem ügyfél által titkosított erőforrásokkal rendelkezhet.
|
|
Enabled
|
string
|
Search szolgáltatás nem megfelelőként lesz megjelölve, ha egy vagy több nem ügyfél által titkosított erőforrás van.
|
|
Unspecified
|
string
|
A kényszerítési szabályzat nincs explicit módon megadva, és a viselkedés ugyanaz, mintha "Letiltva" értékre lenne állítva.
|
SearchSemanticSearch
Beállítja a szemantikai keresés elérhetőségét szabályozó beállításokat. Ez a konfiguráció csak bizonyos keresési termékváltozatok esetében lehetséges bizonyos helyeken.
| Name |
Típus |
Description |
|
disabled
|
string
|
Azt jelzi, hogy a szemantikai rangsorolás le van tiltva a keresési szolgáltatásban.
|
|
free
|
string
|
Engedélyezi a szemantikai rangsorolást egy keresési szolgáltatáson, és azt jelzi, hogy az ingyenes szint korlátain belül kell használni. Ez maximalizálná a szemantikai rangsorolási kérelmek mennyiségét, és felár nélkül kínálják. Ez az újonnan kiépített keresési szolgáltatások alapértelmezett értéke.
|
|
standard
|
string
|
Lehetővé teszi a szemantikai rangsorolást egy keresési szolgáltatáson számlázható szolgáltatásként, nagyobb átviteli sebességgel és a szemantikai rangsorolási kérelmek mennyiségével.
|
SearchService
Egy keresési szolgáltatást és annak aktuális állapotát ismerteti.
| Name |
Típus |
Alapértelmezett érték |
Description |
|
id
|
string
|
|
Az erőforrás teljes erőforrás-azonosítója. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
|
|
identity
|
Identity
|
|
Az erőforrás identitása.
|
|
location
|
string
|
|
Az a földrajzi hely, ahol az erőforrás él
|
|
name
|
string
|
|
Az erőforrás neve
|
|
properties.authOptions
|
DataPlaneAuthOptions
|
|
Meghatározza, hogy a keresési szolgáltatás adatsík API-ja hogyan hitelesíti a kéréseket. Ez nem állítható be, ha a disableLocalAuth értéke igaz.
|
|
properties.disableLocalAuth
|
boolean
|
|
Ha igaz értékre van állítva, a keresési szolgáltatás hívásai nem használhatják az API-kulcsokat a hitelesítéshez. Ez nem állítható igaz értékre, ha a "dataPlaneAuthOptions" definiálva van.
|
|
properties.encryptionWithCmk
|
EncryptionWithCmk
|
|
Meghatározza az erőforrások (például indexek) ügyfélkezelői kulcsokkal történő titkosítására vonatkozó szabályzatokat a keresési szolgáltatáson belül.
|
|
properties.hostingMode
|
HostingMode
|
default
|
Csak a standard3 termékváltozatra alkalmazható. Ezt a tulajdonságot beállíthatja úgy, hogy legfeljebb 3 nagy sűrűségű partíciót engedélyezzen, amelyek legfeljebb 1000 indexet tesznek lehetővé, ami sokkal magasabb, mint bármely más termékváltozat esetében engedélyezett maximális indexek. A standard3 termékváltozat esetében az érték "alapértelmezett" vagy "highDensity". Az összes többi termékváltozat esetében ennek az értéknek "alapértelmezettnek" kell lennie.
|
|
properties.networkRuleSet
|
NetworkRuleSet
|
|
Hálózatspecifikus szabályok, amelyek meghatározzák a keresési szolgáltatás elérésének módját.
|
|
properties.partitionCount
|
integer
|
1
|
A keresési szolgáltatás partícióinak száma; ha meg van adva, 1, 2, 3, 4, 6 vagy 12 lehet. Az 1-nél nagyobb értékek csak standard termékváltozatokra érvényesek. A "standard3" szolgáltatások esetében a hostingMode értéke "highDensity", az engedélyezett értékek 1 és 3 között vannak.
|
|
properties.privateEndpointConnections
|
PrivateEndpointConnection[]
|
|
A keresési szolgáltatás privát végponti kapcsolatainak listája.
|
|
properties.provisioningState
|
ProvisioningState
|
|
A keresési szolgáltatásban végrehajtott utolsó kiépítési művelet állapota. A kiépítés egy köztes állapot, amely a szolgáltatáskapacitás létrehozásakor következik be. A kapacitás beállítása után a provisioningState a "sikeres" vagy a "sikertelen" értékre változik. Az ügyfélalkalmazások lekérdezhetik a kiépítési állapotot (az ajánlott lekérdezési időköz 30 másodperctől egy percig tart), a Keresési szolgáltatás lekérése művelettel ellenőrizheti, hogy mikor fejeződik be egy művelet. Ha az ingyenes szolgáltatást használja, ez az érték általában "sikeresként" jelenik meg közvetlenül a Keresési szolgáltatás létrehozása hívásban. Ennek az az oka, hogy az ingyenes szolgáltatás már beállított kapacitást használ.
|
|
properties.publicNetworkAccess
|
PublicNetworkAccess
|
enabled
|
Ez az érték "engedélyezve" értékre állítható, hogy elkerülje a meglévő ügyfélerőforrások és sablonok kompatibilitástörő változásait. Ha a "letiltva" értékre van állítva, a nyilvános adapteren keresztüli forgalom nem engedélyezett, és a privát végponti kapcsolatok a kizárólagos hozzáférési módszer.
|
|
properties.replicaCount
|
integer
|
1
|
A keresési szolgáltatás replikáinak száma. Ha meg van adva, akkor a standard termékváltozatok esetében 1 és 12 közötti, alapszintű termékváltozat esetén 1 és 3 közötti értéknek kell lennie.
|
|
properties.semanticSearch
|
SearchSemanticSearch
|
|
Beállítja a szemantikai keresés elérhetőségét szabályozó beállításokat. Ez a konfiguráció csak bizonyos keresési termékváltozatok esetében lehetséges bizonyos helyeken.
|
|
properties.sharedPrivateLinkResources
|
SharedPrivateLinkResource[]
|
|
A keresési szolgáltatás által felügyelt megosztott privát kapcsolati erőforrások listája.
|
|
properties.status
|
SearchServiceStatus
|
|
A keresési szolgáltatás állapota. Lehetséges értékek: "futtatás": A keresési szolgáltatás fut, és nincs folyamatban kiépítési művelet. "kiépítés": A keresési szolgáltatás kiépítése vagy vertikális fel- vagy leskálázása folyamatban van. Törlés: A keresési szolgáltatás törlődik. "csökkentett teljesítményű": A keresési szolgáltatás csökkentett teljesítményű. Ez akkor fordulhat elő, ha a mögöttes keresési egységek nem kifogástalan állapotban vannak. A keresési szolgáltatás valószínűleg működőképes, de a teljesítmény lassú lehet, és egyes kérések elvethetők. "letiltva": A keresési szolgáltatás le van tiltva. Ebben az állapotban a szolgáltatás elutasítja az összes API-kérést. "hiba": A keresési szolgáltatás hibaállapotban van. Ha a szolgáltatás csökkentett teljesítményű, letiltott vagy hibaállapotban van, a Microsoft aktívan vizsgálja a mögöttes problémát. Ezekben az állapotokban a dedikált szolgáltatások továbbra is díjkötelesek a kiosztott keresési egységek száma alapján.
|
|
properties.statusDetails
|
string
|
|
A keresési szolgáltatás állapotának részletei.
|
|
sku
|
Sku
|
|
A keresési szolgáltatás termékváltozata, amely meghatározza a számlázási arányt és a kapacitáskorlátokat. Ez a tulajdonság új keresési szolgáltatás létrehozásakor szükséges.
|
|
tags
|
object
|
|
Erőforráscímkék.
|
|
type
|
string
|
|
Az erőforrás típusa. Például "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"
|
SearchServiceStatus
A keresési szolgáltatás állapota. Lehetséges értékek: "futtatás": A keresési szolgáltatás fut, és nincs folyamatban kiépítési művelet. "kiépítés": A keresési szolgáltatás kiépítése vagy vertikális fel- vagy leskálázása folyamatban van. Törlés: A keresési szolgáltatás törlődik. "csökkentett teljesítményű": A keresési szolgáltatás csökkentett teljesítményű. Ez akkor fordulhat elő, ha a mögöttes keresési egységek nem kifogástalan állapotban vannak. A keresési szolgáltatás valószínűleg működőképes, de a teljesítmény lassú lehet, és egyes kérések elvethetők. "letiltva": A keresési szolgáltatás le van tiltva. Ebben az állapotban a szolgáltatás elutasítja az összes API-kérést. "hiba": A keresési szolgáltatás hibaállapotban van. Ha a szolgáltatás csökkentett teljesítményű, letiltott vagy hibaállapotban van, a Microsoft aktívan vizsgálja a mögöttes problémát. Ezekben az állapotokban a dedikált szolgáltatások továbbra is díjkötelesek a kiosztott keresési egységek száma alapján.
| Name |
Típus |
Description |
|
degraded
|
string
|
A keresési szolgáltatás csökkentett teljesítményű, mert a mögöttes keresési egységek nem kifogástalan állapotban vannak.
|
|
deleting
|
string
|
A keresési szolgáltatás törölve van.
|
|
disabled
|
string
|
A keresési szolgáltatás le van tiltva, és a rendszer minden API-kérést elutasít.
|
|
error
|
string
|
A keresési szolgáltatás hibaállapotban van, ami azt jelzi, hogy nem sikerült kiépíteni vagy törölni.
|
|
provisioning
|
string
|
A keresési szolgáltatás kiépítése vagy vertikális fel- vagy leskálázása folyamatban van.
|
|
running
|
string
|
A keresési szolgáltatás fut, és nincs folyamatban kiépítési művelet.
|
SearchServiceUpdate
A keresési szolgáltatás frissítéséhez használt paraméterek.
| Name |
Típus |
Alapértelmezett érték |
Description |
|
id
|
string
|
|
Az erőforrás teljes erőforrás-azonosítója. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
|
|
identity
|
Identity
|
|
Az erőforrás identitása.
|
|
location
|
string
|
|
Az erőforrás földrajzi helye. Ennek a támogatott és regisztrált Azure-georégiók egyikének kell lennie (például az USA nyugati régiója, az USA keleti régiója, Délkelet-Ázsia stb.). Ez a tulajdonság új erőforrás létrehozásakor szükséges.
|
|
name
|
string
|
|
Az erőforrás neve
|
|
properties.authOptions
|
DataPlaneAuthOptions
|
|
Meghatározza, hogy a keresési szolgáltatás adatsík API-ja hogyan hitelesíti a kéréseket. Ez nem állítható be, ha a disableLocalAuth értéke igaz.
|
|
properties.disableLocalAuth
|
boolean
|
|
Ha igaz értékre van állítva, a keresési szolgáltatás hívásai nem használhatják az API-kulcsokat a hitelesítéshez. Ez nem állítható igaz értékre, ha a "dataPlaneAuthOptions" definiálva van.
|
|
properties.encryptionWithCmk
|
EncryptionWithCmk
|
|
Meghatározza az erőforrások (például indexek) ügyfélkezelői kulcsokkal történő titkosítására vonatkozó szabályzatokat a keresési szolgáltatáson belül.
|
|
properties.hostingMode
|
HostingMode
|
default
|
Csak a standard3 termékváltozatra alkalmazható. Ezt a tulajdonságot beállíthatja úgy, hogy legfeljebb 3 nagy sűrűségű partíciót engedélyezzen, amelyek legfeljebb 1000 indexet tesznek lehetővé, ami sokkal magasabb, mint bármely más termékváltozat esetében engedélyezett maximális indexek. A standard3 termékváltozat esetében az érték "alapértelmezett" vagy "highDensity". Az összes többi termékváltozat esetében ennek az értéknek "alapértelmezettnek" kell lennie.
|
|
properties.networkRuleSet
|
NetworkRuleSet
|
|
Hálózatspecifikus szabályok, amelyek meghatározzák a keresési szolgáltatás elérésének módját.
|
|
properties.partitionCount
|
integer
|
1
|
A keresési szolgáltatás partícióinak száma; ha meg van adva, 1, 2, 3, 4, 6 vagy 12 lehet. Az 1-nél nagyobb értékek csak standard termékváltozatokra érvényesek. A "standard3" szolgáltatások esetében a hostingMode értéke "highDensity", az engedélyezett értékek 1 és 3 között vannak.
|
|
properties.privateEndpointConnections
|
PrivateEndpointConnection[]
|
|
A keresési szolgáltatás privát végponti kapcsolatainak listája.
|
|
properties.provisioningState
|
ProvisioningState
|
|
A keresési szolgáltatásban végrehajtott utolsó kiépítési művelet állapota. A kiépítés egy köztes állapot, amely a szolgáltatáskapacitás létrehozásakor következik be. A kapacitás beállítása után a provisioningState a "sikeres" vagy a "sikertelen" értékre változik. Az ügyfélalkalmazások lekérdezhetik a kiépítési állapotot (az ajánlott lekérdezési időköz 30 másodperctől egy percig tart), a Keresési szolgáltatás lekérése művelettel ellenőrizheti, hogy mikor fejeződik be egy művelet. Ha az ingyenes szolgáltatást használja, ez az érték általában "sikeresként" jelenik meg közvetlenül a Keresési szolgáltatás létrehozása hívásban. Ennek az az oka, hogy az ingyenes szolgáltatás már beállított kapacitást használ.
|
|
properties.publicNetworkAccess
|
PublicNetworkAccess
|
enabled
|
Ez az érték "engedélyezve" értékre állítható, hogy elkerülje a meglévő ügyfélerőforrások és sablonok kompatibilitástörő változásait. Ha a "letiltva" értékre van állítva, a nyilvános adapteren keresztüli forgalom nem engedélyezett, és a privát végponti kapcsolatok a kizárólagos hozzáférési módszer.
|
|
properties.replicaCount
|
integer
|
1
|
A keresési szolgáltatás replikáinak száma. Ha meg van adva, akkor a standard termékváltozatok esetében 1 és 12 közötti, alapszintű termékváltozat esetén 1 és 3 közötti értéknek kell lennie.
|
|
properties.semanticSearch
|
SearchSemanticSearch
|
|
Beállítja a szemantikai keresés elérhetőségét szabályozó beállításokat. Ez a konfiguráció csak bizonyos keresési termékváltozatok esetében lehetséges bizonyos helyeken.
|
|
properties.sharedPrivateLinkResources
|
SharedPrivateLinkResource[]
|
|
A keresési szolgáltatás által felügyelt megosztott privát kapcsolati erőforrások listája.
|
|
properties.status
|
SearchServiceStatus
|
|
A keresési szolgáltatás állapota. Lehetséges értékek: "futtatás": A keresési szolgáltatás fut, és nincs folyamatban kiépítési művelet. "kiépítés": A keresési szolgáltatás kiépítése vagy vertikális fel- vagy leskálázása folyamatban van. Törlés: A keresési szolgáltatás törlődik. "csökkentett teljesítményű": A keresési szolgáltatás csökkentett teljesítményű. Ez akkor fordulhat elő, ha a mögöttes keresési egységek nem kifogástalan állapotban vannak. A keresési szolgáltatás valószínűleg működőképes, de a teljesítmény lassú lehet, és egyes kérések elvethetők. "letiltva": A keresési szolgáltatás le van tiltva. Ebben az állapotban a szolgáltatás elutasítja az összes API-kérést. "hiba": A keresési szolgáltatás hibaállapotban van. Ha a szolgáltatás csökkentett teljesítményű, letiltott vagy hibaállapotban van, a Microsoft aktívan vizsgálja a mögöttes problémát. Ezekben az állapotokban a dedikált szolgáltatások továbbra is díjkötelesek a kiosztott keresési egységek száma alapján.
|
|
properties.statusDetails
|
string
|
|
A keresési szolgáltatás állapotának részletei.
|
|
sku
|
Sku
|
|
A keresési szolgáltatás termékváltozata, amely meghatározza a számlázási díjat és a kapacitáskorlátokat. Ez a tulajdonság új keresési szolgáltatás létrehozásakor szükséges.
|
|
tags
|
object
|
|
Címkék az erőforrás kategorizálásához a Azure Portal.
|
|
type
|
string
|
|
Az erőforrás típusa. Például "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"
|
SharedPrivateLinkResource
A keresési szolgáltatás által felügyelt megosztott Private Link-erőforrást ismerteti.
| Name |
Típus |
Description |
|
id
|
string
|
Az erőforrás teljes erőforrás-azonosítója. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
|
|
name
|
string
|
Az erőforrás neve
|
|
properties
|
SharedPrivateLinkResourceProperties
|
A keresési szolgáltatás által felügyelt megosztott Private Link-erőforrás tulajdonságait ismerteti.
|
|
type
|
string
|
Az erőforrás típusa. Például "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"
|
SharedPrivateLinkResourceProperties
A keresési szolgáltatás által felügyelt meglévő megosztott Private Link-erőforrás tulajdonságait ismerteti.
| Name |
Típus |
Description |
|
groupId
|
string
|
Annak az erőforrásnak a szolgáltatójától származó csoportazonosító, amelyre a megosztott privát kapcsolat erőforrása tartozik.
|
|
privateLinkResourceId
|
string
|
Annak az erőforrásnak az erőforrás-azonosítója, amelyre a megosztott privát kapcsolat erőforrása tartozik.
|
|
provisioningState
|
SharedPrivateLinkResourceProvisioningState
|
A megosztott privát kapcsolati erőforrás kiépítési állapota. Az érvényes értékek: Frissítés, Törlés, Sikertelen, Sikeres vagy Hiányos.
|
|
requestMessage
|
string
|
A megosztott privát kapcsolati erőforrás jóváhagyását kérő üzenet.
|
|
resourceRegion
|
string
|
Választható. Megadhatja annak az erőforrásnak az Azure Resource Manager helyét, amelyhez megosztott privát kapcsolatot kíván létrehozni. Ez csak azokhoz az erőforrásokhoz szükséges, amelyek DNS-konfigurációja regionális (például Azure Kubernetes Service).
|
|
status
|
SharedPrivateLinkResourceStatus
|
A megosztott privát kapcsolati erőforrás állapota. Az érvényes értékek Függőben, Jóváhagyva, Elutasítva vagy Leválasztva.
|
SharedPrivateLinkResourceProvisioningState
A megosztott privát kapcsolati erőforrás kiépítési állapota. Az érvényes értékek: Frissítés, Törlés, Sikertelen, Sikeres vagy Hiányos.
| Name |
Típus |
Description |
|
Deleting
|
string
|
|
|
Failed
|
string
|
|
|
Incomplete
|
string
|
|
|
Succeeded
|
string
|
|
|
Updating
|
string
|
|
SharedPrivateLinkResourceStatus
A megosztott privát kapcsolati erőforrás állapota. Az érvényes értékek Függőben, Jóváhagyva, Elutasítva vagy Leválasztva.
| Name |
Típus |
Description |
|
Approved
|
string
|
|
|
Disconnected
|
string
|
|
|
Pending
|
string
|
|
|
Rejected
|
string
|
|
Sku
Meghatározza egy keresési szolgáltatás termékváltozatát, amely meghatározza a számlázási arányt és a kapacitáskorlátokat.
| Name |
Típus |
Description |
|
name
|
SkuName
|
A keresési szolgáltatás termékváltozata. Az érvényes értékek a következők: "ingyenes": Megosztott szolgáltatás. "alapszintű": Dedikált szolgáltatás legfeljebb 3 replikával. "standard": Dedikált szolgáltatás legfeljebb 12 partícióval és 12 replikával. "standard2": Hasonló a standardhoz, de keresési egységenként nagyobb kapacitással. "standard3": A legnagyobb standard ajánlat legfeljebb 12 partícióval és 12 replikával (vagy akár 3 partícióval, több indexkel, ha a hostingMode tulajdonságot is "highDensity" értékre állítja). "storage_optimized_l1": Partíciónként 1 TB-ot támogat, legfeljebb 12 partíciót. "storage_optimized_l2": Partíciónként 2 TB-ot támogat, legfeljebb 12 partíciót."
|
SkuName
A keresési szolgáltatás termékváltozata. Az érvényes értékek a következők: "ingyenes": Megosztott szolgáltatás. "alapszintű": Dedikált szolgáltatás legfeljebb 3 replikával. "standard": Dedikált szolgáltatás legfeljebb 12 partícióval és 12 replikával. "standard2": Hasonló a standardhoz, de keresési egységenként nagyobb kapacitással. "standard3": A legnagyobb standard ajánlat legfeljebb 12 partícióval és 12 replikával (vagy akár 3 partícióval, több indexkel, ha a hostingMode tulajdonságot is "highDensity" értékre állítja). "storage_optimized_l1": Partíciónként 1 TB-ot támogat, legfeljebb 12 partíciót. "storage_optimized_l2": Partíciónként 2 TB-ot támogat, legfeljebb 12 partíciót."
| Name |
Típus |
Description |
|
basic
|
string
|
Számlázható szint egy dedikált szolgáltatáshoz, amely legfeljebb 3 replikával rendelkezik.
|
|
free
|
string
|
Ingyenes szint, SLA-garanciák nélkül, valamint a számlázható szinteken kínált funkciók egy részhalmaza.
|
|
standard
|
string
|
Számlázható szint egy olyan dedikált szolgáltatáshoz, amely legfeljebb 12 partícióval és 12 replikával rendelkezik.
|
|
standard2
|
string
|
Hasonló a "standard" típushoz, de több kapacitással a keresési egységenként.
|
|
standard3
|
string
|
A legnagyobb standard ajánlat akár 12 partícióval és 12 replikával (vagy akár 3 olyan partícióval, amely több indexet biztosít, ha a hostingMode tulajdonságot is "highDensity" értékre állítja).
|
|
storage_optimized_l1
|
string
|
Egy dedikált szolgáltatás számlázható szintje, amely partíciónként 1 TB-ot támogat, legfeljebb 12 partíciót.
|
|
storage_optimized_l2
|
string
|
Egy dedikált szolgáltatás számlázható szintje, amely partíciónként 2 TB-ot támogat, legfeljebb 12 partíciót.
|