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. |
| begin |
Aktualisiert den Azure AI Search-Dienst auf die neueste verfügbare Version. |
| begin |
Aktualisiert den Azure AI Search-Dienst auf die neueste verfügbare Version. |
| check |
Überprüft, ob der angegebene Suchdienstname zur Verwendung verfügbar ist. Suchdienstnamen müssen global eindeutig sein, da sie Teil des Dienst-URI (https://< name.search.windows.net>) sind. |
| 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 |
Aktualisiert 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 innerhalb des aktuellen Abonnements. Sie können diesen Wert aus der Azure Resource Manager-API oder dem Portal abrufen.
- searchServiceName
-
string
Der Name des Azure AI Search-Diensts, der erstellt oder aktualisiert werden soll. Suchdienstnamen dürfen nur Kleinbuchstaben, Ziffern oder Striche enthalten, dürfen nicht als die ersten beiden oder letzten Zeichen Striche verwenden, dürfen keine aufeinander folgenden Striche enthalten und müssen zwischen 2 und 60 Zeichen lang sein. Suchdienstnamen müssen eindeutig sein, da sie Teil des Dienst-URI (https://< name.search.windows.net>) sind. Sie können den Dienstnamen nicht ändern, nachdem der Dienst erstellt wurde.
- service
- SearchService
Die Definition des zu erstellenden oder 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 innerhalb des aktuellen Abonnements. Sie können diesen Wert aus der Azure Resource Manager-API oder dem Portal abrufen.
- searchServiceName
-
string
Der Name des Azure AI Search-Diensts, der erstellt oder aktualisiert werden soll. Suchdienstnamen dürfen nur Kleinbuchstaben, Ziffern oder Striche enthalten, dürfen nicht als die ersten beiden oder letzten Zeichen Striche verwenden, dürfen keine aufeinander folgenden Striche enthalten und müssen zwischen 2 und 60 Zeichen lang sein. Suchdienstnamen müssen eindeutig sein, da sie Teil des Dienst-URI (https://< name.search.windows.net>) sind. Sie können den Dienstnamen nicht ändern, nachdem der Dienst erstellt wurde.
- service
- SearchService
Die Definition des zu erstellenden oder aktualisierenden Suchdiensts.
Die Optionsparameter.
Gibt zurück
Promise<SearchService>
beginUpgrade(string, string, ServicesUpgradeOptionalParams)
Aktualisiert den Azure AI Search-Dienst auf die neueste verfügbare Version.
function beginUpgrade(resourceGroupName: string, searchServiceName: string, options?: ServicesUpgradeOptionalParams): Promise<SimplePollerLike<OperationState<SearchService>, SearchService>>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe innerhalb des aktuellen Abonnements. Sie können diesen Wert aus der Azure Resource Manager-API oder dem Portal abrufen.
- searchServiceName
-
string
Der Name des Azure AI Search-Diensts, der der angegebenen Ressourcengruppe zugeordnet ist.
- options
- ServicesUpgradeOptionalParams
Die Optionsparameter.
Gibt zurück
Promise<@azure/core-lro.SimplePollerLike<OperationState<SearchService>, SearchService>>
beginUpgradeAndWait(string, string, ServicesUpgradeOptionalParams)
Aktualisiert den Azure AI Search-Dienst auf die neueste verfügbare Version.
function beginUpgradeAndWait(resourceGroupName: string, searchServiceName: string, options?: ServicesUpgradeOptionalParams): Promise<SearchService>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe innerhalb des aktuellen Abonnements. Sie können diesen Wert aus der Azure Resource Manager-API oder dem Portal abrufen.
- searchServiceName
-
string
Der Name des Azure AI Search-Diensts, der der angegebenen Ressourcengruppe zugeordnet ist.
- options
- ServicesUpgradeOptionalParams
Die Optionsparameter.
Gibt zurück
Promise<SearchService>
checkNameAvailability(string, ServicesCheckNameAvailabilityOptionalParams)
Überprüft, ob der angegebene Suchdienstname zur Verwendung verfügbar ist. Suchdienstnamen müssen global eindeutig sein, da sie Teil des Dienst-URI (https://< name.search.windows.net>) sind.
function checkNameAvailability(name: string, options?: ServicesCheckNameAvailabilityOptionalParams): Promise<CheckNameAvailabilityOutput>Parameter
- name
-
string
Der zu überprüfende Suchdienstname. Suchdienstnamen dürfen nur Kleinbuchstaben, Ziffern oder Striche enthalten, dürfen nicht als die ersten beiden oder letzten Zeichen Striche verwenden, dürfen keine aufeinander folgenden Striche 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 innerhalb des aktuellen Abonnements. Sie können diesen Wert aus der Azure Resource Manager-API oder dem Portal abrufen.
- searchServiceName
-
string
Der Name des Azure AI 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 innerhalb des aktuellen Abonnements. Sie können diesen Wert aus der Azure Resource Manager-API oder dem Portal abrufen.
- searchServiceName
-
string
Der Name des Azure AI 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 innerhalb des aktuellen Abonnements. Sie können diesen Wert aus der Azure Resource Manager-API oder dem Portal abrufen.
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)
Aktualisiert 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 innerhalb des aktuellen Abonnements. Sie können diesen Wert aus der Azure Resource Manager-API oder dem Portal abrufen.
- searchServiceName
-
string
Der Name des zu aktualisierenden Azure AI Search-Diensts.
- service
- SearchServiceUpdate
Die Definition des zu aktualisierenden Suchdiensts.
- options
- ServicesUpdateOptionalParams
Die Optionsparameter.
Gibt zurück
Promise<SearchService>