ApiManagementService interface
Schnittstelle, die einen ApiManagementService darstellt.
Methoden
| begin |
Updates die Microsoft.ApiManagement-Ressource, die im virtuellen Netzwerk ausgeführt wird, um die aktualisierten DNS-Änderungen zu wählen. |
| begin |
Updates die Microsoft.ApiManagement-Ressource, die im virtuellen Netzwerk ausgeführt wird, um die aktualisierten DNS-Änderungen zu wählen. |
| begin |
Erstellt eine Sicherung des API Management-Diensts für das angegebene Azure Storage-Konto. Dies ist ein lang andauernder Vorgang, der einige Minuten dauern kann. |
| begin |
Erstellt eine Sicherung des API Management-Diensts für das angegebene Azure Storage-Konto. Dies ist ein lang andauernder Vorgang, der einige Minuten dauern kann. |
| begin |
Erstellt oder aktualisiert einen API Management-Dienst. Dies ist ein lang andauernder Vorgang, der einige Minuten dauern kann. |
| begin |
Erstellt oder aktualisiert einen API Management-Dienst. Dies ist ein lang andauernder Vorgang, der einige Minuten dauern kann. |
| begin |
Löscht einen vorhandenen API Management-Dienst. |
| begin |
Löscht einen vorhandenen API Management-Dienst. |
| begin |
Aktualisiert einen API Management-Dienst auf die Stv2-Plattform. Weitere Informationen finden Sie unter https://aka.ms/apim-migrate-stv2. Diese Änderung kann nicht rückgängig gemacht werden. Dies ist ein lang andauernder Vorgang, der einige Minuten dauern kann. |
| begin |
Aktualisiert einen API Management-Dienst auf die Stv2-Plattform. Weitere Informationen finden Sie unter https://aka.ms/apim-migrate-stv2. Diese Änderung kann nicht rückgängig gemacht werden. Dies ist ein lang andauernder Vorgang, der einige Minuten dauern kann. |
| begin |
Stellt eine Sicherung eines API Management Diensts wieder her, der mit dem vorgang ApiManagementService_Backup für den aktuellen Dienst erstellt wurde. Dies ist ein lang andauernder Vorgang, der einige Minuten dauern kann. |
| begin |
Stellt eine Sicherung eines API Management Diensts wieder her, der mit dem vorgang ApiManagementService_Backup für den aktuellen Dienst erstellt wurde. Dies ist ein lang andauernder Vorgang, der einige Minuten dauern kann. |
| begin |
Updates einen vorhandenen API Management-Dienst. |
| begin |
Updates einen vorhandenen API Management-Dienst. |
| check |
Überprüft die Verfügbarkeit und Richtigkeit eines Namens für einen API Management-Dienst. |
| get(string, string, Api |
Ruft eine API Management Dienstressourcenbeschreibung ab. |
| get |
Rufen Sie den benutzerdefinierten Domänenbesitzbezeichner für einen API Management-Dienst ab. |
| get |
Ruft das SSO-Token für den API Management-Dienst ab, das 5 Minuten lang gültig ist. |
| list(Api |
Listet alle API Management Dienste in einem Azure-Abonnement auf. |
| list |
Listet alle API Management Dienste innerhalb einer Ressourcengruppe auf. |
Details zur Methode
beginApplyNetworkConfigurationUpdates(string, string, ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams)
Updates die Microsoft.ApiManagement-Ressource, die im virtuellen Netzwerk ausgeführt wird, um die aktualisierten DNS-Änderungen zu wählen.
function beginApplyNetworkConfigurationUpdates(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams): Promise<SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
- serviceName
-
string
Der Name des API Management-Diensts.
Die Optionsparameter.
Gibt zurück
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>
beginApplyNetworkConfigurationUpdatesAndWait(string, string, ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams)
Updates die Microsoft.ApiManagement-Ressource, die im virtuellen Netzwerk ausgeführt wird, um die aktualisierten DNS-Änderungen zu wählen.
function beginApplyNetworkConfigurationUpdatesAndWait(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams): Promise<ApiManagementServiceResource>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
- serviceName
-
string
Der Name des API Management-Diensts.
Die Optionsparameter.
Gibt zurück
Promise<ApiManagementServiceResource>
beginBackup(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceBackupOptionalParams)
Erstellt eine Sicherung des API Management-Diensts für das angegebene Azure Storage-Konto. Dies ist ein lang andauernder Vorgang, der einige Minuten dauern kann.
function beginBackup(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceBackupRestoreParameters, options?: ApiManagementServiceBackupOptionalParams): Promise<SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
- serviceName
-
string
Der Name des API Management-Diensts.
- parameters
- ApiManagementServiceBackupRestoreParameters
Parameter, die für den ApiManagementService_Backup-Vorgang bereitgestellt werden.
Die Optionsparameter.
Gibt zurück
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>
beginBackupAndWait(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceBackupOptionalParams)
Erstellt eine Sicherung des API Management-Diensts für das angegebene Azure Storage-Konto. Dies ist ein lang andauernder Vorgang, der einige Minuten dauern kann.
function beginBackupAndWait(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceBackupRestoreParameters, options?: ApiManagementServiceBackupOptionalParams): Promise<ApiManagementServiceResource>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
- serviceName
-
string
Der Name des API Management-Diensts.
- parameters
- ApiManagementServiceBackupRestoreParameters
Parameter, die für den ApiManagementService_Backup-Vorgang bereitgestellt werden.
Die Optionsparameter.
Gibt zurück
Promise<ApiManagementServiceResource>
beginCreateOrUpdate(string, string, ApiManagementServiceResource, ApiManagementServiceCreateOrUpdateOptionalParams)
Erstellt oder aktualisiert einen API Management-Dienst. Dies ist ein lang andauernder Vorgang, der einige Minuten dauern kann.
function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceResource, options?: ApiManagementServiceCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
- serviceName
-
string
Der Name des API Management-Diensts.
- parameters
- ApiManagementServiceResource
Parameter, die für den CreateOrUpdate-API Management-Dienstvorgangs bereitgestellt werden.
Die Optionsparameter.
Gibt zurück
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>
beginCreateOrUpdateAndWait(string, string, ApiManagementServiceResource, ApiManagementServiceCreateOrUpdateOptionalParams)
Erstellt oder aktualisiert einen API Management-Dienst. Dies ist ein lang andauernder Vorgang, der einige Minuten dauern kann.
function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceResource, options?: ApiManagementServiceCreateOrUpdateOptionalParams): Promise<ApiManagementServiceResource>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
- serviceName
-
string
Der Name des API Management-Diensts.
- parameters
- ApiManagementServiceResource
Parameter, die für den CreateOrUpdate-API Management-Dienstvorgang bereitgestellt werden.
Die Optionsparameter.
Gibt zurück
Promise<ApiManagementServiceResource>
beginDelete(string, string, ApiManagementServiceDeleteOptionalParams)
Löscht einen vorhandenen API Management-Dienst.
function beginDelete(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
- serviceName
-
string
Der Name des API Management-Diensts.
Die Optionsparameter.
Gibt zurück
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, ApiManagementServiceDeleteOptionalParams)
Löscht einen vorhandenen API Management-Dienst.
function beginDeleteAndWait(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceDeleteOptionalParams): Promise<void>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
- serviceName
-
string
Der Name des API Management-Diensts.
Die Optionsparameter.
Gibt zurück
Promise<void>
beginMigrateToStv2(string, string, ApiManagementServiceMigrateToStv2OptionalParams)
Aktualisiert einen API Management-Dienst auf die Stv2-Plattform. Weitere Informationen finden Sie unter https://aka.ms/apim-migrate-stv2. Diese Änderung kann nicht rückgängig gemacht werden. Dies ist ein lang andauernder Vorgang, der einige Minuten dauern kann.
function beginMigrateToStv2(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceMigrateToStv2OptionalParams): Promise<SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
- serviceName
-
string
Der Name des API Management-Diensts.
Die Optionsparameter.
Gibt zurück
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>
beginMigrateToStv2AndWait(string, string, ApiManagementServiceMigrateToStv2OptionalParams)
Aktualisiert einen API Management-Dienst auf die Stv2-Plattform. Weitere Informationen finden Sie unter https://aka.ms/apim-migrate-stv2. Diese Änderung kann nicht rückgängig gemacht werden. Dies ist ein lang andauernder Vorgang, der einige Minuten dauern kann.
function beginMigrateToStv2AndWait(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceMigrateToStv2OptionalParams): Promise<ApiManagementServiceResource>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
- serviceName
-
string
Der Name des API Management-Diensts.
Die Optionsparameter.
Gibt zurück
Promise<ApiManagementServiceResource>
beginRestore(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceRestoreOptionalParams)
Stellt eine Sicherung eines API Management Diensts wieder her, der mit dem vorgang ApiManagementService_Backup für den aktuellen Dienst erstellt wurde. Dies ist ein lang andauernder Vorgang, der einige Minuten dauern kann.
function beginRestore(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceBackupRestoreParameters, options?: ApiManagementServiceRestoreOptionalParams): Promise<SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
- serviceName
-
string
Der Name des API Management-Diensts.
- parameters
- ApiManagementServiceBackupRestoreParameters
Parameter, die für den Wiederherstellungsvorgang API Management-Diensts aus dem Sicherungsvorgang bereitgestellt werden.
Die Optionsparameter.
Gibt zurück
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>
beginRestoreAndWait(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceRestoreOptionalParams)
Stellt eine Sicherung eines API Management Diensts wieder her, der mit dem vorgang ApiManagementService_Backup für den aktuellen Dienst erstellt wurde. Dies ist ein lang andauernder Vorgang, der einige Minuten dauern kann.
function beginRestoreAndWait(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceBackupRestoreParameters, options?: ApiManagementServiceRestoreOptionalParams): Promise<ApiManagementServiceResource>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
- serviceName
-
string
Der Name des API Management-Diensts.
- parameters
- ApiManagementServiceBackupRestoreParameters
Parameter, die für den Wiederherstellungsvorgang API Management-Diensts aus dem Sicherungsvorgang bereitgestellt werden.
Die Optionsparameter.
Gibt zurück
Promise<ApiManagementServiceResource>
beginUpdate(string, string, ApiManagementServiceUpdateParameters, ApiManagementServiceUpdateOptionalParams)
Updates einen vorhandenen API Management-Dienst.
function beginUpdate(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceUpdateParameters, options?: ApiManagementServiceUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
- serviceName
-
string
Der Name des API Management-Diensts.
- parameters
- ApiManagementServiceUpdateParameters
Parameter, die für den CreateOrUpdate-API Management-Dienstvorgang bereitgestellt werden.
Die Optionsparameter.
Gibt zurück
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>
beginUpdateAndWait(string, string, ApiManagementServiceUpdateParameters, ApiManagementServiceUpdateOptionalParams)
Updates einen vorhandenen API Management-Dienst.
function beginUpdateAndWait(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceUpdateParameters, options?: ApiManagementServiceUpdateOptionalParams): Promise<ApiManagementServiceResource>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
- serviceName
-
string
Der Name des API Management-Diensts.
- parameters
- ApiManagementServiceUpdateParameters
Parameter, die für den CreateOrUpdate-API Management-Dienstvorgang bereitgestellt werden.
Die Optionsparameter.
Gibt zurück
Promise<ApiManagementServiceResource>
checkNameAvailability(ApiManagementServiceCheckNameAvailabilityParameters, ApiManagementServiceCheckNameAvailabilityOptionalParams)
Überprüft die Verfügbarkeit und Richtigkeit eines Namens für einen API Management-Dienst.
function checkNameAvailability(parameters: ApiManagementServiceCheckNameAvailabilityParameters, options?: ApiManagementServiceCheckNameAvailabilityOptionalParams): Promise<ApiManagementServiceNameAvailabilityResult>Parameter
Für den Vorgang CheckNameAvailability bereitgestellte Parameter.
Die Optionsparameter.
Gibt zurück
get(string, string, ApiManagementServiceGetOptionalParams)
Ruft eine API Management Dienstressourcenbeschreibung ab.
function get(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceGetOptionalParams): Promise<ApiManagementServiceResource>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
- serviceName
-
string
Der Name des API Management-Diensts.
Die Optionsparameter.
Gibt zurück
Promise<ApiManagementServiceResource>
getDomainOwnershipIdentifier(ApiManagementServiceGetDomainOwnershipIdentifierOptionalParams)
Rufen Sie den benutzerdefinierten Domänenbesitzbezeichner für einen API Management-Dienst ab.
function getDomainOwnershipIdentifier(options?: ApiManagementServiceGetDomainOwnershipIdentifierOptionalParams): Promise<ApiManagementServiceGetDomainOwnershipIdentifierResult>Parameter
Die Optionsparameter.
Gibt zurück
getSsoToken(string, string, ApiManagementServiceGetSsoTokenOptionalParams)
Ruft das SSO-Token für den API Management-Dienst ab, das 5 Minuten lang gültig ist.
function getSsoToken(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceGetSsoTokenOptionalParams): Promise<ApiManagementServiceGetSsoTokenResult>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
- serviceName
-
string
Der Name des API Management-Diensts.
Die Optionsparameter.
Gibt zurück
list(ApiManagementServiceListOptionalParams)
Listet alle API Management Dienste in einem Azure-Abonnement auf.
function list(options?: ApiManagementServiceListOptionalParams): PagedAsyncIterableIterator<ApiManagementServiceResource, ApiManagementServiceResource[], PageSettings>Parameter
Die Optionsparameter.
Gibt zurück
listByResourceGroup(string, ApiManagementServiceListByResourceGroupOptionalParams)
Listet alle API Management Dienste innerhalb einer Ressourcengruppe auf.
function listByResourceGroup(resourceGroupName: string, options?: ApiManagementServiceListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ApiManagementServiceResource, ApiManagementServiceResource[], PageSettings>Parameter
- resourceGroupName
-
string
Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
Die Optionsparameter.