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 de 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 peilt 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

Microsoft Entra ID OAuth2-autorisatiestroom.

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 welk antwoord de gegevensvlak-API van een zoekservice verzendt voor aanvragen waarvoor de verificatie is mislukt.
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 de wijze waarop 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 het maximum aantal indexen dat is toegestaan voor een andere SKU. Voor de standard3-SKU is de waarde 'default' 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 resource van het privé-eindpunt 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 Service-verbinding met het azure-privé-eindpunt.
PrivateLinkServiceConnectionStatus	Status van de private link-serviceverbinding. Geldige waarden zijn In behandeling, Goedgekeurd, Geweigerd of Verbroken.
ProvisioningState	De status van de laatste inrichtingsbewerking die is uitgevoerd op de zoekservice. Inrichten is een tussenliggende status die optreedt terwijl de servicecapaciteit wordt ingesteld. Nadat de capaciteit is ingesteld, wordt provisioningState gewijzigd in 'succeeded' of 'failed'. Clienttoepassingen kunnen de inrichtingsstatus peilen (het aanbevolen pollinginterval 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 naar 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 wijzigingen in bestaande klantresources en sjablonen fouten veroorzaken. Als deze optie is ingesteld op uitgeschakeld, is verkeer via de openbare interface niet toegestaan en zijn privé-eindpuntverbindingen de exclusieve toegangsmethode.
SearchEncryptionComplianceStatus	Beschrijft of de zoekservice al dan niet compatibel is met betrekking tot niet-door de klant versleutelde resources. Als een service meer dan één niet-door de klant versleutelde resource heeft en Afdwinging is ingeschakeld, wordt de service gemarkeerd als niet-compatibel.
SearchEncryptionWithCmk	Hierin wordt beschreven hoe een zoekservice het gebruik van een of meer niet door de klant versleutelde resources moet afdwingen.
SearchSemanticSearch	Hiermee stelt u opties in die de beschikbaarheid van semantisch zoeken bepalen. 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. 'disabled': de zoekservice is uitgeschakeld. In deze status weigert de service alle API-aanvragen. 'fout': de zoekservice heeft een foutstatus. Als uw service de status gedegradeerd, uitgeschakeld of fout heeft, onderzoekt Microsoft het onderliggende probleem actief. Toegewezen services in deze statussen worden 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 gedeelde 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	Hiermee definieert u de SKU van een zoekservice, waarmee de factureringssnelheid en capaciteitslimieten worden bepaald.
SkuName	De SKU van de zoekservice. Geldige waarden zijn onder andere: '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 standard, maar met meer capaciteit per zoekeenheid. 'standard3': het grootste Standard-aanbod 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

Beschrijft welk antwoord de gegevensvlak-API van een zoekservice verzendt voor aanvragen waarvoor de verificatie is mislukt.

Name	Type	Description
http401WithBearerChallenge	string	Hiermee wordt aangegeven dat aanvragen waarvoor de verificatie is mislukt, moeten worden weergegeven met de HTTP-statuscode 401 (Niet geautoriseerd) en een Bearer-uitdaging moeten presenteren.
http403	string	Geeft aan dat aanvragen waarvoor de verificatie is mislukt, moeten worden weergegeven met de HTTP-statuscode 403 (Verboden).

ApiKeyOnly

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

CloudError

Bevat informatie over een API-fout.

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

CloudErrorBody

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 voor het programmatisch afhandelen van specifieke foutgevallen.
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

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 welk antwoord de gegevensvlak-API van een zoekservice verzendt voor aanvragen waarvoor de verificatie is mislukt.

DataPlaneAuthOptions

Definieert de opties voor de wijze waarop 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

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 al dan niet compatibel is met betrekking tot niet-door de klant versleutelde resources. Als een service meer dan één niet-door de klant versleutelde resource heeft en Afdwinging is ingeschakeld, wordt de service gemarkeerd als niet-compatibel.
enforcement	SearchEncryptionWithCmk	Hierin wordt beschreven hoe een zoekservice het gebruik van een of meer niet door de klant versleutelde resources moet afdwingen.

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 het maximum aantal indexen dat is toegestaan voor een andere SKU. Voor de standard3-SKU is de waarde 'default' of 'highDensity'. Voor alle andere SKU's moet deze waarde 'standaard' zijn.

Name	Type	Description
default	string	De limiet voor het aantal indexen wordt bepaald door de standaardlimieten voor de SKU.
highDensity	string	Alleen toepassing voor standard3 SKU, waarbij de zoekservice maximaal 1000 indexen kan hebben.

Identity

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

Het identiteitstype.

Name	Type	Description
None	string
SystemAssigned	string

IpRule

De IP-beperkingsregel van de zoekservice.

Name	Type	Description
value	string	De 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) moet worden toegestaan.

NetworkRuleSet

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

De resource van het privé-eindpunt van de Microsoft.Network-provider.

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

PrivateEndpointConnection

Beschrijft een bestaande privé-eindpuntverbinding met de zoekservice.

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld - /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

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 is bedoeld.
privateEndpoint	PrivateEndpoint	De resource van het privé-eindpunt van de Microsoft.Network-provider.
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Beschrijft de huidige status van een bestaande Private Link Service-verbinding met het azure-privé-eindpunt.
provisioningState	PrivateLinkServiceConnectionProvisioningState	De inrichtingsstatus van de private link-serviceverbinding. Geldige waarden zijn Bijwerken, Verwijderen, Mislukt, Geslaagd of Onvolledig

PrivateLinkServiceConnectionProvisioningState

De inrichtingsstatus van de private link-serviceverbinding. Geldige waarden zijn Bijwerken, Verwijderen, Mislukt, Geslaagd of Onvolledig

Name	Type	Description
Canceled	string	Inrichtingsaanvraag voor de privékoppelingsserviceverbindingsresource is geannuleerd
Deleting	string	De privékoppelingsserviceverbinding wordt momenteel verwijderd.
Failed	string	De privékoppelingsserviceverbinding is niet ingericht of verwijderd.
Incomplete	string	De inrichtingsaanvraag voor de verbindingsresource van de Private Link-service is geaccepteerd, maar het proces van maken is nog niet gestart.
Succeeded	string	De private link-serviceverbinding is klaar met het inrichten en is klaar voor goedkeuring.
Updating	string	De private link-serviceverbinding wordt samen met andere resources gemaakt om deze volledig functioneel te maken.

PrivateLinkServiceConnectionState

Beschrijft de huidige status van een bestaande Private Link Service-verbinding met het azure-privé-eindpunt.

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

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

Name	Type	Description
Approved	string	De privé-eindpuntverbinding is goedgekeurd en is klaar voor gebruik.
Disconnected	string	De privé-eindpuntverbinding is verwijderd uit de service.
Pending	string	De privé-eindpuntverbinding is gemaakt en wacht op goedkeuring.
Rejected	string	De privé-eindpuntverbinding is geweigerd en kan niet worden gebruikt.

ProvisioningState

De status van de laatste inrichtingsbewerking die is uitgevoerd op de zoekservice. Inrichten is een tussenliggende status die optreedt terwijl de servicecapaciteit wordt ingesteld. Nadat de capaciteit is ingesteld, wordt provisioningState gewijzigd in 'succeeded' of 'failed'. Clienttoepassingen kunnen de inrichtingsstatus peilen (het aanbevolen pollinginterval 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 naar Zoekservice maken. Dit komt doordat de gratis service gebruikmaakt van capaciteit die al is ingesteld.

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

PublicNetworkAccess

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

Name	Type	Description
disabled	string
enabled	string

SearchEncryptionComplianceStatus

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

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

SearchEncryptionWithCmk

Hierin wordt beschreven hoe een zoekservice het gebruik van een of meer niet door de klant versleutelde resources moet afdwingen.

Name	Type	Description
Disabled	string	Er wordt geen afdwinging uitgevoerd en de zoekservice kan niet-door de klant versleutelde resources hebben.
Enabled	string	Search-service wordt gemarkeerd als niet-compatibel als er een of meer niet-door de klant versleutelde resources zijn.
Unspecified	string	Afdwingingsbeleid is niet expliciet opgegeven, waarbij het gedrag hetzelfde is als wanneer het is ingesteld op Uitgeschakeld.

SearchSemanticSearch

Hiermee stelt u opties in die de beschikbaarheid van semantisch zoeken bepalen. Deze configuratie is alleen mogelijk voor bepaalde zoek-SKU's op bepaalde locaties.

Name	Type	Description
disabled	string	Geeft aan dat semantische classificatie is uitgeschakeld voor de zoekservice.
free	string	Schakelt semantische rangschikking in voor een zoekservice en geeft aan dat deze moet worden gebruikt binnen de limieten van de gratis laag. Dit zou het aantal semantische classificatieaanvragen beperken en wordt zonder extra kosten aangeboden. Dit is de standaardinstelling voor nieuw ingerichte zoekservices.
standard	string	Maakt semantische rangschikking op een zoekservice mogelijk als factureerbare functie, met een hogere doorvoer en een hogere hoeveelheid semantische classificatieaanvragen.

SearchService

Beschrijft een zoekservice en de huidige status.

Name	Type	Default value	Description
id	string		Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld - /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 optie is ingesteld op true, mogen 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 elk beleid met betrekking tot het versleutelen van resources (zoals indexen) met behulp van klantmanagersleutels 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 het maximum aantal indexen dat is toegestaan voor een andere SKU. Voor de standard3-SKU is de waarde 'default' 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	1	Het aantal partities in de zoekservice; indien opgegeven, kan dit 1, 2, 3, 4, 6 of 12 zijn. Waarden groter 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 is uitgevoerd op de zoekservice. Inrichten is een tussenliggende status die optreedt terwijl de servicecapaciteit wordt ingesteld. Nadat de capaciteit is ingesteld, wordt provisioningState gewijzigd in 'succeeded' of 'failed'. Clienttoepassingen kunnen de inrichtingsstatus peilen (het aanbevolen pollinginterval 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 naar 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 wijzigingen in bestaande klantresources en sjablonen fouten veroorzaken. Als deze optie is ingesteld op uitgeschakeld, is verkeer via de openbare interface niet toegestaan en zijn privé-eindpuntverbindingen de exclusieve toegangsmethode.
properties.replicaCount	integer	1	Het aantal replica's in de zoekservice. Indien opgegeven, moet dit een waarde zijn tussen 1 en 12 voor standaard-SKU's of tussen 1 en 3 voor de Basis-SKU.
properties.semanticSearch	SearchSemanticSearch		Hiermee stelt u opties in die de beschikbaarheid van semantisch zoeken bepalen. Deze configuratie is alleen mogelijk voor bepaalde zoek-SKU's op bepaalde locaties.
properties.sharedPrivateLinkResources	SharedPrivateLinkResource[]		De lijst met gedeelde privékoppelingsresources 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. 'disabled': de zoekservice is uitgeschakeld. In deze status weigert de service alle API-aanvragen. 'fout': de zoekservice heeft een foutstatus. Als uw service de status gedegradeerd, uitgeschakeld of fout heeft, onderzoekt Microsoft het onderliggende probleem actief. Toegewezen services in deze statussen worden 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, die de factureringssnelheid en capaciteitslimieten bepaalt. 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

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. 'disabled': de zoekservice is uitgeschakeld. In deze status weigert de service alle API-aanvragen. 'fout': de zoekservice heeft een foutstatus. Als uw service de status gedegradeerd, uitgeschakeld of fout heeft, onderzoekt Microsoft het onderliggende probleem actief. Toegewezen services in deze statussen worden nog steeds in rekening gebracht op basis van het aantal ingerichte zoekeenheden.

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

SharedPrivateLinkResource

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

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld - /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

Beschrijft de eigenschappen van een bestaande gedeelde 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	Optioneel. Kan worden gebruikt om de Azure Resource Manager locatie op te geven van de resource waarnaar een gedeelde privékoppeling moet worden gemaakt. Dit is alleen vereist voor 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

De inrichtingsstatus van de gedeelde Private Link-resource. Geldige waarden zijn Bijwerken, Verwijderen, Mislukt, Geslaagd of Onvolledig.

Name	Type	Description
Deleting	string
Failed	string
Incomplete	string
Succeeded	string
Updating	string

SharedPrivateLinkResourceStatus

Status van de gedeelde Private Link-resource. Geldige waarden zijn In behandeling, Goedgekeurd, Geweigerd of Verbroken.

Name	Type	Description
Approved	string
Disconnected	string
Pending	string
Rejected	string

Sku

Hiermee definieert u de SKU van een zoekservice, waarmee de factureringssnelheid en capaciteitslimieten worden bepaald.

Name	Type	Description
name	SkuName	De SKU van de zoekservice. Geldige waarden zijn onder andere: '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 standard, maar met meer capaciteit per zoekeenheid. 'standard3': het grootste Standard-aanbod 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

De SKU van de zoekservice. Geldige waarden zijn onder andere: '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 standard, maar met meer capaciteit per zoekeenheid. 'standard3': het grootste Standard-aanbod 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.'

Name	Type	Description
basic	string	Factureerbare laag voor een toegewezen service met maximaal 3 replica's.
free	string	Gratis laag, zonder SLA-garanties en een subset van de functies die worden aangeboden op factureerbare lagen.
standard	string	Factureerbare laag voor een toegewezen service met maximaal 12 partities en 12 replica's.
standard2	string	Vergelijkbaar met 'standaard', maar met meer capaciteit per zoekeenheid.
standard3	string	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	string	Factureerbare laag voor een toegewezen service die ondersteuning biedt voor 1 TB per partitie, maximaal 12 partities.
storage_optimized_l2	string	Factureerbare laag voor een toegewezen service die ondersteuning biedt voor 2 TB per partitie, maximaal 12 partities.