Services interface
Schnittstelle, die einen Dienst darstellt.
Methoden
begin |
Erstellt oder aktualisiert einen Suchdienst in der angegebenen Ressourcengruppe. Wenn der Suchdienst bereits vorhanden ist, werden alle Eigenschaften mit den angegebenen Werten aktualisiert. |
begin |
Erstellt oder aktualisiert einen Suchdienst in der angegebenen Ressourcengruppe. Wenn der Suchdienst bereits vorhanden ist, werden alle Eigenschaften mit den angegebenen Werten aktualisiert. |
check |
Überprüft, ob der angegebene Suchdienstname zur Verwendung verfügbar ist. Suchdienst Namen müssen global eindeutig sein, da sie Teil des Dienst-URI sind (https://.search.windows.net). |
delete(string, string, Services |
Löscht einen Suchdienst in der angegebenen Ressourcengruppe zusammen mit den zugehörigen Ressourcen. |
get(string, string, Services |
Ruft den Suchdienst mit dem angegebenen Namen in der angegebenen Ressourcengruppe ab. |
list |
Ruft eine Liste aller Suchdienste in der angegebenen Ressourcengruppe ab. |
list |
Ruft eine Liste aller Suchdienste im angegebenen Abonnement ab. |
update(string, string, Search |
Updates einen vorhandenen Suchdienst in der angegebenen Ressourcengruppe. |
Details zur Methode
beginCreateOrUpdate(string, string, SearchService, ServicesCreateOrUpdateOptionalParams)
Erstellt oder aktualisiert einen Suchdienst in der angegebenen Ressourcengruppe. Wenn der Suchdienst bereits vorhanden ist, werden alle Eigenschaften mit den angegebenen Werten aktualisiert.
function beginCreateOrUpdate(resourceGroupName: string, searchServiceName: string, service: SearchService, options?: ServicesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<SearchService>, SearchService>>
Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe im aktuellen Abonnement. Dieser Wert kann über die Azure-Ressourcen-Manager-API oder das Portal abgerufen werden.
- searchServiceName
-
string
Der Name des zu erstellenden oder zu aktualisierenden Azure Cognitive Search Diensts. Suchdienst Namen dürfen nur Kleinbuchstaben, Ziffern oder Bindestriche enthalten, dürfen keine Bindestriche als erste zwei oder letzte Zeichen verwenden, dürfen keine aufeinander folgenden Bindestriche enthalten und müssen zwischen 2 und 60 Zeichen lang sein. Suchdienst Namen müssen global eindeutig sein, da sie Teil des Dienst-URI sind (https://.search.windows.net). Sie können den Dienstnamen nicht ändern, nachdem der Dienst erstellt wurde.
- service
- SearchService
Die Definition des zu erstellenden oder zu aktualisierenden Suchdiensts.
Die Optionsparameter.
Gibt zurück
Promise<@azure/core-lro.SimplePollerLike<OperationState<SearchService>, SearchService>>
beginCreateOrUpdateAndWait(string, string, SearchService, ServicesCreateOrUpdateOptionalParams)
Erstellt oder aktualisiert einen Suchdienst in der angegebenen Ressourcengruppe. Wenn der Suchdienst bereits vorhanden ist, werden alle Eigenschaften mit den angegebenen Werten aktualisiert.
function beginCreateOrUpdateAndWait(resourceGroupName: string, searchServiceName: string, service: SearchService, options?: ServicesCreateOrUpdateOptionalParams): Promise<SearchService>
Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe im aktuellen Abonnement. Dieser Wert kann über die Azure-Ressourcen-Manager-API oder das Portal abgerufen werden.
- searchServiceName
-
string
Der Name des zu erstellenden oder zu aktualisierenden Azure Cognitive Search Diensts. Suchdienst Namen dürfen nur Kleinbuchstaben, Ziffern oder Bindestriche enthalten, dürfen keine Bindestriche als erste zwei oder letzte Zeichen verwenden, dürfen keine aufeinander folgenden Bindestriche enthalten und müssen zwischen 2 und 60 Zeichen lang sein. Suchdienst Namen müssen global eindeutig sein, da sie Teil des Dienst-URI sind (https://.search.windows.net). Sie können den Dienstnamen nicht ändern, nachdem der Dienst erstellt wurde.
- service
- SearchService
Die Definition des zu erstellenden oder zu aktualisierenden Suchdiensts.
Die Optionsparameter.
Gibt zurück
Promise<SearchService>
checkNameAvailability(string, ServicesCheckNameAvailabilityOptionalParams)
Überprüft, ob der angegebene Suchdienstname zur Verwendung verfügbar ist. Suchdienst Namen müssen global eindeutig sein, da sie Teil des Dienst-URI sind (https://.search.windows.net).
function checkNameAvailability(name: string, options?: ServicesCheckNameAvailabilityOptionalParams): Promise<CheckNameAvailabilityOutput>
Parameter
- name
-
string
Der zu überprüfende Suchdienstname. Suchdienst Namen dürfen nur Kleinbuchstaben, Ziffern oder Bindestriche enthalten, dürfen keine Bindestriche als erste zwei oder letzte Zeichen verwenden, dürfen keine aufeinander folgenden Bindestriche enthalten und müssen zwischen 2 und 60 Zeichen lang sein.
Die Optionsparameter.
Gibt zurück
Promise<CheckNameAvailabilityOutput>
delete(string, string, ServicesDeleteOptionalParams)
Löscht einen Suchdienst in der angegebenen Ressourcengruppe zusammen mit den zugehörigen Ressourcen.
function delete(resourceGroupName: string, searchServiceName: string, options?: ServicesDeleteOptionalParams): Promise<void>
Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe im aktuellen Abonnement. Dieser Wert kann über die Azure-Ressourcen-Manager-API oder das Portal abgerufen werden.
- searchServiceName
-
string
Der Name des Azure Cognitive Search Diensts, der der angegebenen Ressourcengruppe zugeordnet ist.
- options
- ServicesDeleteOptionalParams
Die Optionsparameter.
Gibt zurück
Promise<void>
get(string, string, ServicesGetOptionalParams)
Ruft den Suchdienst mit dem angegebenen Namen in der angegebenen Ressourcengruppe ab.
function get(resourceGroupName: string, searchServiceName: string, options?: ServicesGetOptionalParams): Promise<SearchService>
Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe im aktuellen Abonnement. Dieser Wert kann über die Azure-Ressourcen-Manager-API oder das Portal abgerufen werden.
- searchServiceName
-
string
Der Name des Azure Cognitive Search Diensts, der der angegebenen Ressourcengruppe zugeordnet ist.
- options
- ServicesGetOptionalParams
Die Optionsparameter.
Gibt zurück
Promise<SearchService>
listByResourceGroup(string, ServicesListByResourceGroupOptionalParams)
Ruft eine Liste aller Suchdienste in der angegebenen Ressourcengruppe ab.
function listByResourceGroup(resourceGroupName: string, options?: ServicesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<SearchService, SearchService[], PageSettings>
Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe im aktuellen Abonnement. Dieser Wert kann über die Azure-Ressourcen-Manager-API oder das Portal abgerufen werden.
Die Optionsparameter.
Gibt zurück
listBySubscription(ServicesListBySubscriptionOptionalParams)
Ruft eine Liste aller Suchdienste im angegebenen Abonnement ab.
function listBySubscription(options?: ServicesListBySubscriptionOptionalParams): PagedAsyncIterableIterator<SearchService, SearchService[], PageSettings>
Parameter
Die Optionsparameter.
Gibt zurück
update(string, string, SearchServiceUpdate, ServicesUpdateOptionalParams)
Updates einen vorhandenen Suchdienst in der angegebenen Ressourcengruppe.
function update(resourceGroupName: string, searchServiceName: string, service: SearchServiceUpdate, options?: ServicesUpdateOptionalParams): Promise<SearchService>
Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe im aktuellen Abonnement. Dieser Wert kann über die Azure-Ressourcen-Manager-API oder das Portal abgerufen werden.
- searchServiceName
-
string
Der Name des zu aktualisierenden Azure Cognitive Search-Diensts.
- service
- SearchServiceUpdate
Die Definition des zu aktualisierenden Suchdiensts.
- options
- ServicesUpdateOptionalParams
Die Optionsparameter.
Gibt zurück
Promise<SearchService>