特定のリソース グループ内の既存の検索サービスを更新します。
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}?api-version=2024-03-01-preview
URI パラメーター
| 名前 |
/ |
必須 |
型 |
説明 |
|
resourceGroupName
|
path |
True
|
string
|
現在のサブスクリプション内のリソース グループの名前。 この値は、Azure リソース マネージャー API またはポータルから取得できます。
|
|
searchServiceName
|
path |
True
|
string
|
更新する Azure AI Search Serviceの名前。
|
|
subscriptionId
|
path |
True
|
string
|
Microsoft Azure サブスクリプションの一意識別子。 この値は、Azure リソース マネージャー API またはポータルから取得できます。
|
|
api-version
|
query |
True
|
string
|
各要求に使用する API バージョン。
|
| 名前 |
必須 |
型 |
説明 |
|
x-ms-client-request-id
|
|
string
uuid
|
クライアントが生成した、この要求を識別する GUID 値。 指定した場合、これは要求を追跡する方法として応答情報に含まれます。
|
要求本文
| 名前 |
型 |
説明 |
|
identity
|
Identity
|
検索サービス ID の詳細。 null 値は、検索サービスに ID が割り当てられていないことを示します。
|
|
location
|
string
|
リソースの地理的な場所。 これは、サポートおよび登録されている Azure geo リージョンの 1 つである必要があります (たとえば、米国西部、米国東部、東南アジアなど)。 このプロパティは、新しいリソースを作成するときに必要です。
|
|
properties.authOptions
|
DataPlaneAuthOptions
|
検索サービスのデータ プレーン API が要求を認証する方法のオプションを定義します。 'disableLocalAuth' が true に設定されている場合、これは設定できません。
|
|
properties.disableLocalAuth
|
boolean
|
true に設定すると、検索サービスの呼び出しで認証に API キーを使用することは許可されません。 'dataPlaneAuthOptions' が定義されている場合、これは true に設定できません。
|
|
properties.disabledDataExfiltrationOptions
|
SearchDisabledDataExfiltrationOption[]
|
検索サービスに対して明示的に許可されていないデータ流出シナリオの一覧。 現在、サポートされている値は 、将来計画されるより詳細な制御を使用して、可能なすべてのデータ エクスポート シナリオを無効にする "すべて" のみです。
|
|
properties.encryptionWithCmk
|
EncryptionWithCmk
|
検索サービス内でカスタマー マネージャー キーを使用するリソース (インデックスなど) の暗号化に関するポリシーを指定します。
|
|
properties.hostingMode
|
HostingMode
|
Standard3 SKU にのみ適用されます。 このプロパティを設定すると、最大 3 つの高密度パーティションを有効にして、最大 1,000 個のインデックスを使用できます。これは、他の SKU で許可される最大インデックスよりもはるかに大きくなります。 standard3 SKU の場合、値は 'default' または 'highDensity' です。 他のすべての SKU の場合、この値は 'default' である必要があります。
|
|
properties.networkRuleSet
|
NetworkRuleSet
|
Azure AI Search Serviceに到達する方法を決定するネットワーク固有のルール。
|
|
properties.partitionCount
|
integer
|
検索サービス内のパーティションの数。指定する場合は、1、2、3、4、6、または 12 にすることができます。 1 より大きい値は、標準 SKU でのみ有効です。 hostingMode が 'highDensity' に設定されている 'standard3' サービスの場合、許可される値は 1 から 3 の間です。
|
|
properties.publicNetworkAccess
|
PublicNetworkAccess
|
この値を "有効" に設定すると、既存の顧客リソースとテンプレートに重大な変更が加えられるのを防ぐことができます。 'disabled' に設定されている場合、パブリック インターフェイス経由のトラフィックは許可されず、プライベート エンドポイント接続は排他アクセス方法になります。
|
|
properties.replicaCount
|
integer
|
検索サービス内のレプリカの数。 指定する場合は、標準 SKU の場合は 1 から 12 までの値、基本 SKU の場合は 1 から 3 までの値である必要があります。
|
|
properties.semanticSearch
|
SearchSemanticSearch
|
セマンティック検索の可用性を制御するオプションを設定します。 この構成は、特定の場所にある特定の Azure AI Search SKU に対してのみ可能です。
|
|
sku
|
Sku
|
価格レベルと容量の制限を決定する検索サービスの SKU。 このプロパティは、新しい検索サービスを作成するときに必要です。
|
|
tags
|
object
|
Azure portal内のリソースを分類するのに役立つタグ。
|
応答
| 名前 |
型 |
説明 |
|
200 OK
|
SearchService
|
既存のサービス定義が正常に更新されました。 レプリカまたはパーティションの数を変更した場合、スケール操作は非同期的に行われます。 スケール操作の状態は、Get Service 要求の provisioningState プロパティを使用してチェックできます。
|
|
Other Status Codes
|
CloudError
|
HTTP 400 (無効な要求): 指定されたサービス定義が無効であるか、変更できないプロパティを変更しようとしました。 詳細については、応答のエラー コードとメッセージを参照してください。 HTTP 404 (見つかりません): サブスクリプションまたはリソース グループが見つかりませんでした。 HTTP 409 (競合): 指定されたサブスクリプションが無効になっています。
|
セキュリティ
azure_auth
Microsoft ID プラットフォームでサポートされている暗黙的な許可フローを指定します。
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
| 名前 |
説明 |
|
user_impersonation
|
ユーザー アカウントの借用
|
例
SearchUpdateService
Sample Request
PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2024-03-01-preview
{
"tags": {
"app-name": "My e-commerce app",
"new-tag": "Adding a new tag"
},
"properties": {
"replicaCount": 2
}
}
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/preview/2024-03-01-preview/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/cf5ad1932d00c7d15497705ad6b71171d3d68b1e/specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/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{
// AuthOptions: &armsearch.DataPlaneAuthOptions{
// APIKeyOnly: map[string]any{
// },
// },
// DisableLocalAuth: to.Ptr(false),
// DisabledDataExfiltrationOptions: []*armsearch.SearchDisabledDataExfiltrationOption{
// },
// EncryptionWithCmk: &armsearch.EncryptionWithCmk{
// EncryptionComplianceStatus: to.Ptr(armsearch.SearchEncryptionComplianceStatusCompliant),
// Enforcement: to.Ptr(armsearch.SearchEncryptionWithCmkUnspecified),
// },
// HostingMode: to.Ptr(armsearch.HostingModeDefault),
// NetworkRuleSet: &armsearch.NetworkRuleSet{
// Bypass: to.Ptr(armsearch.SearchBypassNone),
// 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/preview/2024-03-01-preview/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
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": [],
"bypass": "None"
},
"privateEndpointConnections": [],
"sharedPrivateLinkResources": [],
"encryptionWithCmk": {
"enforcement": "Unspecified",
"encryptionComplianceStatus": "Compliant"
},
"disableLocalAuth": false,
"authOptions": {
"apiKeyOnly": {}
},
"disabledDataExfiltrationOptions": []
}
}
SearchUpdateServiceAuthOptions
Sample Request
PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2024-03-01-preview
{
"tags": {
"app-name": "My e-commerce app",
"new-tag": "Adding a new tag"
},
"properties": {
"replicaCount": 2,
"authOptions": {
"aadOrApiKey": {
"aadAuthFailureMode": "http401WithBearerChallenge"
}
}
}
}
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/preview/2024-03-01-preview/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/cf5ad1932d00c7d15497705ad6b71171d3d68b1e/specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/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),
// },
// },
// DisabledDataExfiltrationOptions: []*armsearch.SearchDisabledDataExfiltrationOption{
// },
// EncryptionWithCmk: &armsearch.EncryptionWithCmk{
// EncryptionComplianceStatus: to.Ptr(armsearch.SearchEncryptionComplianceStatusCompliant),
// Enforcement: to.Ptr(armsearch.SearchEncryptionWithCmkUnspecified),
// },
// HostingMode: to.Ptr(armsearch.HostingModeDefault),
// NetworkRuleSet: &armsearch.NetworkRuleSet{
// Bypass: to.Ptr(armsearch.SearchBypassNone),
// 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/preview/2024-03-01-preview/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
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": [],
"bypass": "None"
},
"privateEndpointConnections": [],
"sharedPrivateLinkResources": [],
"encryptionWithCmk": {
"enforcement": "Unspecified",
"encryptionComplianceStatus": "Compliant"
},
"authOptions": {
"aadOrApiKey": {
"aadAuthFailureMode": "http401WithBearerChallenge"
}
},
"disabledDataExfiltrationOptions": []
}
}
SearchUpdateServiceDisableLocalAuth
Sample Request
PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2024-03-01-preview
{
"tags": {
"app-name": "My e-commerce app",
"new-tag": "Adding a new tag"
},
"properties": {
"replicaCount": 2,
"disableLocalAuth": true
}
}
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/preview/2024-03-01-preview/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/cf5ad1932d00c7d15497705ad6b71171d3d68b1e/specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/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),
// DisabledDataExfiltrationOptions: []*armsearch.SearchDisabledDataExfiltrationOption{
// },
// EncryptionWithCmk: &armsearch.EncryptionWithCmk{
// EncryptionComplianceStatus: to.Ptr(armsearch.SearchEncryptionComplianceStatusCompliant),
// Enforcement: to.Ptr(armsearch.SearchEncryptionWithCmkUnspecified),
// },
// HostingMode: to.Ptr(armsearch.HostingModeDefault),
// NetworkRuleSet: &armsearch.NetworkRuleSet{
// Bypass: to.Ptr(armsearch.SearchBypassNone),
// 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/preview/2024-03-01-preview/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
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": [],
"bypass": "None"
},
"privateEndpointConnections": [],
"sharedPrivateLinkResources": [],
"encryptionWithCmk": {
"enforcement": "Unspecified",
"encryptionComplianceStatus": "Compliant"
},
"disableLocalAuth": true,
"authOptions": null,
"disabledDataExfiltrationOptions": []
}
}
SearchUpdateServiceToAllowAccessFromPrivateEndpoints
Sample Request
PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2024-03-01-preview
{
"properties": {
"replicaCount": 1,
"partitionCount": 1,
"publicNetworkAccess": "disabled"
}
}
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/preview/2024-03-01-preview/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/cf5ad1932d00c7d15497705ad6b71171d3d68b1e/specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/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{
// AuthOptions: &armsearch.DataPlaneAuthOptions{
// APIKeyOnly: map[string]any{
// },
// },
// DisableLocalAuth: to.Ptr(false),
// DisabledDataExfiltrationOptions: []*armsearch.SearchDisabledDataExfiltrationOption{
// },
// EncryptionWithCmk: &armsearch.EncryptionWithCmk{
// EncryptionComplianceStatus: to.Ptr(armsearch.SearchEncryptionComplianceStatusCompliant),
// Enforcement: to.Ptr(armsearch.SearchEncryptionWithCmkUnspecified),
// },
// HostingMode: to.Ptr(armsearch.HostingModeDefault),
// NetworkRuleSet: &armsearch.NetworkRuleSet{
// Bypass: to.Ptr(armsearch.SearchBypassNone),
// 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),
// SharedPrivateLinkResources: []*armsearch.SharedPrivateLinkResource{
// },
// 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/preview/2024-03-01-preview/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
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": [],
"bypass": "None"
},
"privateEndpointConnections": [],
"sharedPrivateLinkResources": [],
"encryptionWithCmk": {
"enforcement": "Unspecified",
"encryptionComplianceStatus": "Compliant"
},
"disableLocalAuth": false,
"authOptions": {
"apiKeyOnly": {}
},
"disabledDataExfiltrationOptions": []
}
}
SearchUpdateServiceToAllowAccessFromPublicCustomIPs
Sample Request
PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2024-03-01-preview
{
"properties": {
"replicaCount": 3,
"partitionCount": 1,
"publicNetworkAccess": "enabled",
"networkRuleSet": {
"ipRules": [
{
"value": "123.4.5.6"
},
{
"value": "123.4.6.0/18"
}
]
}
}
}
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/preview/2024-03-01-preview/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/cf5ad1932d00c7d15497705ad6b71171d3d68b1e/specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/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{
// AuthOptions: &armsearch.DataPlaneAuthOptions{
// APIKeyOnly: map[string]any{
// },
// },
// DisableLocalAuth: to.Ptr(false),
// DisabledDataExfiltrationOptions: []*armsearch.SearchDisabledDataExfiltrationOption{
// },
// EncryptionWithCmk: &armsearch.EncryptionWithCmk{
// EncryptionComplianceStatus: to.Ptr(armsearch.SearchEncryptionComplianceStatusCompliant),
// Enforcement: to.Ptr(armsearch.SearchEncryptionWithCmkUnspecified),
// },
// 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),
// SharedPrivateLinkResources: []*armsearch.SharedPrivateLinkResource{
// },
// 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/preview/2024-03-01-preview/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
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": [],
"sharedPrivateLinkResources": [],
"encryptionWithCmk": {
"enforcement": "Unspecified",
"encryptionComplianceStatus": "Compliant"
},
"disableLocalAuth": false,
"authOptions": {
"apiKeyOnly": {}
},
"disabledDataExfiltrationOptions": []
}
}
SearchUpdateServiceToAllowAccessFromPublicCustomIPsAndBypass
Sample Request
PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2024-03-01-preview
{
"properties": {
"replicaCount": 3,
"partitionCount": 1,
"publicNetworkAccess": "enabled",
"networkRuleSet": {
"ipRules": [
{
"value": "123.4.5.6"
},
{
"value": "123.4.6.0/18"
}
],
"bypass": "AzurePortal"
}
}
}
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_and_bypass.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": {
"bypass": "AzurePortal",
"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/preview/2024-03-01-preview/examples/SearchUpdateServiceToAllowAccessFromPublicCustomIPsAndBypass.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/cf5ad1932d00c7d15497705ad6b71171d3d68b1e/specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/SearchUpdateServiceToAllowAccessFromPublicCustomIPsAndBypass.json
func ExampleServicesClient_Update_searchUpdateServiceToAllowAccessFromPublicCustomIPsAndBypass() {
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{
Bypass: to.Ptr(armsearch.SearchBypassAzurePortal),
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{
// AuthOptions: &armsearch.DataPlaneAuthOptions{
// APIKeyOnly: map[string]any{
// },
// },
// DisableLocalAuth: to.Ptr(false),
// DisabledDataExfiltrationOptions: []*armsearch.SearchDisabledDataExfiltrationOption{
// },
// EncryptionWithCmk: &armsearch.EncryptionWithCmk{
// EncryptionComplianceStatus: to.Ptr(armsearch.SearchEncryptionComplianceStatusCompliant),
// Enforcement: to.Ptr(armsearch.SearchEncryptionWithCmkUnspecified),
// },
// HostingMode: to.Ptr(armsearch.HostingModeDefault),
// NetworkRuleSet: &armsearch.NetworkRuleSet{
// Bypass: to.Ptr(armsearch.SearchBypassAzurePortal),
// 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),
// SharedPrivateLinkResources: []*armsearch.SharedPrivateLinkResource{
// },
// 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/preview/2024-03-01-preview/examples/SearchUpdateServiceToAllowAccessFromPublicCustomIPsAndBypass.json
*/
async function searchUpdateServiceToAllowAccessFromPublicCustomIPsAndBypass() {
const subscriptionId = process.env["SEARCH_SUBSCRIPTION_ID"] || "subid";
const resourceGroupName = process.env["SEARCH_RESOURCE_GROUP"] || "rg1";
const searchServiceName = "mysearchservice";
const service = {
networkRuleSet: {
bypass: "AzurePortal",
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
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"
}
],
"bypass": "AzurePortal"
},
"privateEndpointConnections": [],
"sharedPrivateLinkResources": [],
"encryptionWithCmk": {
"enforcement": "Unspecified",
"encryptionComplianceStatus": "Compliant"
},
"disableLocalAuth": false,
"authOptions": {
"apiKeyOnly": {}
},
"disabledDataExfiltrationOptions": []
}
}
SearchUpdateServiceToRemoveIdentity
Sample Request
PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2024-03-01-preview
{
"sku": {
"name": "standard"
},
"identity": {
"type": "None"
}
}
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/preview/2024-03-01-preview/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/cf5ad1932d00c7d15497705ad6b71171d3d68b1e/specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/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{
// },
// Properties: &armsearch.ServiceProperties{
// AuthOptions: &armsearch.DataPlaneAuthOptions{
// APIKeyOnly: map[string]any{
// },
// },
// DisableLocalAuth: to.Ptr(false),
// DisabledDataExfiltrationOptions: []*armsearch.SearchDisabledDataExfiltrationOption{
// },
// EncryptionWithCmk: &armsearch.EncryptionWithCmk{
// EncryptionComplianceStatus: to.Ptr(armsearch.SearchEncryptionComplianceStatusCompliant),
// Enforcement: to.Ptr(armsearch.SearchEncryptionWithCmkUnspecified),
// },
// HostingMode: to.Ptr(armsearch.HostingModeDefault),
// NetworkRuleSet: &armsearch.NetworkRuleSet{
// Bypass: to.Ptr(armsearch.SearchBypassNone),
// 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),
// SharedPrivateLinkResources: []*armsearch.SharedPrivateLinkResource{
// },
// 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/preview/2024-03-01-preview/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
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": [],
"bypass": "None"
},
"privateEndpointConnections": [],
"sharedPrivateLinkResources": [],
"encryptionWithCmk": {
"enforcement": "Unspecified",
"encryptionComplianceStatus": "Compliant"
},
"disableLocalAuth": false,
"authOptions": {
"apiKeyOnly": {}
},
"disabledDataExfiltrationOptions": []
}
}
SearchUpdateServiceWithCmkEnforcement
Sample Request
PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2024-03-01-preview
{
"tags": {
"app-name": "My e-commerce app",
"new-tag": "Adding a new tag"
},
"properties": {
"replicaCount": 2,
"encryptionWithCmk": {
"enforcement": "Enabled"
}
}
}
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/preview/2024-03-01-preview/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/cf5ad1932d00c7d15497705ad6b71171d3d68b1e/specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/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),
// DisabledDataExfiltrationOptions: []*armsearch.SearchDisabledDataExfiltrationOption{
// },
// EncryptionWithCmk: &armsearch.EncryptionWithCmk{
// EncryptionComplianceStatus: to.Ptr(armsearch.SearchEncryptionComplianceStatusCompliant),
// Enforcement: to.Ptr(armsearch.SearchEncryptionWithCmkEnabled),
// },
// HostingMode: to.Ptr(armsearch.HostingModeDefault),
// NetworkRuleSet: &armsearch.NetworkRuleSet{
// Bypass: to.Ptr(armsearch.SearchBypassNone),
// 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/preview/2024-03-01-preview/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
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": [],
"bypass": "None"
},
"privateEndpointConnections": [],
"sharedPrivateLinkResources": [],
"encryptionWithCmk": {
"enforcement": "Enabled",
"encryptionComplianceStatus": "Compliant"
},
"disableLocalAuth": false,
"authOptions": {
"apiKeyOnly": {}
},
"disabledDataExfiltrationOptions": []
}
}
SearchUpdateServiceWithDataExfiltration
Sample Request
PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2024-03-01-preview
{
"tags": {
"app-name": "My e-commerce app",
"new-tag": "Adding a new tag"
},
"properties": {
"replicaCount": 2,
"disabledDataExfiltrationOptions": [
"All"
]
}
}
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_data_exfiltration.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": {"disabledDataExfiltrationOptions": ["All"], "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/preview/2024-03-01-preview/examples/SearchUpdateServiceWithDataExfiltration.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/cf5ad1932d00c7d15497705ad6b71171d3d68b1e/specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/SearchUpdateServiceWithDataExfiltration.json
func ExampleServicesClient_Update_searchUpdateServiceWithDataExfiltration() {
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{
DisabledDataExfiltrationOptions: []*armsearch.SearchDisabledDataExfiltrationOption{
to.Ptr(armsearch.SearchDisabledDataExfiltrationOptionAll)},
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),
// DisabledDataExfiltrationOptions: []*armsearch.SearchDisabledDataExfiltrationOption{
// to.Ptr(armsearch.SearchDisabledDataExfiltrationOptionAll)},
// EncryptionWithCmk: &armsearch.EncryptionWithCmk{
// EncryptionComplianceStatus: to.Ptr(armsearch.SearchEncryptionComplianceStatusCompliant),
// Enforcement: to.Ptr(armsearch.SearchEncryptionWithCmkUnspecified),
// },
// HostingMode: to.Ptr(armsearch.HostingModeDefault),
// NetworkRuleSet: &armsearch.NetworkRuleSet{
// Bypass: to.Ptr(armsearch.SearchBypassNone),
// 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/preview/2024-03-01-preview/examples/SearchUpdateServiceWithDataExfiltration.json
*/
async function searchUpdateServiceWithDataExfiltration() {
const subscriptionId = process.env["SEARCH_SUBSCRIPTION_ID"] || "subid";
const resourceGroupName = process.env["SEARCH_RESOURCE_GROUP"] || "rg1";
const searchServiceName = "mysearchservice";
const service = {
disabledDataExfiltrationOptions: ["All"],
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
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": [],
"bypass": "None"
},
"privateEndpointConnections": [],
"sharedPrivateLinkResources": [],
"encryptionWithCmk": {
"enforcement": "Unspecified",
"encryptionComplianceStatus": "Compliant"
},
"disableLocalAuth": false,
"authOptions": {
"apiKeyOnly": {}
},
"disabledDataExfiltrationOptions": [
"All"
]
}
}
SearchUpdateServiceWithSemanticSearch
Sample Request
PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2024-03-01-preview
{
"tags": {
"app-name": "My e-commerce app",
"new-tag": "Adding a new tag"
},
"properties": {
"replicaCount": 2,
"semanticSearch": "standard"
}
}
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/preview/2024-03-01-preview/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/cf5ad1932d00c7d15497705ad6b71171d3d68b1e/specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/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),
// DisabledDataExfiltrationOptions: []*armsearch.SearchDisabledDataExfiltrationOption{
// },
// EncryptionWithCmk: &armsearch.EncryptionWithCmk{
// EncryptionComplianceStatus: to.Ptr(armsearch.SearchEncryptionComplianceStatusCompliant),
// Enforcement: to.Ptr(armsearch.SearchEncryptionWithCmkUnspecified),
// },
// HostingMode: to.Ptr(armsearch.HostingModeDefault),
// NetworkRuleSet: &armsearch.NetworkRuleSet{
// Bypass: to.Ptr(armsearch.SearchBypassNone),
// 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/preview/2024-03-01-preview/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
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": [],
"bypass": "None"
},
"privateEndpointConnections": [],
"sharedPrivateLinkResources": [],
"encryptionWithCmk": {
"enforcement": "Unspecified",
"encryptionComplianceStatus": "Compliant"
},
"disableLocalAuth": false,
"authOptions": {
"apiKeyOnly": {}
},
"disabledDataExfiltrationOptions": [],
"semanticSearch": "standard"
}
}
定義
| 名前 |
説明 |
|
AadAuthFailureMode
|
認証に失敗した要求に対して検索サービスのデータ プレーン API が送信する応答について説明します。
|
|
ApiKeyOnly
|
認証に API キーのみを使用できることを示します。
|
|
CloudError
|
API エラーに関する情報が含まれています。
|
|
CloudErrorBody
|
エラー コードとメッセージを含む特定の API エラーについて説明します。
|
|
DataPlaneAadOrApiKeyAuthOption
|
Microsoft Entra ID テナントの API キーまたはアクセス トークンを認証に使用できることを示します。
|
|
DataPlaneAuthOptions
|
検索サービスがデータ プレーン要求を認証する方法のオプションを定義します。 'disableLocalAuth' が true に設定されている場合、これは設定できません。
|
|
EncryptionWithCmk
|
カスタマー マネージド キーを使用して検索サービス内のリソースを暗号化する方法を決定するポリシーについて説明します。
|
|
HostingMode
|
Standard3 SKU にのみ適用されます。 このプロパティを設定すると、最大 3 つの高密度パーティションを有効にして、最大 1,000 個のインデックスを使用できます。これは、他の SKU で許可されている最大インデックスよりもはるかに大きくなります。 standard3 SKU の場合、値は 'default' または 'highDensity' です。 他のすべての SKU の場合、この値は "default" である必要があります。
|
|
Identity
|
検索サービス ID の詳細。 null 値は、検索サービスに ID が割り当てられていないことを示します。
|
|
IdentityType
|
リソースに使用される ID の種類。 種類 "SystemAssigned, UserAssigned" には、システムによって作成された 1 個の ID と、ユーザー割り当て ID のセットの両方が含まれます。 種類 "None" の場合は、サービスからすべての ID が削除されます。
|
|
IpRule
|
Azure AI Search Serviceの IP 制限規則。
|
|
NetworkRuleSet
|
Azure AI Search Serviceに到達する方法を決定するネットワーク固有のルール。
|
|
PrivateEndpoint
|
Microsoft.Network プロバイダーからのプライベート エンドポイント リソース。
|
|
PrivateEndpointConnection
|
Azure AI Search Serviceへの既存のプライベート エンドポイント接続について説明します。
|
|
PrivateEndpointConnectionProperties
|
検索サービスへの既存のプライベート エンドポイント接続のプロパティについて説明します。
|
|
PrivateLinkServiceConnectionProvisioningState
|
プライベート リンク サービス接続のプロビジョニング状態。 有効な値は、更新、削除、失敗、成功、不完全、または取り消しです。
|
|
PrivateLinkServiceConnectionState
|
プライベート エンドポイントへの既存のAzure Private Link サービス接続の現在の状態について説明します。
|
|
PrivateLinkServiceConnectionStatus
|
プライベート リンク サービス接続の状態。 有効な値は、[保留中]、[承認済み]、[拒否済み]、または [切断] です。
|
|
ProvisioningState
|
検索サービスで最後に実行されたプロビジョニング操作の状態。 プロビジョニングは、サービスの容量が確立されるときに発生する中間的な状態です。 容量が設定されると、provisioningState が 'succeeded' または 'failed' に変更されます。 クライアント アプリケーションは、Get Search Service 操作を使用して操作がいつ完了したのか確認することで、プロビジョニングの状態 (推奨されるポーリング間隔は 30 秒から 1 分) をポーリングできます。 無料サービスを使用している場合、この値は、検索サービスの作成の呼び出しで直接 "成功" として返される傾向があります。 これは、無料のサービスは既にセットアップされている容量を使用するためです。
|
|
PublicNetworkAccess
|
この値を "有効" に設定すると、既存の顧客リソースとテンプレートに重大な変更が加えられるのを防ぐことができます。 'disabled' に設定されている場合、パブリック インターフェイス経由のトラフィックは許可されず、プライベート エンドポイント接続は排他的アクセス方法になります。
|
|
SearchBypass
|
"ipRules" セクションで定義されている規則をバイパスできる受信トラフィックの可能性のある配信元。
|
|
SearchDisabledDataExfiltrationOption
|
検索サービスに対して明示的に許可されていないデータ流出シナリオの一覧。 現在、サポートされている値は 、将来計画されているよりきめ細かな制御を使用して、すべての可能なデータ エクスポート シナリオを無効にする "すべて" のみです。
|
|
SearchEncryptionComplianceStatus
|
CMK で暗号化されていないオブジェクトに関する検索サービスコンプライアンスの状態を返します。 サービスに暗号化されていないオブジェクトが複数あり、適用が有効になっている場合、サービスは非準拠としてマークされます。
|
|
SearchEncryptionWithCmk
|
カスタマー マネージド キーで暗号化されていないオブジェクトが検索サービスによって検出された場合にコンプライアンスを適用する方法について説明します。
|
|
SearchSemanticSearch
|
セマンティック検索の可用性を制御するオプションを設定します。 この構成は、特定の場所にある特定の Azure AI Search SKU でのみ可能です。
|
|
SearchService
|
Azure AI Search Serviceとその現在の状態について説明します。
|
|
SearchServiceStatus
|
検索サービスの状態。 指定できる値は、"実行中" です。検索サービスは実行されており、プロビジョニング操作は進行中です。 'provisioning': 検索サービスがプロビジョニングまたはスケールアップまたはスケールダウンされています。 '削除中': 検索サービスが削除されています。 'degraded': 検索サービスが機能低下しています。 これは、基になる検索単位が正常でない場合に発生する可能性があります。 検索サービスは動作している可能性が高いですが、パフォーマンスが低下し、一部の要求が削除される可能性があります。 'disabled': 検索サービスは無効になっています。 この状態では、サービスはすべての API 要求を拒否します。 'error': 検索サービスがエラー状態です。 'stopped': 検索サービスが無効になっているサブスクリプションにあります。 サービスが低下、無効、またはエラーの状態にある場合は、Azure AI Search チームが基になる問題を積極的に調査していることを意味します。 この状態の専用サービスは、プロビジョニングされた検索単位数に基づいて、引き続き課金対象になります。
|
|
SearchServiceUpdate
|
Azure AI Search Serviceの更新に使用されるパラメーター。
|
|
SharedPrivateLinkResource
|
Azure AI Search Serviceによって管理される共有プライベート リンク リソースについて説明します。
|
|
SharedPrivateLinkResourceProperties
|
Azure AI Search Serviceによって管理される既存の共有プライベート リンク リソースのプロパティについて説明します。
|
|
SharedPrivateLinkResourceProvisioningState
|
共有プライベート リンク リソースのプロビジョニング状態。 有効な値は、更新、削除、失敗、成功、または不完全です。
|
|
SharedPrivateLinkResourceStatus
|
共有プライベート リンク リソースの状態。 有効な値は、[保留中]、[承認済み]、[拒否済み]、または [切断] です。
|
|
Sku
|
課金レートと容量の制限を決定する検索サービスの SKU を定義します。
|
|
SkuName
|
検索サービスの SKU。 有効な値には、'free': 共有サービスが含まれます。 'basic': 最大 3 つのレプリカを持つ専用サービス。 'standard': 最大 12 個のパーティションと 12 個のレプリカを持つ専用サービス。 'standard2': Standard に似ていますが、検索ユニットあたりの容量が多くなります。 'standard3': 最大 12 個のパーティションと 12 個のレプリカを含む最大の Standard オファリング (hostingMode プロパティも 'highDensity' に設定した場合は、より多くのインデックスを持つ最大 3 つのパーティション)。 'storage_optimized_l1': パーティションあたり 1 TB、最大 12 個のパーティションをサポートします。 'storage_optimized_l2': パーティションあたり 2 TB、最大 12 個のパーティションをサポートします。
|
|
UserAssignedManagedIdentity
|
検索サービスに割り当てられたユーザー割り当てマネージド ID の詳細。
|
AadAuthFailureMode
認証に失敗した要求に対して検索サービスのデータ プレーン API が送信する応答について説明します。
| 名前 |
型 |
説明 |
|
http401WithBearerChallenge
|
string
|
認証に失敗した要求に HTTP 状態コード 401 (未承認) を提示し、ベアラー チャレンジを提示する必要があることを示します。
|
|
http403
|
string
|
認証に失敗した要求に HTTP 状態コード 403 (禁止) を提示する必要があることを示します。
|
ApiKeyOnly
認証に API キーのみを使用できることを示します。
CloudError
API エラーに関する情報が含まれています。
| 名前 |
型 |
説明 |
|
error
|
CloudErrorBody
|
エラー コードとメッセージを含む特定の API エラーについて説明します。
|
|
message
|
string
|
問題の原因を示すエラーの簡単な説明 (詳細/デバッグ情報については、'error.message' プロパティを参照してください)。
|
CloudErrorBody
エラー コードとメッセージを含む特定の API エラーについて説明します。
| 名前 |
型 |
説明 |
|
code
|
string
|
エラー状態を HTTP 状態コードよりも正確に記述するエラー コード。 特定のエラー ケースをプログラムで処理するために使用できます。
|
|
details
|
CloudErrorBody[]
|
このエラーに関連する入れ子になったエラーが含まれています。
|
|
message
|
string
|
エラーの詳細を説明し、デバッグ情報を提供するメッセージ。
|
|
target
|
string
|
特定のエラーのターゲット (たとえば、エラーのプロパティの名前)。
|
DataPlaneAadOrApiKeyAuthOption
Microsoft Entra ID テナントの API キーまたはアクセス トークンを認証に使用できることを示します。
| 名前 |
型 |
説明 |
|
aadAuthFailureMode
|
AadAuthFailureMode
|
認証に失敗した要求に対して検索サービスのデータ プレーン API が送信する応答について説明します。
|
DataPlaneAuthOptions
検索サービスがデータ プレーン要求を認証する方法のオプションを定義します。 'disableLocalAuth' が true に設定されている場合、これは設定できません。
EncryptionWithCmk
カスタマー マネージド キーを使用して検索サービス内のリソースを暗号化する方法を決定するポリシーについて説明します。
| 名前 |
型 |
説明 |
|
encryptionComplianceStatus
|
SearchEncryptionComplianceStatus
|
CMK で暗号化されていないオブジェクトに関する検索サービスコンプライアンスの状態を返します。 サービスに暗号化されていないオブジェクトが複数あり、適用が有効になっている場合、サービスは非準拠としてマークされます。
|
|
enforcement
|
SearchEncryptionWithCmk
|
カスタマー マネージド キーで暗号化されていないオブジェクトが検索サービスによって検出された場合にコンプライアンスを適用する方法について説明します。
|
HostingMode
Standard3 SKU にのみ適用されます。 このプロパティを設定すると、最大 3 つの高密度パーティションを有効にして、最大 1,000 個のインデックスを使用できます。これは、他の SKU で許可されている最大インデックスよりもはるかに大きくなります。 standard3 SKU の場合、値は 'default' または 'highDensity' です。 他のすべての SKU の場合、この値は "default" である必要があります。
| 名前 |
型 |
説明 |
|
default
|
string
|
インデックス数の制限は、SKU の既定の制限によって決まります。
|
|
highDensity
|
string
|
検索サービスに最大 1000 個のインデックスを含めることができる Standard3 SKU のアプリケーションのみ。
|
Identity
検索サービス ID の詳細。 null 値は、検索サービスに ID が割り当てられていないことを示します。
| 名前 |
型 |
説明 |
|
principalId
|
string
|
検索サービスのシステム割り当て ID のプリンシパル ID。
|
|
tenantId
|
string
|
検索サービスのシステム割り当て ID のテナント ID。
|
|
type
|
IdentityType
|
リソースに使用される ID の種類。 種類 "SystemAssigned, UserAssigned" には、システムによって作成された 1 個の ID と、ユーザー割り当て ID のセットの両方が含まれます。 種類 "None" の場合は、サービスからすべての ID が削除されます。
|
|
userAssignedIdentities
|
<string,
UserAssignedManagedIdentity>
|
リソースに関連付けられているユーザー ID の一覧。 ユーザー ID ディクショナリ キーの参照は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。
|
IdentityType
リソースに使用される ID の種類。 種類 "SystemAssigned, UserAssigned" には、システムによって作成された 1 個の ID と、ユーザー割り当て ID のセットの両方が含まれます。 種類 "None" の場合は、サービスからすべての ID が削除されます。
| 名前 |
型 |
説明 |
|
None
|
string
|
検索サービスに関連付けられている ID を削除する必要があることを示します。
|
|
SystemAssigned
|
string
|
検索サービスのシステム割り当て ID が有効になっていることを示します。
|
|
SystemAssigned, UserAssigned
|
string
|
検索サービスのシステム割り当て ID が、1 つ以上のユーザー割り当て ID の割り当てと共に有効になっていることを示します。
|
|
UserAssigned
|
string
|
1 つ以上のユーザー割り当て ID が検索サービスに割り当てられることを示します。
|
IpRule
Azure AI Search Serviceの IP 制限規則。
| 名前 |
型 |
説明 |
|
value
|
string
|
許可される 1 つの IPv4 アドレス (例: 123.1.2.3) または CIDR 形式の IP 範囲 (例: 123.1.2.3/24) に対応する値。
|
NetworkRuleSet
Azure AI Search Serviceに到達する方法を決定するネットワーク固有のルール。
| 名前 |
型 |
説明 |
|
bypass
|
SearchBypass
|
"ipRules" セクションで定義されている規則をバイパスできる受信トラフィックの可能性のある配信元。
|
|
ipRules
|
IpRule[]
|
検索サービス エンドポイントへのアクセスを許可する受信ネットワークを定義する IP 制限規則の一覧。 それまでは、他のすべてのパブリック IP ネットワークがファイアウォールによってブロックされます。 これらの制限規則は、検索サービスの 'publicNetworkAccess' が '有効' の場合にのみ適用されます。それ以外の場合、パブリック IP 規則を使用してもパブリック インターフェイス経由のトラフィックは許可されず、プライベート エンドポイント接続が排他的アクセス方法になります。
|
PrivateEndpoint
Microsoft.Network プロバイダーからのプライベート エンドポイント リソース。
| 名前 |
型 |
説明 |
|
id
|
string
|
Microsoft.Network プロバイダーからのプライベート エンドポイント リソースのリソース ID。
|
PrivateEndpointConnection
Azure AI Search Serviceへの既存のプライベート エンドポイント接続について説明します。
| 名前 |
型 |
説明 |
|
id
|
string
|
リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
|
|
name
|
string
|
リソースの名前
|
|
properties
|
PrivateEndpointConnectionProperties
|
Azure AI Search Serviceへの既存のプライベート エンドポイント接続のプロパティについて説明します。
|
|
type
|
string
|
リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"
|
PrivateEndpointConnectionProperties
検索サービスへの既存のプライベート エンドポイント接続のプロパティについて説明します。
PrivateLinkServiceConnectionProvisioningState
プライベート リンク サービス接続のプロビジョニング状態。 有効な値は、更新、削除、失敗、成功、不完全、または取り消しです。
| 名前 |
型 |
説明 |
|
Canceled
|
string
|
プライベート リンク サービス接続リソースのプロビジョニング要求が取り消されました。
|
|
Deleting
|
string
|
プライベート リンク サービス接続は削除中です。
|
|
Failed
|
string
|
プライベート リンク サービス接続のプロビジョニングまたは削除に失敗しました。
|
|
Incomplete
|
string
|
プライベート リンク サービス接続リソースのプロビジョニング要求は受け入れ済みですが、作成プロセスはまだ開始されていません。
|
|
Succeeded
|
string
|
プライベート リンク サービス接続のプロビジョニングが完了し、承認の準備が整いました。
|
|
Updating
|
string
|
プライベート リンク サービス接続は、他のリソースと共に作成中であり、完全に機能します。
|
PrivateLinkServiceConnectionState
プライベート エンドポイントへの既存のAzure Private Link サービス接続の現在の状態について説明します。
| 名前 |
型 |
既定値 |
説明 |
|
actionsRequired
|
string
|
None
|
必要になる可能性がある追加のアクションの説明。
|
|
description
|
string
|
|
プライベート リンク サービスの接続状態の説明。
|
|
status
|
PrivateLinkServiceConnectionStatus
|
|
プライベート リンク サービス接続の状態。 有効な値は、Pending、Approved、Rejected、または Disconnected です。
|
PrivateLinkServiceConnectionStatus
プライベート リンク サービス接続の状態。 有効な値は、[保留中]、[承認済み]、[拒否済み]、または [切断] です。
| 名前 |
型 |
説明 |
|
Approved
|
string
|
プライベート エンドポイント接続が承認され、使用できる状態になります。
|
|
Disconnected
|
string
|
プライベート エンドポイント接続がサービスから削除されました。
|
|
Pending
|
string
|
プライベート エンドポイント接続が作成され、承認が保留中です。
|
|
Rejected
|
string
|
プライベート エンドポイント接続が拒否され、使用できません。
|
ProvisioningState
検索サービスで最後に実行されたプロビジョニング操作の状態。 プロビジョニングは、サービスの容量が確立されるときに発生する中間的な状態です。 容量が設定されると、provisioningState が 'succeeded' または 'failed' に変更されます。 クライアント アプリケーションは、Get Search Service 操作を使用して操作がいつ完了したのか確認することで、プロビジョニングの状態 (推奨されるポーリング間隔は 30 秒から 1 分) をポーリングできます。 無料サービスを使用している場合、この値は、検索サービスの作成の呼び出しで直接 "成功" として返される傾向があります。 これは、無料のサービスは既にセットアップされている容量を使用するためです。
| 名前 |
型 |
説明 |
|
failed
|
string
|
最後のプロビジョニング操作が失敗しました。
|
|
provisioning
|
string
|
検索サービスがプロビジョニングまたはスケールアップまたはスケールダウンされています。
|
|
succeeded
|
string
|
最後のプロビジョニング操作が正常に完了しました。
|
PublicNetworkAccess
この値を "有効" に設定すると、既存の顧客リソースとテンプレートに重大な変更が加えられるのを防ぐことができます。 'disabled' に設定されている場合、パブリック インターフェイス経由のトラフィックは許可されず、プライベート エンドポイント接続は排他的アクセス方法になります。
| 名前 |
型 |
説明 |
|
disabled
|
string
|
検索サービスは、パブリック インターネットからのトラフィックからアクセスできません。 アクセスは、承認されたプライベート エンドポイント接続経由でのみ許可されます。
|
|
enabled
|
string
|
検索サービスには、パブリック インターネットからのトラフィックからアクセスできます。
|
SearchBypass
"ipRules" セクションで定義されている規則をバイパスできる受信トラフィックの可能性のある配信元。
| 名前 |
型 |
説明 |
|
AzurePortal
|
string
|
Azure portalから送信された要求が、'ipRules' セクションで定義されている規則をバイパスできることを示します。
|
|
None
|
string
|
"ipRules" セクションで定義されている規則を配信元がバイパスできないことを示します。 既定値です。
|
SearchDisabledDataExfiltrationOption
検索サービスに対して明示的に許可されていないデータ流出シナリオの一覧。 現在、サポートされている値は 、将来計画されているよりきめ細かな制御を使用して、すべての可能なデータ エクスポート シナリオを無効にする "すべて" のみです。
| 名前 |
型 |
説明 |
|
All
|
string
|
すべてのデータ流出シナリオが無効になっていることを示します。
|
SearchEncryptionComplianceStatus
CMK で暗号化されていないオブジェクトに関する検索サービスコンプライアンスの状態を返します。 サービスに暗号化されていないオブジェクトが複数あり、適用が有効になっている場合、サービスは非準拠としてマークされます。
| 名前 |
型 |
説明 |
|
Compliant
|
string
|
CMK で暗号化されていないオブジェクトの数が 0 であるか、強制が無効になっているため、検索サービスが準拠していることを示します。
|
|
NonCompliant
|
string
|
検索サービスに CMK で暗号化されていないオブジェクトが複数存在することを示します。
|
SearchEncryptionWithCmk
カスタマー マネージド キーで暗号化されていないオブジェクトが検索サービスによって検出された場合にコンプライアンスを適用する方法について説明します。
| 名前 |
型 |
説明 |
|
Disabled
|
string
|
カスタマー マネージド キーの暗号化は適用されません。 組み込みのサービスマネージド暗号化のみが使用されます。
|
|
Enabled
|
string
|
1 つ以上のオブジェクトがカスタマー マネージド キーで暗号化されていない場合、Search Serviceは非準拠としてマークされます。
|
|
Unspecified
|
string
|
強制ポリシーは明示的に指定されていません。動作は 、'Disabled' に設定されている場合と同じです。
|
SearchSemanticSearch
セマンティック検索の可用性を制御するオプションを設定します。 この構成は、特定の場所にある特定の Azure AI Search SKU でのみ可能です。
| 名前 |
型 |
説明 |
|
disabled
|
string
|
検索サービスに対してセマンティック リランカーが無効になっていることを示します。 既定値です。
|
|
free
|
string
|
検索サービスでセマンティック リランカーを有効にし、無料プランの制限内で使用されることを示します。 無料プランでは、セマンティック ランク付け要求の量が上限となり、追加料金なしで提供されます。 これは、新しくプロビジョニングされた検索サービスの既定値です。
|
|
standard
|
string
|
検索サービスのセマンティック リランカーを課金対象の機能として有効にし、より高いスループットと、意味的に再ランク付けされたクエリの量を使用します。
|
SearchService
Azure AI Search Serviceとその現在の状態について説明します。
| 名前 |
型 |
既定値 |
説明 |
|
id
|
string
|
|
リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
|
|
identity
|
Identity
|
|
リソースの ID。
|
|
location
|
string
|
|
リソースが保存されている地理的な場所
|
|
name
|
string
|
|
リソースの名前
|
|
properties.authOptions
|
DataPlaneAuthOptions
|
|
検索サービスのデータ プレーン API が要求を認証する方法のオプションを定義します。 'disableLocalAuth' が true に設定されている場合、これは設定できません。
|
|
properties.disableLocalAuth
|
boolean
|
|
true に設定すると、検索サービスへの呼び出しで認証に API キーを使用することはできません。 'dataPlaneAuthOptions' が定義されている場合、これは true に設定できません。
|
|
properties.disabledDataExfiltrationOptions
|
SearchDisabledDataExfiltrationOption[]
|
|
検索サービスに対して明示的に許可されていないデータ流出シナリオの一覧。 現在、サポートされている値は 、将来計画されているよりきめ細かな制御を使用して、すべての可能なデータ エクスポート シナリオを無効にする "すべて" のみです。
|
|
properties.eTag
|
string
|
|
更新中にオプティミスティック コンカレンシー制御に使用できるサービスの etag を表すシステム生成プロパティ。
|
|
properties.encryptionWithCmk
|
EncryptionWithCmk
|
|
検索サービス内のカスタマー マネージャー キーを使用したリソース (インデックスなど) の暗号化に関するポリシーを指定します。
|
|
properties.hostingMode
|
HostingMode
|
default
|
Standard3 SKU にのみ適用されます。 このプロパティを設定すると、最大 3 つの高密度パーティションを有効にして、最大 1,000 個のインデックスを使用できます。これは、他の SKU で許可されている最大インデックスよりもはるかに大きくなります。 standard3 SKU の場合、値は 'default' または 'highDensity' です。 他のすべての SKU の場合、この値は "default" である必要があります。
|
|
properties.networkRuleSet
|
NetworkRuleSet
|
|
Azure AI Search Serviceに到達する方法を決定するネットワーク固有のルール。
|
|
properties.partitionCount
|
integer
|
1
|
検索サービス内のパーティションの数。指定した場合は、1、2、3、4、6、または 12 にすることができます。 1 より大きい値は、標準 SKU でのみ有効です。 hostingMode が 'highDensity' に設定されている 'standard3' サービスの場合、許可される値は 1 から 3 の間です。
|
|
properties.privateEndpointConnections
|
PrivateEndpointConnection[]
|
|
Azure AI Search Serviceへのプライベート エンドポイント接続の一覧。
|
|
properties.provisioningState
|
ProvisioningState
|
|
検索サービスで最後に実行されたプロビジョニング操作の状態。 プロビジョニングは、サービスの容量が確立されるときに発生する中間的な状態です。 容量が設定されると、provisioningState が 'succeeded' または 'failed' に変更されます。 クライアント アプリケーションは、Get Search Service 操作を使用して操作がいつ完了したのか確認することで、プロビジョニングの状態 (推奨されるポーリング間隔は 30 秒から 1 分) をポーリングできます。 無料サービスを使用している場合、この値は、検索サービスの作成の呼び出しで直接 "成功" として返される傾向があります。 これは、無料のサービスは既にセットアップされている容量を使用するためです。
|
|
properties.publicNetworkAccess
|
PublicNetworkAccess
|
enabled
|
この値を "有効" に設定すると、既存の顧客リソースとテンプレートに重大な変更が加えられるのを防ぐことができます。 'disabled' に設定されている場合、パブリック インターフェイス経由のトラフィックは許可されず、プライベート エンドポイント接続は排他的アクセス方法になります。
|
|
properties.replicaCount
|
integer
|
1
|
検索サービス内のレプリカの数。 指定する場合は、標準 SKU の場合は 1 から 12 までの値、Basic SKU の場合は 1 から 3 までの値である必要があります。
|
|
properties.semanticSearch
|
SearchSemanticSearch
|
|
セマンティック検索の可用性を制御するオプションを設定します。 この構成は、特定の場所にある特定の Azure AI Search SKU でのみ可能です。
|
|
properties.sharedPrivateLinkResources
|
SharedPrivateLinkResource[]
|
|
Azure AI Search Serviceによって管理される共有プライベート リンク リソースの一覧。
|
|
properties.status
|
SearchServiceStatus
|
|
検索サービスの状態。 指定できる値は、"実行中" です。検索サービスは実行されており、プロビジョニング操作は進行中です。 'provisioning': 検索サービスがプロビジョニングまたはスケールアップまたはスケールダウンされています。 '削除中': 検索サービスが削除されています。 'degraded': 検索サービスが機能低下しています。 これは、基になる検索単位が正常でない場合に発生する可能性があります。 検索サービスは動作している可能性が高いですが、パフォーマンスが低下し、一部の要求が削除される可能性があります。 'disabled': 検索サービスは無効になっています。 この状態では、サービスはすべての API 要求を拒否します。 'error': 検索サービスがエラー状態です。 'stopped': 検索サービスが無効になっているサブスクリプションにあります。 サービスが低下、無効、またはエラーの状態にある場合は、Azure AI Search チームが基になる問題を積極的に調査していることを意味します。 この状態の専用サービスは、プロビジョニングされた検索単位数に基づいて、引き続き課金対象になります。
|
|
properties.statusDetails
|
string
|
|
検索サービスの状態の詳細。
|
|
sku
|
Sku
|
|
価格レベルと容量の制限を決定する検索サービスの SKU。 このプロパティは、新しい検索サービスを作成するときに必要です。
|
|
tags
|
object
|
|
リソース タグ。
|
|
type
|
string
|
|
リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"
|
SearchServiceStatus
検索サービスの状態。 指定できる値は、"実行中" です。検索サービスは実行されており、プロビジョニング操作は進行中です。 'provisioning': 検索サービスがプロビジョニングまたはスケールアップまたはスケールダウンされています。 '削除中': 検索サービスが削除されています。 'degraded': 検索サービスが機能低下しています。 これは、基になる検索単位が正常でない場合に発生する可能性があります。 検索サービスは動作している可能性が高いですが、パフォーマンスが低下し、一部の要求が削除される可能性があります。 'disabled': 検索サービスは無効になっています。 この状態では、サービスはすべての API 要求を拒否します。 'error': 検索サービスがエラー状態です。 'stopped': 検索サービスが無効になっているサブスクリプションにあります。 サービスが低下、無効、またはエラーの状態にある場合は、Azure AI Search チームが基になる問題を積極的に調査していることを意味します。 この状態の専用サービスは、プロビジョニングされた検索単位数に基づいて、引き続き課金対象になります。
| 名前 |
型 |
説明 |
|
degraded
|
string
|
基になる検索ユニットが正常でないため、検索サービスが低下しています。
|
|
deleting
|
string
|
検索サービスが削除されています。
|
|
disabled
|
string
|
検索サービスが無効になっており、すべての API 要求が拒否されます。
|
|
error
|
string
|
検索サービスがエラー状態であり、プロビジョニングの失敗または削除を示します。
|
|
provisioning
|
string
|
検索サービスがプロビジョニングまたはスケールアップまたはスケールダウンされています。
|
|
running
|
string
|
検索サービスが実行されており、プロビジョニング操作は進行中です。
|
|
stopped
|
string
|
検索サービスは、無効になっているサブスクリプションにあります。
|
SearchServiceUpdate
Azure AI Search Serviceの更新に使用されるパラメーター。
| 名前 |
型 |
既定値 |
説明 |
|
id
|
string
|
|
リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
|
|
identity
|
Identity
|
|
検索サービス ID の詳細。 null 値は、検索サービスに ID が割り当てられていないことを示します。
|
|
location
|
string
|
|
リソースの地理的な場所。 これは、サポートされ、登録されている Azure geo リージョンの 1 つである必要があります (たとえば、米国西部、米国東部、東南アジアなど)。 このプロパティは、新しいリソースを作成するときに必要です。
|
|
name
|
string
|
|
リソースの名前
|
|
properties.authOptions
|
DataPlaneAuthOptions
|
|
検索サービスのデータ プレーン API が要求を認証する方法のオプションを定義します。 'disableLocalAuth' が true に設定されている場合、これは設定できません。
|
|
properties.disableLocalAuth
|
boolean
|
|
true に設定すると、検索サービスへの呼び出しで認証に API キーを使用することはできません。 'dataPlaneAuthOptions' が定義されている場合、これは true に設定できません。
|
|
properties.disabledDataExfiltrationOptions
|
SearchDisabledDataExfiltrationOption[]
|
|
検索サービスに対して明示的に許可されていないデータ流出シナリオの一覧。 現在、サポートされている値は 、将来計画されているよりきめ細かな制御を使用して、すべての可能なデータ エクスポート シナリオを無効にする "すべて" のみです。
|
|
properties.eTag
|
string
|
|
更新中にオプティミスティック コンカレンシー制御に使用できるサービスの etag を表すシステム生成プロパティ。
|
|
properties.encryptionWithCmk
|
EncryptionWithCmk
|
|
検索サービス内のカスタマー マネージャー キーを使用したリソース (インデックスなど) の暗号化に関するポリシーを指定します。
|
|
properties.hostingMode
|
HostingMode
|
default
|
Standard3 SKU にのみ適用されます。 このプロパティを設定すると、最大 3 つの高密度パーティションを有効にして、最大 1,000 個のインデックスを使用できます。これは、他の SKU で許可されている最大インデックスよりもはるかに大きくなります。 standard3 SKU の場合、値は 'default' または 'highDensity' です。 他のすべての SKU の場合、この値は "default" である必要があります。
|
|
properties.networkRuleSet
|
NetworkRuleSet
|
|
Azure AI Search Serviceに到達する方法を決定するネットワーク固有のルール。
|
|
properties.partitionCount
|
integer
|
1
|
検索サービス内のパーティションの数。指定した場合は、1、2、3、4、6、または 12 にすることができます。 1 より大きい値は、標準 SKU でのみ有効です。 hostingMode が 'highDensity' に設定されている 'standard3' サービスの場合、許可される値は 1 から 3 の間です。
|
|
properties.privateEndpointConnections
|
PrivateEndpointConnection[]
|
|
Azure AI Search Serviceへのプライベート エンドポイント接続の一覧。
|
|
properties.provisioningState
|
ProvisioningState
|
|
検索サービスで最後に実行されたプロビジョニング操作の状態。 プロビジョニングは、サービスの容量が確立されるときに発生する中間的な状態です。 容量が設定されると、provisioningState が 'succeeded' または 'failed' に変更されます。 クライアント アプリケーションは、Get Search Service 操作を使用して操作がいつ完了したのか確認することで、プロビジョニングの状態 (推奨されるポーリング間隔は 30 秒から 1 分) をポーリングできます。 無料サービスを使用している場合、この値は、検索サービスの作成の呼び出しで直接 "成功" として返される傾向があります。 これは、無料のサービスは既にセットアップされている容量を使用するためです。
|
|
properties.publicNetworkAccess
|
PublicNetworkAccess
|
enabled
|
この値を "有効" に設定すると、既存の顧客リソースとテンプレートに重大な変更が加えられるのを防ぐことができます。 'disabled' に設定されている場合、パブリック インターフェイス経由のトラフィックは許可されず、プライベート エンドポイント接続は排他的アクセス方法になります。
|
|
properties.replicaCount
|
integer
|
1
|
検索サービス内のレプリカの数。 指定する場合は、標準 SKU の場合は 1 から 12 までの値、Basic SKU の場合は 1 から 3 までの値である必要があります。
|
|
properties.semanticSearch
|
SearchSemanticSearch
|
|
セマンティック検索の可用性を制御するオプションを設定します。 この構成は、特定の場所にある特定の Azure AI Search SKU でのみ可能です。
|
|
properties.sharedPrivateLinkResources
|
SharedPrivateLinkResource[]
|
|
Azure AI Search Serviceによって管理される共有プライベート リンク リソースの一覧。
|
|
properties.status
|
SearchServiceStatus
|
|
検索サービスの状態。 指定できる値は、"実行中" です。検索サービスは実行されており、プロビジョニング操作は進行中です。 'provisioning': 検索サービスがプロビジョニングまたはスケールアップまたはスケールダウンされています。 '削除中': 検索サービスが削除されています。 'degraded': 検索サービスが機能低下しています。 これは、基になる検索単位が正常でない場合に発生する可能性があります。 検索サービスは動作している可能性が高いですが、パフォーマンスが低下し、一部の要求が削除される可能性があります。 'disabled': 検索サービスは無効になっています。 この状態では、サービスはすべての API 要求を拒否します。 'error': 検索サービスがエラー状態です。 'stopped': 検索サービスが無効になっているサブスクリプションにあります。 サービスが低下、無効、またはエラーの状態にある場合は、Azure AI Search チームが基になる問題を積極的に調査していることを意味します。 この状態の専用サービスは、プロビジョニングされた検索単位数に基づいて、引き続き課金対象になります。
|
|
properties.statusDetails
|
string
|
|
検索サービスの状態の詳細。
|
|
sku
|
Sku
|
|
価格レベルと容量の制限を決定する検索サービスの SKU。 このプロパティは、新しい検索サービスを作成するときに必要です。
|
|
tags
|
object
|
|
Azure portalでリソースを分類するのに役立つタグ。
|
|
type
|
string
|
|
リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"
|
SharedPrivateLinkResource
Azure AI Search Serviceによって管理される共有プライベート リンク リソースについて説明します。
| 名前 |
型 |
説明 |
|
id
|
string
|
リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
|
|
name
|
string
|
リソースの名前
|
|
properties
|
SharedPrivateLinkResourceProperties
|
Azure AI Search Serviceによって管理される共有プライベート リンク リソースのプロパティについて説明します。
|
|
type
|
string
|
リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"
|
SharedPrivateLinkResourceProperties
Azure AI Search Serviceによって管理される既存の共有プライベート リンク リソースのプロパティについて説明します。
| 名前 |
型 |
説明 |
|
groupId
|
string
|
共有プライベート リンク リソースの対象となるリソースのプロバイダーからのグループ ID。
|
|
privateLinkResourceId
|
string
|
共有プライベート リンク リソースの対象となるリソースのリソース ID。
|
|
provisioningState
|
SharedPrivateLinkResourceProvisioningState
|
共有プライベート リンク リソースのプロビジョニング状態。 有効な値は、更新、削除、失敗、成功、または不完全です。
|
|
requestMessage
|
string
|
共有プライベート リンク リソースの承認を要求するためのメッセージ。
|
|
resourceRegion
|
string
|
省略可能。 共有プライベート リンクを作成するリソースの Azure Resource Managerの場所を指定するために使用できます。 これは、DNS 構成がリージョン (Azure Kubernetes Service など) であるリソースにのみ必要です。
|
|
status
|
SharedPrivateLinkResourceStatus
|
共有プライベート リンク リソースの状態。 有効な値は、[保留中]、[承認済み]、[拒否済み]、または [切断] です。
|
SharedPrivateLinkResourceProvisioningState
共有プライベート リンク リソースのプロビジョニング状態。 有効な値は、更新、削除、失敗、成功、または不完全です。
| 名前 |
型 |
説明 |
|
Deleting
|
string
|
共有プライベート リンク リソースは、削除中です。
|
|
Failed
|
string
|
共有プライベート リンク リソースをプロビジョニングまたは削除できませんでした。
|
|
Incomplete
|
string
|
共有プライベート リンク リソースのプロビジョニング要求は受け入れ済みですが、作成プロセスはまだ開始されていません。
|
|
Succeeded
|
string
|
共有プライベート リンク リソースのプロビジョニングが完了し、承認の準備が整いました。
|
|
Updating
|
string
|
共有プライベート リンク リソースは、完全に機能するために、他のリソースと共に作成中です。
|
SharedPrivateLinkResourceStatus
共有プライベート リンク リソースの状態。 有効な値は、[保留中]、[承認済み]、[拒否済み]、または [切断] です。
| 名前 |
型 |
説明 |
|
Approved
|
string
|
共有プライベート リンク リソースが承認され、使用できる状態になります。
|
|
Disconnected
|
string
|
共有プライベート リンク リソースがサービスから削除されました。
|
|
Pending
|
string
|
共有プライベート リンク リソースが作成され、承認が保留中です。
|
|
Rejected
|
string
|
共有プライベート リンク リソースは拒否され、使用できません。
|
Sku
課金レートと容量の制限を決定する検索サービスの SKU を定義します。
| 名前 |
型 |
説明 |
|
name
|
SkuName
|
検索サービスの SKU。 有効な値には、'free': 共有サービスが含まれます。 'basic': 最大 3 つのレプリカを持つ専用サービス。 'standard': 最大 12 個のパーティションと 12 個のレプリカを持つ専用サービス。 'standard2': Standard に似ていますが、検索ユニットあたりの容量が多くなります。 'standard3': 最大 12 個のパーティションと 12 個のレプリカを含む最大の Standard オファリング (hostingMode プロパティも 'highDensity' に設定した場合は、より多くのインデックスを持つ最大 3 つのパーティション)。 'storage_optimized_l1': パーティションあたり 1 TB、最大 12 個のパーティションをサポートします。 'storage_optimized_l2': パーティションあたり 2 TB、最大 12 個のパーティションをサポートします。
|
SkuName
検索サービスの SKU。 有効な値には、'free': 共有サービスが含まれます。 'basic': 最大 3 つのレプリカを持つ専用サービス。 'standard': 最大 12 個のパーティションと 12 個のレプリカを持つ専用サービス。 'standard2': Standard に似ていますが、検索ユニットあたりの容量が多くなります。 'standard3': 最大 12 個のパーティションと 12 個のレプリカを含む最大の Standard オファリング (hostingMode プロパティも 'highDensity' に設定した場合は、より多くのインデックスを持つ最大 3 つのパーティション)。 'storage_optimized_l1': パーティションあたり 1 TB、最大 12 個のパーティションをサポートします。 'storage_optimized_l2': パーティションあたり 2 TB、最大 12 個のパーティションをサポートします。
| 名前 |
型 |
説明 |
|
basic
|
string
|
最大 3 つのレプリカを持つ専用サービスの課金対象レベル。
|
|
free
|
string
|
無料レベル。SLA が保証されておらず、課金対象レベルで提供される機能のサブセットが含まれます。
|
|
standard
|
string
|
最大 12 個のパーティションと 12 個のレプリカを持つ専用サービスの課金対象レベル。
|
|
standard2
|
string
|
'standard' に似ていますが、検索ユニットあたりの容量が多くなります。
|
|
standard3
|
string
|
最大 12 個のパーティションと 12 個のレプリカを備えた最大の Standard オファリング (hostingMode プロパティも 'highDensity' に設定した場合は、インデックスが追加された最大 3 つのパーティション)。
|
|
storage_optimized_l1
|
string
|
パーティションあたり 1 TB、最大 12 個のパーティションをサポートする専用サービスの課金対象レベル。
|
|
storage_optimized_l2
|
string
|
パーティションあたり 2 TB、最大 12 個のパーティションをサポートする専用サービスの課金対象レベル。
|
UserAssignedManagedIdentity
検索サービスに割り当てられたユーザー割り当てマネージド ID の詳細。
| 名前 |
型 |
説明 |
|
clientId
|
string
|
ユーザー割り当て ID のクライアント ID。
|
|
principalId
|
string
|
ユーザー割り当て ID のプリンシパル ID。
|