Services interface
表示服務的介面。
方法
方法詳細資料
beginCreateOrUpdate(string, string, ServiceResource, ServicesCreateOrUpdateOptionalParams)
建立新的服務或更新結束的服務。
function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, resource: ServiceResource, options?: ServicesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ServiceResource>, ServiceResource>>參數
- resourceGroupName
-
string
包含資源的資源群組名稱。 您可以從 Azure 資源管理員 API 或入口網站取得這個值。
- serviceName
-
string
服務資源的名稱。
- resource
- ServiceResource
建立或更新作業的參數
選項參數。
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<ServiceResource>, ServiceResource>>
beginCreateOrUpdateAndWait(string, string, ServiceResource, ServicesCreateOrUpdateOptionalParams)
建立新的服務或更新結束的服務。
function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, resource: ServiceResource, options?: ServicesCreateOrUpdateOptionalParams): Promise<ServiceResource>參數
- resourceGroupName
-
string
包含資源的資源群組名稱。 您可以從 Azure 資源管理員 API 或入口網站取得這個值。
- serviceName
-
string
服務資源的名稱。
- resource
- ServiceResource
建立或更新作業的參數
選項參數。
傳回
Promise<ServiceResource>
beginDelete(string, string, ServicesDeleteOptionalParams)
刪除服務的作業。
function beginDelete(resourceGroupName: string, serviceName: string, options?: ServicesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>參數
- resourceGroupName
-
string
包含資源的資源群組名稱。 您可以從 Azure 資源管理員 API 或入口網站取得這個值。
- serviceName
-
string
服務資源的名稱。
- options
- ServicesDeleteOptionalParams
選項參數。
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, ServicesDeleteOptionalParams)
刪除服務的作業。
function beginDeleteAndWait(resourceGroupName: string, serviceName: string, options?: ServicesDeleteOptionalParams): Promise<void>參數
- resourceGroupName
-
string
包含資源的資源群組名稱。 您可以從 Azure 資源管理員 API 或入口網站取得這個值。
- serviceName
-
string
服務資源的名稱。
- options
- ServicesDeleteOptionalParams
選項參數。
傳回
Promise<void>
beginDisableApmGlobally(string, string, ApmReference, ServicesDisableApmGloballyOptionalParams)
全域停用 APM。
function beginDisableApmGlobally(resourceGroupName: string, serviceName: string, apm: ApmReference, options?: ServicesDisableApmGloballyOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>參數
- resourceGroupName
-
string
包含資源的資源群組名稱。 您可以從 Azure 資源管理員 API 或入口網站取得這個值。
- serviceName
-
string
服務資源的名稱。
- apm
- ApmReference
停用作業的目標 APM
選項參數。
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDisableApmGloballyAndWait(string, string, ApmReference, ServicesDisableApmGloballyOptionalParams)
全域停用 APM。
function beginDisableApmGloballyAndWait(resourceGroupName: string, serviceName: string, apm: ApmReference, options?: ServicesDisableApmGloballyOptionalParams): Promise<void>參數
- resourceGroupName
-
string
包含資源的資源群組名稱。 您可以從 Azure 資源管理員 API 或入口網站取得這個值。
- serviceName
-
string
服務資源的名稱。
- apm
- ApmReference
停用作業的目標 APM
選項參數。
傳回
Promise<void>
beginEnableApmGlobally(string, string, ApmReference, ServicesEnableApmGloballyOptionalParams)
全域啟用 APM。
function beginEnableApmGlobally(resourceGroupName: string, serviceName: string, apm: ApmReference, options?: ServicesEnableApmGloballyOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>參數
- resourceGroupName
-
string
包含資源的資源群組名稱。 您可以從 Azure 資源管理員 API 或入口網站取得這個值。
- serviceName
-
string
服務資源的名稱。
- apm
- ApmReference
啟用作業的目標 APM
選項參數。
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginEnableApmGloballyAndWait(string, string, ApmReference, ServicesEnableApmGloballyOptionalParams)
全域啟用 APM。
function beginEnableApmGloballyAndWait(resourceGroupName: string, serviceName: string, apm: ApmReference, options?: ServicesEnableApmGloballyOptionalParams): Promise<void>參數
- resourceGroupName
-
string
包含資源的資源群組名稱。 您可以從 Azure 資源管理員 API 或入口網站取得這個值。
- serviceName
-
string
服務資源的名稱。
- apm
- ApmReference
啟用作業的目標 APM
選項參數。
傳回
Promise<void>
beginFlushVnetDnsSetting(string, string, ServicesFlushVnetDnsSettingOptionalParams)
排清 VNET 插入服務的 DNS 設定 虛擬網路。
function beginFlushVnetDnsSetting(resourceGroupName: string, serviceName: string, options?: ServicesFlushVnetDnsSettingOptionalParams): Promise<SimplePollerLike<OperationState<ServicesFlushVnetDnsSettingHeaders>, ServicesFlushVnetDnsSettingHeaders>>參數
- resourceGroupName
-
string
包含資源的資源群組名稱。 您可以從 Azure 資源管理員 API 或入口網站取得這個值。
- serviceName
-
string
服務資源的名稱。
選項參數。
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<ServicesFlushVnetDnsSettingHeaders>, ServicesFlushVnetDnsSettingHeaders>>
beginFlushVnetDnsSettingAndWait(string, string, ServicesFlushVnetDnsSettingOptionalParams)
排清 VNET 插入服務的 DNS 設定 虛擬網路。
function beginFlushVnetDnsSettingAndWait(resourceGroupName: string, serviceName: string, options?: ServicesFlushVnetDnsSettingOptionalParams): Promise<ServicesFlushVnetDnsSettingHeaders>參數
- resourceGroupName
-
string
包含資源的資源群組名稱。 您可以從 Azure 資源管理員 API 或入口網站取得這個值。
- serviceName
-
string
服務資源的名稱。
選項參數。
傳回
Promise<ServicesFlushVnetDnsSettingHeaders>
beginStart(string, string, ServicesStartOptionalParams)
啟動服務。
function beginStart(resourceGroupName: string, serviceName: string, options?: ServicesStartOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>參數
- resourceGroupName
-
string
包含資源的資源群組名稱。 您可以從 Azure 資源管理員 API 或入口網站取得這個值。
- serviceName
-
string
服務資源的名稱。
- options
- ServicesStartOptionalParams
選項參數。
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginStartAndWait(string, string, ServicesStartOptionalParams)
啟動服務。
function beginStartAndWait(resourceGroupName: string, serviceName: string, options?: ServicesStartOptionalParams): Promise<void>參數
- resourceGroupName
-
string
包含資源的資源群組名稱。 您可以從 Azure 資源管理員 API 或入口網站取得這個值。
- serviceName
-
string
服務資源的名稱。
- options
- ServicesStartOptionalParams
選項參數。
傳回
Promise<void>
beginStop(string, string, ServicesStopOptionalParams)
停止服務。
function beginStop(resourceGroupName: string, serviceName: string, options?: ServicesStopOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>參數
- resourceGroupName
-
string
包含資源的資源群組名稱。 您可以從 Azure 資源管理員 API 或入口網站取得這個值。
- serviceName
-
string
服務資源的名稱。
- options
- ServicesStopOptionalParams
選項參數。
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginStopAndWait(string, string, ServicesStopOptionalParams)
停止服務。
function beginStopAndWait(resourceGroupName: string, serviceName: string, options?: ServicesStopOptionalParams): Promise<void>參數
- resourceGroupName
-
string
包含資源的資源群組名稱。 您可以從 Azure 資源管理員 API 或入口網站取得這個值。
- serviceName
-
string
服務資源的名稱。
- options
- ServicesStopOptionalParams
選項參數。
傳回
Promise<void>
beginUpdate(string, string, ServiceResource, ServicesUpdateOptionalParams)
更新結束服務的作業。
function beginUpdate(resourceGroupName: string, serviceName: string, resource: ServiceResource, options?: ServicesUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ServiceResource>, ServiceResource>>參數
- resourceGroupName
-
string
包含資源的資源群組名稱。 您可以從 Azure 資源管理員 API 或入口網站取得這個值。
- serviceName
-
string
服務資源的名稱。
- resource
- ServiceResource
更新作業的參數
- options
- ServicesUpdateOptionalParams
選項參數。
傳回
Promise<@azure/core-lro.SimplePollerLike<OperationState<ServiceResource>, ServiceResource>>
beginUpdateAndWait(string, string, ServiceResource, ServicesUpdateOptionalParams)
更新結束服務的作業。
function beginUpdateAndWait(resourceGroupName: string, serviceName: string, resource: ServiceResource, options?: ServicesUpdateOptionalParams): Promise<ServiceResource>參數
- resourceGroupName
-
string
包含資源的資源群組名稱。 您可以從 Azure 資源管理員 API 或入口網站取得這個值。
- serviceName
-
string
服務資源的名稱。
- resource
- ServiceResource
更新作業的參數
- options
- ServicesUpdateOptionalParams
選項參數。
傳回
Promise<ServiceResource>
checkNameAvailability(string, NameAvailabilityParameters, ServicesCheckNameAvailabilityOptionalParams)
檢查資源名稱是否有效，且尚未使用中。
function checkNameAvailability(location: string, availabilityParameters: NameAvailabilityParameters, options?: ServicesCheckNameAvailabilityOptionalParams): Promise<NameAvailability>參數
- location
-
string
區域
- availabilityParameters
- NameAvailabilityParameters
提供給作業的參數。
選項參數。
傳回
Promise<NameAvailability>
disableTestEndpoint(string, string, ServicesDisableTestEndpointOptionalParams)
停用服務的測試端點功能。
function disableTestEndpoint(resourceGroupName: string, serviceName: string, options?: ServicesDisableTestEndpointOptionalParams): Promise<void>參數
- resourceGroupName
-
string
包含資源的資源群組名稱。 您可以從 Azure 資源管理員 API 或入口網站取得這個值。
- serviceName
-
string
服務資源的名稱。
選項參數。
傳回
Promise<void>
enableTestEndpoint(string, string, ServicesEnableTestEndpointOptionalParams)
啟用服務的測試端點功能。
function enableTestEndpoint(resourceGroupName: string, serviceName: string, options?: ServicesEnableTestEndpointOptionalParams): Promise<TestKeys>參數
- resourceGroupName
-
string
包含資源的資源群組名稱。 您可以從 Azure 資源管理員 API 或入口網站取得這個值。
- serviceName
-
string
服務資源的名稱。
選項參數。
傳回
Promise<TestKeys>
get(string, string, ServicesGetOptionalParams)
取得服務及其屬性。
function get(resourceGroupName: string, serviceName: string, options?: ServicesGetOptionalParams): Promise<ServiceResource>參數
- resourceGroupName
-
string
包含資源的資源群組名稱。 您可以從 Azure 資源管理員 API 或入口網站取得這個值。
- serviceName
-
string
服務資源的名稱。
- options
- ServicesGetOptionalParams
選項參數。
傳回
Promise<ServiceResource>
list(string, ServicesListOptionalParams)
處理列出資源群組中所有資源的要求。
function list(resourceGroupName: string, options?: ServicesListOptionalParams): PagedAsyncIterableIterator<ServiceResource, ServiceResource[], PageSettings>參數
- resourceGroupName
-
string
包含資源的資源群組名稱。 您可以從 Azure 資源管理員 API 或入口網站取得這個值。
- options
- ServicesListOptionalParams
選項參數。
傳回
listBySubscription(ServicesListBySubscriptionOptionalParams)
處理要求以列出訂用帳戶中的所有資源。
function listBySubscription(options?: ServicesListBySubscriptionOptionalParams): PagedAsyncIterableIterator<ServiceResource, ServiceResource[], PageSettings>參數
選項參數。
傳回
listGloballyEnabledApms(string, string, ServicesListGloballyEnabledApmsOptionalParams)
列出服務已啟用全域的 APM。
function listGloballyEnabledApms(resourceGroupName: string, serviceName: string, options?: ServicesListGloballyEnabledApmsOptionalParams): Promise<GloballyEnabledApms>參數
- resourceGroupName
-
string
包含資源的資源群組名稱。 您可以從 Azure 資源管理員 API 或入口網站取得這個值。
- serviceName
-
string
服務資源的名稱。
選項參數。
傳回
Promise<GloballyEnabledApms>
listSupportedApmTypes(string, string, ServicesListSupportedApmTypesOptionalParams)
列出服務支援的 APM 類型。
function listSupportedApmTypes(resourceGroupName: string, serviceName: string, options?: ServicesListSupportedApmTypesOptionalParams): PagedAsyncIterableIterator<SupportedApmType, SupportedApmType[], PageSettings>參數
- resourceGroupName
-
string
包含資源的資源群組名稱。 您可以從 Azure 資源管理員 API 或入口網站取得這個值。
- serviceName
-
string
服務資源的名稱。
選項參數。
傳回
listSupportedServerVersions(string, string, ServicesListSupportedServerVersionsOptionalParams)
清單 Microsoft.AppPlatform 提供者支援的所有可用伺服器版本。
function listSupportedServerVersions(resourceGroupName: string, serviceName: string, options?: ServicesListSupportedServerVersionsOptionalParams): PagedAsyncIterableIterator<SupportedServerVersion, SupportedServerVersion[], PageSettings>參數
- resourceGroupName
-
string
包含資源的資源群組名稱。 您可以從 Azure 資源管理員 API 或入口網站取得這個值。
- serviceName
-
string
服務資源的名稱。
選項參數。
傳回
listTestKeys(string, string, ServicesListTestKeysOptionalParams)
列出服務的測試金鑰。
function listTestKeys(resourceGroupName: string, serviceName: string, options?: ServicesListTestKeysOptionalParams): Promise<TestKeys>參數
- resourceGroupName
-
string
包含資源的資源群組名稱。 您可以從 Azure 資源管理員 API 或入口網站取得這個值。
- serviceName
-
string
服務資源的名稱。
選項參數。
傳回
Promise<TestKeys>
regenerateTestKey(string, string, RegenerateTestKeyRequestPayload, ServicesRegenerateTestKeyOptionalParams)
重新產生服務的測試金鑰。
function regenerateTestKey(resourceGroupName: string, serviceName: string, regenerateTestKeyRequest: RegenerateTestKeyRequestPayload, options?: ServicesRegenerateTestKeyOptionalParams): Promise<TestKeys>參數
- resourceGroupName
-
string
包含資源的資源群組名稱。 您可以從 Azure 資源管理員 API 或入口網站取得這個值。
- serviceName
-
string
服務資源的名稱。
- regenerateTestKeyRequest
- RegenerateTestKeyRequestPayload
作業的參數
選項參數。
傳回
Promise<TestKeys>