Aggiornamenti un servizio di ricerca esistente nel gruppo di risorse specificato.
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}?api-version=2024-03-01-preview
Parametri dell'URI
Nome |
In |
Necessario |
Tipo |
Descrizione |
resourceGroupName
|
path |
True
|
string
|
Nome del gruppo di risorse all'interno della sottoscrizione corrente. È possibile ottenere questo valore dall'API di Gestione risorse di Azure o dal portale.
|
searchServiceName
|
path |
True
|
string
|
Nome del servizio di ricerca di intelligenza artificiale di Azure da aggiornare.
|
subscriptionId
|
path |
True
|
string
|
Identificatore univoco per una sottoscrizione di Microsoft Azure. È possibile ottenere questo valore dall'API di Gestione risorse di Azure o dal portale.
|
api-version
|
query |
True
|
string
|
Versione dell'API da usare per ogni richiesta.
|
Nome |
Necessario |
Tipo |
Descrizione |
x-ms-client-request-id
|
|
string
uuid
|
Valore GUID generato dal client che identifica la richiesta. Se specificato, verrà incluso nelle informazioni di risposta come modo per tenere traccia della richiesta.
|
Corpo della richiesta
Nome |
Tipo |
Descrizione |
identity
|
Identity
|
Dettagli sull'identità del servizio di ricerca. Un valore Null indica che al servizio di ricerca non è assegnata alcuna identità.
|
location
|
string
|
Posizione geografica della risorsa. Deve trattarsi di una delle aree geografiche di Azure supportate e registrate, ad esempio Stati Uniti occidentali, Stati Uniti orientali, Asia sud-orientale e così via. Questa proprietà è necessaria durante la creazione di una nuova risorsa.
|
properties.authOptions
|
DataPlaneAuthOptions
|
Definisce le opzioni per il modo in cui l'API del piano dati di un servizio di ricerca autentica le richieste. Questa impostazione non può essere impostata se 'disableLocalAuth' è impostato su true.
|
properties.disableLocalAuth
|
boolean
|
Se impostato su true, le chiamate al servizio di ricerca non saranno autorizzate a usare le chiavi API per l'autenticazione. Questa impostazione non può essere impostata su true se sono definiti "dataPlaneAuthOptions".
|
properties.disabledDataExfiltrationOptions
|
SearchDisabledDataExfiltrationOption[]
|
Elenco di scenari di esfiltrazione dei dati che non sono esplicitamente consentiti per il servizio di ricerca. Attualmente, l'unico valore supportato è "All" per disabilitare tutti i possibili scenari di esportazione dei dati con controlli più granulari pianificati per il futuro.
|
properties.encryptionWithCmk
|
EncryptionWithCmk
|
Specifica i criteri relativi alla crittografia delle risorse (ad esempio gli indici) usando le chiavi del customer manager all'interno di un servizio di ricerca.
|
properties.hostingMode
|
HostingMode
|
Applicabile solo per lo SKU Standard3. È possibile impostare questa proprietà per abilitare fino a 3 partizioni ad alta densità che consentono fino a 1000 indici, che sono molto più elevati rispetto agli indici massimi consentiti per qualsiasi altro SKU. Per lo SKU standard3, il valore è "default" o "highDensity". Per tutti gli altri SKU, questo valore deve essere 'default'.
|
properties.networkRuleSet
|
NetworkRuleSet
|
Regole specifiche della rete che determinano il modo in cui è possibile raggiungere il servizio di ricerca di intelligenza artificiale di Azure.
|
properties.partitionCount
|
integer
|
Numero di partizioni nel servizio di ricerca; se specificato, può essere 1, 2, 3, 4, 6 o 12. I valori maggiori di 1 sono validi solo per gli SKU standard. Per i servizi 'standard3' con hostingMode impostato su 'highDensity', i valori consentiti sono compresi tra 1 e 3.
|
properties.publicNetworkAccess
|
PublicNetworkAccess
|
Questo valore può essere impostato su "abilitato" per evitare modifiche di rilievo nelle risorse e nei modelli dei clienti esistenti. Se impostato su "disabilitato", il traffico sull'interfaccia pubblica non è consentito e le connessioni endpoint private saranno il metodo di accesso esclusivo.
|
properties.replicaCount
|
integer
|
Numero di repliche nel servizio di ricerca. Se specificato, deve essere un valore compreso tra 1 e 12 inclusi per GLI SKU standard o compreso tra 1 e 3 inclusi per lo SKU basic.
|
properties.semanticSearch
|
SearchSemanticSearch
|
Imposta le opzioni che controllano la disponibilità della ricerca semantica. Questa configurazione è possibile solo per determinati SKU di Ricerca intelligenza artificiale di Azure in determinate posizioni.
|
sku
|
Sku
|
SKU del servizio di ricerca, che determina i limiti di livello prezzo e capacità. Questa proprietà è necessaria quando si crea un nuovo servizio di ricerca.
|
tags
|
object
|
Tag che consentono di classificare la risorsa nel portale di Azure.
|
Risposte
Nome |
Tipo |
Descrizione |
200 OK
|
SearchService
|
La definizione del servizio esistente è stata aggiornata correttamente. Se è stato modificato il numero di repliche o partizioni, l'operazione di scalabilità verrà eseguita in modo asincrono. È possibile controllare lo stato di un'operazione di scalabilità tramite la proprietà provisioningState di una richiesta Get Service.
|
Other Status Codes
|
CloudError
|
HTTP 400 (richiesta non valida): la definizione del servizio specificata non è valida o si è tentato di modificare una proprietà non modificabile. Per informazioni dettagliate, vedere il codice di errore e il messaggio nella risposta. HTTP 404 (Non trovato): impossibile trovare la sottoscrizione o il gruppo di risorse. HTTP 409 (Conflitto): la sottoscrizione specificata è disabilitata.
|
Sicurezza
azure_auth
Specifica un flusso di concessione implicita, come supportato in Microsoft Identity Platform.
Tipo:
oauth2
Flow:
implicit
URL di autorizzazione:
https://login.microsoftonline.com/common/oauth2/authorize
Ambiti
Nome |
Descrizione |
user_impersonation
|
rappresentare l'account utente
|
Esempio
SearchUpdateService
Esempio di richiesta
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
using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Search.Models;
using Azure.ResourceManager.Search;
// Generated from example definition: specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/SearchUpdateService.json
// this example is just showing the usage of "Services_Update" operation, for the dependent resources, they will have to be created separately.
// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);
// this example assumes you already have this SearchServiceResource created on azure
// for more information of creating SearchServiceResource, please refer to the document of SearchServiceResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string searchServiceName = "mysearchservice";
ResourceIdentifier searchServiceResourceId = SearchServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, searchServiceName);
SearchServiceResource searchService = client.GetSearchServiceResource(searchServiceResourceId);
// invoke the operation
SearchServicePatch patch = new SearchServicePatch(new AzureLocation("placeholder"))
{
ReplicaCount = 2,
Tags =
{
["app-name"] = "My e-commerce app",
["new-tag"] = "Adding a new tag",
},
};
SearchServiceResource result = await searchService.UpdateAsync(patch);
// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SearchServiceData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Risposta di esempio
{
"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
Esempio di richiesta
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
using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Search.Models;
using Azure.ResourceManager.Search;
// Generated from example definition: specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/SearchUpdateServiceAuthOptions.json
// this example is just showing the usage of "Services_Update" operation, for the dependent resources, they will have to be created separately.
// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);
// this example assumes you already have this SearchServiceResource created on azure
// for more information of creating SearchServiceResource, please refer to the document of SearchServiceResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string searchServiceName = "mysearchservice";
ResourceIdentifier searchServiceResourceId = SearchServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, searchServiceName);
SearchServiceResource searchService = client.GetSearchServiceResource(searchServiceResourceId);
// invoke the operation
SearchServicePatch patch = new SearchServicePatch(new AzureLocation("placeholder"))
{
ReplicaCount = 2,
AuthOptions = new SearchAadAuthDataPlaneAuthOptions()
{
AadAuthFailureMode = SearchAadAuthFailureMode.Http401WithBearerChallenge,
},
Tags =
{
["app-name"] = "My e-commerce app",
["new-tag"] = "Adding a new tag",
},
};
SearchServiceResource result = await searchService.UpdateAsync(patch);
// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SearchServiceData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Risposta di esempio
{
"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
Esempio di richiesta
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
using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Search.Models;
using Azure.ResourceManager.Search;
// Generated from example definition: specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/SearchUpdateServiceDisableLocalAuth.json
// this example is just showing the usage of "Services_Update" operation, for the dependent resources, they will have to be created separately.
// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);
// this example assumes you already have this SearchServiceResource created on azure
// for more information of creating SearchServiceResource, please refer to the document of SearchServiceResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string searchServiceName = "mysearchservice";
ResourceIdentifier searchServiceResourceId = SearchServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, searchServiceName);
SearchServiceResource searchService = client.GetSearchServiceResource(searchServiceResourceId);
// invoke the operation
SearchServicePatch patch = new SearchServicePatch(new AzureLocation("placeholder"))
{
ReplicaCount = 2,
IsLocalAuthDisabled = true,
Tags =
{
["app-name"] = "My e-commerce app",
["new-tag"] = "Adding a new tag",
},
};
SearchServiceResource result = await searchService.UpdateAsync(patch);
// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SearchServiceData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Risposta di esempio
{
"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
Esempio di richiesta
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
using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Search.Models;
using Azure.ResourceManager.Search;
// Generated from example definition: specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/SearchUpdateServiceToAllowAccessFromPrivateEndpoints.json
// this example is just showing the usage of "Services_Update" operation, for the dependent resources, they will have to be created separately.
// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);
// this example assumes you already have this SearchServiceResource created on azure
// for more information of creating SearchServiceResource, please refer to the document of SearchServiceResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string searchServiceName = "mysearchservice";
ResourceIdentifier searchServiceResourceId = SearchServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, searchServiceName);
SearchServiceResource searchService = client.GetSearchServiceResource(searchServiceResourceId);
// invoke the operation
SearchServicePatch patch = new SearchServicePatch(new AzureLocation("placeholder"))
{
ReplicaCount = 1,
PartitionCount = 1,
PublicInternetAccess = SearchServicePublicInternetAccess.Disabled,
};
SearchServiceResource result = await searchService.UpdateAsync(patch);
// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SearchServiceData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Risposta di esempio
{
"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
Esempio di richiesta
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
using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Search.Models;
using Azure.ResourceManager.Search;
// Generated from example definition: specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/SearchUpdateServiceToAllowAccessFromPublicCustomIPs.json
// this example is just showing the usage of "Services_Update" operation, for the dependent resources, they will have to be created separately.
// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);
// this example assumes you already have this SearchServiceResource created on azure
// for more information of creating SearchServiceResource, please refer to the document of SearchServiceResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string searchServiceName = "mysearchservice";
ResourceIdentifier searchServiceResourceId = SearchServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, searchServiceName);
SearchServiceResource searchService = client.GetSearchServiceResource(searchServiceResourceId);
// invoke the operation
SearchServicePatch patch = new SearchServicePatch(new AzureLocation("placeholder"))
{
ReplicaCount = 3,
PartitionCount = 1,
PublicInternetAccess = SearchServicePublicInternetAccess.Enabled,
NetworkRuleSet = new SearchServiceNetworkRuleSet()
{
IPRules =
{
new SearchServiceIPRule()
{
Value = "123.4.5.6",
},new SearchServiceIPRule()
{
Value = "123.4.6.0/18",
}
},
},
};
SearchServiceResource result = await searchService.UpdateAsync(patch);
// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SearchServiceData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Risposta di esempio
{
"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
Esempio di richiesta
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
using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Search.Models;
using Azure.ResourceManager.Search;
// Generated from example definition: specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/SearchUpdateServiceToAllowAccessFromPublicCustomIPsAndBypass.json
// this example is just showing the usage of "Services_Update" operation, for the dependent resources, they will have to be created separately.
// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);
// this example assumes you already have this SearchServiceResource created on azure
// for more information of creating SearchServiceResource, please refer to the document of SearchServiceResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string searchServiceName = "mysearchservice";
ResourceIdentifier searchServiceResourceId = SearchServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, searchServiceName);
SearchServiceResource searchService = client.GetSearchServiceResource(searchServiceResourceId);
// invoke the operation
SearchServicePatch patch = new SearchServicePatch(new AzureLocation("placeholder"))
{
ReplicaCount = 3,
PartitionCount = 1,
PublicInternetAccess = SearchServicePublicInternetAccess.Enabled,
NetworkRuleSet = new SearchServiceNetworkRuleSet()
{
IPRules =
{
new SearchServiceIPRule()
{
Value = "123.4.5.6",
},new SearchServiceIPRule()
{
Value = "123.4.6.0/18",
}
},
Bypass = SearchBypass.AzurePortal,
},
};
SearchServiceResource result = await searchService.UpdateAsync(patch);
// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SearchServiceData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Risposta di esempio
{
"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
Esempio di richiesta
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
using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Search.Models;
using Azure.ResourceManager.Search;
// Generated from example definition: specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/SearchUpdateServiceToRemoveIdentity.json
// this example is just showing the usage of "Services_Update" operation, for the dependent resources, they will have to be created separately.
// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);
// this example assumes you already have this SearchServiceResource created on azure
// for more information of creating SearchServiceResource, please refer to the document of SearchServiceResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string searchServiceName = "mysearchservice";
ResourceIdentifier searchServiceResourceId = SearchServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, searchServiceName);
SearchServiceResource searchService = client.GetSearchServiceResource(searchServiceResourceId);
// invoke the operation
SearchServicePatch patch = new SearchServicePatch(new AzureLocation("placeholder"))
{
SearchSkuName = SearchServiceSkuName.Standard,
Identity = new ManagedServiceIdentity("None"),
};
SearchServiceResource result = await searchService.UpdateAsync(patch);
// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SearchServiceData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Risposta di esempio
{
"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
Esempio di richiesta
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
using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Search.Models;
using Azure.ResourceManager.Search;
// Generated from example definition: specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/SearchUpdateServiceWithCmkEnforcement.json
// this example is just showing the usage of "Services_Update" operation, for the dependent resources, they will have to be created separately.
// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);
// this example assumes you already have this SearchServiceResource created on azure
// for more information of creating SearchServiceResource, please refer to the document of SearchServiceResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string searchServiceName = "mysearchservice";
ResourceIdentifier searchServiceResourceId = SearchServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, searchServiceName);
SearchServiceResource searchService = client.GetSearchServiceResource(searchServiceResourceId);
// invoke the operation
SearchServicePatch patch = new SearchServicePatch(new AzureLocation("placeholder"))
{
ReplicaCount = 2,
EncryptionWithCmk = new SearchEncryptionWithCmk()
{
Enforcement = SearchEncryptionWithCmkEnforcement.Enabled,
},
Tags =
{
["app-name"] = "My e-commerce app",
["new-tag"] = "Adding a new tag",
},
};
SearchServiceResource result = await searchService.UpdateAsync(patch);
// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SearchServiceData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Risposta di esempio
{
"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
Esempio di richiesta
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
using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Search.Models;
using Azure.ResourceManager.Search;
// Generated from example definition: specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/SearchUpdateServiceWithDataExfiltration.json
// this example is just showing the usage of "Services_Update" operation, for the dependent resources, they will have to be created separately.
// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);
// this example assumes you already have this SearchServiceResource created on azure
// for more information of creating SearchServiceResource, please refer to the document of SearchServiceResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string searchServiceName = "mysearchservice";
ResourceIdentifier searchServiceResourceId = SearchServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, searchServiceName);
SearchServiceResource searchService = client.GetSearchServiceResource(searchServiceResourceId);
// invoke the operation
SearchServicePatch patch = new SearchServicePatch(new AzureLocation("placeholder"))
{
ReplicaCount = 2,
DisabledDataExfiltrationOptions =
{
SearchDisabledDataExfiltrationOption.All
},
Tags =
{
["app-name"] = "My e-commerce app",
["new-tag"] = "Adding a new tag",
},
};
SearchServiceResource result = await searchService.UpdateAsync(patch);
// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SearchServiceData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Risposta di esempio
{
"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
Esempio di richiesta
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
using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Search.Models;
using Azure.ResourceManager.Search;
// Generated from example definition: specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/SearchUpdateServiceWithSemanticSearch.json
// this example is just showing the usage of "Services_Update" operation, for the dependent resources, they will have to be created separately.
// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);
// this example assumes you already have this SearchServiceResource created on azure
// for more information of creating SearchServiceResource, please refer to the document of SearchServiceResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string searchServiceName = "mysearchservice";
ResourceIdentifier searchServiceResourceId = SearchServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, searchServiceName);
SearchServiceResource searchService = client.GetSearchServiceResource(searchServiceResourceId);
// invoke the operation
SearchServicePatch patch = new SearchServicePatch(new AzureLocation("placeholder"))
{
ReplicaCount = 2,
SemanticSearch = SearchSemanticSearch.Standard,
Tags =
{
["app-name"] = "My e-commerce app",
["new-tag"] = "Adding a new tag",
},
};
SearchServiceResource result = await searchService.UpdateAsync(patch);
// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SearchServiceData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Risposta di esempio
{
"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"
}
}
Definizioni
Nome |
Descrizione |
AadAuthFailureMode
|
Descrive la risposta che l'API del piano dati di un servizio di ricerca invia per le richieste che hanno avuto esito negativo nell'autenticazione.
|
ApiKeyOnly
|
Indica che solo la chiave API può essere usata per l'autenticazione.
|
CloudError
|
Contiene informazioni su un errore dell'API.
|
CloudErrorBody
|
Descrive un particolare errore dell'API con un codice di errore e un messaggio.
|
DataPlaneAadOrApiKeyAuthOption
|
Indica che è possibile usare la chiave API o un token di accesso da un tenant Microsoft Entra ID per l'autenticazione.
|
DataPlaneAuthOptions
|
Definisce le opzioni per il modo in cui il servizio di ricerca autentica una richiesta del piano dati. Impossibile impostare se 'disableLocalAuth' è impostato su true.
|
EncryptionWithCmk
|
Descrive un criterio che determina il modo in cui le risorse all'interno del servizio di ricerca devono essere crittografate con chiavi gestite dal cliente.
|
HostingMode
|
Applicabile solo per lo SKU Standard3. È possibile impostare questa proprietà per abilitare fino a 3 partizioni ad alta densità che consentono fino a 1000 indici, che sono molto più elevati rispetto agli indici massimi consentiti per qualsiasi altro SKU. Per lo SKU standard3, il valore è "default" o "highDensity". Per tutti gli altri SKU, questo valore deve essere 'default'.
|
Identity
|
Informazioni dettagliate sull'identità del servizio di ricerca. Un valore Null indica che il servizio di ricerca non ha identità assegnata.
|
IdentityType
|
Tipo di identità usata per la risorsa. Il tipo "SystemAssigned, UserAssigned" include sia un'identità creata dal sistema che un set di identità assegnate dall'utente. Il tipo "Nessuno" rimuoverà tutte le identità dal servizio.
|
IpRule
|
Regola di restrizione IP del servizio di ricerca di intelligenza artificiale di Azure.
|
NetworkRuleSet
|
Regole specifiche della rete che determinano il modo in cui è possibile raggiungere il servizio di ricerca di Intelligenza artificiale di Azure.
|
PrivateEndpoint
|
Risorsa endpoint privato dal provider Microsoft.Network.
|
PrivateEndpointConnection
|
Descrive una connessione endpoint privato esistente alla servizio di ricerca di Intelligenza artificiale di Azure.
|
PrivateEndpointConnectionProperties
|
Descrive le proprietà di una connessione di endpoint privato esistente al servizio di ricerca.
|
PrivateLinkServiceConnectionProvisioningState
|
Stato di provisioning della connessione al servizio di collegamento privato. I valori validi sono Aggiornamento, Eliminazione, Operazione non riuscita, Completata, Incompleta o Annullata.
|
PrivateLinkServiceConnectionState
|
Descrive lo stato corrente di una connessione al servizio collegamento privato di Azure esistente all'endpoint privato.
|
PrivateLinkServiceConnectionStatus
|
Stato della connessione al servizio di collegamento privato. I valori validi sono In sospeso, Approvato, Rifiutato o Disconnesso.
|
ProvisioningState
|
Stato dell'ultima operazione di provisioning eseguita nel servizio di ricerca. Il provisioning è uno stato intermedio che si verifica quando viene stabilita la capacità del servizio. Dopo la configurazione della capacità, provisioningState viene modificato in "succeeded" o "failed". Le applicazioni client possono eseguire il polling dello stato di provisioning (l'intervallo di polling consigliato è compreso tra 30 secondi e un minuto) usando l'operazione Get Search Service per verificare quando viene completata un'operazione. Se si usa il servizio gratuito, questo valore tende a tornare come "riuscito" direttamente nella chiamata a Crea servizio di ricerca. Ciò avviene perché il servizio gratuito utilizza una capacità che è già configurata.
|
PublicNetworkAccess
|
Questo valore può essere impostato su "abilitato" per evitare modifiche di rilievo nelle risorse e nei modelli dei clienti esistenti. Se impostato su "disabilitato", il traffico sull'interfaccia pubblica non è consentito e le connessioni endpoint private saranno il metodo di accesso esclusivo.
|
SearchBypass
|
Origini possibili del traffico in ingresso che possono ignorare le regole definite nella sezione 'ipRules'.
|
SearchDisabledDataExfiltrationOption
|
Elenco di scenari di esfiltrazione dei dati non consentiti in modo esplicito per il servizio di ricerca. Attualmente, l'unico valore supportato è "All" per disabilitare tutti gli scenari di esportazione dei dati possibili con controlli più granulari pianificati per il futuro.
|
SearchEncryptionComplianceStatus
|
Restituisce lo stato di conformità del servizio di ricerca rispetto agli oggetti non crittografati da CMK. Se un servizio ha più di un oggetto non crittografato e l'imposizione è abilitata, il servizio viene contrassegnato come non conforme.
|
SearchEncryptionWithCmk
|
Descrive in che modo un servizio di ricerca deve applicare la conformità se trova oggetti non crittografati con la chiave gestita dal cliente.
|
SearchSemanticSearch
|
Imposta le opzioni che controllano la disponibilità della ricerca semantica. Questa configurazione è possibile solo per determinati SKU di Ricerca intelligenza artificiale di Azure in determinate posizioni.
|
SearchService
|
Descrive un servizio di ricerca di intelligenza artificiale di Azure e il relativo stato corrente.
|
SearchServiceStatus
|
Stato del servizio di ricerca. I valori possibili includono: 'running': il servizio di ricerca è in esecuzione e non sono in corso operazioni di provisioning. 'provisioning': viene effettuato il provisioning o la riduzione del servizio di ricerca. 'delete': il servizio di ricerca viene eliminato. "degradato": il servizio di ricerca è danneggiato. Ciò può verificarsi quando le unità di ricerca sottostanti non sono integre. Il servizio di ricerca è molto probabilmente operativo, ma le prestazioni potrebbero essere lente e alcune richieste potrebbero essere eliminate. 'disabled': il servizio di ricerca è disabilitato. In questo stato, il servizio rifiuterà tutte le richieste API. 'error': il servizio di ricerca si trova in uno stato di errore. 'stopped': il servizio di ricerca si trova in una sottoscrizione disabilitata. Se il servizio si trova negli stati di errore, disabilitati o degradati, significa che il team di Ricerca intelligenza artificiale di Azure sta esaminando attivamente il problema sottostante. I servizi dedicati in questi stati sono ancora addebitabili in base al numero di unità di ricerca di cui è stato effettuato il provisioning.
|
SearchServiceUpdate
|
I parametri usati per aggiornare un servizio di ricerca di intelligenza artificiale di Azure.
|
SharedPrivateLinkResource
|
Descrive una risorsa di collegamento privato condivisa gestita dalla servizio di ricerca di Intelligenza artificiale di Azure.
|
SharedPrivateLinkResourceProperties
|
Descrive le proprietà di una risorsa di collegamento privato condiviso esistente gestita dal servizio di ricerca di Intelligenza artificiale di Azure.
|
SharedPrivateLinkResourceProvisioningState
|
Stato di provisioning della risorsa collegamento privato condiviso. I valori validi sono Aggiornamento, Eliminazione, Non riuscita, Operazione riuscita o Incompleta.
|
SharedPrivateLinkResourceStatus
|
Stato della risorsa collegamento privato condiviso. I valori validi sono In sospeso, Approvato, Rifiutato o Disconnesso.
|
Sku
|
Definisce lo SKU di un servizio di ricerca, che determina i limiti di fatturazione e capacità.
|
SkuName
|
SKU del servizio di ricerca. I valori validi includono: 'free': Servizio condiviso. 'basic': servizio dedicato con un massimo di 3 repliche. 'standard': servizio dedicato con un massimo di 12 partizioni e 12 repliche. 'standard2': simile allo standard, ma con una maggiore capacità per ogni unità di ricerca. 'standard3': la più grande offerta Standard con un massimo di 12 partizioni e 12 repliche (o fino a 3 partizioni con più indici se si imposta anche la proprietà hostingMode su 'highDensity'). 'storage_optimized_l1': supporta 1 TB per partizione, fino a 12 partizioni. 'storage_optimized_l2': supporta 2 TB per partizione, fino a 12 partizioni".
|
UserAssignedManagedIdentity
|
Dettagli dell'identità gestita assegnata dall'utente assegnata al servizio di ricerca.
|
AadAuthFailureMode
Descrive la risposta che l'API del piano dati di un servizio di ricerca invia per le richieste che hanno avuto esito negativo nell'autenticazione.
Nome |
Tipo |
Descrizione |
http401WithBearerChallenge
|
string
|
Indica che le richieste che non hanno superato l'autenticazione devono essere presentate con un codice di stato HTTP 401 (non autorizzato) e presentano una Richiesta di connessione.
|
http403
|
string
|
Indica che le richieste di autenticazione non riuscite devono essere presentate con un codice di stato HTTP 403 (Accesso negato).
|
ApiKeyOnly
Indica che solo la chiave API può essere usata per l'autenticazione.
CloudError
Contiene informazioni su un errore dell'API.
Nome |
Tipo |
Descrizione |
error
|
CloudErrorBody
|
Descrive un particolare errore dell'API con un codice di errore e un messaggio.
|
message
|
string
|
Breve descrizione dell'errore che indica cosa è andato storto (per informazioni dettagliate/di debug fare riferimento alla proprietà "error.message").
|
CloudErrorBody
Descrive un particolare errore dell'API con un codice di errore e un messaggio.
Nome |
Tipo |
Descrizione |
code
|
string
|
Codice di errore che descrive più precisamente la condizione di errore rispetto a un codice di stato HTTP. Può essere usato per gestire casi di errore specifici a livello di codice.
|
details
|
CloudErrorBody[]
|
Contiene errori annidati correlati a questo errore.
|
message
|
string
|
Messaggio che descrive l'errore in dettaglio e fornisce informazioni di debug.
|
target
|
string
|
Destinazione dell'errore specifico, ad esempio il nome della proprietà in errore.
|
DataPlaneAadOrApiKeyAuthOption
Indica che è possibile usare la chiave API o un token di accesso da un tenant Microsoft Entra ID per l'autenticazione.
Nome |
Tipo |
Descrizione |
aadAuthFailureMode
|
AadAuthFailureMode
|
Descrive la risposta che l'API del piano dati di un servizio di ricerca invia per le richieste che hanno avuto esito negativo nell'autenticazione.
|
DataPlaneAuthOptions
Definisce le opzioni per il modo in cui il servizio di ricerca autentica una richiesta del piano dati. Impossibile impostare se 'disableLocalAuth' è impostato su true.
Nome |
Tipo |
Descrizione |
aadOrApiKey
|
DataPlaneAadOrApiKeyAuthOption
|
Indica che è possibile usare la chiave API o un token di accesso da un tenant Microsoft Entra ID per l'autenticazione.
|
apiKeyOnly
|
ApiKeyOnly
|
Indica che solo la chiave API può essere usata per l'autenticazione.
|
EncryptionWithCmk
Descrive un criterio che determina il modo in cui le risorse all'interno del servizio di ricerca devono essere crittografate con chiavi gestite dal cliente.
Nome |
Tipo |
Descrizione |
encryptionComplianceStatus
|
SearchEncryptionComplianceStatus
|
Restituisce lo stato di conformità del servizio di ricerca rispetto agli oggetti non crittografati da CMK. Se un servizio ha più di un oggetto non crittografato e l'applicazione è abilitata, il servizio viene contrassegnato come non conforme.
|
enforcement
|
SearchEncryptionWithCmk
|
Viene descritto come un servizio di ricerca deve applicare la conformità se trova oggetti non crittografati con la chiave gestita dal cliente.
|
HostingMode
Applicabile solo per lo SKU Standard3. È possibile impostare questa proprietà per abilitare fino a 3 partizioni ad alta densità che consentono fino a 1000 indici, che sono molto più elevati rispetto agli indici massimi consentiti per qualsiasi altro SKU. Per lo SKU standard3, il valore è "default" o "highDensity". Per tutti gli altri SKU, questo valore deve essere 'default'.
Nome |
Tipo |
Descrizione |
default
|
string
|
Il limite per il numero di indici è determinato dai limiti predefiniti per lo SKU.
|
highDensity
|
string
|
Solo l'applicazione per lo SKU Standard3, in cui il servizio di ricerca può avere fino a 1000 indici.
|
Identity
Informazioni dettagliate sull'identità del servizio di ricerca. Un valore Null indica che il servizio di ricerca non ha identità assegnata.
Nome |
Tipo |
Descrizione |
principalId
|
string
|
ID principale dell'identità assegnata dal sistema del servizio di ricerca.
|
tenantId
|
string
|
ID tenant dell'identità assegnata dal sistema del servizio di ricerca.
|
type
|
IdentityType
|
Tipo di identità utilizzata per la risorsa. Il tipo 'SystemAssigned, UserAssigned' include sia un'identità creata dal sistema che un set di identità assegnate dall'utente. Il tipo 'Nessuno' rimuoverà tutte le identità dal servizio.
|
userAssignedIdentities
|
<string,
UserAssignedManagedIdentity>
|
Elenco delle identità utente associate alla risorsa. I riferimenti alla chiave del dizionario identità utente saranno ID risorsa ARM nel formato :/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
|
IdentityType
Tipo di identità usata per la risorsa. Il tipo "SystemAssigned, UserAssigned" include sia un'identità creata dal sistema che un set di identità assegnate dall'utente. Il tipo "Nessuno" rimuoverà tutte le identità dal servizio.
Nome |
Tipo |
Descrizione |
None
|
string
|
Indica che è necessario rimuovere qualsiasi identità associata al servizio di ricerca.
|
SystemAssigned
|
string
|
Indica che l'identità assegnata dal sistema per il servizio di ricerca verrà abilitata.
|
SystemAssigned, UserAssigned
|
string
|
Indica che l'identità assegnata dal sistema per il servizio di ricerca verrà abilitata insieme all'assegnazione di una o più identità assegnate dall'utente.
|
UserAssigned
|
string
|
Indica che una o più identità assegnate dall'utente verranno assegnate al servizio di ricerca.
|
IpRule
Regola di restrizione IP del servizio di ricerca di intelligenza artificiale di Azure.
Nome |
Tipo |
Descrizione |
value
|
string
|
Valore corrispondente a un singolo indirizzo IPv4 (ad esempio, 123.1.2.3) o a un intervallo IP in formato CIDR (ad esempio, 123.1.2.3/24) da consentire.
|
NetworkRuleSet
Regole specifiche della rete che determinano il modo in cui è possibile raggiungere il servizio di ricerca di Intelligenza artificiale di Azure.
Nome |
Tipo |
Descrizione |
bypass
|
SearchBypass
|
Origini possibili del traffico in ingresso che possono ignorare le regole definite nella sezione 'ipRules'.
|
ipRules
|
IpRule[]
|
Elenco delle regole di restrizione IP che definisce le reti in ingresso con la possibilità di accedere all'endpoint del servizio di ricerca. Nel frattempo, tutte le altre reti IP pubbliche vengono bloccate dal firewall. Queste regole di restrizione vengono applicate solo quando il 'publicNetworkAccess' del servizio di ricerca è 'abilitato'; in caso contrario, il traffico sull'interfaccia pubblica non è consentito anche con le regole IP pubbliche e le connessioni endpoint private sarebbero il metodo di accesso esclusivo.
|
PrivateEndpoint
Risorsa endpoint privato dal provider Microsoft.Network.
Nome |
Tipo |
Descrizione |
id
|
string
|
ID risorsa della risorsa endpoint privato del provider Microsoft.Network.
|
PrivateEndpointConnection
Descrive una connessione endpoint privato esistente alla servizio di ricerca di Intelligenza artificiale di Azure.
Nome |
Tipo |
Descrizione |
id
|
string
|
ID di risorsa completo per la risorsa. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
|
name
|
string
|
nome della risorsa.
|
properties
|
PrivateEndpointConnectionProperties
|
Descrive le proprietà di una connessione dell'endpoint privato esistente alla servizio di ricerca di intelligenza artificiale di Azure.
|
type
|
string
|
Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"
|
PrivateEndpointConnectionProperties
Descrive le proprietà di una connessione di endpoint privato esistente al servizio di ricerca.
Nome |
Tipo |
Descrizione |
groupId
|
string
|
ID gruppo della risorsa di Azure per cui è destinato il servizio di collegamento privato.
|
privateEndpoint
|
PrivateEndpoint
|
Risorsa endpoint privato dal provider Microsoft.Network.
|
privateLinkServiceConnectionState
|
PrivateLinkServiceConnectionState
|
Descrive lo stato corrente di una connessione al servizio collegamento privato di Azure esistente all'endpoint privato.
|
provisioningState
|
PrivateLinkServiceConnectionProvisioningState
|
Stato di provisioning della connessione al servizio di collegamento privato. I valori validi sono Aggiornamento, Eliminazione, Operazione non riuscita, Completata, Incompleta o Annullata.
|
PrivateLinkServiceConnectionProvisioningState
Stato di provisioning della connessione al servizio di collegamento privato. I valori validi sono Aggiornamento, Eliminazione, Operazione non riuscita, Completata, Incompleta o Annullata.
Nome |
Tipo |
Descrizione |
Canceled
|
string
|
La richiesta di provisioning per la risorsa di connessione al servizio di collegamento privato è stata annullata.
|
Deleting
|
string
|
La connessione al servizio di collegamento privato è in corso di eliminazione.
|
Failed
|
string
|
Impossibile eseguire il provisioning o l'eliminazione della connessione al servizio collegamento privato.
|
Incomplete
|
string
|
La richiesta di provisioning per la risorsa di connessione al servizio collegamento privato è stata accettata, ma il processo di creazione non è ancora iniziato.
|
Succeeded
|
string
|
Il provisioning della connessione al servizio collegamento privato è stato completato ed è pronto per l'approvazione.
|
Updating
|
string
|
La connessione al servizio di collegamento privato è in corso di creazione insieme ad altre risorse affinché sia completamente funzionante.
|
PrivateLinkServiceConnectionState
Descrive lo stato corrente di una connessione al servizio collegamento privato di Azure esistente all'endpoint privato.
Nome |
Tipo |
Valore predefinito |
Descrizione |
actionsRequired
|
string
|
None
|
Descrizione di eventuali azioni aggiuntive che possono essere necessarie.
|
description
|
string
|
|
Descrizione dello stato di connessione del servizio di collegamento privato.
|
status
|
PrivateLinkServiceConnectionStatus
|
|
Stato della connessione al servizio di collegamento privato. I valori validi sono In sospeso, Approvato, Rifiutato o Disconnesso.
|
PrivateLinkServiceConnectionStatus
Stato della connessione al servizio di collegamento privato. I valori validi sono In sospeso, Approvato, Rifiutato o Disconnesso.
Nome |
Tipo |
Descrizione |
Approved
|
string
|
La connessione all'endpoint privato è approvata ed è pronta per l'uso.
|
Disconnected
|
string
|
La connessione all'endpoint privato è stata rimossa dal servizio.
|
Pending
|
string
|
La connessione all'endpoint privato è stata creata ed è in attesa di approvazione.
|
Rejected
|
string
|
La connessione all'endpoint privato è stata rifiutata e non può essere usata.
|
ProvisioningState
Stato dell'ultima operazione di provisioning eseguita nel servizio di ricerca. Il provisioning è uno stato intermedio che si verifica quando viene stabilita la capacità del servizio. Dopo la configurazione della capacità, provisioningState viene modificato in "succeeded" o "failed". Le applicazioni client possono eseguire il polling dello stato di provisioning (l'intervallo di polling consigliato è compreso tra 30 secondi e un minuto) usando l'operazione Get Search Service per verificare quando viene completata un'operazione. Se si usa il servizio gratuito, questo valore tende a tornare come "riuscito" direttamente nella chiamata a Crea servizio di ricerca. Ciò avviene perché il servizio gratuito utilizza una capacità che è già configurata.
Nome |
Tipo |
Descrizione |
failed
|
string
|
L'ultima operazione di provisioning non è riuscita.
|
provisioning
|
string
|
È in corso il provisioning del servizio di ricerca o l'aumento o la riduzione delle prestazioni.
|
succeeded
|
string
|
L'ultima operazione di provisioning è stata completata correttamente.
|
PublicNetworkAccess
Questo valore può essere impostato su "abilitato" per evitare modifiche di rilievo nelle risorse e nei modelli dei clienti esistenti. Se impostato su "disabilitato", il traffico sull'interfaccia pubblica non è consentito e le connessioni endpoint private saranno il metodo di accesso esclusivo.
Nome |
Tipo |
Descrizione |
disabled
|
string
|
Il servizio di ricerca non è accessibile dal traffico proveniente dalla rete Internet pubblica. L'accesso è consentito solo tramite le connessioni endpoint private approvate.
|
enabled
|
string
|
Il servizio di ricerca è accessibile dal traffico proveniente dalla rete Internet pubblica.
|
SearchBypass
Origini possibili del traffico in ingresso che possono ignorare le regole definite nella sezione 'ipRules'.
Nome |
Tipo |
Descrizione |
AzurePortal
|
string
|
Indica che le richieste provenienti dal portale di Azure possono ignorare le regole definite nella sezione 'ipRules'.
|
None
|
string
|
Indica che nessuna origine può ignorare le regole definite nella sezione 'ipRules'. Questo è il valore predefinito.
|
SearchDisabledDataExfiltrationOption
Elenco di scenari di esfiltrazione dei dati non consentiti in modo esplicito per il servizio di ricerca. Attualmente, l'unico valore supportato è "All" per disabilitare tutti gli scenari di esportazione dei dati possibili con controlli più granulari pianificati per il futuro.
Nome |
Tipo |
Descrizione |
All
|
string
|
Indica che tutti gli scenari di esfiltrazione dei dati sono disabilitati.
|
SearchEncryptionComplianceStatus
Restituisce lo stato di conformità del servizio di ricerca rispetto agli oggetti non crittografati da CMK. Se un servizio ha più di un oggetto non crittografato e l'imposizione è abilitata, il servizio viene contrassegnato come non conforme.
Nome |
Tipo |
Descrizione |
Compliant
|
string
|
Indica che il servizio di ricerca è conforme perché il numero di oggetti non crittografati da CMK è zero o l'imposizione è disabilitata.
|
NonCompliant
|
string
|
Indica che il servizio di ricerca dispone di più oggetti non crittografati da CMK.
|
SearchEncryptionWithCmk
Descrive in che modo un servizio di ricerca deve applicare la conformità se trova oggetti non crittografati con la chiave gestita dal cliente.
Nome |
Tipo |
Descrizione |
Disabled
|
string
|
Non verrà eseguita alcuna imposizione della crittografia della chiave gestita dal cliente. Viene usata solo la crittografia gestita dal servizio predefinita.
|
Enabled
|
string
|
servizio di ricerca verrà contrassegnato come non conforme se uno o più oggetti non sono crittografati con una chiave gestita dal cliente.
|
Unspecified
|
string
|
I criteri di imposizione non vengono specificati in modo esplicito, con il comportamento che corrisponde a se fosse impostato su "Disabilitato".
|
SearchSemanticSearch
Imposta le opzioni che controllano la disponibilità della ricerca semantica. Questa configurazione è possibile solo per determinati SKU di Ricerca intelligenza artificiale di Azure in determinate posizioni.
Nome |
Tipo |
Descrizione |
disabled
|
string
|
Indica che il reranker semantico è disabilitato per il servizio di ricerca. Questo è il valore predefinito.
|
free
|
string
|
Abilita il reranker semantico in un servizio di ricerca e indica che deve essere usato entro i limiti del piano gratuito. Il piano gratuito limiterebbe il volume di richieste di classificazione semantica e viene offerto senza costi aggiuntivi. Si tratta dell'impostazione predefinita per i servizi di ricerca di cui è stato appena effettuato il provisioning.
|
standard
|
string
|
Abilita il reranker semantico in un servizio di ricerca come funzionalità fatturabile, con una velocità effettiva e un volume più elevati di query con classificazione semantica.
|
SearchService
Descrive un servizio di ricerca di intelligenza artificiale di Azure e il relativo stato corrente.
Nome |
Tipo |
Valore predefinito |
Descrizione |
id
|
string
|
|
ID di risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
|
identity
|
Identity
|
|
Identità della risorsa.
|
location
|
string
|
|
Posizione geografica in cui vive la risorsa
|
name
|
string
|
|
nome della risorsa.
|
properties.authOptions
|
DataPlaneAuthOptions
|
|
Definisce le opzioni per il modo in cui l'API del piano dati di un servizio di ricerca autentica le richieste. Impossibile impostare se 'disableLocalAuth' è impostato su true.
|
properties.disableLocalAuth
|
boolean
|
|
Se impostato su true, le chiamate al servizio di ricerca non saranno consentite per l'uso delle chiavi API per l'autenticazione. Impossibile impostare su true se sono definiti 'dataPlaneAuthOptions'.
|
properties.disabledDataExfiltrationOptions
|
SearchDisabledDataExfiltrationOption[]
|
|
Elenco di scenari di esfiltrazione dei dati non consentiti in modo esplicito per il servizio di ricerca. Attualmente, l'unico valore supportato è "All" per disabilitare tutti gli scenari di esportazione dei dati possibili con controlli più granulari pianificati per il futuro.
|
properties.eTag
|
string
|
|
Proprietà generata dal sistema che rappresenta l'etag del servizio che può essere per il controllo di concorrenza ottimistica durante gli aggiornamenti.
|
properties.encryptionWithCmk
|
EncryptionWithCmk
|
|
Specifica tutti i criteri relativi alla crittografia delle risorse (ad esempio gli indici) usando le chiavi del customer manager all'interno di un servizio di ricerca.
|
properties.hostingMode
|
HostingMode
|
default
|
Applicabile solo per lo SKU standard3. È possibile impostare questa proprietà per abilitare fino a 3 partizioni ad alta densità che consentono fino a 1000 indici, che sono molto superiori agli indici massimi consentiti per qualsiasi altro SKU. Per lo SKU standard3, il valore è "predefinito" o "highDensity". Per tutti gli altri SKU, questo valore deve essere "predefinito".
|
properties.networkRuleSet
|
NetworkRuleSet
|
|
Regole specifiche della rete che determinano il modo in cui è possibile raggiungere il servizio di ricerca di Intelligenza artificiale di Azure.
|
properties.partitionCount
|
integer
|
1
|
Numero di partizioni nel servizio di ricerca; se specificato, può essere 1, 2, 3, 4, 6 o 12. I valori maggiori di 1 sono validi solo per SKU standard. Per i servizi 'standard3' con hostingMode impostato su 'highDensity', i valori consentiti sono compresi tra 1 e 3.
|
properties.privateEndpointConnections
|
PrivateEndpointConnection[]
|
|
Elenco delle connessioni dell'endpoint privato all'servizio di ricerca di intelligenza artificiale di Azure.
|
properties.provisioningState
|
ProvisioningState
|
|
Stato dell'ultima operazione di provisioning eseguita nel servizio di ricerca. Il provisioning è uno stato intermedio che si verifica quando viene stabilita la capacità del servizio. Dopo aver configurato la capacità, provisioningState cambia in "riuscito" o "non riuscito". Le applicazioni client possono eseguire il polling dello stato di provisioning (l'intervallo di polling consigliato è compreso tra 30 secondi e un minuto) usando l'operazione Get Search Service per verificare quando viene completata un'operazione. Se si usa il servizio gratuito, questo valore tende a tornare come "riuscito" direttamente nella chiamata a Crea servizio di ricerca. Ciò avviene perché il servizio gratuito utilizza una capacità che è già configurata.
|
properties.publicNetworkAccess
|
PublicNetworkAccess
|
enabled
|
Questo valore può essere impostato su "abilitato" per evitare modifiche di rilievo sulle risorse e i modelli dei clienti esistenti. Se impostato su "disabilitato", il traffico sull'interfaccia pubblica non è consentito e le connessioni endpoint private sarebbero il metodo di accesso esclusivo.
|
properties.replicaCount
|
integer
|
1
|
Numero di repliche nel servizio di ricerca. Se specificato, deve essere un valore compreso tra 1 e 12 inclusi per SKU standard o tra 1 e 3 inclusi per SKU di base.
|
properties.semanticSearch
|
SearchSemanticSearch
|
|
Imposta le opzioni che controllano la disponibilità della ricerca semantica. Questa configurazione è possibile solo per determinati SKU di Ricerca intelligenza artificiale di Azure in determinate posizioni.
|
properties.sharedPrivateLinkResources
|
SharedPrivateLinkResource[]
|
|
Elenco delle risorse di collegamento privato condivise gestite dal servizio di ricerca di Intelligenza artificiale di Azure.
|
properties.status
|
SearchServiceStatus
|
|
Stato del servizio di ricerca. I valori possibili includono: "in esecuzione": il servizio di ricerca è in esecuzione e non sono in corso operazioni di provisioning. 'provisioning': il servizio di ricerca viene effettuato il provisioning o il ridimensionamento o la riduzione. 'delete': il servizio di ricerca viene eliminato. "degradato": il servizio di ricerca è danneggiato. Ciò può verificarsi quando le unità di ricerca sottostanti non sono integre. Il servizio di ricerca è probabilmente operativo, ma le prestazioni potrebbero essere lente e alcune richieste potrebbero essere eliminate. 'disabilitato': il servizio di ricerca è disabilitato. In questo stato, il servizio rifiuterà tutte le richieste API. 'error': il servizio di ricerca si trova in uno stato di errore. 'arrestato': il servizio di ricerca si trova in una sottoscrizione disabilitata. Se il servizio si trova negli stati di errore, disabilitati o degradati, significa che il team di Ricerca intelligenza artificiale di Azure sta analizzando attivamente il problema sottostante. I servizi dedicati in questi stati sono ancora addebitabili in base al numero di unità di ricerca di cui è stato effettuato il provisioning.
|
properties.statusDetails
|
string
|
|
Dettagli dello stato del servizio di ricerca.
|
sku
|
Sku
|
|
SKU del servizio di ricerca, che determina i limiti di prezzo e capacità. Questa proprietà è necessaria quando si crea un nuovo servizio di ricerca.
|
tags
|
object
|
|
Tag di risorse.
|
type
|
string
|
|
Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"
|
SearchServiceStatus
Stato del servizio di ricerca. I valori possibili includono: 'running': il servizio di ricerca è in esecuzione e non sono in corso operazioni di provisioning. 'provisioning': viene effettuato il provisioning o la riduzione del servizio di ricerca. 'delete': il servizio di ricerca viene eliminato. "degradato": il servizio di ricerca è danneggiato. Ciò può verificarsi quando le unità di ricerca sottostanti non sono integre. Il servizio di ricerca è molto probabilmente operativo, ma le prestazioni potrebbero essere lente e alcune richieste potrebbero essere eliminate. 'disabled': il servizio di ricerca è disabilitato. In questo stato, il servizio rifiuterà tutte le richieste API. 'error': il servizio di ricerca si trova in uno stato di errore. 'stopped': il servizio di ricerca si trova in una sottoscrizione disabilitata. Se il servizio si trova negli stati di errore, disabilitati o degradati, significa che il team di Ricerca intelligenza artificiale di Azure sta esaminando attivamente il problema sottostante. I servizi dedicati in questi stati sono ancora addebitabili in base al numero di unità di ricerca di cui è stato effettuato il provisioning.
Nome |
Tipo |
Descrizione |
degraded
|
string
|
Il servizio di ricerca è danneggiato perché le unità di ricerca sottostanti non sono integre.
|
deleting
|
string
|
Il servizio di ricerca viene eliminato.
|
disabled
|
string
|
Il servizio di ricerca è disabilitato e tutte le richieste API verranno rifiutate.
|
error
|
string
|
Lo stato del servizio di ricerca è in stato di errore, che indica un errore durante il provisioning o l'eliminazione.
|
provisioning
|
string
|
È in corso il provisioning del servizio di ricerca o l'aumento o la riduzione delle prestazioni.
|
running
|
string
|
Il servizio di ricerca è in esecuzione e non sono in corso operazioni di provisioning.
|
stopped
|
string
|
Il servizio di ricerca si trova in una sottoscrizione disabilitata.
|
SearchServiceUpdate
I parametri usati per aggiornare un servizio di ricerca di intelligenza artificiale di Azure.
Nome |
Tipo |
Valore predefinito |
Descrizione |
id
|
string
|
|
ID di risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
|
identity
|
Identity
|
|
Dettagli sull'identità del servizio di ricerca. Un valore Null indica che al servizio di ricerca non è assegnata alcuna identità.
|
location
|
string
|
|
Posizione geografica della risorsa. Deve trattarsi di una delle aree geografiche di Azure supportate e registrate, ad esempio Stati Uniti occidentali, Stati Uniti orientali, Asia sud-orientale e così via. Questa proprietà è necessaria durante la creazione di una nuova risorsa.
|
name
|
string
|
|
nome della risorsa.
|
properties.authOptions
|
DataPlaneAuthOptions
|
|
Definisce le opzioni per il modo in cui l'API del piano dati di un servizio di ricerca autentica le richieste. Questa impostazione non può essere impostata se 'disableLocalAuth' è impostato su true.
|
properties.disableLocalAuth
|
boolean
|
|
Se impostato su true, le chiamate al servizio di ricerca non saranno autorizzate a usare le chiavi API per l'autenticazione. Questa impostazione non può essere impostata su true se sono definiti "dataPlaneAuthOptions".
|
properties.disabledDataExfiltrationOptions
|
SearchDisabledDataExfiltrationOption[]
|
|
Elenco di scenari di esfiltrazione dei dati che non sono esplicitamente consentiti per il servizio di ricerca. Attualmente, l'unico valore supportato è "All" per disabilitare tutti i possibili scenari di esportazione dei dati con controlli più granulari pianificati per il futuro.
|
properties.eTag
|
string
|
|
Proprietà generata dal sistema che rappresenta l'etag del servizio che può essere per il controllo della concorrenza ottimistica durante gli aggiornamenti.
|
properties.encryptionWithCmk
|
EncryptionWithCmk
|
|
Specifica i criteri relativi alla crittografia delle risorse (ad esempio gli indici) usando le chiavi del customer manager all'interno di un servizio di ricerca.
|
properties.hostingMode
|
HostingMode
|
default
|
Applicabile solo per lo SKU Standard3. È possibile impostare questa proprietà per abilitare fino a 3 partizioni ad alta densità che consentono fino a 1000 indici, che sono molto più elevati rispetto agli indici massimi consentiti per qualsiasi altro SKU. Per lo SKU standard3, il valore è "default" o "highDensity". Per tutti gli altri SKU, questo valore deve essere 'default'.
|
properties.networkRuleSet
|
NetworkRuleSet
|
|
Regole specifiche della rete che determinano il modo in cui è possibile raggiungere il servizio di ricerca di intelligenza artificiale di Azure.
|
properties.partitionCount
|
integer
|
1
|
Numero di partizioni nel servizio di ricerca; se specificato, può essere 1, 2, 3, 4, 6 o 12. I valori maggiori di 1 sono validi solo per gli SKU standard. Per i servizi 'standard3' con hostingMode impostato su 'highDensity', i valori consentiti sono compresi tra 1 e 3.
|
properties.privateEndpointConnections
|
PrivateEndpointConnection[]
|
|
Elenco di connessioni di endpoint privato al servizio di ricerca di intelligenza artificiale di Azure.
|
properties.provisioningState
|
ProvisioningState
|
|
Stato dell'ultima operazione di provisioning eseguita nel servizio di ricerca. Il provisioning è uno stato intermedio che si verifica quando viene stabilita la capacità del servizio. Dopo la configurazione della capacità, provisioningState viene modificato in "succeeded" o "failed". Le applicazioni client possono eseguire il polling dello stato di provisioning (l'intervallo di polling consigliato è compreso tra 30 secondi e un minuto) usando l'operazione Get Search Service per verificare quando viene completata un'operazione. Se si usa il servizio gratuito, questo valore tende a tornare come "riuscito" direttamente nella chiamata a Crea servizio di ricerca. Ciò avviene perché il servizio gratuito utilizza una capacità che è già configurata.
|
properties.publicNetworkAccess
|
PublicNetworkAccess
|
enabled
|
Questo valore può essere impostato su "abilitato" per evitare modifiche di rilievo nelle risorse e nei modelli dei clienti esistenti. Se impostato su "disabilitato", il traffico sull'interfaccia pubblica non è consentito e le connessioni endpoint private saranno il metodo di accesso esclusivo.
|
properties.replicaCount
|
integer
|
1
|
Numero di repliche nel servizio di ricerca. Se specificato, deve essere un valore compreso tra 1 e 12 inclusi per GLI SKU standard o compreso tra 1 e 3 inclusi per lo SKU basic.
|
properties.semanticSearch
|
SearchSemanticSearch
|
|
Imposta le opzioni che controllano la disponibilità della ricerca semantica. Questa configurazione è possibile solo per determinati SKU di Ricerca intelligenza artificiale di Azure in determinate posizioni.
|
properties.sharedPrivateLinkResources
|
SharedPrivateLinkResource[]
|
|
Elenco delle risorse di collegamento privato condivise gestite dal servizio di ricerca di intelligenza artificiale di Azure.
|
properties.status
|
SearchServiceStatus
|
|
Stato del servizio di ricerca. I valori possibili includono: 'running': il servizio di ricerca è in esecuzione e non sono in corso operazioni di provisioning. 'provisioning': viene effettuato il provisioning o la riduzione del servizio di ricerca. 'delete': il servizio di ricerca viene eliminato. "degradato": il servizio di ricerca è danneggiato. Ciò può verificarsi quando le unità di ricerca sottostanti non sono integre. Il servizio di ricerca è molto probabilmente operativo, ma le prestazioni potrebbero essere lente e alcune richieste potrebbero essere eliminate. 'disabled': il servizio di ricerca è disabilitato. In questo stato, il servizio rifiuterà tutte le richieste API. 'error': il servizio di ricerca si trova in uno stato di errore. 'stopped': il servizio di ricerca si trova in una sottoscrizione disabilitata. Se il servizio si trova negli stati di errore, disabilitati o degradati, significa che il team di Ricerca intelligenza artificiale di Azure sta esaminando attivamente il problema sottostante. I servizi dedicati in questi stati sono ancora addebitabili in base al numero di unità di ricerca di cui è stato effettuato il provisioning.
|
properties.statusDetails
|
string
|
|
Dettagli dello stato del servizio di ricerca.
|
sku
|
Sku
|
|
SKU del servizio di ricerca, che determina i limiti di livello prezzo e capacità. Questa proprietà è necessaria quando si crea un nuovo servizio di ricerca.
|
tags
|
object
|
|
Tag che consentono di classificare la risorsa nel portale di Azure.
|
type
|
string
|
|
Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"
|
SharedPrivateLinkResource
Descrive una risorsa di collegamento privato condivisa gestita dalla servizio di ricerca di Intelligenza artificiale di Azure.
Nome |
Tipo |
Descrizione |
id
|
string
|
ID di risorsa completo per la risorsa. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
|
name
|
string
|
nome della risorsa.
|
properties
|
SharedPrivateLinkResourceProperties
|
Descrive le proprietà di una risorsa di collegamento privato condiviso gestita dalla servizio di ricerca di intelligenza artificiale di Azure.
|
type
|
string
|
Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"
|
SharedPrivateLinkResourceProperties
Descrive le proprietà di una risorsa di collegamento privato condiviso esistente gestita dal servizio di ricerca di Intelligenza artificiale di Azure.
Nome |
Tipo |
Descrizione |
groupId
|
string
|
L'ID gruppo del provider della risorsa per la risorsa di collegamento privato condiviso è per.
|
privateLinkResourceId
|
string
|
L'ID risorsa della risorsa a cui è destinata la risorsa collegamento privato condiviso.
|
provisioningState
|
SharedPrivateLinkResourceProvisioningState
|
Stato di provisioning della risorsa collegamento privato condiviso. I valori validi sono Aggiornamento, Eliminazione, Non riuscita, Operazione riuscita o Incompleta.
|
requestMessage
|
string
|
Messaggio per richiedere l'approvazione della risorsa di collegamento privato condiviso.
|
resourceRegion
|
string
|
facoltativo. Può essere usato per specificare il percorso di Resource Manager di Azure della risorsa per cui viene creato un collegamento privato condiviso. Questa operazione è necessaria solo per le risorse la cui configurazione DNS è a livello di area, ad esempio servizio Azure Kubernetes.
|
status
|
SharedPrivateLinkResourceStatus
|
Stato della risorsa collegamento privato condiviso. I valori validi sono In sospeso, Approvato, Rifiutato o Disconnesso.
|
SharedPrivateLinkResourceProvisioningState
Stato di provisioning della risorsa collegamento privato condiviso. I valori validi sono Aggiornamento, Eliminazione, Non riuscita, Operazione riuscita o Incompleta.
Nome |
Tipo |
Descrizione |
Deleting
|
string
|
La risorsa di collegamento privato condiviso è in fase di eliminazione.
|
Failed
|
string
|
Il provisioning o l'eliminazione della risorsa collegamento privato condiviso non è riuscita.
|
Incomplete
|
string
|
La richiesta di provisioning per la risorsa di collegamento privato condiviso è stata accettata, ma il processo di creazione non è ancora iniziato.
|
Succeeded
|
string
|
Il provisioning della risorsa collegamento privato condiviso è stato completato ed è pronto per l'approvazione.
|
Updating
|
string
|
La risorsa di collegamento privato condiviso è in fase di creazione insieme ad altre risorse perché sia completamente funzionante.
|
SharedPrivateLinkResourceStatus
Stato della risorsa collegamento privato condiviso. I valori validi sono In sospeso, Approvato, Rifiutato o Disconnesso.
Nome |
Tipo |
Descrizione |
Approved
|
string
|
La risorsa collegamento privato condiviso è approvata ed è pronta per l'uso.
|
Disconnected
|
string
|
La risorsa collegamento privato condiviso è stata rimossa dal servizio.
|
Pending
|
string
|
La risorsa di collegamento privato condiviso è stata creata ed è in attesa di approvazione.
|
Rejected
|
string
|
La risorsa di collegamento privato condiviso è stata rifiutata e non può essere usata.
|
Sku
Definisce lo SKU di un servizio di ricerca, che determina i limiti di fatturazione e capacità.
Nome |
Tipo |
Descrizione |
name
|
SkuName
|
SKU del servizio di ricerca. I valori validi includono: 'free': Servizio condiviso. 'basic': servizio dedicato con un massimo di 3 repliche. 'standard': servizio dedicato con un massimo di 12 partizioni e 12 repliche. 'standard2': simile allo standard, ma con una maggiore capacità per ogni unità di ricerca. 'standard3': la più grande offerta Standard con un massimo di 12 partizioni e 12 repliche (o fino a 3 partizioni con più indici se si imposta anche la proprietà hostingMode su 'highDensity'). 'storage_optimized_l1': supporta 1 TB per partizione, fino a 12 partizioni. 'storage_optimized_l2': supporta 2 TB per partizione, fino a 12 partizioni.
|
SkuName
SKU del servizio di ricerca. I valori validi includono: 'free': Servizio condiviso. 'basic': servizio dedicato con un massimo di 3 repliche. 'standard': servizio dedicato con un massimo di 12 partizioni e 12 repliche. 'standard2': simile allo standard, ma con una maggiore capacità per ogni unità di ricerca. 'standard3': la più grande offerta Standard con un massimo di 12 partizioni e 12 repliche (o fino a 3 partizioni con più indici se si imposta anche la proprietà hostingMode su 'highDensity'). 'storage_optimized_l1': supporta 1 TB per partizione, fino a 12 partizioni. 'storage_optimized_l2': supporta 2 TB per partizione, fino a 12 partizioni".
Nome |
Tipo |
Descrizione |
basic
|
string
|
Livello fatturabile per un servizio dedicato con un massimo di 3 repliche.
|
free
|
string
|
Livello gratuito, senza garanzie di contratto di servizio e un subset delle funzionalità offerte nei livelli fatturabili.
|
standard
|
string
|
Livello fatturabile per un servizio dedicato con un massimo di 12 partizioni e 12 repliche.
|
standard2
|
string
|
Simile a "standard", ma con una maggiore capacità per ogni unità di ricerca.
|
standard3
|
string
|
La più grande offerta Standard con un massimo di 12 partizioni e 12 repliche (o fino a 3 partizioni con più indici se si imposta anche la proprietà hostingMode su "highDensity").
|
storage_optimized_l1
|
string
|
Livello fatturabile per un servizio dedicato che supporta 1 TB per partizione, fino a 12 partizioni.
|
storage_optimized_l2
|
string
|
Livello fatturabile per un servizio dedicato che supporta 2 TB per partizione, fino a 12 partizioni.
|
UserAssignedManagedIdentity
Dettagli dell'identità gestita assegnata dall'utente assegnata al servizio di ricerca.
Nome |
Tipo |
Descrizione |
clientId
|
string
|
ID client dell'identità assegnata dall'utente.
|
principalId
|
string
|
ID principale dell'identità assegnata dall'utente.
|