ApiManagementService interface
Interface die een ApiManagementService vertegenwoordigt.
Methoden
| begin |
Updates de resource Microsoft.ApiManagement die wordt uitgevoerd in het virtuele netwerk om de bijgewerkte DNS-wijzigingen te kiezen. |
| begin |
Updates de resource Microsoft.ApiManagement die wordt uitgevoerd in het virtuele netwerk om de bijgewerkte DNS-wijzigingen te kiezen. |
| begin |
Hiermee maakt u een back-up van de API Management-service naar het opgegeven Azure Storage-account. Dit is een langdurige bewerking en kan enkele minuten duren. |
| begin |
Hiermee maakt u een back-up van de API Management-service naar het opgegeven Azure Storage-account. Dit is een langdurige bewerking en kan enkele minuten duren. |
| begin |
Hiermee wordt een API Management-service gemaakt of bijgewerkt. Dit is een langdurige bewerking en kan enkele minuten duren. |
| begin |
Hiermee wordt een API Management-service gemaakt of bijgewerkt. Dit is een langdurige bewerking en kan enkele minuten duren. |
| begin |
Hiermee verwijdert u een bestaande API Management-service. |
| begin |
Hiermee verwijdert u een bestaande API Management-service. |
| begin |
Hiermee wordt een API Management-service bijgewerkt naar het Stv2-platform. Raadpleeg voor https://aka.ms/apim-migrate-stv2meer informatie. Deze wijziging kan niet ongedaan worden gemaakt. Dit is een langdurige bewerking en kan enkele minuten duren. |
| begin |
Hiermee wordt een API Management-service bijgewerkt naar het Stv2-platform. Raadpleeg voor https://aka.ms/apim-migrate-stv2meer informatie. Deze wijziging kan niet ongedaan worden gemaakt. Dit is een langdurige bewerking en kan enkele minuten duren. |
| begin |
Hiermee herstelt u een back-up van een API Management service die is gemaakt met behulp van de ApiManagementService_Backup bewerking voor de huidige service. Dit is een langdurige bewerking en kan enkele minuten duren. |
| begin |
Hiermee herstelt u een back-up van een API Management service die is gemaakt met behulp van de ApiManagementService_Backup bewerking voor de huidige service. Dit is een langdurige bewerking en kan enkele minuten duren. |
| begin |
Updates een bestaande API Management-service. |
| begin |
Updates een bestaande API Management-service. |
| check |
Controleert de beschikbaarheid en juistheid van een naam voor een API Management service. |
| get(string, string, Api |
Hiermee haalt u een API Management serviceresourcebeschrijving op. |
| get |
Haal de id van het aangepaste domeineigendom op voor een API Management-service. |
| get |
Hiermee haalt u het token voor eenmalige aanmelding voor de API Management Service op dat 5 minuten geldig is. |
| list(Api |
Een lijst met alle API Management services binnen een Azure-abonnement. |
| list |
Alle API Management services in een resourcegroep weergeven. |
Methodedetails
beginApplyNetworkConfigurationUpdates(string, string, ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams)
Updates de resource Microsoft.ApiManagement die wordt uitgevoerd in het virtuele netwerk om de bijgewerkte DNS-wijzigingen te kiezen.
function beginApplyNetworkConfigurationUpdates(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams): Promise<SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management service.
De optiesparameters.
Retouren
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>
beginApplyNetworkConfigurationUpdatesAndWait(string, string, ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams)
Updates de resource Microsoft.ApiManagement die wordt uitgevoerd in het virtuele netwerk om de bijgewerkte DNS-wijzigingen te kiezen.
function beginApplyNetworkConfigurationUpdatesAndWait(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams): Promise<ApiManagementServiceResource>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management service.
De optiesparameters.
Retouren
Promise<ApiManagementServiceResource>
beginBackup(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceBackupOptionalParams)
Hiermee maakt u een back-up van de API Management-service naar het opgegeven Azure Storage-account. Dit is een langdurige bewerking en kan enkele minuten duren.
function beginBackup(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceBackupRestoreParameters, options?: ApiManagementServiceBackupOptionalParams): Promise<SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management service.
- parameters
- ApiManagementServiceBackupRestoreParameters
Parameters die zijn opgegeven voor de bewerking ApiManagementService_Backup.
De optiesparameters.
Retouren
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>
beginBackupAndWait(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceBackupOptionalParams)
Hiermee maakt u een back-up van de API Management-service naar het opgegeven Azure Storage-account. Dit is een langdurige bewerking en kan enkele minuten duren.
function beginBackupAndWait(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceBackupRestoreParameters, options?: ApiManagementServiceBackupOptionalParams): Promise<ApiManagementServiceResource>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management service.
- parameters
- ApiManagementServiceBackupRestoreParameters
Parameters die zijn opgegeven voor de bewerking ApiManagementService_Backup.
De optiesparameters.
Retouren
Promise<ApiManagementServiceResource>
beginCreateOrUpdate(string, string, ApiManagementServiceResource, ApiManagementServiceCreateOrUpdateOptionalParams)
Hiermee wordt een API Management-service gemaakt of bijgewerkt. Dit is een langdurige bewerking en kan enkele minuten duren.
function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceResource, options?: ApiManagementServiceCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management service.
- parameters
- ApiManagementServiceResource
Parameters die zijn opgegeven voor de bewerking CreateOrUpdate API Management service.
De optiesparameters.
Retouren
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>
beginCreateOrUpdateAndWait(string, string, ApiManagementServiceResource, ApiManagementServiceCreateOrUpdateOptionalParams)
Hiermee wordt een API Management-service gemaakt of bijgewerkt. Dit is een langdurige bewerking en kan enkele minuten duren.
function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceResource, options?: ApiManagementServiceCreateOrUpdateOptionalParams): Promise<ApiManagementServiceResource>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management service.
- parameters
- ApiManagementServiceResource
Parameters die zijn opgegeven voor de bewerking CreateOrUpdate API Management service.
De optiesparameters.
Retouren
Promise<ApiManagementServiceResource>
beginDelete(string, string, ApiManagementServiceDeleteOptionalParams)
Hiermee verwijdert u een bestaande API Management-service.
function beginDelete(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management service.
De optiesparameters.
Retouren
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, ApiManagementServiceDeleteOptionalParams)
Hiermee verwijdert u een bestaande API Management-service.
function beginDeleteAndWait(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management service.
De optiesparameters.
Retouren
Promise<void>
beginMigrateToStv2(string, string, ApiManagementServiceMigrateToStv2OptionalParams)
Hiermee wordt een API Management-service bijgewerkt naar het Stv2-platform. Raadpleeg voor https://aka.ms/apim-migrate-stv2meer informatie. Deze wijziging kan niet ongedaan worden gemaakt. Dit is een langdurige bewerking en kan enkele minuten duren.
function beginMigrateToStv2(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceMigrateToStv2OptionalParams): Promise<SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management service.
De optiesparameters.
Retouren
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>
beginMigrateToStv2AndWait(string, string, ApiManagementServiceMigrateToStv2OptionalParams)
Hiermee wordt een API Management-service bijgewerkt naar het Stv2-platform. Raadpleeg voor https://aka.ms/apim-migrate-stv2meer informatie. Deze wijziging kan niet ongedaan worden gemaakt. Dit is een langdurige bewerking en kan enkele minuten duren.
function beginMigrateToStv2AndWait(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceMigrateToStv2OptionalParams): Promise<ApiManagementServiceResource>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management service.
De optiesparameters.
Retouren
Promise<ApiManagementServiceResource>
beginRestore(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceRestoreOptionalParams)
Hiermee herstelt u een back-up van een API Management service die is gemaakt met behulp van de ApiManagementService_Backup bewerking voor de huidige service. Dit is een langdurige bewerking en kan enkele minuten duren.
function beginRestore(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceBackupRestoreParameters, options?: ApiManagementServiceRestoreOptionalParams): Promise<SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management service.
- parameters
- ApiManagementServiceBackupRestoreParameters
Parameters die zijn opgegeven voor de API Management-service herstellen vanuit de back-upbewerking.
De optiesparameters.
Retouren
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>
beginRestoreAndWait(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceRestoreOptionalParams)
Hiermee herstelt u een back-up van een API Management service die is gemaakt met behulp van de ApiManagementService_Backup bewerking voor de huidige service. Dit is een langdurige bewerking en kan enkele minuten duren.
function beginRestoreAndWait(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceBackupRestoreParameters, options?: ApiManagementServiceRestoreOptionalParams): Promise<ApiManagementServiceResource>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management service.
- parameters
- ApiManagementServiceBackupRestoreParameters
Parameters die zijn opgegeven voor de API Management-service herstellen vanuit de back-upbewerking.
De optiesparameters.
Retouren
Promise<ApiManagementServiceResource>
beginUpdate(string, string, ApiManagementServiceUpdateParameters, ApiManagementServiceUpdateOptionalParams)
Updates een bestaande API Management-service.
function beginUpdate(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceUpdateParameters, options?: ApiManagementServiceUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management service.
- parameters
- ApiManagementServiceUpdateParameters
Parameters die zijn opgegeven voor de bewerking CreateOrUpdate API Management service.
De optiesparameters.
Retouren
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>
beginUpdateAndWait(string, string, ApiManagementServiceUpdateParameters, ApiManagementServiceUpdateOptionalParams)
Updates een bestaande API Management-service.
function beginUpdateAndWait(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceUpdateParameters, options?: ApiManagementServiceUpdateOptionalParams): Promise<ApiManagementServiceResource>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management service.
- parameters
- ApiManagementServiceUpdateParameters
Parameters die zijn opgegeven voor de bewerking CreateOrUpdate API Management service.
De optiesparameters.
Retouren
Promise<ApiManagementServiceResource>
checkNameAvailability(ApiManagementServiceCheckNameAvailabilityParameters, ApiManagementServiceCheckNameAvailabilityOptionalParams)
Controleert de beschikbaarheid en juistheid van een naam voor een API Management service.
function checkNameAvailability(parameters: ApiManagementServiceCheckNameAvailabilityParameters, options?: ApiManagementServiceCheckNameAvailabilityOptionalParams): Promise<ApiManagementServiceNameAvailabilityResult>Parameters
Parameters die zijn opgegeven voor de bewerking CheckNameAvailability.
De optiesparameters.
Retouren
get(string, string, ApiManagementServiceGetOptionalParams)
Hiermee haalt u een API Management serviceresourcebeschrijving op.
function get(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceGetOptionalParams): Promise<ApiManagementServiceResource>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management service.
De optiesparameters.
Retouren
Promise<ApiManagementServiceResource>
getDomainOwnershipIdentifier(ApiManagementServiceGetDomainOwnershipIdentifierOptionalParams)
Haal de id van het aangepaste domeineigendom op voor een API Management-service.
function getDomainOwnershipIdentifier(options?: ApiManagementServiceGetDomainOwnershipIdentifierOptionalParams): Promise<ApiManagementServiceGetDomainOwnershipIdentifierResult>Parameters
De optiesparameters.
Retouren
getSsoToken(string, string, ApiManagementServiceGetSsoTokenOptionalParams)
Hiermee haalt u het token voor eenmalige aanmelding voor de API Management Service op dat 5 minuten geldig is.
function getSsoToken(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceGetSsoTokenOptionalParams): Promise<ApiManagementServiceGetSsoTokenResult>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management service.
De optiesparameters.
Retouren
list(ApiManagementServiceListOptionalParams)
Een lijst met alle API Management services binnen een Azure-abonnement.
function list(options?: ApiManagementServiceListOptionalParams): PagedAsyncIterableIterator<ApiManagementServiceResource, ApiManagementServiceResource[], PageSettings>Parameters
De optiesparameters.
Retouren
listByResourceGroup(string, ApiManagementServiceListByResourceGroupOptionalParams)
Alle API Management services in een resourcegroep weergeven.
function listByResourceGroup(resourceGroupName: string, options?: ApiManagementServiceListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ApiManagementServiceResource, ApiManagementServiceResource[], PageSettings>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
De optiesparameters.