Verilen kaynak grubunda var olan bir arama hizmetini Güncelleştirmeler.
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}?api-version=2023-11-01
URI Parametreleri
| Name |
İçinde |
Gerekli |
Tür |
Description |
|
resourceGroupName
|
path |
True
|
string
|
Geçerli abonelik içindeki kaynak grubunun adı. Bu değeri Azure Resource Manager API'sinden veya portaldan alabilirsiniz.
|
|
searchServiceName
|
path |
True
|
string
|
Güncelleştirilecek arama hizmetinin adı.
|
|
subscriptionId
|
path |
True
|
string
|
Microsoft Azure aboneliğinin benzersiz tanımlayıcısı. Bu değeri Azure Resource Manager API'sinden, komut satırı araçlarından veya portaldan alabilirsiniz.
|
|
api-version
|
query |
True
|
string
|
Her istek için kullanılacak API sürümü.
|
| Name |
Gerekli |
Tür |
Description |
|
x-ms-client-request-id
|
|
string
uuid
|
Bu isteği tanımlayan istemci tarafından oluşturulan GUID değeri. Belirtilirse, isteği izlemenin bir yolu olarak yanıt bilgilerine eklenir.
|
İstek Gövdesi
| Name |
Tür |
Description |
|
identity
|
Identity
|
Kaynağın kimliği.
|
|
location
|
string
|
Kaynağın coğrafi konumu. Bu, desteklenen ve kayıtlı Azure coğrafi bölgelerinden biri olmalıdır (örneğin, Batı ABD, Doğu ABD, Güneydoğu Asya vb.). Yeni bir kaynak oluşturulurken bu özellik gereklidir.
|
|
properties.authOptions
|
DataPlaneAuthOptions
|
Arama hizmetinin veri düzlemi API'sinin isteklerin kimliğini doğrulama seçeneklerini tanımlar. 'disableLocalAuth' true olarak ayarlandıysa bu ayarlanamaz.
|
|
properties.disableLocalAuth
|
boolean
|
true olarak ayarlandığında, arama hizmetine yapılan çağrıların kimlik doğrulaması için API anahtarlarını kullanmasına izin verilmez. 'dataPlaneAuthOptions' tanımlanmışsa bu true olarak ayarlanamaz.
|
|
properties.encryptionWithCmk
|
EncryptionWithCmk
|
Arama hizmetindeki customer manager anahtarlarını kullanarak kaynakların (dizinler gibi) şifrelenmesiyle ilgili tüm ilkeleri belirtir.
|
|
properties.hostingMode
|
HostingMode
|
Yalnızca standard3 SKU için geçerlidir. Bu özelliği, 1000'e kadar dizine izin veren en fazla 3 yüksek yoğunluklu bölümü etkinleştirecek şekilde ayarlayabilirsiniz; bu, diğer SKU'lar için izin verilen en yüksek dizinden çok daha yüksektir. Standard3 SKU'su için değer 'default' veya 'highDensity' şeklindedir. Diğer tüm SKU'lar için bu değer 'varsayılan' olmalıdır.
|
|
properties.networkRuleSet
|
NetworkRuleSet
|
Arama hizmetine nasıl ulaşıldığını belirleyen ağa özgü kurallar.
|
|
properties.partitionCount
|
integer
|
Arama hizmetindeki bölüm sayısı; belirtilirse, 1, 2, 3, 4, 6 veya 12 olabilir. 1'den büyük değerler yalnızca standart SKU'lar için geçerlidir. hostingMode 'highDensity' olarak ayarlanmış 'standard3' hizmetleri için izin verilen değerler 1 ile 3 arasındadır.
|
|
properties.publicNetworkAccess
|
PublicNetworkAccess
|
Mevcut müşteri kaynaklarında ve şablonlarında hataya neden olan değişiklikleri önlemek için bu değer 'etkin' olarak ayarlanabilir. 'Devre dışı' olarak ayarlanırsa, ortak arabirim üzerinden trafiğe izin verilmez ve özel uç nokta bağlantıları özel erişim yöntemi olacaktır.
|
|
properties.replicaCount
|
integer
|
Arama hizmetindeki çoğaltma sayısı. Belirtilirse, standart SKU'lar için 1 ile 12 arasında (bunlar dahil) veya temel SKU'lar için 1 ile 3 arasında bir değer olmalıdır.
|
|
properties.semanticSearch
|
SearchSemanticSearch
|
Anlamsal aramanın kullanılabilirliğini denetleye seçenekleri ayarlar. Bu yapılandırma yalnızca belirli konumlardaki belirli arama SKU'ları için mümkündür.
|
|
sku
|
Sku
|
Faturalama oranını ve kapasite sınırlarını belirleyen arama hizmetinin SKU'su. Yeni bir arama hizmeti oluşturulurken bu özellik gereklidir.
|
|
tags
|
object
|
Azure portal kaynağı kategorilere ayırmaya yardımcı olacak etiketler.
|
Yanıtlar
| Name |
Tür |
Description |
|
200 OK
|
SearchService
|
Mevcut hizmet tanımı başarıyla güncelleştirildi. Çoğaltma veya bölüm sayısını değiştirdiyseniz, ölçeklendirme işlemi zaman uyumsuz olarak gerçekleşir. Hizmet tanımınızı düzenli aralıklarla alabilir ve provisioningState özelliği aracılığıyla ilerleme durumunu izleyebilirsiniz.
|
|
Other Status Codes
|
CloudError
|
HTTP 400 (Hatalı İstek): Verilen hizmet tanımı geçersiz veya sabit bir özelliği değiştirmeye çalıştınız; Ayrıntılar için yanıttaki hata koduna ve iletiye bakın. HTTP 404 (Bulunamadı): Abonelik veya kaynak grubu bulunamadı. HTTP 409 (Çakışma): Belirtilen abonelik devre dışı bırakıldı.
|
Güvenlik
azure_auth
OAuth2 yetkilendirme akışını Microsoft Entra ID.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
| Name |
Description |
|
user_impersonation
|
kullanıcı hesabınızın kimliğine bürünme
|
Örnekler
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"
}
}
Tanımlar
| Name |
Description |
|
AadAuthFailureMode
|
Bir arama hizmetinin veri düzlemi API'sinin kimlik doğrulaması başarısız olan istekler için göndereceği yanıtı açıklar.
|
|
ApiKeyOnly
|
Kimlik doğrulaması için yalnızca API anahtarının kullanılabileceğini gösterir.
|
|
CloudError
|
API hatası hakkında bilgi içerir.
|
|
CloudErrorBody
|
Hata kodu ve ileti içeren belirli bir API hatası açıklanır.
|
|
DataPlaneAadOrApiKeyAuthOption
|
Microsoft Entra ID kiracıdan alınan API anahtarının veya erişim belirtecinin kimlik doğrulaması için kullanılabileceğini gösterir.
|
|
DataPlaneAuthOptions
|
Arama hizmetinin bir veri düzlemi isteğinin kimliğini doğrulama seçeneklerini tanımlar. 'disableLocalAuth' true olarak ayarlandıysa bu ayarlanamaz.
|
|
EncryptionWithCmk
|
Arama hizmetindeki kaynakların customer=managed anahtarlarla nasıl şifreleneceğini belirleyen bir ilkeyi açıklar.
|
|
HostingMode
|
Yalnızca standard3 SKU için geçerlidir. Bu özelliği, 1000'e kadar dizine izin veren en fazla 3 yüksek yoğunluklu bölümü etkinleştirecek şekilde ayarlayabilirsiniz; bu, diğer SKU'lar için izin verilen en yüksek dizinden çok daha yüksektir. Standard3 SKU'su için değer 'default' veya 'highDensity' şeklindedir. Diğer tüm SKU'lar için bu değer 'varsayılan' olmalıdır.
|
|
Identity
|
Kaynağın kimliği.
|
|
IdentityType
|
Kimlik türü.
|
|
IpRule
|
Arama hizmetinin IP kısıtlama kuralı.
|
|
NetworkRuleSet
|
Arama hizmetine nasıl ulaşıldığını belirleyen ağa özgü kurallar.
|
|
PrivateEndpoint
|
Microsoft.Network sağlayıcısından özel uç nokta kaynağı.
|
|
PrivateEndpointConnection
|
Arama hizmetine var olan bir özel uç nokta bağlantısını açıklar.
|
|
PrivateEndpointConnectionProperties
|
Arama hizmetine yönelik mevcut Özel Uç Nokta bağlantısının özelliklerini açıklar.
|
|
PrivateLinkServiceConnectionProvisioningState
|
Özel bağlantı hizmeti bağlantısının sağlama durumu. Geçerli değerler Güncelleştirme, Silme, Başarısız, Başarılı veya Tamamlanmadı değerleridir
|
|
PrivateLinkServiceConnectionState
|
Azure Özel Uç Noktasına var olan bir Özel Bağlantı Hizmeti bağlantısının geçerli durumunu açıklar.
|
|
PrivateLinkServiceConnectionStatus
|
Özel bağlantı hizmeti bağlantısının durumu. Geçerli değerler Beklemede, Onaylandı, Reddedildi veya Bağlantısı Kesildi şeklindedir.
|
|
ProvisioningState
|
Arama hizmetinde gerçekleştirilen son sağlama işleminin durumu. Sağlama, hizmet kapasitesi oluşturulurken oluşan bir ara durumdur. Kapasite ayarlandıktan sonra provisioningState değeri 'başarılı' veya 'başarısız' olarak değişir. İstemci uygulamaları, bir işlemin ne zaman tamamlandığını görmek için Arama Hizmetini Al işlemini kullanarak sağlama durumunu yoklayabilir (önerilen yoklama aralığı 30 saniyeden bir dakikaya kadardır). Ücretsiz hizmeti kullanıyorsanız, bu değer doğrudan Arama hizmeti oluşturma çağrısında 'başarılı' olarak geri dönme eğilimindedir. Bunun nedeni, ücretsiz hizmetin zaten ayarlanmış kapasiteyi kullanmasıdır.
|
|
PublicNetworkAccess
|
Mevcut müşteri kaynaklarında ve şablonlarında hataya neden olan değişiklikleri önlemek için bu değer 'etkin' olarak ayarlanabilir. 'Devre dışı' olarak ayarlanırsa, ortak arabirim üzerinden trafiğe izin verilmez ve özel uç nokta bağlantıları özel erişim yöntemi olacaktır.
|
|
SearchEncryptionComplianceStatus
|
Arama hizmetinin müşteri tarafından şifrelenmemiş kaynaklara sahip olma konusunda uyumlu olup olmadığını açıklar. Bir hizmette müşteri tarafından şifrelenmemiş birden fazla kaynak varsa ve 'Zorlama' 'etkin' ise, hizmet 'Uyumsuz' olarak işaretlenir.
|
|
SearchEncryptionWithCmk
|
Bir arama hizmetinin müşteri tarafından şifrelenmemiş bir veya daha fazla kaynağa sahip olmayı nasıl zorunlu kılması gerektiğini açıklar.
|
|
SearchSemanticSearch
|
Anlamsal aramanın kullanılabilirliğini denetleye seçenekleri ayarlar. Bu yapılandırma yalnızca belirli konumlardaki belirli arama SKU'ları için mümkündür.
|
|
SearchService
|
Bir arama hizmetini ve geçerli durumunu açıklar.
|
|
SearchServiceStatus
|
Arama hizmetinin durumu. Olası değerler şunlardır: 'running': Arama hizmeti çalışıyor ve sağlama işlemleri devam ediyor. 'sağlama': Arama hizmeti sağlanıyor veya ölçeği artırılıyor veya azaltılıyor. 'silme': Arama hizmeti siliniyor. 'Düzeyi düşürüldü': Arama hizmetinin düzeyi düşürüldü. Temel alınan arama birimleri iyi durumda olmadığında bu durum oluşabilir. Arama hizmeti büyük olasılıkla çalışır durumdadır, ancak performans yavaş olabilir ve bazı istekler bırakılabilir. 'devre dışı': Arama hizmeti devre dışı bırakıldı. Bu durumda hizmet tüm API isteklerini reddeder. 'error': Arama hizmeti bir hata durumunda. Hizmetiniz düzeyi düşürülmüş, devre dışı veya hata durumlarındaysa, Microsoft temel alınan sorunu etkin bir şekilde araştırıyordur. Bu durumlardaki ayrılmış hizmetler, sağlanan arama birimi sayısına bağlı olarak ücretlendirilebilir.
|
|
SearchServiceUpdate
|
Arama hizmetini güncelleştirmek için kullanılan parametreler.
|
|
SharedPrivateLinkResource
|
Arama hizmeti tarafından yönetilen Paylaşılan Özel Bağlantı Kaynağını açıklar.
|
|
SharedPrivateLinkResourceProperties
|
Arama hizmeti tarafından yönetilen mevcut Paylaşılan Özel Bağlantı Kaynağının özelliklerini açıklar.
|
|
SharedPrivateLinkResourceProvisioningState
|
Paylaşılan özel bağlantı kaynağının sağlama durumu. Geçerli değerler Güncelleştirme, Silme, Başarısız, Başarılı veya Tamamlanmadı değerleridir.
|
|
SharedPrivateLinkResourceStatus
|
Paylaşılan özel bağlantı kaynağının durumu. Geçerli değerler Beklemede, Onaylandı, Reddedildi veya Bağlantısı Kesildi.
|
|
Sku
|
Faturalama oranını ve kapasite sınırlarını belirleyen arama hizmetinin SKU'sunu tanımlar.
|
|
SkuName
|
Arama hizmetinin SKU'su. Geçerli değerler şunlardır: 'free': Paylaşılan hizmet. 'basic': En fazla 3 çoğaltması olan ayrılmış hizmet. 'standart': En fazla 12 bölüm ve 12 çoğaltma ile ayrılmış hizmet. 'standard2': Standartla benzer, ancak arama birimi başına daha fazla kapasiteye sahiptir. 'standard3': 12 bölüme ve 12 çoğaltmaya (veya hostingMode özelliğini 'highDensity' olarak ayarladıysanız daha fazla dizin içeren en fazla 3 bölüme) sahip en büyük Standart teklif. 'storage_optimized_l1': Bölüm başına 12 bölüme kadar 1 TB destekler. 'storage_optimized_l2': Bölüm başına en fazla 12 bölüm olmak üzere 2 TB destekler.'
|
AadAuthFailureMode
Bir arama hizmetinin veri düzlemi API'sinin kimlik doğrulaması başarısız olan istekler için göndereceği yanıtı açıklar.
| Name |
Tür |
Description |
|
http401WithBearerChallenge
|
string
|
Başarısız kimlik doğrulaması isteklerine 401 (Yetkisiz) HTTP durum kodu sunulması ve Taşıyıcı Sınaması sunulması gerektiğini gösterir.
|
|
http403
|
string
|
Başarısız kimlik doğrulaması isteklerinin 403 (Yasak) HTTP durum koduyla sunulması gerektiğini gösterir.
|
ApiKeyOnly
Kimlik doğrulaması için yalnızca API anahtarının kullanılabileceğini gösterir.
CloudError
API hatası hakkında bilgi içerir.
| Name |
Tür |
Description |
|
error
|
CloudErrorBody
|
Hata kodu ve ileti içeren belirli bir API hatası açıklanır.
|
CloudErrorBody
Hata kodu ve ileti içeren belirli bir API hatası açıklanır.
| Name |
Tür |
Description |
|
code
|
string
|
Http durum kodundan daha kesin bir şekilde hata koşulunu açıklayan bir hata kodu. Belirli hata durumlarını program aracılığıyla işlemek için kullanılabilir.
|
|
details
|
CloudErrorBody[]
|
Bu hatayla ilgili iç içe hatalar içerir.
|
|
message
|
string
|
Hatayı ayrıntılı olarak açıklayan ve hata ayıklama bilgileri sağlayan bir ileti.
|
|
target
|
string
|
Belirli bir hatanın hedefi (örneğin, hatadaki özelliğin adı).
|
DataPlaneAadOrApiKeyAuthOption
Microsoft Entra ID kiracıdan alınan API anahtarının veya erişim belirtecinin kimlik doğrulaması için kullanılabileceğini gösterir.
| Name |
Tür |
Description |
|
aadAuthFailureMode
|
AadAuthFailureMode
|
Bir arama hizmetinin veri düzlemi API'sinin kimlik doğrulaması başarısız olan istekler için göndereceği yanıtı açıklar.
|
DataPlaneAuthOptions
Arama hizmetinin bir veri düzlemi isteğinin kimliğini doğrulama seçeneklerini tanımlar. 'disableLocalAuth' true olarak ayarlandıysa bu ayarlanamaz.
| Name |
Tür |
Description |
|
aadOrApiKey
|
DataPlaneAadOrApiKeyAuthOption
|
Microsoft Entra ID kiracıdan alınan API anahtarının veya erişim belirtecinin kimlik doğrulaması için kullanılabileceğini gösterir.
|
|
apiKeyOnly
|
ApiKeyOnly
|
Kimlik doğrulaması için yalnızca API anahtarının kullanılabileceğini gösterir.
|
EncryptionWithCmk
Arama hizmetindeki kaynakların customer=managed anahtarlarla nasıl şifreleneceğini belirleyen bir ilkeyi açıklar.
| Name |
Tür |
Description |
|
encryptionComplianceStatus
|
SearchEncryptionComplianceStatus
|
Arama hizmetinin müşteri tarafından şifrelenmemiş kaynaklara sahip olma konusunda uyumlu olup olmadığını açıklar. Bir hizmette müşteri tarafından şifrelenmemiş birden fazla kaynak varsa ve 'Zorlama' 'etkin' ise, hizmet 'Uyumsuz' olarak işaretlenir.
|
|
enforcement
|
SearchEncryptionWithCmk
|
Bir arama hizmetinin müşteri tarafından şifrelenmemiş bir veya daha fazla kaynağa sahip olmayı nasıl zorunlu kılması gerektiğini açıklar.
|
HostingMode
Yalnızca standard3 SKU için geçerlidir. Bu özelliği, 1000'e kadar dizine izin veren en fazla 3 yüksek yoğunluklu bölümü etkinleştirecek şekilde ayarlayabilirsiniz; bu, diğer SKU'lar için izin verilen en yüksek dizinden çok daha yüksektir. Standard3 SKU'su için değer 'default' veya 'highDensity' şeklindedir. Diğer tüm SKU'lar için bu değer 'varsayılan' olmalıdır.
| Name |
Tür |
Description |
|
default
|
string
|
Dizin sayısı sınırı, SKU'nun varsayılan sınırlarına göre belirlenir.
|
|
highDensity
|
string
|
Yalnızca arama hizmetinin en fazla 1000 dizine sahip olabileceği standard3 SKU'su için uygulama.
|
Identity
Kaynağın kimliği.
| Name |
Tür |
Description |
|
principalId
|
string
|
Arama hizmetinin sistem tarafından atanan kimliğinin asıl kimliği.
|
|
tenantId
|
string
|
Arama hizmetinin sistem tarafından atanan kimliğinin kiracı kimliği.
|
|
type
|
IdentityType
|
Kimlik türü.
|
IdentityType
Kimlik türü.
| Name |
Tür |
Description |
|
None
|
string
|
|
|
SystemAssigned
|
string
|
|
IpRule
Arama hizmetinin IP kısıtlama kuralı.
| Name |
Tür |
Description |
|
value
|
string
|
Tek bir IPv4 adresine (örneğin, 123.1.2.3) veya CIDR biçiminde bir IP aralığına (örneğin, 123.1.2.3/24) karşılık gelen değere izin verilir.
|
NetworkRuleSet
Arama hizmetine nasıl ulaşıldığını belirleyen ağa özgü kurallar.
| Name |
Tür |
Description |
|
ipRules
|
IpRule[]
|
IP güvenlik duvarı için kullanılan IP kısıtlama kurallarının listesi. Kurallarla eşleşmeyen TÜM IP'ler güvenlik duvarı tarafından engellenir. Bu kurallar yalnızca arama hizmetinin 'publicNetworkAccess' değeri 'etkin' olduğunda uygulanır.
|
PrivateEndpoint
Microsoft.Network sağlayıcısından özel uç nokta kaynağı.
| Name |
Tür |
Description |
|
id
|
string
|
Microsoft.Network sağlayıcısından gelen özel uç nokta kaynağının kaynak kimliği.
|
PrivateEndpointConnection
Arama hizmetine var olan bir özel uç nokta bağlantısını açıklar.
| Name |
Tür |
Description |
|
id
|
string
|
Kaynağın tam kaynak kimliği. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
|
|
name
|
string
|
Kaynağın adı
|
|
properties
|
PrivateEndpointConnectionProperties
|
Arama hizmetine var olan bir özel uç nokta bağlantısının özelliklerini açıklar.
|
|
type
|
string
|
Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts"
|
PrivateEndpointConnectionProperties
Arama hizmetine yönelik mevcut Özel Uç Nokta bağlantısının özelliklerini açıklar.
| Name |
Tür |
Description |
|
groupId
|
string
|
Özel bağlantı hizmeti bağlantısının ait olduğu kaynak sağlayıcısının grup kimliği.
|
|
privateEndpoint
|
PrivateEndpoint
|
Microsoft.Network sağlayıcısından özel uç nokta kaynağı.
|
|
privateLinkServiceConnectionState
|
PrivateLinkServiceConnectionState
|
Azure Özel Uç Noktasına var olan bir Özel Bağlantı Hizmeti bağlantısının geçerli durumunu açıklar.
|
|
provisioningState
|
PrivateLinkServiceConnectionProvisioningState
|
Özel bağlantı hizmeti bağlantısının sağlama durumu. Geçerli değerler Güncelleştirme, Silme, Başarısız, Başarılı veya Tamamlanmadı değerleridir
|
PrivateLinkServiceConnectionProvisioningState
Özel bağlantı hizmeti bağlantısının sağlama durumu. Geçerli değerler Güncelleştirme, Silme, Başarısız, Başarılı veya Tamamlanmadı değerleridir
| Name |
Tür |
Description |
|
Canceled
|
string
|
Özel bağlantı hizmeti bağlantı kaynağı için sağlama isteği iptal edildi
|
|
Deleting
|
string
|
Özel bağlantı hizmeti bağlantısı siliniyor.
|
|
Failed
|
string
|
Özel bağlantı hizmeti bağlantısı sağlanamadı veya silinemedi.
|
|
Incomplete
|
string
|
Özel bağlantı hizmeti bağlantı kaynağı için sağlama isteği kabul edildi, ancak oluşturma işlemi henüz başlamadı.
|
|
Succeeded
|
string
|
Özel bağlantı hizmeti bağlantısı sağlamayı tamamladı ve onay için hazır.
|
|
Updating
|
string
|
Özel bağlantı hizmeti bağlantısı, tamamen işlevsel olması için diğer kaynaklarla birlikte oluşturulma aşamasındadır.
|
PrivateLinkServiceConnectionState
Azure Özel Uç Noktasına var olan bir Özel Bağlantı Hizmeti bağlantısının geçerli durumunu açıklar.
| Name |
Tür |
Varsayılan değer |
Description |
|
actionsRequired
|
string
|
None
|
Gerekli olabilecek ek eylemlerin açıklaması.
|
|
description
|
string
|
|
Özel bağlantı hizmeti bağlantı durumunun açıklaması.
|
|
status
|
PrivateLinkServiceConnectionStatus
|
|
Özel bağlantı hizmeti bağlantısının durumu. Geçerli değerler Beklemede, Onaylandı, Reddedildi veya Bağlantısı Kesildi şeklindedir.
|
PrivateLinkServiceConnectionStatus
Özel bağlantı hizmeti bağlantısının durumu. Geçerli değerler Beklemede, Onaylandı, Reddedildi veya Bağlantısı Kesildi şeklindedir.
| Name |
Tür |
Description |
|
Approved
|
string
|
Özel uç nokta bağlantısı onaylandı ve kullanıma hazır.
|
|
Disconnected
|
string
|
Özel uç nokta bağlantısı hizmetten kaldırıldı.
|
|
Pending
|
string
|
Özel uç nokta bağlantısı oluşturuldu ve onay bekliyor.
|
|
Rejected
|
string
|
Özel uç nokta bağlantısı reddedildi ve kullanılamaz.
|
ProvisioningState
Arama hizmetinde gerçekleştirilen son sağlama işleminin durumu. Sağlama, hizmet kapasitesi oluşturulurken oluşan bir ara durumdur. Kapasite ayarlandıktan sonra provisioningState değeri 'başarılı' veya 'başarısız' olarak değişir. İstemci uygulamaları, bir işlemin ne zaman tamamlandığını görmek için Arama Hizmetini Al işlemini kullanarak sağlama durumunu yoklayabilir (önerilen yoklama aralığı 30 saniyeden bir dakikaya kadardır). Ücretsiz hizmeti kullanıyorsanız, bu değer doğrudan Arama hizmeti oluşturma çağrısında 'başarılı' olarak geri dönme eğilimindedir. Bunun nedeni, ücretsiz hizmetin zaten ayarlanmış kapasiteyi kullanmasıdır.
| Name |
Tür |
Description |
|
failed
|
string
|
Son sağlama işlemi başarısız oldu.
|
|
provisioning
|
string
|
Arama hizmeti sağlanıyor veya ölçeği artırılıyor veya azaltılıyor.
|
|
succeeded
|
string
|
Son sağlama işlemi başarıyla tamamlandı.
|
PublicNetworkAccess
Mevcut müşteri kaynaklarında ve şablonlarında hataya neden olan değişiklikleri önlemek için bu değer 'etkin' olarak ayarlanabilir. 'Devre dışı' olarak ayarlanırsa, ortak arabirim üzerinden trafiğe izin verilmez ve özel uç nokta bağlantıları özel erişim yöntemi olacaktır.
| Name |
Tür |
Description |
|
disabled
|
string
|
|
|
enabled
|
string
|
|
SearchEncryptionComplianceStatus
Arama hizmetinin müşteri tarafından şifrelenmemiş kaynaklara sahip olma konusunda uyumlu olup olmadığını açıklar. Bir hizmette müşteri tarafından şifrelenmemiş birden fazla kaynak varsa ve 'Zorlama' 'etkin' ise, hizmet 'Uyumsuz' olarak işaretlenir.
| Name |
Tür |
Description |
|
Compliant
|
string
|
Müşteri tarafından şifrelenmeyen kaynakların sayısı sıfır olduğundan veya zorlama devre dışı bırakıldığından, arama hizmetinin uyumlu olduğunu gösterir.
|
|
NonCompliant
|
string
|
Arama hizmetinin müşteri tarafından şifrelenmemiş birden fazla kaynağı olduğunu gösterir.
|
SearchEncryptionWithCmk
Bir arama hizmetinin müşteri tarafından şifrelenmemiş bir veya daha fazla kaynağa sahip olmayı nasıl zorunlu kılması gerektiğini açıklar.
| Name |
Tür |
Description |
|
Disabled
|
string
|
Zorlama yapılmaz ve arama hizmeti müşteri tarafından şifrelenmemiş kaynaklara sahip olabilir.
|
|
Enabled
|
string
|
Arama hizmeti, müşteri tarafından şifrelenmeyen bir veya daha fazla kaynak varsa uyumsuz olarak işaretlenir.
|
|
Unspecified
|
string
|
Zorlama ilkesi açıkça belirtilmemiştir ve davranış 'Devre Dışı' olarak ayarlanmış gibi olur.
|
SearchSemanticSearch
Anlamsal aramanın kullanılabilirliğini denetleye seçenekleri ayarlar. Bu yapılandırma yalnızca belirli konumlardaki belirli arama SKU'ları için mümkündür.
| Name |
Tür |
Description |
|
disabled
|
string
|
Anlam derecelendirmesinin arama hizmeti için devre dışı bırakıldığını gösterir.
|
|
free
|
string
|
Arama hizmetinde anlam sıralamasını etkinleştirir ve ücretsiz katmanın sınırları içinde kullanılacağını belirtir. Bu, anlamsal derecelendirme isteklerinin hacmini kapsatır ve ek ücret ödemeden sunulur. Bu, yeni sağlanan arama hizmetleri için varsayılandır.
|
|
standard
|
string
|
Daha yüksek aktarım hızına ve anlamsal derecelendirme istekleri hacmine sahip bir arama hizmetinde faturalanabilir özellik olarak anlam sıralamasını etkinleştirir.
|
SearchService
Bir arama hizmetini ve geçerli durumunu açıklar.
| Name |
Tür |
Varsayılan değer |
Description |
|
id
|
string
|
|
Kaynağın tam kaynak kimliği. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
|
|
identity
|
Identity
|
|
Kaynağın kimliği.
|
|
location
|
string
|
|
Kaynağın bulunduğu coğrafi konum
|
|
name
|
string
|
|
Kaynağın adı
|
|
properties.authOptions
|
DataPlaneAuthOptions
|
|
Arama hizmetinin veri düzlemi API'sinin isteklerin kimliğini doğrulama seçeneklerini tanımlar. 'disableLocalAuth' true olarak ayarlandıysa bu ayarlanamaz.
|
|
properties.disableLocalAuth
|
boolean
|
|
true olarak ayarlandığında, arama hizmetine yapılan çağrıların kimlik doğrulaması için API anahtarlarını kullanmasına izin verilmez. 'dataPlaneAuthOptions' tanımlanmışsa bu true olarak ayarlanamaz.
|
|
properties.encryptionWithCmk
|
EncryptionWithCmk
|
|
Arama hizmetindeki customer manager anahtarlarını kullanarak kaynakların (dizinler gibi) şifrelenmesiyle ilgili tüm ilkeleri belirtir.
|
|
properties.hostingMode
|
HostingMode
|
default
|
Yalnızca standard3 SKU için geçerlidir. Bu özelliği, 1000'e kadar dizine izin veren en fazla 3 yüksek yoğunluklu bölümü etkinleştirecek şekilde ayarlayabilirsiniz; bu, diğer SKU'lar için izin verilen en yüksek dizinden çok daha yüksektir. Standard3 SKU'su için değer 'default' veya 'highDensity' şeklindedir. Diğer tüm SKU'lar için bu değer 'varsayılan' olmalıdır.
|
|
properties.networkRuleSet
|
NetworkRuleSet
|
|
Arama hizmetine nasıl ulaşıldığını belirleyen ağa özgü kurallar.
|
|
properties.partitionCount
|
integer
|
1
|
Arama hizmetindeki bölüm sayısı; belirtilirse, 1, 2, 3, 4, 6 veya 12 olabilir. 1'den büyük değerler yalnızca standart SKU'lar için geçerlidir. hostingMode 'highDensity' olarak ayarlanmış 'standard3' hizmetleri için izin verilen değerler 1 ile 3 arasındadır.
|
|
properties.privateEndpointConnections
|
PrivateEndpointConnection[]
|
|
Arama hizmetine yönelik özel uç nokta bağlantılarının listesi.
|
|
properties.provisioningState
|
ProvisioningState
|
|
Arama hizmetinde gerçekleştirilen son sağlama işleminin durumu. Sağlama, hizmet kapasitesi oluşturulurken oluşan bir ara durumdur. Kapasite ayarlandıktan sonra provisioningState değeri 'başarılı' veya 'başarısız' olarak değişir. İstemci uygulamaları, bir işlemin ne zaman tamamlandığını görmek için Arama Hizmetini Al işlemini kullanarak sağlama durumunu yoklayabilir (önerilen yoklama aralığı 30 saniyeden bir dakikaya kadardır). Ücretsiz hizmeti kullanıyorsanız, bu değer doğrudan Arama hizmeti oluşturma çağrısında 'başarılı' olarak geri dönme eğilimindedir. Bunun nedeni, ücretsiz hizmetin zaten ayarlanmış kapasiteyi kullanmasıdır.
|
|
properties.publicNetworkAccess
|
PublicNetworkAccess
|
enabled
|
Mevcut müşteri kaynaklarında ve şablonlarında hataya neden olan değişiklikleri önlemek için bu değer 'etkin' olarak ayarlanabilir. 'Devre dışı' olarak ayarlanırsa, ortak arabirim üzerinden trafiğe izin verilmez ve özel uç nokta bağlantıları özel erişim yöntemi olacaktır.
|
|
properties.replicaCount
|
integer
|
1
|
Arama hizmetindeki çoğaltma sayısı. Belirtilirse, standart SKU'lar için 1 ile 12 arasında (bunlar dahil) veya temel SKU'lar için 1 ile 3 arasında bir değer olmalıdır.
|
|
properties.semanticSearch
|
SearchSemanticSearch
|
|
Anlamsal aramanın kullanılabilirliğini denetleye seçenekleri ayarlar. Bu yapılandırma yalnızca belirli konumlardaki belirli arama SKU'ları için mümkündür.
|
|
properties.sharedPrivateLinkResources
|
SharedPrivateLinkResource[]
|
|
Arama hizmeti tarafından yönetilen paylaşılan özel bağlantı kaynaklarının listesi.
|
|
properties.status
|
SearchServiceStatus
|
|
Arama hizmetinin durumu. Olası değerler şunlardır: 'running': Arama hizmeti çalışıyor ve sağlama işlemleri devam ediyor. 'sağlama': Arama hizmeti sağlanıyor veya ölçeği artırılıyor veya azaltılıyor. 'silme': Arama hizmeti siliniyor. 'Düzeyi düşürüldü': Arama hizmetinin düzeyi düşürüldü. Temel alınan arama birimleri iyi durumda olmadığında bu durum oluşabilir. Arama hizmeti büyük olasılıkla çalışır durumdadır, ancak performans yavaş olabilir ve bazı istekler bırakılabilir. 'devre dışı': Arama hizmeti devre dışı bırakıldı. Bu durumda hizmet tüm API isteklerini reddeder. 'error': Arama hizmeti bir hata durumunda. Hizmetiniz düzeyi düşürülmüş, devre dışı veya hata durumlarındaysa, Microsoft temel alınan sorunu etkin bir şekilde araştırıyordur. Bu durumlardaki ayrılmış hizmetler, sağlanan arama birimi sayısına bağlı olarak ücretlendirilebilir.
|
|
properties.statusDetails
|
string
|
|
Arama hizmeti durumunun ayrıntıları.
|
|
sku
|
Sku
|
|
Faturalama oranını ve kapasite sınırlarını belirleyen arama hizmetinin SKU'su. Yeni bir arama hizmeti oluşturulurken bu özellik gereklidir.
|
|
tags
|
object
|
|
Kaynak etiketleri.
|
|
type
|
string
|
|
Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts"
|
SearchServiceStatus
Arama hizmetinin durumu. Olası değerler şunlardır: 'running': Arama hizmeti çalışıyor ve sağlama işlemleri devam ediyor. 'sağlama': Arama hizmeti sağlanıyor veya ölçeği artırılıyor veya azaltılıyor. 'silme': Arama hizmeti siliniyor. 'Düzeyi düşürüldü': Arama hizmetinin düzeyi düşürüldü. Temel alınan arama birimleri iyi durumda olmadığında bu durum oluşabilir. Arama hizmeti büyük olasılıkla çalışır durumdadır, ancak performans yavaş olabilir ve bazı istekler bırakılabilir. 'devre dışı': Arama hizmeti devre dışı bırakıldı. Bu durumda hizmet tüm API isteklerini reddeder. 'error': Arama hizmeti bir hata durumunda. Hizmetiniz düzeyi düşürülmüş, devre dışı veya hata durumlarındaysa, Microsoft temel alınan sorunu etkin bir şekilde araştırıyordur. Bu durumlardaki ayrılmış hizmetler, sağlanan arama birimi sayısına bağlı olarak ücretlendirilebilir.
| Name |
Tür |
Description |
|
degraded
|
string
|
Temel alınan arama birimleri iyi durumda olmadığından arama hizmetinin düzeyi düşürüldü.
|
|
deleting
|
string
|
Arama hizmeti siliniyor.
|
|
disabled
|
string
|
Arama hizmeti devre dışı bırakılır ve tüm API istekleri reddedilir.
|
|
error
|
string
|
Arama hizmeti hata durumundadır ve sağlama veya silme işleminin başarısız olduğunu gösterir.
|
|
provisioning
|
string
|
Arama hizmeti sağlanıyor veya ölçeği artırılıyor veya azaltılıyor.
|
|
running
|
string
|
Arama hizmeti çalışıyor ve sağlama işlemleri devam ediyor.
|
SearchServiceUpdate
Arama hizmetini güncelleştirmek için kullanılan parametreler.
| Name |
Tür |
Varsayılan değer |
Description |
|
id
|
string
|
|
Kaynağın tam kaynak kimliği. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
|
|
identity
|
Identity
|
|
Kaynağın kimliği.
|
|
location
|
string
|
|
Kaynağın coğrafi konumu. Bu, desteklenen ve kayıtlı Azure coğrafi bölgelerinden biri olmalıdır (örneğin, Batı ABD, Doğu ABD, Güneydoğu Asya vb.). Yeni bir kaynak oluşturulurken bu özellik gereklidir.
|
|
name
|
string
|
|
Kaynağın adı
|
|
properties.authOptions
|
DataPlaneAuthOptions
|
|
Arama hizmetinin veri düzlemi API'sinin isteklerin kimliğini doğrulama seçeneklerini tanımlar. 'disableLocalAuth' true olarak ayarlandıysa bu ayarlanamaz.
|
|
properties.disableLocalAuth
|
boolean
|
|
true olarak ayarlandığında, arama hizmetine yapılan çağrıların kimlik doğrulaması için API anahtarlarını kullanmasına izin verilmez. 'dataPlaneAuthOptions' tanımlanmışsa bu true olarak ayarlanamaz.
|
|
properties.encryptionWithCmk
|
EncryptionWithCmk
|
|
Arama hizmetindeki customer manager anahtarlarını kullanarak kaynakların (dizinler gibi) şifrelenmesiyle ilgili tüm ilkeleri belirtir.
|
|
properties.hostingMode
|
HostingMode
|
default
|
Yalnızca standard3 SKU için geçerlidir. Bu özelliği, 1000'e kadar dizine izin veren en fazla 3 yüksek yoğunluklu bölümü etkinleştirecek şekilde ayarlayabilirsiniz; bu, diğer SKU'lar için izin verilen en yüksek dizinden çok daha yüksektir. Standard3 SKU'su için değer 'default' veya 'highDensity' şeklindedir. Diğer tüm SKU'lar için bu değer 'varsayılan' olmalıdır.
|
|
properties.networkRuleSet
|
NetworkRuleSet
|
|
Arama hizmetine nasıl ulaşıldığını belirleyen ağa özgü kurallar.
|
|
properties.partitionCount
|
integer
|
1
|
Arama hizmetindeki bölüm sayısı; belirtilirse, 1, 2, 3, 4, 6 veya 12 olabilir. 1'den büyük değerler yalnızca standart SKU'lar için geçerlidir. hostingMode 'highDensity' olarak ayarlanmış 'standard3' hizmetleri için izin verilen değerler 1 ile 3 arasındadır.
|
|
properties.privateEndpointConnections
|
PrivateEndpointConnection[]
|
|
Arama hizmetine yönelik özel uç nokta bağlantılarının listesi.
|
|
properties.provisioningState
|
ProvisioningState
|
|
Arama hizmetinde gerçekleştirilen son sağlama işleminin durumu. Sağlama, hizmet kapasitesi oluşturulurken oluşan bir ara durumdur. Kapasite ayarlandıktan sonra provisioningState değeri 'başarılı' veya 'başarısız' olarak değişir. İstemci uygulamaları, bir işlemin ne zaman tamamlandığını görmek için Arama Hizmetini Al işlemini kullanarak sağlama durumunu yoklayabilir (önerilen yoklama aralığı 30 saniyeden bir dakikaya kadardır). Ücretsiz hizmeti kullanıyorsanız, bu değer doğrudan Arama hizmeti oluşturma çağrısında 'başarılı' olarak geri dönme eğilimindedir. Bunun nedeni, ücretsiz hizmetin zaten ayarlanmış kapasiteyi kullanmasıdır.
|
|
properties.publicNetworkAccess
|
PublicNetworkAccess
|
enabled
|
Mevcut müşteri kaynaklarında ve şablonlarında hataya neden olan değişiklikleri önlemek için bu değer 'etkin' olarak ayarlanabilir. 'Devre dışı' olarak ayarlanırsa, ortak arabirim üzerinden trafiğe izin verilmez ve özel uç nokta bağlantıları özel erişim yöntemi olacaktır.
|
|
properties.replicaCount
|
integer
|
1
|
Arama hizmetindeki çoğaltma sayısı. Belirtilirse, standart SKU'lar için 1 ile 12 arasında (bunlar dahil) veya temel SKU'lar için 1 ile 3 arasında bir değer olmalıdır.
|
|
properties.semanticSearch
|
SearchSemanticSearch
|
|
Anlamsal aramanın kullanılabilirliğini denetleye seçenekleri ayarlar. Bu yapılandırma yalnızca belirli konumlardaki belirli arama SKU'ları için mümkündür.
|
|
properties.sharedPrivateLinkResources
|
SharedPrivateLinkResource[]
|
|
Arama hizmeti tarafından yönetilen paylaşılan özel bağlantı kaynaklarının listesi.
|
|
properties.status
|
SearchServiceStatus
|
|
Arama hizmetinin durumu. Olası değerler şunlardır: 'running': Arama hizmeti çalışıyor ve sağlama işlemleri devam ediyor. 'sağlama': Arama hizmeti sağlanıyor veya ölçeği artırılıyor veya azaltılıyor. 'silme': Arama hizmeti siliniyor. 'Düzeyi düşürüldü': Arama hizmetinin düzeyi düşürüldü. Temel alınan arama birimleri iyi durumda olmadığında bu durum oluşabilir. Arama hizmeti büyük olasılıkla çalışır durumdadır, ancak performans yavaş olabilir ve bazı istekler bırakılabilir. 'devre dışı': Arama hizmeti devre dışı bırakıldı. Bu durumda hizmet tüm API isteklerini reddeder. 'error': Arama hizmeti bir hata durumunda. Hizmetiniz düzeyi düşürülmüş, devre dışı veya hata durumlarındaysa, Microsoft temel alınan sorunu etkin bir şekilde araştırıyordur. Bu durumlardaki ayrılmış hizmetler, sağlanan arama birimi sayısına bağlı olarak ücretlendirilebilir.
|
|
properties.statusDetails
|
string
|
|
Arama hizmeti durumunun ayrıntıları.
|
|
sku
|
Sku
|
|
Faturalama oranını ve kapasite sınırlarını belirleyen arama hizmetinin SKU'su. Yeni bir arama hizmeti oluşturulurken bu özellik gereklidir.
|
|
tags
|
object
|
|
Azure portal kaynağı kategorilere ayırmaya yardımcı olacak etiketler.
|
|
type
|
string
|
|
Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts"
|
SharedPrivateLinkResource
Arama hizmeti tarafından yönetilen Paylaşılan Özel Bağlantı Kaynağını açıklar.
| Name |
Tür |
Description |
|
id
|
string
|
Kaynağın tam kaynak kimliği. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
|
|
name
|
string
|
Kaynağın adı
|
|
properties
|
SharedPrivateLinkResourceProperties
|
Arama hizmeti tarafından yönetilen Paylaşılan Özel Bağlantı Kaynağının özelliklerini açıklar.
|
|
type
|
string
|
Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts"
|
SharedPrivateLinkResourceProperties
Arama hizmeti tarafından yönetilen mevcut Paylaşılan Özel Bağlantı Kaynağının özelliklerini açıklar.
| Name |
Tür |
Description |
|
groupId
|
string
|
Paylaşılan özel bağlantı kaynağının kaynak sağlayıcısının grup kimliği.
|
|
privateLinkResourceId
|
string
|
Paylaşılan özel bağlantı kaynağının kaynak kimliği.
|
|
provisioningState
|
SharedPrivateLinkResourceProvisioningState
|
Paylaşılan özel bağlantı kaynağının sağlama durumu. Geçerli değerler Güncelleştirme, Silme, Başarısız, Başarılı veya Tamamlanmadı değerleridir.
|
|
requestMessage
|
string
|
Paylaşılan özel bağlantı kaynağının onaylanmasını istemek için istek iletisi.
|
|
resourceRegion
|
string
|
İsteğe bağlı. Paylaşılan özel bağlantının oluşturulacağı kaynağın Azure Resource Manager konumunu belirtmek için kullanılabilir. Bu yalnızca DNS yapılandırması bölgesel olan (Azure Kubernetes Service gibi) kaynaklar için gereklidir.
|
|
status
|
SharedPrivateLinkResourceStatus
|
Paylaşılan özel bağlantı kaynağının durumu. Geçerli değerler Beklemede, Onaylandı, Reddedildi veya Bağlantısı Kesildi.
|
SharedPrivateLinkResourceProvisioningState
Paylaşılan özel bağlantı kaynağının sağlama durumu. Geçerli değerler Güncelleştirme, Silme, Başarısız, Başarılı veya Tamamlanmadı değerleridir.
| Name |
Tür |
Description |
|
Deleting
|
string
|
|
|
Failed
|
string
|
|
|
Incomplete
|
string
|
|
|
Succeeded
|
string
|
|
|
Updating
|
string
|
|
SharedPrivateLinkResourceStatus
Paylaşılan özel bağlantı kaynağının durumu. Geçerli değerler Beklemede, Onaylandı, Reddedildi veya Bağlantısı Kesildi.
| Name |
Tür |
Description |
|
Approved
|
string
|
|
|
Disconnected
|
string
|
|
|
Pending
|
string
|
|
|
Rejected
|
string
|
|
Sku
Faturalama oranını ve kapasite sınırlarını belirleyen arama hizmetinin SKU'sunu tanımlar.
| Name |
Tür |
Description |
|
name
|
SkuName
|
Arama hizmetinin SKU'su. Geçerli değerler şunlardır: 'free': Paylaşılan hizmet. 'basic': En fazla 3 çoğaltması olan ayrılmış hizmet. 'standart': En fazla 12 bölüm ve 12 çoğaltma ile ayrılmış hizmet. 'standard2': Standartla benzer, ancak arama birimi başına daha fazla kapasiteye sahiptir. 'standard3': 12 bölüme ve 12 çoğaltmaya (veya hostingMode özelliğini 'highDensity' olarak ayarladıysanız daha fazla dizin içeren en fazla 3 bölüme) sahip en büyük Standart teklif. 'storage_optimized_l1': Bölüm başına 12 bölüme kadar 1 TB destekler. 'storage_optimized_l2': Bölüm başına en fazla 12 bölüm olmak üzere 2 TB destekler.'
|
SkuName
Arama hizmetinin SKU'su. Geçerli değerler şunlardır: 'free': Paylaşılan hizmet. 'basic': En fazla 3 çoğaltması olan ayrılmış hizmet. 'standart': En fazla 12 bölüm ve 12 çoğaltma ile ayrılmış hizmet. 'standard2': Standartla benzer, ancak arama birimi başına daha fazla kapasiteye sahiptir. 'standard3': 12 bölüme ve 12 çoğaltmaya (veya hostingMode özelliğini 'highDensity' olarak ayarladıysanız daha fazla dizin içeren en fazla 3 bölüme) sahip en büyük Standart teklif. 'storage_optimized_l1': Bölüm başına 12 bölüme kadar 1 TB destekler. 'storage_optimized_l2': Bölüm başına en fazla 12 bölüm olmak üzere 2 TB destekler.'
| Name |
Tür |
Description |
|
basic
|
string
|
En fazla 3 çoğaltmaya sahip ayrılmış bir hizmet için faturalanabilir katman.
|
|
free
|
string
|
Ücretsiz katman, SLA garantisi olmadan ve faturalanabilir katmanlarda sunulan özelliklerin bir alt kümesiyle.
|
|
standard
|
string
|
En fazla 12 bölüme ve 12 çoğaltmaya sahip ayrılmış bir hizmet için faturalanabilir katman.
|
|
standard2
|
string
|
'Standart'a benzer, ancak arama birimi başına daha fazla kapasiteye sahiptir.
|
|
standard3
|
string
|
12 bölüme ve 12 çoğaltmaya (veya hostingMode özelliğini 'highDensity' olarak ayarladıysanız daha fazla dizine sahip en fazla 3 bölüme) sahip en büyük Standart teklif.
|
|
storage_optimized_l1
|
string
|
Bölüm başına 12 bölüme kadar 1 TB destekleyen ayrılmış bir hizmet için faturalanabilir katman.
|
|
storage_optimized_l2
|
string
|
Bölüm başına en fazla 12 bölüm olmak üzere 2 TB destekleyen ayrılmış bir hizmet için faturalanabilir katman.
|