Apps interface
表示应用的接口。
方法
方法详细信息
beginCreateOrUpdate(string, string, App, AppsCreateOrUpdateOptionalParams)
创建或更新 IoT Central 应用程序的元数据。 修改属性的常见模式是检索 IoT Central 应用程序元数据和安全元数据,然后将其与新正文中的修改值合并,以更新 IoT Central 应用程序。
function beginCreateOrUpdate(resourceGroupName: string, resourceName: string, app: App, options?: AppsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<App>, App>>
参数
- resourceGroupName
-
string
包含 IoT Central 应用程序的资源组的名称。
- resourceName
-
string
IoT Central 应用程序的 ARM 资源名称。
- app
- App
IoT Central 应用程序元数据和安全元数据。
- options
- AppsCreateOrUpdateOptionalParams
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<App>, App>>
beginCreateOrUpdateAndWait(string, string, App, AppsCreateOrUpdateOptionalParams)
创建或更新 IoT Central 应用程序的元数据。 修改属性的常见模式是检索 IoT Central 应用程序元数据和安全元数据,然后将其与新正文中的修改值合并,以更新 IoT Central 应用程序。
function beginCreateOrUpdateAndWait(resourceGroupName: string, resourceName: string, app: App, options?: AppsCreateOrUpdateOptionalParams): Promise<App>
参数
- resourceGroupName
-
string
包含 IoT Central 应用程序的资源组的名称。
- resourceName
-
string
IoT Central 应用程序的 ARM 资源名称。
- app
- App
IoT Central 应用程序元数据和安全元数据。
- options
- AppsCreateOrUpdateOptionalParams
选项参数。
返回
Promise<App>
beginDelete(string, string, AppsDeleteOptionalParams)
删除 IoT Central 应用程序。
function beginDelete(resourceGroupName: string, resourceName: string, options?: AppsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
参数
- resourceGroupName
-
string
包含 IoT Central 应用程序的资源组的名称。
- resourceName
-
string
IoT Central 应用程序的 ARM 资源名称。
- options
- AppsDeleteOptionalParams
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginDeleteAndWait(string, string, AppsDeleteOptionalParams)
删除 IoT Central 应用程序。
function beginDeleteAndWait(resourceGroupName: string, resourceName: string, options?: AppsDeleteOptionalParams): Promise<void>
参数
- resourceGroupName
-
string
包含 IoT Central 应用程序的资源组的名称。
- resourceName
-
string
IoT Central 应用程序的 ARM 资源名称。
- options
- AppsDeleteOptionalParams
选项参数。
返回
Promise<void>
beginUpdate(string, string, AppPatch, AppsUpdateOptionalParams)
更新 IoT Central 应用程序的元数据。
function beginUpdate(resourceGroupName: string, resourceName: string, appPatch: AppPatch, options?: AppsUpdateOptionalParams): Promise<PollerLike<PollOperationState<App>, App>>
参数
- resourceGroupName
-
string
包含 IoT Central 应用程序的资源组的名称。
- resourceName
-
string
IoT Central 应用程序的 ARM 资源名称。
- appPatch
- AppPatch
IoT Central 应用程序元数据和安全元数据。
- options
- AppsUpdateOptionalParams
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<App>, App>>
beginUpdateAndWait(string, string, AppPatch, AppsUpdateOptionalParams)
更新 IoT Central 应用程序的元数据。
function beginUpdateAndWait(resourceGroupName: string, resourceName: string, appPatch: AppPatch, options?: AppsUpdateOptionalParams): Promise<App>
参数
- resourceGroupName
-
string
包含 IoT Central 应用程序的资源组的名称。
- resourceName
-
string
IoT Central 应用程序的 ARM 资源名称。
- appPatch
- AppPatch
IoT Central 应用程序元数据和安全元数据。
- options
- AppsUpdateOptionalParams
选项参数。
返回
Promise<App>
checkNameAvailability(OperationInputs, AppsCheckNameAvailabilityOptionalParams)
检查 IoT Central 应用程序名称是否可用。
function checkNameAvailability(operationInputs: OperationInputs, options?: AppsCheckNameAvailabilityOptionalParams): Promise<AppAvailabilityInfo>
参数
- operationInputs
- OperationInputs
将 OperationInputs 结构中的 name 参数设置为要检查的 IoT Central 应用程序的名称。
选项参数。
返回
Promise<AppAvailabilityInfo>
checkSubdomainAvailability(OperationInputs, AppsCheckSubdomainAvailabilityOptionalParams)
检查 IoT Central 应用程序子域是否可用。
function checkSubdomainAvailability(operationInputs: OperationInputs, options?: AppsCheckSubdomainAvailabilityOptionalParams): Promise<AppAvailabilityInfo>
参数
- operationInputs
- OperationInputs
将 OperationInputs 结构中的 name 参数设置为要检查的 IoT Central 应用程序的子域。
选项参数。
返回
Promise<AppAvailabilityInfo>
get(string, string, AppsGetOptionalParams)
获取 IoT Central 应用程序的元数据。
function get(resourceGroupName: string, resourceName: string, options?: AppsGetOptionalParams): Promise<App>
参数
- resourceGroupName
-
string
包含 IoT Central 应用程序的资源组的名称。
- resourceName
-
string
IoT Central 应用程序的 ARM 资源名称。
- options
- AppsGetOptionalParams
选项参数。
返回
Promise<App>
listByResourceGroup(string, AppsListByResourceGroupOptionalParams)
获取资源组中的所有 IoT Central 应用程序。
function listByResourceGroup(resourceGroupName: string, options?: AppsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<App, App[], PageSettings>
参数
- resourceGroupName
-
string
包含 IoT Central 应用程序的资源组的名称。
选项参数。
返回
listBySubscription(AppsListBySubscriptionOptionalParams)
获取订阅中的所有 IoT Central 应用程序。
function listBySubscription(options?: AppsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<App, App[], PageSettings>
参数
选项参数。
返回
listTemplates(AppsListTemplatesOptionalParams)
获取所有可用的应用程序模板。
function listTemplates(options?: AppsListTemplatesOptionalParams): PagedAsyncIterableIterator<AppTemplate, AppTemplate[], PageSettings>
参数
- options
- AppsListTemplatesOptionalParams
选项参数。