DigitalTwins interface
表示 DigitalTwins 的接口。
方法
方法详细信息
beginCreateOrUpdate(string, string, DigitalTwinsDescription, DigitalTwinsCreateOrUpdateOptionalParams)
创建或更新 DigitalTwinsInstance 的元数据。 修改属性的常见模式是检索 DigitalTwinsInstance 和安全元数据,然后将其与新正文中的修改值合并,以更新 DigitalTwinsInstance。
function beginCreateOrUpdate(resourceGroupName: string, resourceName: string, digitalTwinsCreate: DigitalTwinsDescription, options?: DigitalTwinsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<DigitalTwinsDescription>, DigitalTwinsDescription>>
参数
- resourceGroupName
-
string
包含 DigitalTwinsInstance 的资源组的名称。
- resourceName
-
string
DigitalTwinsInstance 的名称。
- digitalTwinsCreate
- DigitalTwinsDescription
DigitalTwinsInstance 和安全元数据。
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<DigitalTwinsDescription>, DigitalTwinsDescription>>
beginCreateOrUpdateAndWait(string, string, DigitalTwinsDescription, DigitalTwinsCreateOrUpdateOptionalParams)
创建或更新 DigitalTwinsInstance 的元数据。 修改属性的常见模式是检索 DigitalTwinsInstance 和安全元数据,然后将其与新正文中的修改值合并,以更新 DigitalTwinsInstance。
function beginCreateOrUpdateAndWait(resourceGroupName: string, resourceName: string, digitalTwinsCreate: DigitalTwinsDescription, options?: DigitalTwinsCreateOrUpdateOptionalParams): Promise<DigitalTwinsDescription>
参数
- resourceGroupName
-
string
包含 DigitalTwinsInstance 的资源组的名称。
- resourceName
-
string
DigitalTwinsInstance 的名称。
- digitalTwinsCreate
- DigitalTwinsDescription
DigitalTwinsInstance 和安全元数据。
选项参数。
返回
Promise<DigitalTwinsDescription>
beginDelete(string, string, DigitalTwinsDeleteOptionalParams)
删除 DigitalTwinsInstance。
function beginDelete(resourceGroupName: string, resourceName: string, options?: DigitalTwinsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<DigitalTwinsDescription>, DigitalTwinsDescription>>
参数
- resourceGroupName
-
string
包含 DigitalTwinsInstance 的资源组的名称。
- resourceName
-
string
DigitalTwinsInstance 的名称。
- options
- DigitalTwinsDeleteOptionalParams
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<DigitalTwinsDescription>, DigitalTwinsDescription>>
beginDeleteAndWait(string, string, DigitalTwinsDeleteOptionalParams)
删除 DigitalTwinsInstance。
function beginDeleteAndWait(resourceGroupName: string, resourceName: string, options?: DigitalTwinsDeleteOptionalParams): Promise<DigitalTwinsDescription>
参数
- resourceGroupName
-
string
包含 DigitalTwinsInstance 的资源组的名称。
- resourceName
-
string
DigitalTwinsInstance 的名称。
- options
- DigitalTwinsDeleteOptionalParams
选项参数。
返回
Promise<DigitalTwinsDescription>
beginUpdate(string, string, DigitalTwinsPatchDescription, DigitalTwinsUpdateOptionalParams)
更新 DigitalTwinsInstance 的元数据。
function beginUpdate(resourceGroupName: string, resourceName: string, digitalTwinsPatchDescription: DigitalTwinsPatchDescription, options?: DigitalTwinsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<DigitalTwinsDescription>, DigitalTwinsDescription>>
参数
- resourceGroupName
-
string
包含 DigitalTwinsInstance 的资源组的名称。
- resourceName
-
string
DigitalTwinsInstance 的名称。
- digitalTwinsPatchDescription
- DigitalTwinsPatchDescription
DigitalTwinsInstance 和安全元数据。
- options
- DigitalTwinsUpdateOptionalParams
选项参数。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<DigitalTwinsDescription>, DigitalTwinsDescription>>
beginUpdateAndWait(string, string, DigitalTwinsPatchDescription, DigitalTwinsUpdateOptionalParams)
更新 DigitalTwinsInstance 的元数据。
function beginUpdateAndWait(resourceGroupName: string, resourceName: string, digitalTwinsPatchDescription: DigitalTwinsPatchDescription, options?: DigitalTwinsUpdateOptionalParams): Promise<DigitalTwinsDescription>
参数
- resourceGroupName
-
string
包含 DigitalTwinsInstance 的资源组的名称。
- resourceName
-
string
DigitalTwinsInstance 的名称。
- digitalTwinsPatchDescription
- DigitalTwinsPatchDescription
DigitalTwinsInstance 和安全元数据。
- options
- DigitalTwinsUpdateOptionalParams
选项参数。
返回
Promise<DigitalTwinsDescription>
checkNameAvailability(string, CheckNameRequest, DigitalTwinsCheckNameAvailabilityOptionalParams)
检查 DigitalTwinsInstance 名称是否可用。
function checkNameAvailability(location: string, digitalTwinsInstanceCheckName: CheckNameRequest, options?: DigitalTwinsCheckNameAvailabilityOptionalParams): Promise<CheckNameResult>
参数
- location
-
string
DigitalTwinsInstance 的位置。
- digitalTwinsInstanceCheckName
- CheckNameRequest
将 DigitalTwinsInstanceCheckName 结构中的 name 参数设置为要检查的 DigitalTwinsInstance 的名称。
选项参数。
返回
Promise<CheckNameResult>
get(string, string, DigitalTwinsGetOptionalParams)
获取 DigitalTwinsInstances 资源。
function get(resourceGroupName: string, resourceName: string, options?: DigitalTwinsGetOptionalParams): Promise<DigitalTwinsDescription>
参数
- resourceGroupName
-
string
包含 DigitalTwinsInstance 的资源组的名称。
- resourceName
-
string
DigitalTwinsInstance 的名称。
- options
- DigitalTwinsGetOptionalParams
选项参数。
返回
Promise<DigitalTwinsDescription>
list(DigitalTwinsListOptionalParams)
获取订阅中的所有 DigitalTwinsInstances。
function list(options?: DigitalTwinsListOptionalParams): PagedAsyncIterableIterator<DigitalTwinsDescription, DigitalTwinsDescription[], PageSettings>
参数
- options
- DigitalTwinsListOptionalParams
选项参数。
返回
listByResourceGroup(string, DigitalTwinsListByResourceGroupOptionalParams)
获取资源组中的所有 DigitalTwinsInstances。
function listByResourceGroup(resourceGroupName: string, options?: DigitalTwinsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<DigitalTwinsDescription, DigitalTwinsDescription[], PageSettings>
参数
- resourceGroupName
-
string
包含 DigitalTwinsInstance 的资源组的名称。
选项参数。