Services - Get

Referentie

Service:: Search Management

API-versie:: 2023-11-01

Hiermee haalt u de zoekservice op met de opgegeven naam in de opgegeven resourcegroep.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}?api-version=2023-11-01

URI-parameters

Name	In	Vereist	Type	Description
resourceGroupName	path	True	string	De naam van de resourcegroep binnen het huidige abonnement. U kunt deze waarde verkrijgen via de Azure Resource Manager-API of de portal.
searchServiceName	path	True	string	De naam van de zoekservice die is gekoppeld aan de opgegeven resourcegroep.
subscriptionId	path	True	string	De unieke id voor een Microsoft Azure-abonnement. U kunt deze waarde verkrijgen via de Azure Resource Manager-API, opdrachtregelprogramma's of de portal.
api-version	query	True	string	De API-versie die voor elke aanvraag moet worden gebruikt.

Aanvraagkoptekst

Name	Vereist	Type	Description
x-ms-client-request-id		string (uuid)	Een door de client gegenereerde GUID-waarde die deze aanvraag identificeert. Indien opgegeven, wordt dit opgenomen in antwoordinformatie als een manier om de aanvraag bij te houden.

Antwoorden

Name	Type	Description
200 OK	SearchService	De definitie van de zoekservice is opgehaald en staat in het antwoord. Als u zoekt naar de voltooiing van een inrichtings- of schaalbewerking, kunt u de status ervan controleren via de eigenschap provisioningState.
Other Status Codes	CloudError	HTTP 404 (niet gevonden): de naam van het abonnement, de resourcegroep of de zoekservice is niet gevonden.

Beveiliging

azure_auth

Autorisatiestroom voor Microsoft Entra-id OAuth2.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

SearchGetService

Voorbeeldaanvraag

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2023-11-01


/**
 * Samples for Services GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchGetService.json
     */
    /**
     * Sample code: SearchGetService.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void searchGetService(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.searchServices().manager().serviceClient().getServices().getByResourceGroupWithResponse("rg1",
            "mysearchservice", null, com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential
from azure.mgmt.search import SearchManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-search
# USAGE
    python search_get_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.get(
        resource_group_name="rg1",
        search_service_name="mysearchservice",
    )
    print(response)


# x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchGetService.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/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/search/armsearch"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7e29dd59eef13ef347d09e41a63f2585be77b3ca/specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchGetService.json
func ExampleServicesClient_Get() {
	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().Get(ctx, "rg1", "mysearchservice", &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"),
	// 	},
	// 	Properties: &armsearch.ServiceProperties{
	// 		HostingMode: to.Ptr(armsearch.HostingModeDefault),
	// 		NetworkRuleSet: &armsearch.NetworkRuleSet{
	// 			IPRules: []*armsearch.IPRule{
	// 			},
	// 		},
	// 		PartitionCount: to.Ptr[int32](1),
	// 		PrivateEndpointConnections: []*armsearch.PrivateEndpointConnection{
	// 		},
	// 		ProvisioningState: to.Ptr(armsearch.ProvisioningStateSucceeded),
	// 		PublicNetworkAccess: to.Ptr(armsearch.PublicNetworkAccessEnabled),
	// 		ReplicaCount: to.Ptr[int32](3),
	// 		Status: to.Ptr(armsearch.SearchServiceStatusRunning),
	// 		StatusDetails: to.Ptr(""),
	// 	},
	// 	SKU: &armsearch.SKU{
	// 		Name: to.Ptr(armsearch.SKUNameStandard),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { SearchManagementClient } = require("@azure/arm-search");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets the search service with the given name in the given resource group.
 *
 * @summary Gets the search service with the given name in the given resource group.
 * x-ms-original-file: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchGetService.json
 */
async function searchGetService() {
  const subscriptionId = process.env["SEARCH_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["SEARCH_RESOURCE_GROUP"] || "rg1";
  const searchServiceName = "mysearchservice";
  const credential = new DefaultAzureCredential();
  const client = new SearchManagementClient(credential, subscriptionId);
  const result = await client.services.get(resourceGroupName, searchServiceName);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Search;
using Azure.ResourceManager.Search.Models;

// Generated from example definition: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchGetService.json
// this example is just showing the usage of "Services_Get" 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
SearchServiceResource result = await searchService.GetAsync();

// 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

Voorbeeldrespons

Statuscode:: 200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice",
  "name": "mysearchservice",
  "location": "westus",
  "type": "Microsoft.Search/searchServices",
  "tags": {
    "app-name": "My e-commerce app"
  },
  "sku": {
    "name": "standard"
  },
  "properties": {
    "replicaCount": 3,
    "partitionCount": 1,
    "status": "running",
    "statusDetails": "",
    "hostingMode": "default",
    "provisioningState": "succeeded",
    "publicNetworkAccess": "enabled",
    "networkRuleSet": {
      "ipRules": []
    },
    "privateEndpointConnections": []
  }
}

Definities

Name	Description
AadAuthFailureMode	Beschrijft welke reactie de gegevensvlak-API van een zoekservice zou verzenden naar aanvragen die mislukte verificatie hebben.
ApiKeyOnly	Geeft aan dat alleen de API-sleutel kan worden gebruikt voor verificatie.
CloudError	Bevat informatie over een API-fout.
CloudErrorBody	Beschrijft een bepaalde API-fout met een foutcode en een bericht.
DataPlaneAadOrApiKeyAuthOption	Geeft aan dat de API-sleutel of een toegangstoken van een Microsoft Entra ID-tenant kan worden gebruikt voor verificatie.
DataPlaneAuthOptions	Definieert de opties voor hoe de zoekservice een aanvraag voor een gegevensvlak verifieert. Dit kan niet worden ingesteld als 'disableLocalAuth' is ingesteld op true.
EncryptionWithCmk	Beschrijft een beleid dat bepaalt hoe resources binnen de zoekservice moeten worden versleuteld met door de klant beheerde sleutels.
HostingMode	Alleen van toepassing op de standard3-SKU. U kunt deze eigenschap instellen om maximaal 3 high-densitypartities in te schakelen die maximaal 1000 indexen toestaan, wat veel hoger is dan de maximumindexen die zijn toegestaan voor elke andere SKU. Voor de standard3-SKU is de waarde 'standaard' of 'highDensity'. Voor alle andere SKU's moet deze waarde 'standaard' zijn.
Identity	Identiteit voor de resource.
IdentityType	Het identiteitstype.
IpRule	De IP-beperkingsregel van de zoekservice.
NetworkRuleSet	Netwerkspecifieke regels die bepalen hoe de zoekservice kan worden bereikt.
PrivateEndpoint	De privé-eindpuntresource van de Microsoft.Network-provider.
PrivateEndpointConnection	Beschrijft een bestaande privé-eindpuntverbinding met de zoekservice.
PrivateEndpointConnectionProperties	Beschrijft de eigenschappen van een bestaande privé-eindpuntverbinding met de zoekservice.
PrivateLinkServiceConnectionProvisioningState	De inrichtingsstatus van de private link-serviceverbinding. Geldige waarden zijn bijwerken, verwijderen, mislukt, geslaagd of onvolledig
PrivateLinkServiceConnectionState	Beschrijft de huidige status van een bestaande Private Link-serviceverbinding met het Privé-eindpunt van Azure.
PrivateLinkServiceConnectionStatus	Status van de private link-serviceverbinding. Geldige waarden zijn In behandeling, Goedgekeurd, Geweigerd of Verbroken.
ProvisioningState	De status van de laatste inrichtingsbewerking die wordt uitgevoerd op de zoekservice. Inrichten is een tussenliggende status die zich voordoet terwijl de servicecapaciteit tot stand wordt gebracht. Nadat de capaciteit is ingesteld, verandert provisioningState in 'succeeded' of 'failed'. Clienttoepassingen kunnen de inrichtingsstatus peilen (het aanbevolen polling-interval is van 30 seconden tot één minuut) met behulp van de bewerking Zoekservice ophalen om te zien wanneer een bewerking is voltooid. Als u de gratis service gebruikt, komt deze waarde meestal rechtstreeks terug als 'geslaagd' in de aanroep van de zoekservice maken. Dit komt doordat de gratis service gebruikmaakt van capaciteit die al is ingesteld.
PublicNetworkAccess	Deze waarde kan worden ingesteld op 'ingeschakeld' om te voorkomen dat bestaande klantbronnen en sjablonen fouten veroorzaken. Als deze optie is ingesteld op Uitgeschakeld, is verkeer via openbare interface niet toegestaan en zijn privé-eindpuntverbindingen de exclusieve toegangsmethode.
SearchEncryptionComplianceStatus	Beschrijft of de zoekservice wel of niet compatibel is met betrekking tot niet-door de klant versleutelde resources. Als een service meer dan één niet-klant versleutelde resource heeft en 'Afdwinging' is ingeschakeld, wordt de service gemarkeerd als 'nonCompliant'.
SearchEncryptionWithCmk	Beschrijft hoe een zoekservice een of meer niet-door de klant versleutelde resources moet afdwingen.
SearchSemanticSearch	Hiermee stelt u opties in waarmee de beschikbaarheid van semantische zoekopdrachten wordt ingesteld. Deze configuratie is alleen mogelijk voor bepaalde zoek-SKU's op bepaalde locaties.
SearchService	Beschrijft een zoekservice en de huidige status.
SearchServiceStatus	De status van de zoekservice. Mogelijke waarden zijn: 'wordt uitgevoerd': de zoekservice wordt uitgevoerd en er worden geen inrichtingsbewerkingen uitgevoerd. 'inrichting': de zoekservice wordt ingericht of omhoog of omlaag geschaald. 'verwijderen': de zoekservice wordt verwijderd. 'gedegradeerd': de zoekservice is gedegradeerd. Dit kan gebeuren wanneer de onderliggende zoekeenheden niet in orde zijn. De zoekservice is waarschijnlijk operationeel, maar de prestaties kunnen traag zijn en sommige aanvragen kunnen worden verwijderd. 'uitgeschakeld': de zoekservice is uitgeschakeld. In deze status weigert de service alle API-aanvragen. 'error': de zoekservice heeft een foutstatus. Als uw service in de gedegradeerde, uitgeschakelde of foutstatussen staat, onderzoekt Microsoft het onderliggende probleem actief. Toegewezen services in deze statussen zijn nog steeds in rekening gebracht op basis van het aantal ingerichte zoekeenheden.
SharedPrivateLinkResource	Beschrijft een Gedeelde Private Link-resource die wordt beheerd door de zoekservice.
SharedPrivateLinkResourceProperties	Beschrijft de eigenschappen van een bestaande Shared Private Link-resource die wordt beheerd door de zoekservice.
SharedPrivateLinkResourceProvisioningState	De inrichtingsstatus van de gedeelde private link-resource. Geldige waarden zijn bijwerken, verwijderen, mislukt, geslaagd of onvolledig.
SharedPrivateLinkResourceStatus	Status van de gedeelde private link-resource. Geldige waarden zijn in behandeling, goedgekeurd, geweigerd of verbroken.
Sku	Definieert de SKU van een zoekservice, waarmee de factureringsfrequentie en capaciteitslimieten worden bepaald.
SkuName	De SKU van de zoekservice. Geldige waarden zijn: 'gratis': Gedeelde service. 'basic': toegewezen service met maximaal 3 replica's. 'standaard': toegewezen service met maximaal 12 partities en 12 replica's. 'standard2': vergelijkbaar met standaard, maar met meer capaciteit per zoekeenheid. 'standard3': de grootste Standard-aanbieding met maximaal 12 partities en 12 replica's (of maximaal 3 partities met meer indexen als u ook de eigenschap hostingMode instelt op 'highDensity'). 'storage_optimized_l1': ondersteunt 1 TB per partitie, maximaal 12 partities. 'storage_optimized_l2': ondersteunt 2 TB per partitie, maximaal 12 partities.'

AadAuthFailureMode

Inventarisatie

Beschrijft welke reactie de gegevensvlak-API van een zoekservice zou verzenden naar aanvragen die mislukte verificatie hebben.

Waarde	Description
http401WithBearerChallenge	Geeft aan dat aanvragen die mislukte verificatie moeten worden weergegeven met een HTTP-statuscode van 401 (niet geautoriseerd) en een Bearer-uitdaging presenteren.
http403	Geeft aan dat aanvragen die mislukte verificatie moeten worden weergegeven met een HTTP-statuscode van 403 (verboden).

ApiKeyOnly

Object

Geeft aan dat alleen de API-sleutel kan worden gebruikt voor verificatie.

CloudError

Object

Bevat informatie over een API-fout.

Name	Type	Description
error	CloudErrorBody	Beschrijft een bepaalde API-fout met een foutcode en een bericht.

CloudErrorBody

Object

Beschrijft een bepaalde API-fout met een foutcode en een bericht.

Name	Type	Description
code	string	Een foutcode die de foutvoorwaarde nauwkeuriger beschrijft dan een HTTP-statuscode. Kan worden gebruikt om programmatisch specifieke foutcases af te handelen.
details	CloudErrorBody[]	Bevat geneste fouten die betrekking hebben op deze fout.
message	string	Een bericht met een gedetailleerde beschrijving van de fout en informatie over foutopsporing.
target	string	Het doel van de specifieke fout (bijvoorbeeld de naam van de eigenschap in fout).

DataPlaneAadOrApiKeyAuthOption

Object

Geeft aan dat de API-sleutel of een toegangstoken van een Microsoft Entra ID-tenant kan worden gebruikt voor verificatie.

Name	Type	Description
aadAuthFailureMode	AadAuthFailureMode	Beschrijft welke reactie de gegevensvlak-API van een zoekservice zou verzenden naar aanvragen die mislukte verificatie hebben.

DataPlaneAuthOptions

Object

Definieert de opties voor hoe de zoekservice een aanvraag voor een gegevensvlak verifieert. Dit kan niet worden ingesteld als 'disableLocalAuth' is ingesteld op true.

Name	Type	Description
aadOrApiKey	DataPlaneAadOrApiKeyAuthOption	Geeft aan dat de API-sleutel of een toegangstoken van een Microsoft Entra ID-tenant kan worden gebruikt voor verificatie.
apiKeyOnly	ApiKeyOnly	Geeft aan dat alleen de API-sleutel kan worden gebruikt voor verificatie.

EncryptionWithCmk

Object

Beschrijft een beleid dat bepaalt hoe resources binnen de zoekservice moeten worden versleuteld met door de klant beheerde sleutels.

Name	Type	Description
encryptionComplianceStatus	SearchEncryptionComplianceStatus	Beschrijft of de zoekservice wel of niet compatibel is met betrekking tot niet-door de klant versleutelde resources. Als een service meer dan één niet-klant versleutelde resource heeft en 'Afdwinging' is ingeschakeld, wordt de service gemarkeerd als 'nonCompliant'.
enforcement	SearchEncryptionWithCmk	Beschrijft hoe een zoekservice een of meer niet-door de klant versleutelde resources moet afdwingen.

HostingMode

Inventarisatie

Alleen van toepassing op de standard3-SKU. U kunt deze eigenschap instellen om maximaal 3 high-densitypartities in te schakelen die maximaal 1000 indexen toestaan, wat veel hoger is dan de maximumindexen die zijn toegestaan voor elke andere SKU. Voor de standard3-SKU is de waarde 'standaard' of 'highDensity'. Voor alle andere SKU's moet deze waarde 'standaard' zijn.

Waarde	Description
default	De limiet voor het aantal indexen wordt bepaald door de standaardlimieten voor de SKU.
highDensity	Alleen toepassing voor standard3-SKU, waarbij de zoekservice maximaal 1000 indexen kan bevatten.

Identity

Object

Identiteit voor de resource.

Name	Type	Description
principalId	string	De principal-id van de door het systeem toegewezen identiteit van de zoekservice.
tenantId	string	De tenant-id van de door het systeem toegewezen identiteit van de zoekservice.
type	IdentityType	Het identiteitstype.

IdentityType

Inventarisatie

Het identiteitstype.

Waarde	Description
None
SystemAssigned

IpRule

Object

De IP-beperkingsregel van de zoekservice.

Name	Type	Description
value	string	Waarde die overeenkomt met één IPv4-adres (bijvoorbeeld 123.1.2.3) of een IP-bereik in CIDR-indeling (bijvoorbeeld 123.1.2.3/24) dat is toegestaan.

NetworkRuleSet

Object

Netwerkspecifieke regels die bepalen hoe de zoekservice kan worden bereikt.

Name	Type	Description
ipRules	IpRule[]	Een lijst met IP-beperkingsregels die worden gebruikt voor een IP-firewall. Ip-adressen die niet overeenkomen met de regels, worden geblokkeerd door de firewall. Deze regels worden alleen toegepast wanneer de 'publicNetworkAccess' van de zoekservice is ingeschakeld.

PrivateEndpoint

Object

De privé-eindpuntresource van de Microsoft.Network-provider.

Name	Type	Description
id	string	De resource-id van de privé-eindpuntresource van de Microsoft.Network-provider.

PrivateEndpointConnection

Object

Beschrijft een bestaande privé-eindpuntverbinding met de zoekservice.

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	De naam van de resource
properties	PrivateEndpointConnectionProperties	Beschrijft de eigenschappen van een bestaande privé-eindpuntverbinding met de zoekservice.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

PrivateEndpointConnectionProperties

Object

Beschrijft de eigenschappen van een bestaande privé-eindpuntverbinding met de zoekservice.

Name	Type	Description
groupId	string	De groeps-id van de provider van de resource waarvoor de private link-serviceverbinding geldt.
privateEndpoint	PrivateEndpoint	De privé-eindpuntresource van de Microsoft.Network-provider.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Beschrijft de huidige status van een bestaande Private Link-serviceverbinding met het Privé-eindpunt van Azure.
provisioningState	PrivateLinkServiceConnectionProvisioningState	De inrichtingsstatus van de private link-serviceverbinding. Geldige waarden zijn bijwerken, verwijderen, mislukt, geslaagd of onvolledig

PrivateLinkServiceConnectionProvisioningState

Inventarisatie

De inrichtingsstatus van de private link-serviceverbinding. Geldige waarden zijn bijwerken, verwijderen, mislukt, geslaagd of onvolledig

Waarde	Description
Canceled	Inrichtingsaanvraag voor de private link-serviceverbindingsresource is geannuleerd
Deleting	De private link-serviceverbinding wordt verwijderd.
Failed	De private link-serviceverbinding kan niet worden ingericht of verwijderd.
Incomplete	De inrichtingsaanvraag voor de private link-serviceverbindingsresource is geaccepteerd, maar het proces van maken is nog niet gestart.
Succeeded	De private link-serviceverbinding is ingericht en is gereed voor goedkeuring.
Updating	De private link-serviceverbinding wordt in het proces gemaakt, samen met andere resources, zodat deze volledig functioneel is.

PrivateLinkServiceConnectionState

Object

Beschrijft de huidige status van een bestaande Private Link-serviceverbinding met het Privé-eindpunt van Azure.

Name	Type	Default value	Description
actionsRequired	string	None	Een beschrijving van eventuele extra acties die nodig kunnen zijn.
description	string		De beschrijving voor de verbindingsstatus van de Private Link-service.
status	PrivateLinkServiceConnectionStatus		Status van de private link-serviceverbinding. Geldige waarden zijn In behandeling, Goedgekeurd, Geweigerd of Verbroken.

PrivateLinkServiceConnectionStatus

Inventarisatie

Status van de private link-serviceverbinding. Geldige waarden zijn In behandeling, Goedgekeurd, Geweigerd of Verbroken.

Waarde	Description
Approved	De verbinding met het privé-eindpunt is goedgekeurd en kan worden gebruikt.
Disconnected	De privé-eindpuntverbinding is verwijderd uit de service.
Pending	De privé-eindpuntverbinding is gemaakt en wacht op goedkeuring.
Rejected	De privé-eindpuntverbinding is geweigerd en kan niet worden gebruikt.

ProvisioningState

Inventarisatie

De status van de laatste inrichtingsbewerking die wordt uitgevoerd op de zoekservice. Inrichten is een tussenliggende status die zich voordoet terwijl de servicecapaciteit tot stand wordt gebracht. Nadat de capaciteit is ingesteld, verandert provisioningState in 'succeeded' of 'failed'. Clienttoepassingen kunnen de inrichtingsstatus peilen (het aanbevolen polling-interval is van 30 seconden tot één minuut) met behulp van de bewerking Zoekservice ophalen om te zien wanneer een bewerking is voltooid. Als u de gratis service gebruikt, komt deze waarde meestal rechtstreeks terug als 'geslaagd' in de aanroep van de zoekservice maken. Dit komt doordat de gratis service gebruikmaakt van capaciteit die al is ingesteld.

Waarde	Description
failed	De laatste inrichtingsbewerking is mislukt.
provisioning	De zoekservice wordt ingericht of omhoog of omlaag geschaald.
succeeded	De laatste inrichtingsbewerking is voltooid.

PublicNetworkAccess

Inventarisatie

Deze waarde kan worden ingesteld op 'ingeschakeld' om te voorkomen dat bestaande klantbronnen en sjablonen fouten veroorzaken. Als deze optie is ingesteld op Uitgeschakeld, is verkeer via openbare interface niet toegestaan en zijn privé-eindpuntverbindingen de exclusieve toegangsmethode.

Waarde	Description
disabled
enabled

SearchEncryptionComplianceStatus

Inventarisatie

Beschrijft of de zoekservice wel of niet compatibel is met betrekking tot niet-door de klant versleutelde resources. Als een service meer dan één niet-klant versleutelde resource heeft en 'Afdwinging' is ingeschakeld, wordt de service gemarkeerd als 'nonCompliant'.

Waarde	Description
Compliant	Geeft aan dat de zoekservice compatibel is, omdat het aantal niet-door de klant versleutelde resources nul is of het afdwingen is uitgeschakeld.
NonCompliant	Geeft aan dat de zoekservice meer dan één niet-door de klant versleutelde resources heeft.

SearchEncryptionWithCmk

Inventarisatie

Beschrijft hoe een zoekservice een of meer niet-door de klant versleutelde resources moet afdwingen.

Waarde	Description
Disabled	Er wordt geen afdwinging uitgevoerd en de zoekservice kan niet-door de klant versleutelde resources hebben.
Enabled	De zoekservice wordt gemarkeerd als niet-compatibel als er een of meer niet-door de klant versleutelde resources zijn.
Unspecified	Afdwingingsbeleid wordt niet expliciet opgegeven, waarbij het gedrag hetzelfde is als als 'Uitgeschakeld'.

SearchSemanticSearch

Inventarisatie

Hiermee stelt u opties in waarmee de beschikbaarheid van semantische zoekopdrachten wordt ingesteld. Deze configuratie is alleen mogelijk voor bepaalde zoek-SKU's op bepaalde locaties.

Waarde	Description
disabled	Geeft aan dat semantische rangschikking is uitgeschakeld voor de zoekservice.
free	Hiermee wordt semantische classificatie voor een zoekservice ingeschakeld en wordt aangegeven dat deze moet worden gebruikt binnen de limieten van de gratis laag. Dit zou het volume van semantische classificatieaanvragen beperken en zonder extra kosten worden aangeboden. Dit is de standaardinstelling voor nieuw ingerichte zoekservices.
standard	Hiermee schakelt u semantische classificatie in voor een zoekservice als factureerbare functie, met een hogere doorvoer en een hoger volume aan semantische classificatieaanvragen.

SearchService

Object

Beschrijft een zoekservice en de huidige status.

Name	Type	Default value	Description
id	string		Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	Identity		De identiteit van de resource.
location	string		De geografische locatie waar de resource zich bevindt
name	string		De naam van de resource
properties.authOptions	DataPlaneAuthOptions		Definieert de opties voor de wijze waarop de gegevensvlak-API van een zoekservice aanvragen verifieert. Dit kan niet worden ingesteld als 'disableLocalAuth' is ingesteld op true.
properties.disableLocalAuth	boolean		Als deze is ingesteld op true, kunnen aanroepen naar de zoekservice geen API-sleutels gebruiken voor verificatie. Dit kan niet worden ingesteld op true als 'dataPlaneAuthOptions' is gedefinieerd.
properties.encryptionWithCmk	EncryptionWithCmk		Hiermee geeft u een beleid met betrekking tot de versleuteling van resources (zoals indexen) met behulp van customer manager-sleutels binnen een zoekservice.
properties.hostingMode	HostingMode	default	Alleen van toepassing op de standard3-SKU. U kunt deze eigenschap instellen om maximaal 3 high-densitypartities in te schakelen die maximaal 1000 indexen toestaan, wat veel hoger is dan de maximumindexen die zijn toegestaan voor elke andere SKU. Voor de standard3-SKU is de waarde 'standaard' of 'highDensity'. Voor alle andere SKU's moet deze waarde 'standaard' zijn.
properties.networkRuleSet	NetworkRuleSet		Netwerkspecifieke regels die bepalen hoe de zoekservice kan worden bereikt.
properties.partitionCount	integer (int32) minimum: 1 maximum: 12	1	Het aantal partities in de zoekservice; indien opgegeven, kan dit 1, 2, 3, 4, 6 of 12 zijn. Waarden die groter zijn dan 1 zijn alleen geldig voor standaard-SKU's. Voor 'standard3'-services waarbij hostingMode is ingesteld op 'highDensity', liggen de toegestane waarden tussen 1 en 3.
properties.privateEndpointConnections	PrivateEndpointConnection[]		De lijst met privé-eindpuntverbindingen met de zoekservice.
properties.provisioningState	ProvisioningState		De status van de laatste inrichtingsbewerking die wordt uitgevoerd op de zoekservice. Inrichten is een tussenliggende status die zich voordoet terwijl de servicecapaciteit tot stand wordt gebracht. Nadat de capaciteit is ingesteld, verandert provisioningState in 'succeeded' of 'failed'. Clienttoepassingen kunnen de inrichtingsstatus peilen (het aanbevolen polling-interval is van 30 seconden tot één minuut) met behulp van de bewerking Zoekservice ophalen om te zien wanneer een bewerking is voltooid. Als u de gratis service gebruikt, komt deze waarde meestal rechtstreeks terug als 'geslaagd' in de aanroep van de zoekservice maken. Dit komt doordat de gratis service gebruikmaakt van capaciteit die al is ingesteld.
properties.publicNetworkAccess	PublicNetworkAccess	enabled	Deze waarde kan worden ingesteld op 'ingeschakeld' om te voorkomen dat bestaande klantbronnen en sjablonen fouten veroorzaken. Als deze optie is ingesteld op Uitgeschakeld, is verkeer via openbare interface niet toegestaan en zijn privé-eindpuntverbindingen de exclusieve toegangsmethode.
properties.replicaCount	integer (int32) minimum: 1 maximum: 12	1	Het aantal replica's in de zoekservice. Indien opgegeven, moet deze een waarde tussen 1 en 12 inclusief zijn voor standaard-SKU's of tussen 1 en 3 inclusief voor de basis-SKU.
properties.semanticSearch	SearchSemanticSearch		Hiermee stelt u opties in waarmee de beschikbaarheid van semantische zoekopdrachten wordt ingesteld. Deze configuratie is alleen mogelijk voor bepaalde zoek-SKU's op bepaalde locaties.
properties.sharedPrivateLinkResources	SharedPrivateLinkResource[]		De lijst met gedeelde private link-resources die worden beheerd door de zoekservice.
properties.status	SearchServiceStatus		De status van de zoekservice. Mogelijke waarden zijn: 'wordt uitgevoerd': de zoekservice wordt uitgevoerd en er worden geen inrichtingsbewerkingen uitgevoerd. 'inrichting': de zoekservice wordt ingericht of omhoog of omlaag geschaald. 'verwijderen': de zoekservice wordt verwijderd. 'gedegradeerd': de zoekservice is gedegradeerd. Dit kan gebeuren wanneer de onderliggende zoekeenheden niet in orde zijn. De zoekservice is waarschijnlijk operationeel, maar de prestaties kunnen traag zijn en sommige aanvragen kunnen worden verwijderd. 'uitgeschakeld': de zoekservice is uitgeschakeld. In deze status weigert de service alle API-aanvragen. 'error': de zoekservice heeft een foutstatus. Als uw service in de gedegradeerde, uitgeschakelde of foutstatussen staat, onderzoekt Microsoft het onderliggende probleem actief. Toegewezen services in deze statussen zijn nog steeds in rekening gebracht op basis van het aantal ingerichte zoekeenheden.
properties.statusDetails	string		De details van de status van de zoekservice.
sku	Sku		De SKU van de zoekservice, waarmee de factureringsfrequentie en capaciteitslimieten worden bepaald. Deze eigenschap is vereist bij het maken van een nieuwe zoekservice.
tags	object		Resourcetags.
type	string		Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

SearchServiceStatus

Inventarisatie

De status van de zoekservice. Mogelijke waarden zijn: 'wordt uitgevoerd': de zoekservice wordt uitgevoerd en er worden geen inrichtingsbewerkingen uitgevoerd. 'inrichting': de zoekservice wordt ingericht of omhoog of omlaag geschaald. 'verwijderen': de zoekservice wordt verwijderd. 'gedegradeerd': de zoekservice is gedegradeerd. Dit kan gebeuren wanneer de onderliggende zoekeenheden niet in orde zijn. De zoekservice is waarschijnlijk operationeel, maar de prestaties kunnen traag zijn en sommige aanvragen kunnen worden verwijderd. 'uitgeschakeld': de zoekservice is uitgeschakeld. In deze status weigert de service alle API-aanvragen. 'error': de zoekservice heeft een foutstatus. Als uw service in de gedegradeerde, uitgeschakelde of foutstatussen staat, onderzoekt Microsoft het onderliggende probleem actief. Toegewezen services in deze statussen zijn nog steeds in rekening gebracht op basis van het aantal ingerichte zoekeenheden.

Waarde	Description
degraded	De zoekservice is gedegradeerd omdat onderliggende zoekeenheden niet in orde zijn.
deleting	De zoekservice wordt verwijderd.
disabled	De zoekservice is uitgeschakeld en alle API-aanvragen worden geweigerd.
error	De zoekservice heeft de foutstatus, wat aangeeft dat er een fout is opgetreden bij het inrichten of verwijderen.
provisioning	De zoekservice wordt ingericht of omhoog of omlaag geschaald.
running	De zoekservice wordt uitgevoerd en er worden geen inrichtingsbewerkingen uitgevoerd.

SharedPrivateLinkResource

Object

Beschrijft een Gedeelde Private Link-resource die wordt beheerd door de zoekservice.

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	De naam van de resource
properties	SharedPrivateLinkResourceProperties	Beschrijft de eigenschappen van een Gedeelde Private Link-resource die wordt beheerd door de zoekservice.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

SharedPrivateLinkResourceProperties

Object

Beschrijft de eigenschappen van een bestaande Shared Private Link-resource die wordt beheerd door de zoekservice.

Name	Type	Description
groupId	string	De groeps-id van de provider van de resource waarvoor de gedeelde private link-resource is bedoeld.
privateLinkResourceId	string	De resource-id van de resource waarvoor de gedeelde private link-resource is bedoeld.
provisioningState	SharedPrivateLinkResourceProvisioningState	De inrichtingsstatus van de gedeelde private link-resource. Geldige waarden zijn bijwerken, verwijderen, mislukt, geslaagd of onvolledig.
requestMessage	string	Het aanvraagbericht voor het aanvragen van goedkeuring van de gedeelde private link-resource.
resourceRegion	string	Facultatief. Kan worden gebruikt om de Azure Resource Manager-locatie op te geven van de resource waaraan een gedeelde privékoppeling moet worden gemaakt. Dit is alleen vereist voor de resources waarvan de DNS-configuratie regionaal is (zoals Azure Kubernetes Service).
status	SharedPrivateLinkResourceStatus	Status van de gedeelde private link-resource. Geldige waarden zijn in behandeling, goedgekeurd, geweigerd of verbroken.

SharedPrivateLinkResourceProvisioningState

Inventarisatie

De inrichtingsstatus van de gedeelde private link-resource. Geldige waarden zijn bijwerken, verwijderen, mislukt, geslaagd of onvolledig.

Waarde	Description
Deleting
Failed
Incomplete
Succeeded
Updating

SharedPrivateLinkResourceStatus

Inventarisatie

Status van de gedeelde private link-resource. Geldige waarden zijn in behandeling, goedgekeurd, geweigerd of verbroken.

Waarde	Description
Approved
Disconnected
Pending
Rejected

Sku

Object

Definieert de SKU van een zoekservice, waarmee de factureringsfrequentie en capaciteitslimieten worden bepaald.

Name	Type	Description
name	SkuName	De SKU van de zoekservice. Geldige waarden zijn: 'gratis': Gedeelde service. 'basic': toegewezen service met maximaal 3 replica's. 'standaard': toegewezen service met maximaal 12 partities en 12 replica's. 'standard2': vergelijkbaar met standaard, maar met meer capaciteit per zoekeenheid. 'standard3': de grootste Standard-aanbieding met maximaal 12 partities en 12 replica's (of maximaal 3 partities met meer indexen als u ook de eigenschap hostingMode instelt op 'highDensity'). 'storage_optimized_l1': ondersteunt 1 TB per partitie, maximaal 12 partities. 'storage_optimized_l2': ondersteunt 2 TB per partitie, maximaal 12 partities.'

SkuName

Inventarisatie

De SKU van de zoekservice. Geldige waarden zijn: 'gratis': Gedeelde service. 'basic': toegewezen service met maximaal 3 replica's. 'standaard': toegewezen service met maximaal 12 partities en 12 replica's. 'standard2': vergelijkbaar met standaard, maar met meer capaciteit per zoekeenheid. 'standard3': de grootste Standard-aanbieding met maximaal 12 partities en 12 replica's (of maximaal 3 partities met meer indexen als u ook de eigenschap hostingMode instelt op 'highDensity'). 'storage_optimized_l1': ondersteunt 1 TB per partitie, maximaal 12 partities. 'storage_optimized_l2': ondersteunt 2 TB per partitie, maximaal 12 partities.'

Waarde	Description
basic	Factureerbare laag voor een toegewezen service met maximaal 3 replica's.
free	Gratis laag, zonder SLA-garanties en een subset van de functies die worden aangeboden voor factureerbare lagen.
standard	Factureerbare laag voor een toegewezen service met maximaal 12 partities en 12 replica's.
standard2	Vergelijkbaar met 'standaard', maar met meer capaciteit per zoekeenheid.
standard3	De grootste Standard-aanbieding met maximaal 12 partities en 12 replica's (of maximaal 3 partities met meer indexen als u ook de eigenschap hostingMode instelt op 'highDensity').
storage_optimized_l1	Factureerbare laag voor een toegewezen service die 1 TB per partitie ondersteunt, maximaal 12 partities.
storage_optimized_l2	Factureerbare laag voor een toegewezen service die 2 TB per partitie ondersteunt, maximaal 12 partities.