Services - Update

Referencia

Szolgáltatás:: Search Management

API-verzió:: 2024-03-01-preview

Frissítések egy meglévő keresési szolgáltatást az adott erőforráscsoportban.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
resourceGroupName	path	True	string	Az aktuális előfizetésen belüli erőforráscsoport neve. Ezt az értéket az Azure Resource Manager API-ból vagy a portálról szerezheti be.
searchServiceName	path	True	string	A frissíteni Search szolgáltatás Azure AI neve.
subscriptionId	path	True	string	A Microsoft Azure-előfizetés egyedi azonosítója. Ezt az értéket az Azure Resource Manager API-ból vagy a portálról szerezheti be.
api-version	query	True	string	Az egyes kérésekhez használandó API-verzió.

Kérelem fejléce

Name	Kötelező	Típus	Description
x-ms-client-request-id		string uuid	Egy ügyfél által létrehozott GUID-érték, amely azonosítja ezt a kérést. Ha meg van adva, ez a kérés nyomon követésének módjaként szerepelni fog a válaszinformációkban.

Kérelem törzse

Name	Típus	Description
identity	Identity	A keresési szolgáltatás identitásának részletei. A null érték azt jelzi, hogy a keresési szolgáltatáshoz nincs hozzárendelve identitás.
location	string	Az erőforrás földrajzi helye. Ennek a támogatott és regisztrált Azure-georégiók egyikének kell lennie (például az USA nyugati régiója, az USA keleti régiója, Délkelet-Ázsia stb.). Ez a tulajdonság új erőforrás létrehozásakor szükséges.
properties.authOptions	DataPlaneAuthOptions	Meghatározza, hogy a keresési szolgáltatás adatsík API-ja hogyan hitelesítse a kéréseket. Ez nem állítható be, ha a disableLocalAuth értéke igaz.
properties.disableLocalAuth	boolean	Ha true (igaz) értékre van állítva, a keresési szolgáltatás hívásai nem használhatnak API-kulcsokat a hitelesítéshez. Ez nem állítható true értékre, ha a "dataPlaneAuthOptions" definiálva van.
properties.disabledDataExfiltrationOptions	SearchDisabledDataExfiltrationOption[]	Azon adatkiszivárgási forgatókönyvek listája, amelyek kifejezetten nem engedélyezettek a keresési szolgáltatás számára. Jelenleg az egyetlen támogatott érték az "Összes", amely letiltja az összes lehetséges adatexportálási forgatókönyvet a jövőben tervezett részletesebb vezérlőkkel.
properties.encryptionWithCmk	EncryptionWithCmk	Megadja az erőforrások (például indexek) ügyfélmenedzser-kulcsokkal történő titkosítására vonatkozó szabályzatokat a keresési szolgáltatáson belül.
properties.hostingMode	HostingMode	Csak a standard3 termékváltozatra vonatkozik. Ezt a tulajdonságot beállíthatja úgy, hogy legfeljebb 3 nagy sűrűségű partíciót engedélyezzen, amelyek akár 1000 indexet is lehetővé tesznek, ami sokkal nagyobb, mint bármely más termékváltozat esetében engedélyezett maximális index. A standard3 termékváltozat esetében az érték "alapértelmezett" vagy "highDensity". Az összes többi termékváltozat esetében ennek az értéknek "alapértelmezettnek" kell lennie.
properties.networkRuleSet	NetworkRuleSet	Hálózatspecifikus szabályok, amelyek meghatározzák az Azure AI Search szolgáltatás elérését.
properties.partitionCount	integer	A keresési szolgáltatás partícióinak száma; ha meg van adva, ez lehet 1, 2, 3, 4, 6 vagy 12. Az 1-nél nagyobb értékek csak standard termékváltozatokra érvényesek. A "standard3" szolgáltatások esetében a hostingMode értéke "highDensity", az engedélyezett értékek 1 és 3 között vannak.
properties.publicNetworkAccess	PublicNetworkAccess	Ez az érték "engedélyezve" értékre állítható, hogy elkerülje a meglévő ügyfélerőforrások és sablonok kompatibilitástörő változásait. Ha "letiltva" értékre van állítva, a nyilvános felületen keresztüli forgalom nem engedélyezett, és a privát végponti kapcsolatok a kizárólagos hozzáférési módszer.
properties.replicaCount	integer	A keresési szolgáltatás replikáinak száma. Ha meg van adva, akkor az értéknek 1 és 12 közöttinek kell lennie a standard termékváltozatok esetében, vagy 1 és 3 közötti értéknek kell lennie, amely az alapszintű termékváltozatot is magában foglalja.
properties.semanticSearch	SearchSemanticSearch	Beállítja a szemantikai keresés rendelkezésre állását szabályozó beállításokat. Ez a konfiguráció csak bizonyos Azure AI Search termékváltozatok esetében lehetséges bizonyos helyeken.
sku	Sku	A keresési szolgáltatás termékváltozata, amely meghatározza az árszintet és a kapacitáskorlátokat. Ez a tulajdonság új keresési szolgáltatás létrehozásakor szükséges.
tags	object	Címkék az erőforrás kategorizálásához a Azure Portal.

Válaszok

Name	Típus	Description
200 OK	SearchService	A meglévő szolgáltatásdefiníció frissítése sikerült. Ha módosította a replikák vagy partíciók számát, a skálázási művelet aszinkron módon fog történni. A skálázási művelet állapotát a Szolgáltatás lekérése kérés provisioningState tulajdonságával ellenőrizheti.
Other Status Codes	CloudError	HTTP 400 (hibás kérelem): A megadott szolgáltatásdefiníció érvénytelen, vagy nem módosítható tulajdonságot próbált módosítani. A részletekért tekintse meg a hibakódot és az üzenetet a válaszban. HTTP 404 (Nem található): Az előfizetés vagy az erőforráscsoport nem található. HTTP 409 (ütközés): A megadott előfizetés le van tiltva.

Biztonság

azure_auth

A Microsoft Identity platformon támogatott implicit engedélyezési folyamatot határoz meg.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	felhasználói fiók megszemélyesítése

Példák

SearchUpdateService

SearchUpdateServiceAuthOptions

SearchUpdateServiceDisableLocalAuth

SearchUpdateServiceToAllowAccessFromPrivateEndpoints

SearchUpdateServiceToAllowAccessFromPublicCustomIPs

SearchUpdateServiceToAllowAccessFromPublicCustomIPsAndBypass

SearchUpdateServiceToRemoveIdentity

SearchUpdateServiceWithCmkEnforcement

SearchUpdateServiceWithDataExfiltration

SearchUpdateServiceWithSemanticSearch

SearchUpdateService

Mintakérelem

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

Mintaválasz

Állapotkód:: 200

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

Mintakérelem

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

Mintaválasz

Állapotkód:: 200

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

Mintakérelem

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

Mintaválasz

Állapotkód:: 200

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

Mintakérelem

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

Mintaválasz

Állapotkód:: 200

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

Mintakérelem

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

Mintaválasz

Állapotkód:: 200

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

Mintakérelem

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

Mintaválasz

Állapotkód:: 200

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

Mintakérelem

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

Mintaválasz

Állapotkód:: 200

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

Mintakérelem

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

Mintaválasz

Állapotkód:: 200

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

Mintakérelem

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

Mintaválasz

Állapotkód:: 200

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

Mintakérelem

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

Mintaválasz

Állapotkód:: 200

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

Definíciók

Name	Description
AadAuthFailureMode	Leírja, hogy a keresési szolgáltatás adatsík API-ja milyen választ küld a sikertelen hitelesítést igénylő kérésekre.
ApiKeyOnly	Azt jelzi, hogy csak az API-kulcs használható a hitelesítéshez.
CloudError	API-hibával kapcsolatos információkat tartalmaz.
CloudErrorBody	Egy adott API-hibát ír le hibakóddal és üzenettel.
DataPlaneAadOrApiKeyAuthOption	Azt jelzi, hogy az API-kulcs vagy egy Microsoft Entra ID-bérlő hozzáférési jogkivonata használható a hitelesítéshez.
DataPlaneAuthOptions	Meghatározza, hogy a keresési szolgáltatás hogyan hitelesítse az adatsík-kéréseket. Ez nem állítható be, ha a disableLocalAuth értéke igaz.
EncryptionWithCmk	Egy szabályzatot ír le, amely meghatározza, hogy a keresési szolgáltatás erőforrásai hogyan legyenek titkosítva az ügyfél által kezelt kulcsokkal.
HostingMode	Csak a standard3 termékváltozatra alkalmazható. Ezt a tulajdonságot beállíthatja úgy, hogy legfeljebb 3 nagy sűrűségű partíciót engedélyezzen, amelyek legfeljebb 1000 indexet tesznek lehetővé, ami sokkal magasabb, mint bármely más termékváltozat esetében engedélyezett maximális indexek. A standard3 termékváltozat esetében az érték "alapértelmezett" vagy "highDensity". Az összes többi termékváltozat esetében ennek az értéknek "alapértelmezettnek" kell lennie.
Identity	A keresési szolgáltatás identitásának részletei. A null érték azt jelzi, hogy a keresési szolgáltatáshoz nincs hozzárendelve identitás.
IdentityType	Az erőforráshoz használt identitás típusa. A "SystemAssigned, UserAssigned" típus magában foglalja a rendszer által létrehozott identitást és a felhasználó által hozzárendelt identitások készletét is. A "Nincs" típus eltávolítja az összes identitást a szolgáltatásból.
IpRule	Az Azure AI-Search szolgáltatás IP-korlátozási szabálya.
NetworkRuleSet	Hálózatspecifikus szabályok, amelyek meghatározzák az Azure AI Search szolgáltatás elérését.
PrivateEndpoint	A Microsoft.Network-szolgáltató privát végpont-erőforrása.
PrivateEndpointConnection	Az Azure AI-Search szolgáltatás meglévő privát végpontkapcsolatát ismerteti.
PrivateEndpointConnectionProperties	Egy meglévő privát végponti kapcsolat tulajdonságait ismerteti a keresési szolgáltatással.
PrivateLinkServiceConnectionProvisioningState	A privát kapcsolat szolgáltatáskapcsolat kiépítési állapota. Az érvényes értékek: Frissítés, Törlés, Sikertelen, Sikeres, Hiányos vagy Mégse.
PrivateLinkServiceConnectionState	Egy meglévő Azure Private Link szolgáltatás privát végponthoz való kapcsolatának aktuális állapotát ismerteti.
PrivateLinkServiceConnectionStatus	A privát kapcsolati szolgáltatáskapcsolat állapota. Az érvényes értékek Függőben, Jóváhagyva, Elutasítva vagy Leválasztva.
ProvisioningState	A keresési szolgáltatásban végrehajtott utolsó kiépítési művelet állapota. A kiépítés egy köztes állapot, amely a szolgáltatáskapacitás létrehozásakor következik be. A kapacitás beállítása után a provisioningState a "sikeres" vagy a "sikertelen" értékre változik. Az ügyfélalkalmazások lekérdezhetik a kiépítési állapotot (az ajánlott lekérdezési időköz 30 másodperctől egy percig tart), a Keresési szolgáltatás lekérése művelettel ellenőrizheti, hogy mikor fejeződik be egy művelet. Ha az ingyenes szolgáltatást használja, ez az érték általában "sikeresként" jelenik meg közvetlenül a Keresési szolgáltatás létrehozása hívásban. Ennek az az oka, hogy az ingyenes szolgáltatás már beállított kapacitást használ.
PublicNetworkAccess	Ez az érték "engedélyezve" értékre állítható, hogy elkerülje a meglévő ügyfélerőforrások és sablonok kompatibilitástörő változásait. Ha a "letiltva" értékre van állítva, a nyilvános adapteren keresztüli forgalom nem engedélyezett, és a privát végponti kapcsolatok a kizárólagos hozzáférési módszer.
SearchBypass	A bejövő forgalom lehetséges eredete, amely megkerülheti az "ipRules" szakaszban meghatározott szabályokat.
SearchDisabledDataExfiltrationOption	Azon adatkiszivárgási forgatókönyvek listája, amelyek kifejezetten nem engedélyezettek a keresési szolgáltatás számára. Jelenleg az egyetlen támogatott érték az "Összes", amely letiltja az összes lehetséges adatexportálási forgatókönyvet a jövőben tervezett részletesebb vezérlőkkel.
SearchEncryptionComplianceStatus	A keresési szolgáltatásnak való megfelelőség állapotát adja vissza a nem CMK által titkosított objektumokra vonatkozóan. Ha egy szolgáltatás több titkosítatlan objektummal rendelkezik, és a kényszerítés engedélyezve van, a szolgáltatás nem megfelelőként van megjelölve.
SearchEncryptionWithCmk	Ismerteti, hogyan kell a keresési szolgáltatásnak kikényszerítenie a megfelelőséget, ha olyan objektumokat talál, amelyek nincsenek titkosítva az ügyfél által felügyelt kulccsal.
SearchSemanticSearch	Beállítja a szemantikai keresés elérhetőségét szabályozó beállításokat. Ez a konfiguráció csak bizonyos Azure AI Search termékváltozatok esetében lehetséges bizonyos helyeken.
SearchService	Egy Azure AI-Search szolgáltatás és jelenlegi állapotát ismerteti.
SearchServiceStatus	A keresési szolgáltatás állapota. Lehetséges értékek: "futtatás": A keresési szolgáltatás fut, és nincs folyamatban kiépítési művelet. "kiépítés": A keresési szolgáltatás kiépítése vagy vertikális fel- vagy leskálázása folyamatban van. Törlés: A keresési szolgáltatás törlődik. "csökkentett teljesítményű": A keresési szolgáltatás csökkentett teljesítményű. Ez akkor fordulhat elő, ha a mögöttes keresési egységek nem kifogástalan állapotban vannak. A keresési szolgáltatás valószínűleg működőképes, de a teljesítmény lassú lehet, és egyes kérések elvethetők. "letiltva": A keresési szolgáltatás le van tiltva. Ebben az állapotban a szolgáltatás elutasítja az összes API-kérést. "hiba": A keresési szolgáltatás hibaállapotban van. "leállított": A keresési szolgáltatás le van tiltva egy előfizetésben. Ha a szolgáltatás csökkentett teljesítményű, letiltott vagy hibaállapotban van, az azt jelenti, hogy az Azure AI Search csapata aktívan vizsgálja az alapul szolgáló problémát. Ezekben az állapotokban a dedikált szolgáltatások továbbra is díjkötelesek a kiosztott keresési egységek száma alapján.
SearchServiceUpdate	Az Azure AI-Search szolgáltatás frissítéséhez használt paraméterek.
SharedPrivateLinkResource	Az Azure AI Search szolgáltatás által felügyelt megosztott privát kapcsolati erőforrást ismerteti.
SharedPrivateLinkResourceProperties	Az Azure AI Search szolgáltatás által felügyelt meglévő megosztott privát kapcsolati erőforrás tulajdonságait ismerteti.
SharedPrivateLinkResourceProvisioningState	A megosztott privát kapcsolati erőforrás kiépítési állapota. Az érvényes értékek: Frissítés, Törlés, Sikertelen, Sikeres vagy Hiányos.
SharedPrivateLinkResourceStatus	A megosztott privát kapcsolati erőforrás állapota. Az érvényes értékek Függőben, Jóváhagyva, Elutasítva vagy Leválasztva.
Sku	Meghatározza egy keresési szolgáltatás termékváltozatát, amely meghatározza a számlázási díjszabást és a kapacitáskorlátokat.
SkuName	A keresési szolgáltatás termékváltozata. Az érvényes értékek a következők: "ingyenes": Megosztott szolgáltatás. "alapszintű": Dedikált szolgáltatás legfeljebb 3 replikával. "standard": Dedikált szolgáltatás legfeljebb 12 partícióval és 12 replikával. "standard2": Hasonló a standardhoz, de keresési egységenként nagyobb kapacitással. "standard3": A legnagyobb standard ajánlat legfeljebb 12 partícióval és 12 replikával (vagy akár 3 partícióval, több indexkel, ha a hostingMode tulajdonságot is "highDensity" értékre állítja). "storage_optimized_l1": Partíciónként 1 TB-ot támogat, legfeljebb 12 partíciót. "storage_optimized_l2": Partíciónként 2 TB-ot támogat, legfeljebb 12 partíciót."
UserAssignedManagedIdentity	A keresési szolgáltatáshoz hozzárendelt felhasználó által hozzárendelt felügyelt identitás részletei.

AadAuthFailureMode

Leírja, hogy a keresési szolgáltatás adatsík API-ja milyen választ küld a sikertelen hitelesítést igénylő kérésekre.

Name	Típus	Description
http401WithBearerChallenge	string	Azt jelzi, hogy a sikertelen hitelesítést igénylő kéréseket egy 401-es (Jogosulatlan) HTTP-állapotkóddal kell megjeleníteni, és meg kell jeleníteni a Tulajdonosi kihívást.
http403	string	Azt jelzi, hogy a sikertelen hitelesítést igénylő kéréseket 403-ás (Tiltott) HTTP-állapotkóddal kell bemutatni.

ApiKeyOnly

Azt jelzi, hogy csak az API-kulcs használható a hitelesítéshez.

CloudError

API-hibával kapcsolatos információkat tartalmaz.

Name	Típus	Description
error	CloudErrorBody	Egy adott API-hibát ír le hibakóddal és üzenettel.
message	string	A hiba rövid leírása, amely arra utal, hogy mi történt (a részletekért/hibakeresési információkért tekintse meg az "error.message" tulajdonságot).

CloudErrorBody

Egy adott API-hibát ír le hibakóddal és üzenettel.

Name	Típus	Description
code	string	Hibakód, amely pontosabban írja le a hibafeltételt, mint egy HTTP-állapotkód. Adott hibaesetek programozott kezelésére használható.
details	CloudErrorBody[]	Beágyazott hibákat tartalmaz, amelyek ehhez a hibához kapcsolódnak.
message	string	Egy üzenet, amely részletesen leírja a hibát, és hibakeresési információkat nyújt.
target	string	Az adott hiba célja (például a hiba tulajdonságának neve).

DataPlaneAadOrApiKeyAuthOption

Azt jelzi, hogy az API-kulcs vagy egy Microsoft Entra ID-bérlő hozzáférési jogkivonata használható a hitelesítéshez.

Name	Típus	Description
aadAuthFailureMode	AadAuthFailureMode	Leírja, hogy a keresési szolgáltatás adatsík API-ja milyen választ küld a sikertelen hitelesítést igénylő kérésekre.

DataPlaneAuthOptions

Meghatározza, hogy a keresési szolgáltatás hogyan hitelesítse az adatsík-kéréseket. Ez nem állítható be, ha a disableLocalAuth értéke igaz.

Name	Típus	Description
aadOrApiKey	DataPlaneAadOrApiKeyAuthOption	Azt jelzi, hogy az API-kulcs vagy egy Microsoft Entra ID-bérlő hozzáférési jogkivonata használható a hitelesítéshez.
apiKeyOnly	ApiKeyOnly	Azt jelzi, hogy csak az API-kulcs használható a hitelesítéshez.

EncryptionWithCmk

Egy szabályzatot ír le, amely meghatározza, hogy a keresési szolgáltatás erőforrásai hogyan legyenek titkosítva az ügyfél által kezelt kulcsokkal.

Name	Típus	Description
encryptionComplianceStatus	SearchEncryptionComplianceStatus	A keresési szolgáltatás nem CMK által titkosított objektumokra vonatkozó megfelelőségi állapotát adja vissza. Ha egy szolgáltatás több titkosítatlan objektummal rendelkezik, és a kényszerítés engedélyezve van, a szolgáltatás nem megfelelőként lesz megjelölve.
enforcement	SearchEncryptionWithCmk	Ez a cikk azt ismerteti, hogy a keresési szolgáltatásnak hogyan kell kikényszerítenie a megfelelőséget, ha olyan objektumokat talál, amelyek nincsenek titkosítva az ügyfél által kezelt kulccsal.

HostingMode

Csak a standard3 termékváltozatra alkalmazható. Ezt a tulajdonságot beállíthatja úgy, hogy legfeljebb 3 nagy sűrűségű partíciót engedélyezzen, amelyek legfeljebb 1000 indexet tesznek lehetővé, ami sokkal magasabb, mint bármely más termékváltozat esetében engedélyezett maximális indexek. A standard3 termékváltozat esetében az érték "alapértelmezett" vagy "highDensity". Az összes többi termékváltozat esetében ennek az értéknek "alapértelmezettnek" kell lennie.

Name	Típus	Description
default	string	Az indexek számának korlátját a termékváltozat alapértelmezett korlátai határozzák meg.
highDensity	string	Csak standard3 termékváltozatú alkalmazás, ahol a keresési szolgáltatás legfeljebb 1000 indexet tartalmazhat.

Identity

A keresési szolgáltatás identitásának részletei. A null érték azt jelzi, hogy a keresési szolgáltatáshoz nincs hozzárendelve identitás.

Name	Típus	Description
principalId	string	A keresési szolgáltatás rendszer által hozzárendelt identitásának egyszerű azonosítója.
tenantId	string	A keresési szolgáltatás rendszer által hozzárendelt identitásának bérlőazonosítója.
type	IdentityType	Az erőforráshoz használt identitás típusa. A "SystemAssigned, UserAssigned" típus magában foglalja a rendszer által létrehozott identitást és a felhasználó által hozzárendelt identitások készletét. A "Nincs" típus eltávolítja az összes identitást a szolgáltatásból.
userAssignedIdentities	<string, UserAssignedManagedIdentity>	Az erőforráshoz társított felhasználói identitások listája. A felhasználói identitás szótárkulcs-hivatkozásai ARM-erőforrásazonosítók lesznek a következő formában: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

IdentityType

Az erőforráshoz használt identitás típusa. A "SystemAssigned, UserAssigned" típus magában foglalja a rendszer által létrehozott identitást és a felhasználó által hozzárendelt identitások készletét is. A "Nincs" típus eltávolítja az összes identitást a szolgáltatásból.

Name	Típus	Description
None	string	Azt jelzi, hogy a keresési szolgáltatáshoz társított identitásokat el kell távolítani.
SystemAssigned	string	Azt jelzi, hogy a keresési szolgáltatás rendszer által hozzárendelt identitása engedélyezve lesz.
SystemAssigned, UserAssigned	string	Azt jelzi, hogy a keresési szolgáltatás rendszer által hozzárendelt identitása engedélyezve lesz egy vagy több felhasználó által hozzárendelt identitás hozzárendelésével együtt.
UserAssigned	string	Azt jelzi, hogy egy vagy több felhasználó által hozzárendelt identitás lesz hozzárendelve a keresési szolgáltatáshoz.

IpRule

Az Azure AI-Search szolgáltatás IP-korlátozási szabálya.

Name	Típus	Description
value	string	Egyetlen IPv4-címnek (például 123.1.2.3) vagy CIDR formátumú IP-címtartománynak (pl. 123.1.2.3/24) megfelelő érték engedélyezhető.

NetworkRuleSet

Hálózatspecifikus szabályok, amelyek meghatározzák az Azure AI Search szolgáltatás elérését.

Name	Típus	Description
bypass	SearchBypass	A bejövő forgalom lehetséges eredete, amelyek megkerülhetik az "ipRules" szakaszban meghatározott szabályokat.
ipRules	IpRule[]	Ip-korlátozási szabályok listája, amelyek meghatározzák a bejövő hálózat(ok)t a keresési szolgáltatásvégponthoz való hozzáférés engedélyezésével. Addig is a tűzfal blokkolja az összes többi nyilvános IP-hálózatot. Ezeket a korlátozási szabályokat csak akkor alkalmazza a rendszer, ha a keresési szolgáltatás "publicNetworkAccess" tulajdonsága engedélyezve van; ellenkező esetben a nyilvános interfészen keresztüli forgalom még nyilvános IP-szabályokkal sem engedélyezett, és a privát végponti kapcsolatok lennének a kizárólagos hozzáférési módszer.

PrivateEndpoint

A Microsoft.Network-szolgáltató privát végpont-erőforrása.

Name	Típus	Description
id	string	A Microsoft.Network-szolgáltató privát végponti erőforrásának erőforrás-azonosítója.

PrivateEndpointConnection

Az Azure AI-Search szolgáltatás meglévő privát végpontkapcsolatát ismerteti.

Name	Típus	Description
id	string	Az erőforrás teljes erőforrás-azonosítója. Például : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Az erőforrás neve
properties	PrivateEndpointConnectionProperties	Az Azure AI-Search szolgáltatás meglévő privát végponti kapcsolat tulajdonságait ismerteti.
type	string	Az erőforrás típusa. Például"Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

PrivateEndpointConnectionProperties

Egy meglévő privát végponti kapcsolat tulajdonságait ismerteti a keresési szolgáltatással.

Name	Típus	Description
groupId	string	Annak az Azure-erőforrásnak a csoportazonosítója, amelyhez a privát kapcsolati szolgáltatás tartozik.
privateEndpoint	PrivateEndpoint	A Microsoft.Network-szolgáltató privát végpont-erőforrása.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Egy meglévő Azure Private Link szolgáltatás privát végponthoz való kapcsolatának aktuális állapotát ismerteti.
provisioningState	PrivateLinkServiceConnectionProvisioningState	A privát kapcsolat szolgáltatáskapcsolat kiépítési állapota. Az érvényes értékek: Frissítés, Törlés, Sikertelen, Sikeres, Hiányos vagy Mégse.

PrivateLinkServiceConnectionProvisioningState

A privát kapcsolat szolgáltatáskapcsolat kiépítési állapota. Az érvényes értékek: Frissítés, Törlés, Sikertelen, Sikeres, Hiányos vagy Mégse.

Name	Típus	Description
Canceled	string	A privát kapcsolati szolgáltatás kapcsolati erőforrásának létesítési kérése megszakadt.
Deleting	string	A privát kapcsolat szolgáltatáskapcsolat törlése folyamatban van.
Failed	string	A privát kapcsolat szolgáltatáskapcsolatot nem sikerült kiépíteni vagy törölni.
Incomplete	string	A privát kapcsolati szolgáltatás kapcsolati erőforrásának létesítési kérése elfogadva, de a létrehozási folyamat még nem kezdődött meg.
Succeeded	string	A privát kapcsolat szolgáltatáskapcsolata befejeződött, és készen áll a jóváhagyásra.
Updating	string	A privát kapcsolat szolgáltatáskapcsolat létrehozása folyamatban van más erőforrásokkal együtt, hogy teljes mértékben működőképes legyen.

PrivateLinkServiceConnectionState

Egy meglévő Azure Private Link szolgáltatás privát végponthoz való kapcsolatának aktuális állapotát ismerteti.

Name	Típus	Alapértelmezett érték	Description
actionsRequired	string	None	Az esetlegesen szükséges további műveletek leírása.
description	string		A private link szolgáltatás kapcsolati állapotának leírása.
status	PrivateLinkServiceConnectionStatus		A privát kapcsolat szolgáltatáskapcsolatának állapota. Az érvényes értékek Függőben, Jóváhagyva, Elutasítva vagy Leválasztva.

PrivateLinkServiceConnectionStatus

A privát kapcsolati szolgáltatáskapcsolat állapota. Az érvényes értékek Függőben, Jóváhagyva, Elutasítva vagy Leválasztva.

Name	Típus	Description
Approved	string	A privát végponti kapcsolat jóvá van hagyva, és használatra kész.
Disconnected	string	A privát végponti kapcsolat el lett távolítva a szolgáltatásból.
Pending	string	A privát végponti kapcsolat létrejött, és jóváhagyásra vár.
Rejected	string	A privát végponti kapcsolat el lett utasítva, és nem használható.

ProvisioningState

A keresési szolgáltatásban végrehajtott utolsó kiépítési művelet állapota. A kiépítés egy köztes állapot, amely a szolgáltatáskapacitás létrehozásakor következik be. A kapacitás beállítása után a provisioningState a "sikeres" vagy a "sikertelen" értékre változik. Az ügyfélalkalmazások lekérdezhetik a kiépítési állapotot (az ajánlott lekérdezési időköz 30 másodperctől egy percig tart), a Keresési szolgáltatás lekérése művelettel ellenőrizheti, hogy mikor fejeződik be egy művelet. Ha az ingyenes szolgáltatást használja, ez az érték általában "sikeresként" jelenik meg közvetlenül a Keresési szolgáltatás létrehozása hívásban. Ennek az az oka, hogy az ingyenes szolgáltatás már beállított kapacitást használ.

Name	Típus	Description
failed	string	Az utolsó kiépítési művelet meghiúsult.
provisioning	string	A keresési szolgáltatás kiépítése vagy vertikális fel- vagy leskálázása folyamatban van.
succeeded	string	Az utolsó kiépítési művelet sikeresen befejeződött.

PublicNetworkAccess

Ez az érték "engedélyezve" értékre állítható, hogy elkerülje a meglévő ügyfélerőforrások és sablonok kompatibilitástörő változásait. Ha a "letiltva" értékre van állítva, a nyilvános adapteren keresztüli forgalom nem engedélyezett, és a privát végponti kapcsolatok a kizárólagos hozzáférési módszer.

Name	Típus	Description
disabled	string	A keresési szolgáltatás nem érhető el a nyilvános internetről származó forgalomból. A hozzáférés csak jóváhagyott privát végponti kapcsolatokon keresztül engedélyezett.
enabled	string	A keresési szolgáltatás a nyilvános internetről származó forgalomból érhető el.

SearchBypass

A bejövő forgalom lehetséges eredete, amely megkerülheti az "ipRules" szakaszban meghatározott szabályokat.

Name	Típus	Description
AzurePortal	string	Azt jelzi, hogy a Azure Portal származó kérések megkerülhetik az "ipRules" szakaszban meghatározott szabályokat.
None	string	Azt jelzi, hogy egyetlen forrás sem tudja megkerülni az "ipRules" szakaszban meghatározott szabályokat. Ez az alapértelmezett beállítás.

SearchDisabledDataExfiltrationOption

Azon adatkiszivárgási forgatókönyvek listája, amelyek kifejezetten nem engedélyezettek a keresési szolgáltatás számára. Jelenleg az egyetlen támogatott érték az "Összes", amely letiltja az összes lehetséges adatexportálási forgatókönyvet a jövőben tervezett részletesebb vezérlőkkel.

Name	Típus	Description
All	string	Azt jelzi, hogy minden adatkiszivárgási forgatókönyv le van tiltva.

SearchEncryptionComplianceStatus

A keresési szolgáltatásnak való megfelelőség állapotát adja vissza a nem CMK által titkosított objektumokra vonatkozóan. Ha egy szolgáltatás több titkosítatlan objektummal rendelkezik, és a kényszerítés engedélyezve van, a szolgáltatás nem megfelelőként van megjelölve.

Name	Típus	Description
Compliant	string	Azt jelzi, hogy a keresési szolgáltatás megfelelő, mert a nem CMK által titkosított objektumok száma nulla, vagy a kényszerítés le van tiltva.
NonCompliant	string	Azt jelzi, hogy a keresési szolgáltatás több, nem CMK által titkosított objektummal rendelkezik.

SearchEncryptionWithCmk

Ismerteti, hogyan kell a keresési szolgáltatásnak kikényszerítenie a megfelelőséget, ha olyan objektumokat talál, amelyek nincsenek titkosítva az ügyfél által felügyelt kulccsal.

Name	Típus	Description
Disabled	string	Az ügyfél által felügyelt kulcstitkosítás nem lesz kényszerítve. A rendszer csak a beépített, szolgáltatás által felügyelt titkosítást használja.
Enabled	string	Search szolgáltatás nem megfelelőként lesz megjelölve, ha egy vagy több objektum nincs ügyfél által felügyelt kulccsal titkosítva.
Unspecified	string	A kényszerítési szabályzat nincs explicit módon megadva, és a viselkedés ugyanaz, mintha "Letiltva" értékre lenne állítva.

SearchSemanticSearch

Beállítja a szemantikai keresés elérhetőségét szabályozó beállításokat. Ez a konfiguráció csak bizonyos Azure AI Search termékváltozatok esetében lehetséges bizonyos helyeken.

Name	Típus	Description
disabled	string	Azt jelzi, hogy a szemantikai reranker le van tiltva a keresési szolgáltatásban. Ez az alapértelmezett beállítás.
free	string	Engedélyezi a szemantikai rerankert egy keresési szolgáltatásban, és azt jelzi, hogy az ingyenes csomag korlátain belül kell használni. Az ingyenes csomag korlátozza a szemantikai rangsorolási kérelmek mennyiségét, és ingyenesen érhető el. Ez az újonnan kiépített keresési szolgáltatások alapértelmezett értéke.
standard	string	Lehetővé teszi a szemantikai rerankert a keresési szolgáltatásban számlázható szolgáltatásként, nagyobb átviteli sebességgel és szemantikailag reranked lekérdezések mennyiségével.

SearchService

Egy Azure AI-Search szolgáltatás és jelenlegi állapotát ismerteti.

Name	Típus	Alapértelmezett érték	Description
id	string		Az erőforrás teljes erőforrás-azonosítója. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity		Az erőforrás identitása.
location	string		A földrajzi hely, ahol az erőforrás él
name	string		Az erőforrás neve
properties.authOptions	DataPlaneAuthOptions		Meghatározza, hogy a keresési szolgáltatás adatsík API-ja hogyan hitelesítse a kéréseket. Ez nem állítható be, ha a disableLocalAuth értéke igaz.
properties.disableLocalAuth	boolean		Ha true (igaz) értékre van állítva, a keresési szolgáltatás hívásai nem használhatnak API-kulcsokat a hitelesítéshez. Ez nem állítható true értékre, ha a "dataPlaneAuthOptions" definiálva van.
properties.disabledDataExfiltrationOptions	SearchDisabledDataExfiltrationOption[]		Azon adatkiszivárgási forgatókönyvek listája, amelyek kifejezetten nem engedélyezettek a keresési szolgáltatás számára. Jelenleg az egyetlen támogatott érték az "Összes", amely letiltja az összes lehetséges adatexportálási forgatókönyvet a jövőben tervezett részletesebb vezérlőkkel.
properties.eTag	string		Egy rendszer által létrehozott tulajdonság, amely a szolgáltatás etagjét jelöli, amely optimalizált egyidejűség-vezérlést biztosít a frissítések során.
properties.encryptionWithCmk	EncryptionWithCmk		Megadja az erőforrások (például indexek) ügyfélmenedzser-kulcsokkal történő titkosítására vonatkozó szabályzatokat a keresési szolgáltatáson belül.
properties.hostingMode	HostingMode	default	Csak a standard3 termékváltozatra vonatkozik. Ezt a tulajdonságot beállíthatja úgy, hogy legfeljebb 3 nagy sűrűségű partíciót engedélyezzen, amelyek akár 1000 indexet is lehetővé tesznek, ami sokkal nagyobb, mint bármely más termékváltozat esetében engedélyezett maximális index. A standard3 termékváltozat esetében az érték "alapértelmezett" vagy "highDensity". Az összes többi termékváltozat esetében ennek az értéknek "alapértelmezettnek" kell lennie.
properties.networkRuleSet	NetworkRuleSet		Hálózatspecifikus szabályok, amelyek meghatározzák az Azure AI Search szolgáltatás elérését.
properties.partitionCount	integer	1	A keresési szolgáltatás partícióinak száma; ha meg van adva, ez lehet 1, 2, 3, 4, 6 vagy 12. Az 1-nél nagyobb értékek csak standard termékváltozatokra érvényesek. A "standard3" szolgáltatások esetében a hostingMode értéke "highDensity", az engedélyezett értékek 1 és 3 között vannak.
properties.privateEndpointConnections	PrivateEndpointConnection[]		Az Azure AI-Search szolgáltatás privát végponti kapcsolatainak listája.
properties.provisioningState	ProvisioningState		A keresési szolgáltatáson végrehajtott utolsó kiépítési művelet állapota. A kiépítés egy köztes állapot, amely a szolgáltatáskapacitás létrehozása közben következik be. A kapacitás beállítása után a provisioningState értéke "sikeres" vagy "sikertelen". Az ügyfélalkalmazások lekérdezhetik a kiépítési állapotot (az ajánlott lekérdezési időköz 30 másodperctől egy percig tart), a Keresési szolgáltatás lekérése művelettel ellenőrizheti, hogy mikor fejeződik be egy művelet. Ha az ingyenes szolgáltatást használja, ez az érték általában "sikeresként" jelenik meg közvetlenül a Keresési szolgáltatás létrehozása hívásban. Ennek az az oka, hogy az ingyenes szolgáltatás már beállított kapacitást használ.
properties.publicNetworkAccess	PublicNetworkAccess	enabled	Ez az érték "engedélyezve" értékre állítható, hogy elkerülje a meglévő ügyfélerőforrások és sablonok kompatibilitástörő változásait. Ha "letiltva" értékre van állítva, a nyilvános felületen keresztüli forgalom nem engedélyezett, és a privát végponti kapcsolatok a kizárólagos hozzáférési módszer.
properties.replicaCount	integer	1	A keresési szolgáltatás replikáinak száma. Ha meg van adva, akkor az értéknek 1 és 12 közöttinek kell lennie a standard termékváltozatok esetében, vagy 1 és 3 közötti értéknek kell lennie, amely az alapszintű termékváltozatot is magában foglalja.
properties.semanticSearch	SearchSemanticSearch		Beállítja a szemantikai keresés rendelkezésre állását szabályozó beállításokat. Ez a konfiguráció csak bizonyos Azure AI Search termékváltozatok esetében lehetséges bizonyos helyeken.
properties.sharedPrivateLinkResources	SharedPrivateLinkResource[]		Az Azure AI Search szolgáltatás által felügyelt megosztott privát kapcsolati erőforrások listája.
properties.status	SearchServiceStatus		A keresési szolgáltatás állapota. A lehetséges értékek a következők: "fut": A keresési szolgáltatás fut, és nincs folyamatban kiépítési művelet. "kiépítés": A keresési szolgáltatás kiépítése vagy vertikális fel- vagy leskálázása folyamatban van. "törlés": A keresési szolgáltatás törlődik. "csökkentett teljesítményű": A keresési szolgáltatás csökkentett teljesítményű. Ez akkor fordulhat elő, ha a mögöttes keresési egységek állapota nem megfelelő. A keresési szolgáltatás valószínűleg működik, de a teljesítmény lassú lehet, és egyes kérések elvethetők. 'disabled': A keresési szolgáltatás le van tiltva. Ebben az állapotban a szolgáltatás elutasítja az összes API-kérést. "hiba": A keresési szolgáltatás hibaállapotban van. 'leállított': A keresési szolgáltatás le van tiltva egy előfizetésben. Ha a szolgáltatás csökkentett teljesítményű, letiltott vagy hibaállapotban van, az azt jelenti, hogy az Azure AI Search csapata aktívan vizsgálja a mögöttes problémát. Ezekben az állapotokban a dedikált szolgáltatások továbbra is díjkötelesek a kiépített keresési egységek száma alapján.
properties.statusDetails	string		A keresési szolgáltatás állapotának részletei.
sku	Sku		A keresési szolgáltatás termékváltozata, amely meghatározza az árszintet és a kapacitáskorlátokat. Ez a tulajdonság új keresési szolgáltatás létrehozásakor szükséges.
tags	object		Erőforráscímkék.
type	string		Az erőforrás típusa. Például "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

SearchServiceStatus

A keresési szolgáltatás állapota. Lehetséges értékek: "futtatás": A keresési szolgáltatás fut, és nincs folyamatban kiépítési művelet. "kiépítés": A keresési szolgáltatás kiépítése vagy vertikális fel- vagy leskálázása folyamatban van. Törlés: A keresési szolgáltatás törlődik. "csökkentett teljesítményű": A keresési szolgáltatás csökkentett teljesítményű. Ez akkor fordulhat elő, ha a mögöttes keresési egységek nem kifogástalan állapotban vannak. A keresési szolgáltatás valószínűleg működőképes, de a teljesítmény lassú lehet, és egyes kérések elvethetők. "letiltva": A keresési szolgáltatás le van tiltva. Ebben az állapotban a szolgáltatás elutasítja az összes API-kérést. "hiba": A keresési szolgáltatás hibaállapotban van. "leállított": A keresési szolgáltatás le van tiltva egy előfizetésben. Ha a szolgáltatás csökkentett teljesítményű, letiltott vagy hibaállapotban van, az azt jelenti, hogy az Azure AI Search csapata aktívan vizsgálja az alapul szolgáló problémát. Ezekben az állapotokban a dedikált szolgáltatások továbbra is díjkötelesek a kiosztott keresési egységek száma alapján.

Name	Típus	Description
degraded	string	A keresési szolgáltatás csökkentett teljesítményű, mert a mögöttes keresési egységek nem kifogástalan állapotban vannak.
deleting	string	A keresési szolgáltatás törölve van.
disabled	string	A keresési szolgáltatás le van tiltva, és a rendszer minden API-kérést elutasít.
error	string	A keresési szolgáltatás hibaállapotban van, ami azt jelzi, hogy nem sikerült kiépíteni vagy törölni.
provisioning	string	A keresési szolgáltatás kiépítése vagy vertikális fel- vagy leskálázása folyamatban van.
running	string	A keresési szolgáltatás fut, és nincs folyamatban kiépítési művelet.
stopped	string	A keresési szolgáltatás le van tiltva egy előfizetésben.

SearchServiceUpdate

Az Azure AI-Search szolgáltatás frissítéséhez használt paraméterek.

Name	Típus	Alapértelmezett érték	Description
id	string		Az erőforrás teljes erőforrás-azonosítója. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity		A keresési szolgáltatás identitásának részletei. A null érték azt jelzi, hogy a keresési szolgáltatáshoz nincs hozzárendelve identitás.
location	string		Az erőforrás földrajzi helye. Ennek a támogatott és regisztrált Azure-georégiók egyikének kell lennie (például az USA nyugati régiója, az USA keleti régiója, Délkelet-Ázsia stb.). Ez a tulajdonság új erőforrás létrehozásakor szükséges.
name	string		Az erőforrás neve
properties.authOptions	DataPlaneAuthOptions		Meghatározza, hogy a keresési szolgáltatás adatsík API-ja hogyan hitelesíti a kéréseket. Ez nem állítható be, ha a disableLocalAuth értéke igaz.
properties.disableLocalAuth	boolean		Ha igaz értékre van állítva, a keresési szolgáltatás hívásai nem használhatják az API-kulcsokat a hitelesítéshez. Ez nem állítható igaz értékre, ha a "dataPlaneAuthOptions" definiálva van.
properties.disabledDataExfiltrationOptions	SearchDisabledDataExfiltrationOption[]		A keresési szolgáltatásra kifejezetten nem engedélyezett adatkiszivárgási forgatókönyvek listája. Jelenleg az egyetlen támogatott érték az "Összes", amely letiltja az összes lehetséges adatexportálási forgatókönyvet a jövőben tervezett részletesebb vezérlőkkel.
properties.eTag	string		A rendszer által létrehozott tulajdonság, amely a szolgáltatás etagjét jelöli, amely a frissítések során optimista egyidejűség-vezérlésre alkalmas lehet.
properties.encryptionWithCmk	EncryptionWithCmk		Meghatározza az erőforrások (például indexek) ügyfélkezelői kulcsokkal történő titkosítására vonatkozó szabályzatokat a keresési szolgáltatáson belül.
properties.hostingMode	HostingMode	default	Csak a standard3 termékváltozatra alkalmazható. Ezt a tulajdonságot beállíthatja úgy, hogy legfeljebb 3 nagy sűrűségű partíciót engedélyezzen, amelyek legfeljebb 1000 indexet tesznek lehetővé, ami sokkal magasabb, mint bármely más termékváltozat esetében engedélyezett maximális indexek. A standard3 termékváltozat esetében az érték "alapértelmezett" vagy "highDensity". Az összes többi termékváltozat esetében ennek az értéknek "alapértelmezettnek" kell lennie.
properties.networkRuleSet	NetworkRuleSet		Hálózatspecifikus szabályok, amelyek meghatározzák az Azure AI-Search szolgáltatás elérésének módját.
properties.partitionCount	integer	1	A keresési szolgáltatás partícióinak száma; ha meg van adva, 1, 2, 3, 4, 6 vagy 12 lehet. Az 1-nél nagyobb értékek csak standard termékváltozatokra érvényesek. A "standard3" szolgáltatások esetében a hostingMode értéke "highDensity", az engedélyezett értékek 1 és 3 között vannak.
properties.privateEndpointConnections	PrivateEndpointConnection[]		Az Azure AI-Search szolgáltatás privát végponti kapcsolatainak listája.
properties.provisioningState	ProvisioningState		A keresési szolgáltatásban végrehajtott utolsó kiépítési művelet állapota. A kiépítés egy köztes állapot, amely a szolgáltatáskapacitás létrehozásakor következik be. A kapacitás beállítása után a provisioningState a "sikeres" vagy a "sikertelen" értékre változik. Az ügyfélalkalmazások lekérdezhetik a kiépítési állapotot (az ajánlott lekérdezési időköz 30 másodperctől egy percig tart), a Keresési szolgáltatás lekérése művelettel ellenőrizheti, hogy mikor fejeződik be egy művelet. Ha az ingyenes szolgáltatást használja, ez az érték általában "sikeresként" jelenik meg közvetlenül a Keresési szolgáltatás létrehozása hívásban. Ennek az az oka, hogy az ingyenes szolgáltatás már beállított kapacitást használ.
properties.publicNetworkAccess	PublicNetworkAccess	enabled	Ez az érték "engedélyezve" értékre állítható, hogy elkerülje a meglévő ügyfélerőforrások és sablonok kompatibilitástörő változásait. Ha a "letiltva" értékre van állítva, a nyilvános adapteren keresztüli forgalom nem engedélyezett, és a privát végponti kapcsolatok a kizárólagos hozzáférési módszer.
properties.replicaCount	integer	1	A keresési szolgáltatás replikáinak száma. Ha meg van adva, akkor a standard termékváltozatok esetében 1 és 12 közötti, alapszintű termékváltozat esetén 1 és 3 közötti értéknek kell lennie.
properties.semanticSearch	SearchSemanticSearch		Beállítja a szemantikai keresés elérhetőségét szabályozó beállításokat. Ez a konfiguráció csak bizonyos Azure AI Search termékváltozatok esetében lehetséges bizonyos helyeken.
properties.sharedPrivateLinkResources	SharedPrivateLinkResource[]		Az Azure AI Search szolgáltatás által felügyelt megosztott privát kapcsolati erőforrások listája.
properties.status	SearchServiceStatus		A keresési szolgáltatás állapota. Lehetséges értékek: "futtatás": A keresési szolgáltatás fut, és nincs folyamatban kiépítési művelet. "kiépítés": A keresési szolgáltatás kiépítése vagy vertikális fel- vagy leskálázása folyamatban van. Törlés: A keresési szolgáltatás törlődik. "csökkentett teljesítményű": A keresési szolgáltatás csökkentett teljesítményű. Ez akkor fordulhat elő, ha a mögöttes keresési egységek nem kifogástalan állapotban vannak. A keresési szolgáltatás valószínűleg működőképes, de a teljesítmény lassú lehet, és egyes kérések elvethetők. "letiltva": A keresési szolgáltatás le van tiltva. Ebben az állapotban a szolgáltatás elutasítja az összes API-kérést. "hiba": A keresési szolgáltatás hibaállapotban van. "leállított": A keresési szolgáltatás le van tiltva egy előfizetésben. Ha a szolgáltatás csökkentett teljesítményű, letiltott vagy hibaállapotban van, az azt jelenti, hogy az Azure AI Search csapata aktívan vizsgálja az alapul szolgáló problémát. Ezekben az állapotokban a dedikált szolgáltatások továbbra is díjkötelesek a kiosztott keresési egységek száma alapján.
properties.statusDetails	string		A keresési szolgáltatás állapotának részletei.
sku	Sku		A keresési szolgáltatás termékváltozata, amely meghatározza az árszintet és a kapacitáskorlátokat. Ez a tulajdonság új keresési szolgáltatás létrehozásakor szükséges.
tags	object		Címkék az erőforrás kategorizálásához a Azure Portal.
type	string		Az erőforrás típusa. Például "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

SharedPrivateLinkResource

Az Azure AI Search szolgáltatás által felügyelt megosztott privát kapcsolati erőforrást ismerteti.

Name	Típus	Description
id	string	Az erőforrás teljes erőforrás-azonosítója. Például : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Az erőforrás neve
properties	SharedPrivateLinkResourceProperties	Az Azure AI-Search szolgáltatás által felügyelt megosztott privát kapcsolati erőforrás tulajdonságait ismerteti.
type	string	Az erőforrás típusa. Például"Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

SharedPrivateLinkResourceProperties

Az Azure AI Search szolgáltatás által felügyelt meglévő megosztott privát kapcsolati erőforrás tulajdonságait ismerteti.

Name	Típus	Description
groupId	string	Annak az erőforrásnak a szolgáltatójától származó csoportazonosító, amelyre a megosztott privát kapcsolat erőforrása tartozik.
privateLinkResourceId	string	Annak az erőforrásnak az erőforrás-azonosítója, amelyre a megosztott privát kapcsolat erőforrása tartozik.
provisioningState	SharedPrivateLinkResourceProvisioningState	A megosztott privát kapcsolati erőforrás kiépítési állapota. Az érvényes értékek: Frissítés, Törlés, Sikertelen, Sikeres vagy Hiányos.
requestMessage	string	A megosztott privát kapcsolat erőforrásának jóváhagyását kérő üzenet.
resourceRegion	string	Választható. Segítségével megadhatja annak az erőforrásnak az Azure Resource Manager helyét, amelyhez megosztott privát kapcsolat jön létre. Ez csak azokhoz az erőforrásokhoz szükséges, amelyek DNS-konfigurációja regionális (például Azure Kubernetes Service).
status	SharedPrivateLinkResourceStatus	A megosztott privát kapcsolati erőforrás állapota. Az érvényes értékek Függőben, Jóváhagyva, Elutasítva vagy Leválasztva.

SharedPrivateLinkResourceProvisioningState

A megosztott privát kapcsolati erőforrás kiépítési állapota. Az érvényes értékek: Frissítés, Törlés, Sikertelen, Sikeres vagy Hiányos.

Name	Típus	Description
Deleting	string	A megosztott privát kapcsolati erőforrás törlése folyamatban van.
Failed	string	A megosztott privát kapcsolati erőforrás kiépítése vagy törlése nem sikerült.
Incomplete	string	A megosztott privát kapcsolatú erőforrásra vonatkozó kiépítési kérelem el lett fogadva, de a létrehozási folyamat még nem kezdődött meg.
Succeeded	string	A megosztott privát kapcsolati erőforrás üzembe helyezése befejeződött, és készen áll a jóváhagyásra.
Updating	string	A megosztott privát kapcsolati erőforrás létrehozása folyamatban van a többi erőforrással együtt, hogy teljes mértékben működőképes legyen.

SharedPrivateLinkResourceStatus

A megosztott privát kapcsolati erőforrás állapota. Az érvényes értékek Függőben, Jóváhagyva, Elutasítva vagy Leválasztva.

Name	Típus	Description
Approved	string	A megosztott privát kapcsolati erőforrás jóvá van hagyva, és használatra kész.
Disconnected	string	A megosztott privát kapcsolati erőforrás el lett távolítva a szolgáltatásból.
Pending	string	A megosztott privát kapcsolati erőforrás létrejött, és jóváhagyásra vár.
Rejected	string	A megosztott privát kapcsolati erőforrás el lett utasítva, és nem használható.

Sku

Meghatározza egy keresési szolgáltatás termékváltozatát, amely meghatározza a számlázási díjszabást és a kapacitáskorlátokat.

Name	Típus	Description
name	SkuName	A keresési szolgáltatás termékváltozata. Az érvényes értékek a következők: "ingyenes": Megosztott szolgáltatás. "alapszintű": Dedikált szolgáltatás legfeljebb 3 replikával. "standard": Dedikált szolgáltatás legfeljebb 12 partícióval és 12 replikával. "standard2": Hasonló a standardhoz, de a keresési egységenként nagyobb kapacitással. "standard3": A legnagyobb standard ajánlat, amely legfeljebb 12 partícióval és 12 replikával (vagy akár 3 olyan partícióval, amely több indexet biztosít, ha a hostingMode tulajdonságot is "highDensity" értékre állítja). "storage_optimized_l1": Partíciónként 1 TB-ot támogat, legfeljebb 12 partíciót. "storage_optimized_l2: Partíciónként 2 TB-ot támogat, legfeljebb 12 partíciót."

SkuName

A keresési szolgáltatás termékváltozata. Az érvényes értékek a következők: "ingyenes": Megosztott szolgáltatás. "alapszintű": Dedikált szolgáltatás legfeljebb 3 replikával. "standard": Dedikált szolgáltatás legfeljebb 12 partícióval és 12 replikával. "standard2": Hasonló a standardhoz, de keresési egységenként nagyobb kapacitással. "standard3": A legnagyobb standard ajánlat legfeljebb 12 partícióval és 12 replikával (vagy akár 3 partícióval, több indexkel, ha a hostingMode tulajdonságot is "highDensity" értékre állítja). "storage_optimized_l1": Partíciónként 1 TB-ot támogat, legfeljebb 12 partíciót. "storage_optimized_l2": Partíciónként 2 TB-ot támogat, legfeljebb 12 partíciót."

Name	Típus	Description
basic	string	Számlázható szint egy dedikált szolgáltatáshoz, amely legfeljebb 3 replikával rendelkezik.
free	string	Ingyenes szint, SLA-garanciák nélkül, valamint a számlázható szinteken kínált funkciók egy részhalmaza.
standard	string	Számlázható szint egy olyan dedikált szolgáltatáshoz, amely legfeljebb 12 partícióval és 12 replikával rendelkezik.
standard2	string	Hasonló a "standard" típushoz, de több kapacitással a keresési egységenként.
standard3	string	A legnagyobb standard ajánlat akár 12 partícióval és 12 replikával (vagy akár 3 olyan partícióval, amely több indexet biztosít, ha a hostingMode tulajdonságot is "highDensity" értékre állítja).
storage_optimized_l1	string	Egy dedikált szolgáltatás számlázható szintje, amely partíciónként 1 TB-ot támogat, legfeljebb 12 partíciót.
storage_optimized_l2	string	Egy dedikált szolgáltatás számlázható szintje, amely partíciónként 2 TB-ot támogat, legfeljebb 12 partíciót.

UserAssignedManagedIdentity

A keresési szolgáltatáshoz hozzárendelt felhasználó által hozzárendelt felügyelt identitás részletei.

Name	Típus	Description
clientId	string	A felhasználó által hozzárendelt identitás ügyfélazonosítója.
principalId	string	A felhasználó által hozzárendelt identitás egyszerű azonosítója.

Megosztás a következőn keresztül:

Services - Update

URI-paraméterek

Kérelem fejléce

Kérelem törzse

Válaszok

Biztonság

azure_auth

Hatókörök

Példák

SearchUpdateService

Mintakérelem

Mintaválasz

SearchUpdateServiceAuthOptions

Mintakérelem

Mintaválasz

SearchUpdateServiceDisableLocalAuth

Mintakérelem

Mintaválasz

SearchUpdateServiceToAllowAccessFromPrivateEndpoints

Mintakérelem

Mintaválasz

SearchUpdateServiceToAllowAccessFromPublicCustomIPs

Mintakérelem

Mintaválasz

SearchUpdateServiceToAllowAccessFromPublicCustomIPsAndBypass

Mintakérelem

Mintaválasz

SearchUpdateServiceToRemoveIdentity

Mintakérelem

Mintaválasz

SearchUpdateServiceWithCmkEnforcement

Mintakérelem

Mintaválasz

SearchUpdateServiceWithDataExfiltration

Mintakérelem

Mintaválasz

SearchUpdateServiceWithSemanticSearch

Mintakérelem

Mintaválasz

Definíciók

AadAuthFailureMode

ApiKeyOnly

CloudError

CloudErrorBody

DataPlaneAadOrApiKeyAuthOption

DataPlaneAuthOptions

EncryptionWithCmk

HostingMode

Identity

IdentityType

IpRule

NetworkRuleSet

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateLinkServiceConnectionProvisioningState

PrivateLinkServiceConnectionState

PrivateLinkServiceConnectionStatus

ProvisioningState

PublicNetworkAccess

SearchBypass

SearchDisabledDataExfiltrationOption

SearchEncryptionComplianceStatus

SearchEncryptionWithCmk

SearchSemanticSearch

SearchService

SearchServiceStatus

SearchServiceUpdate

SharedPrivateLinkResource

SharedPrivateLinkResourceProperties

SharedPrivateLinkResourceProvisioningState

SharedPrivateLinkResourceStatus

Sku

SkuName

UserAssignedManagedIdentity

További források