ApiManagementService interface
ApiManagementService を表すインターフェイス。
メソッド
メソッドの詳細
beginApplyNetworkConfigurationUpdates(string, string, ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams)
仮想ネットワークで実行されている Microsoft.ApiManagement リソースを更新して、更新された DNS の変更を選択します。
function beginApplyNetworkConfigurationUpdates(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams): Promise<SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
options パラメーター。
戻り値
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>
beginApplyNetworkConfigurationUpdatesAndWait(string, string, ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams)
仮想ネットワークで実行されている Microsoft.ApiManagement リソースを更新して、更新された DNS の変更を選択します。
function beginApplyNetworkConfigurationUpdatesAndWait(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceApplyNetworkConfigurationUpdatesOptionalParams): Promise<ApiManagementServiceResource>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
options パラメーター。
戻り値
Promise<ApiManagementServiceResource>
beginBackup(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceBackupOptionalParams)
指定された Azure ストレージ アカウントへのAPI Management サービスのバックアップを作成します。 これは実行時間の長い操作であり、完了までに数分かかる場合があります。
function beginBackup(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceBackupRestoreParameters, options?: ApiManagementServiceBackupOptionalParams): Promise<SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- parameters
- ApiManagementServiceBackupRestoreParameters
ApiManagementService_Backup操作に指定されたパラメーター。
options パラメーター。
戻り値
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>
beginBackupAndWait(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceBackupOptionalParams)
指定された Azure ストレージ アカウントへのAPI Management サービスのバックアップを作成します。 これは実行時間の長い操作であり、完了までに数分かかる場合があります。
function beginBackupAndWait(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceBackupRestoreParameters, options?: ApiManagementServiceBackupOptionalParams): Promise<ApiManagementServiceResource>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- parameters
- ApiManagementServiceBackupRestoreParameters
ApiManagementService_Backup操作に指定されたパラメーター。
options パラメーター。
戻り値
Promise<ApiManagementServiceResource>
beginCreateOrUpdate(string, string, ApiManagementServiceResource, ApiManagementServiceCreateOrUpdateOptionalParams)
API Management サービスを作成または更新します。 これは実行時間の長い操作であり、完了までに数分かかる場合があります。
function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceResource, options?: ApiManagementServiceCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- parameters
- ApiManagementServiceResource
CreateOrUpdate API Management サービス操作に指定されたパラメーター。
options パラメーター。
戻り値
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>
beginCreateOrUpdateAndWait(string, string, ApiManagementServiceResource, ApiManagementServiceCreateOrUpdateOptionalParams)
API Management サービスを作成または更新します。 これは実行時間の長い操作であり、完了までに数分かかる場合があります。
function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceResource, options?: ApiManagementServiceCreateOrUpdateOptionalParams): Promise<ApiManagementServiceResource>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- parameters
- ApiManagementServiceResource
CreateOrUpdate API Management サービス操作に指定されたパラメーター。
options パラメーター。
戻り値
Promise<ApiManagementServiceResource>
beginDelete(string, string, ApiManagementServiceDeleteOptionalParams)
既存の API Management サービスを削除します。
function beginDelete(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
options パラメーター。
戻り値
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, ApiManagementServiceDeleteOptionalParams)
既存の API Management サービスを削除します。
function beginDeleteAndWait(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceDeleteOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
options パラメーター。
戻り値
Promise<void>
beginMigrateToStv2(string, string, ApiManagementServiceMigrateToStv2OptionalParams)
API Management サービスを Stv2 プラットフォームにアップグレードします。 詳細については、 を https://aka.ms/apim-migrate-stv2参照してください。 この変更は元に戻すことはできません。 これは実行時間の長い操作であり、完了までに数分かかる場合があります。
function beginMigrateToStv2(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceMigrateToStv2OptionalParams): Promise<SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
options パラメーター。
戻り値
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>
beginMigrateToStv2AndWait(string, string, ApiManagementServiceMigrateToStv2OptionalParams)
API Management サービスを Stv2 プラットフォームにアップグレードします。 詳細については、 を https://aka.ms/apim-migrate-stv2参照してください。 この変更は元に戻すことはできません。 これは実行時間の長い操作であり、完了までに数分かかる場合があります。
function beginMigrateToStv2AndWait(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceMigrateToStv2OptionalParams): Promise<ApiManagementServiceResource>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
options パラメーター。
戻り値
Promise<ApiManagementServiceResource>
beginRestore(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceRestoreOptionalParams)
現在のサービスでApiManagementService_Backup操作を使用して作成されたAPI Management サービスのバックアップを復元します。 これは実行時間の長い操作であり、完了までに数分かかる場合があります。
function beginRestore(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceBackupRestoreParameters, options?: ApiManagementServiceRestoreOptionalParams): Promise<SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- parameters
- ApiManagementServiceBackupRestoreParameters
バックアップ操作から復元API Managementサービスに指定されたパラメーター。
options パラメーター。
戻り値
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>
beginRestoreAndWait(string, string, ApiManagementServiceBackupRestoreParameters, ApiManagementServiceRestoreOptionalParams)
現在のサービスでApiManagementService_Backup操作を使用して作成されたAPI Management サービスのバックアップを復元します。 これは実行時間の長い操作であり、完了までに数分かかる場合があります。
function beginRestoreAndWait(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceBackupRestoreParameters, options?: ApiManagementServiceRestoreOptionalParams): Promise<ApiManagementServiceResource>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- parameters
- ApiManagementServiceBackupRestoreParameters
バックアップ操作から復元API Managementサービスに指定されたパラメーター。
options パラメーター。
戻り値
Promise<ApiManagementServiceResource>
beginUpdate(string, string, ApiManagementServiceUpdateParameters, ApiManagementServiceUpdateOptionalParams)
既存のAPI Management サービスを更新します。
function beginUpdate(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceUpdateParameters, options?: ApiManagementServiceUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- parameters
- ApiManagementServiceUpdateParameters
CreateOrUpdate API Management サービス操作に指定されたパラメーター。
options パラメーター。
戻り値
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiManagementServiceResource>, ApiManagementServiceResource>>
beginUpdateAndWait(string, string, ApiManagementServiceUpdateParameters, ApiManagementServiceUpdateOptionalParams)
既存のAPI Management サービスを更新します。
function beginUpdateAndWait(resourceGroupName: string, serviceName: string, parameters: ApiManagementServiceUpdateParameters, options?: ApiManagementServiceUpdateOptionalParams): Promise<ApiManagementServiceResource>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- parameters
- ApiManagementServiceUpdateParameters
CreateOrUpdate API Management サービス操作に指定されたパラメーター。
options パラメーター。
戻り値
Promise<ApiManagementServiceResource>
checkNameAvailability(ApiManagementServiceCheckNameAvailabilityParameters, ApiManagementServiceCheckNameAvailabilityOptionalParams)
API Management サービスの名前の可用性と正確性を確認します。
function checkNameAvailability(parameters: ApiManagementServiceCheckNameAvailabilityParameters, options?: ApiManagementServiceCheckNameAvailabilityOptionalParams): Promise<ApiManagementServiceNameAvailabilityResult>パラメーター
CheckNameAvailability 操作に指定されたパラメーター。
options パラメーター。
戻り値
get(string, string, ApiManagementServiceGetOptionalParams)
API Management サービス リソースの説明を取得します。
function get(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceGetOptionalParams): Promise<ApiManagementServiceResource>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
options パラメーター。
戻り値
Promise<ApiManagementServiceResource>
getDomainOwnershipIdentifier(ApiManagementServiceGetDomainOwnershipIdentifierOptionalParams)
API Management サービスのカスタム ドメイン所有権識別子を取得します。
function getDomainOwnershipIdentifier(options?: ApiManagementServiceGetDomainOwnershipIdentifierOptionalParams): Promise<ApiManagementServiceGetDomainOwnershipIdentifierResult>パラメーター
options パラメーター。
戻り値
getSsoToken(string, string, ApiManagementServiceGetSsoTokenOptionalParams)
5 分間有効なAPI Management サービスのシングル サインオン トークンを取得します。
function getSsoToken(resourceGroupName: string, serviceName: string, options?: ApiManagementServiceGetSsoTokenOptionalParams): Promise<ApiManagementServiceGetSsoTokenResult>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
options パラメーター。
戻り値
list(ApiManagementServiceListOptionalParams)
Azure サブスクリプション内のすべてのAPI Management サービスを一覧表示します。
function list(options?: ApiManagementServiceListOptionalParams): PagedAsyncIterableIterator<ApiManagementServiceResource, ApiManagementServiceResource[], PageSettings>パラメーター
options パラメーター。
戻り値
listByResourceGroup(string, ApiManagementServiceListByResourceGroupOptionalParams)
リソース グループ内のすべてのAPI Management サービスを一覧表示します。
function listByResourceGroup(resourceGroupName: string, options?: ApiManagementServiceListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ApiManagementServiceResource, ApiManagementServiceResource[], PageSettings>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
options パラメーター。