你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
IotDpsResource interface
表示 IotDpsResource 的接口。
方法
方法详细信息
beginCreateOrUpdate(string, string, ProvisioningServiceDescription, IotDpsResourceCreateOrUpdateOptionalParams)
创建或更新预配服务的元数据。 修改属性的常见模式是检索预配服务元数据和安全元数据，然后将它们与新正文中的修改值合并，以更新预配服务。
function beginCreateOrUpdate(resourceGroupName: string, provisioningServiceName: string, iotDpsDescription: ProvisioningServiceDescription, options?: IotDpsResourceCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<ProvisioningServiceDescription>, ProvisioningServiceDescription>>参数
- resourceGroupName
-
string
资源组标识符。
- provisioningServiceName
-
string
要创建或更新的预配服务的名称。
- iotDpsDescription
- ProvisioningServiceDescription
要创建或更新的预配服务的说明。
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<ProvisioningServiceDescription>, ProvisioningServiceDescription>>
beginCreateOrUpdateAndWait(string, string, ProvisioningServiceDescription, IotDpsResourceCreateOrUpdateOptionalParams)
创建或更新预配服务的元数据。 修改属性的常见模式是检索预配服务元数据和安全元数据，然后将它们与新正文中的修改值合并，以更新预配服务。
function beginCreateOrUpdateAndWait(resourceGroupName: string, provisioningServiceName: string, iotDpsDescription: ProvisioningServiceDescription, options?: IotDpsResourceCreateOrUpdateOptionalParams): Promise<ProvisioningServiceDescription>参数
- resourceGroupName
-
string
资源组标识符。
- provisioningServiceName
-
string
要创建或更新的预配服务的名称。
- iotDpsDescription
- ProvisioningServiceDescription
要创建或更新的预配服务的说明。
选项参数。
返回
Promise<ProvisioningServiceDescription>
beginCreateOrUpdatePrivateEndpointConnection(string, string, string, PrivateEndpointConnection, IotDpsResourceCreateOrUpdatePrivateEndpointConnectionOptionalParams)
创建或更新具有指定名称的专用终结点连接的状态
function beginCreateOrUpdatePrivateEndpointConnection(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, privateEndpointConnection: PrivateEndpointConnection, options?: IotDpsResourceCreateOrUpdatePrivateEndpointConnectionOptionalParams): Promise<PollerLike<PollOperationState<PrivateEndpointConnection>, PrivateEndpointConnection>>参数
- resourceGroupName
-
string
包含预配服务的资源组的名称。
- resourceName
-
string
预配服务的名称。
- privateEndpointConnectionName
-
string
专用终结点连接的名称
- privateEndpointConnection
- PrivateEndpointConnection
具有更新属性的专用终结点连接
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<PrivateEndpointConnection>, PrivateEndpointConnection>>
beginCreateOrUpdatePrivateEndpointConnectionAndWait(string, string, string, PrivateEndpointConnection, IotDpsResourceCreateOrUpdatePrivateEndpointConnectionOptionalParams)
创建或更新具有指定名称的专用终结点连接的状态
function beginCreateOrUpdatePrivateEndpointConnectionAndWait(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, privateEndpointConnection: PrivateEndpointConnection, options?: IotDpsResourceCreateOrUpdatePrivateEndpointConnectionOptionalParams): Promise<PrivateEndpointConnection>参数
- resourceGroupName
-
string
包含预配服务的资源组的名称。
- resourceName
-
string
预配服务的名称。
- privateEndpointConnectionName
-
string
专用终结点连接的名称
- privateEndpointConnection
- PrivateEndpointConnection
具有更新属性的专用终结点连接
返回
Promise<PrivateEndpointConnection>
beginDelete(string, string, IotDpsResourceDeleteOptionalParams)
删除预配服务。
function beginDelete(provisioningServiceName: string, resourceGroupName: string, options?: IotDpsResourceDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>参数
- provisioningServiceName
-
string
要删除的预配服务的名称。
- resourceGroupName
-
string
资源组标识符。
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginDeleteAndWait(string, string, IotDpsResourceDeleteOptionalParams)
删除预配服务。
function beginDeleteAndWait(provisioningServiceName: string, resourceGroupName: string, options?: IotDpsResourceDeleteOptionalParams): Promise<void>参数
- provisioningServiceName
-
string
要删除的预配服务的名称。
- resourceGroupName
-
string
资源组标识符。
选项参数。
返回
Promise<void>
beginDeletePrivateEndpointConnection(string, string, string, IotDpsResourceDeletePrivateEndpointConnectionOptionalParams)
删除具有指定名称的专用终结点连接
function beginDeletePrivateEndpointConnection(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, options?: IotDpsResourceDeletePrivateEndpointConnectionOptionalParams): Promise<PollerLike<PollOperationState<PrivateEndpointConnection>, PrivateEndpointConnection>>参数
- resourceGroupName
-
string
包含预配服务的资源组的名称。
- resourceName
-
string
预配服务的名称。
- privateEndpointConnectionName
-
string
专用终结点连接的名称
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<PrivateEndpointConnection>, PrivateEndpointConnection>>
beginDeletePrivateEndpointConnectionAndWait(string, string, string, IotDpsResourceDeletePrivateEndpointConnectionOptionalParams)
删除具有指定名称的专用终结点连接
function beginDeletePrivateEndpointConnectionAndWait(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, options?: IotDpsResourceDeletePrivateEndpointConnectionOptionalParams): Promise<PrivateEndpointConnection>参数
- resourceGroupName
-
string
包含预配服务的资源组的名称。
- resourceName
-
string
预配服务的名称。
- privateEndpointConnectionName
-
string
专用终结点连接的名称
返回
Promise<PrivateEndpointConnection>
beginUpdate(string, string, TagsResource, IotDpsResourceUpdateOptionalParams)
更新现有预配服务的标记。 若要更新其他字段，请使用 CreateOrUpdate 方法
function beginUpdate(resourceGroupName: string, provisioningServiceName: string, provisioningServiceTags: TagsResource, options?: IotDpsResourceUpdateOptionalParams): Promise<PollerLike<PollOperationState<ProvisioningServiceDescription>, ProvisioningServiceDescription>>参数
- resourceGroupName
-
string
资源组标识符。
- provisioningServiceName
-
string
要创建或更新的预配服务的名称。
- provisioningServiceTags
- TagsResource
更新了要设置为预配服务实例的标记信息。
选项参数。
返回
Promise<PollerLike<@azure/core-lro.PollOperationState<ProvisioningServiceDescription>, ProvisioningServiceDescription>>
beginUpdateAndWait(string, string, TagsResource, IotDpsResourceUpdateOptionalParams)
更新现有预配服务的标记。 若要更新其他字段，请使用 CreateOrUpdate 方法
function beginUpdateAndWait(resourceGroupName: string, provisioningServiceName: string, provisioningServiceTags: TagsResource, options?: IotDpsResourceUpdateOptionalParams): Promise<ProvisioningServiceDescription>参数
- resourceGroupName
-
string
资源组标识符。
- provisioningServiceName
-
string
要创建或更新的预配服务的名称。
- provisioningServiceTags
- TagsResource
更新了要设置为预配服务实例的标记信息。
选项参数。
返回
Promise<ProvisioningServiceDescription>
checkProvisioningServiceNameAvailability(OperationInputs, IotDpsResourceCheckProvisioningServiceNameAvailabilityOptionalParams)
检查预配服务名称是否可用。 这将验证名称在语法上是否有效以及名称是否可用
function checkProvisioningServiceNameAvailability(argumentsParam: OperationInputs, options?: IotDpsResourceCheckProvisioningServiceNameAvailabilityOptionalParams): Promise<NameAvailabilityInfo>参数
- argumentsParam
- OperationInputs
将 OperationInputs 结构中的 name 参数设置为要检查的预配服务的名称。
返回
Promise<NameAvailabilityInfo>
get(string, string, IotDpsResourceGetOptionalParams)
获取不带 SAS 密钥的预配服务的元数据。
function get(provisioningServiceName: string, resourceGroupName: string, options?: IotDpsResourceGetOptionalParams): Promise<ProvisioningServiceDescription>参数
- provisioningServiceName
-
string
要检索的预配服务的名称。
- resourceGroupName
-
string
资源组名称。
- options
- IotDpsResourceGetOptionalParams
选项参数。
返回
Promise<ProvisioningServiceDescription>
getOperationResult(string, string, string, string, IotDpsResourceGetOperationResultOptionalParams)
获取长时间运行的操作的状态，例如创建、更新或删除预配服务。
function getOperationResult(operationId: string, resourceGroupName: string, provisioningServiceName: string, asyncinfo: string, options?: IotDpsResourceGetOperationResultOptionalParams): Promise<AsyncOperationResult>参数
- operationId
-
string
对应于长时间运行的操作的操作 ID。 使用此来轮询状态。
- resourceGroupName
-
string
资源组标识符。
- provisioningServiceName
-
string
运行操作的预配服务的名称。
- asyncinfo
-
string
用于轮询操作状态的异步标头，在创建长时间运行的操作时获取。
选项参数。
返回
Promise<AsyncOperationResult>
getPrivateEndpointConnection(string, string, string, IotDpsResourceGetPrivateEndpointConnectionOptionalParams)
获取专用终结点连接属性
function getPrivateEndpointConnection(resourceGroupName: string, resourceName: string, privateEndpointConnectionName: string, options?: IotDpsResourceGetPrivateEndpointConnectionOptionalParams): Promise<PrivateEndpointConnection>参数
- resourceGroupName
-
string
包含预配服务的资源组的名称。
- resourceName
-
string
预配服务的名称。
- privateEndpointConnectionName
-
string
专用终结点连接的名称
选项参数。
返回
Promise<PrivateEndpointConnection>
getPrivateLinkResources(string, string, string, IotDpsResourceGetPrivateLinkResourcesOptionalParams)
获取给定预配服务的指定专用链接资源
function getPrivateLinkResources(resourceGroupName: string, resourceName: string, groupId: string, options?: IotDpsResourceGetPrivateLinkResourcesOptionalParams): Promise<GroupIdInformation>参数
- resourceGroupName
-
string
包含预配服务的资源组的名称。
- resourceName
-
string
预配服务的名称。
- groupId
-
string
专用链接资源的名称
选项参数。
返回
Promise<GroupIdInformation>
listByResourceGroup(string, IotDpsResourceListByResourceGroupOptionalParams)
获取给定资源组中所有预配服务的列表。
function listByResourceGroup(resourceGroupName: string, options?: IotDpsResourceListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ProvisioningServiceDescription, ProvisioningServiceDescription[], PageSettings>参数
- resourceGroupName
-
string
资源组标识符。
选项参数。
返回
listBySubscription(IotDpsResourceListBySubscriptionOptionalParams)
列出给定订阅 ID 的所有预配服务。
function listBySubscription(options?: IotDpsResourceListBySubscriptionOptionalParams): PagedAsyncIterableIterator<ProvisioningServiceDescription, ProvisioningServiceDescription[], PageSettings>参数
选项参数。
返回
listKeys(string, string, IotDpsResourceListKeysOptionalParams)
列出预配服务的主密钥和辅助密钥。
function listKeys(provisioningServiceName: string, resourceGroupName: string, options?: IotDpsResourceListKeysOptionalParams): PagedAsyncIterableIterator<SharedAccessSignatureAuthorizationRuleAccessRightsDescription, SharedAccessSignatureAuthorizationRuleAccessRightsDescription[], PageSettings>参数
- provisioningServiceName
-
string
要为其获取共享访问密钥的预配服务名称。
- resourceGroupName
-
string
资源组名称
选项参数。
返回
listKeysForKeyName(string, string, string, IotDpsResourceListKeysForKeyNameOptionalParams)
列出特定密钥名称的主密钥和辅助密钥
function listKeysForKeyName(provisioningServiceName: string, keyName: string, resourceGroupName: string, options?: IotDpsResourceListKeysForKeyNameOptionalParams): Promise<SharedAccessSignatureAuthorizationRuleAccessRightsDescription>参数
- provisioningServiceName
-
string
预配服务的名称。
- keyName
-
string
要获取其键值的逻辑键名称。
- resourceGroupName
-
string
包含预配服务的资源组的名称。
选项参数。
返回
listPrivateEndpointConnections(string, string, IotDpsResourceListPrivateEndpointConnectionsOptionalParams)
列出专用终结点连接属性
function listPrivateEndpointConnections(resourceGroupName: string, resourceName: string, options?: IotDpsResourceListPrivateEndpointConnectionsOptionalParams): Promise<IotDpsResourceListPrivateEndpointConnectionsResponse>参数
- resourceGroupName
-
string
包含预配服务的资源组的名称。
- resourceName
-
string
预配服务的名称。
返回
listPrivateLinkResources(string, string, IotDpsResourceListPrivateLinkResourcesOptionalParams)
列出给定预配服务的专用链接资源
function listPrivateLinkResources(resourceGroupName: string, resourceName: string, options?: IotDpsResourceListPrivateLinkResourcesOptionalParams): Promise<PrivateLinkResources>参数
- resourceGroupName
-
string
包含预配服务的资源组的名称。
- resourceName
-
string
预配服务的名称。
选项参数。
返回
Promise<PrivateLinkResources>
listValidSkus(string, string, IotDpsResourceListValidSkusOptionalParams)
获取预配服务的有效 SKU 和层的列表。
function listValidSkus(provisioningServiceName: string, resourceGroupName: string, options?: IotDpsResourceListValidSkusOptionalParams): PagedAsyncIterableIterator<IotDpsSkuDefinition, IotDpsSkuDefinition[], PageSettings>参数
- provisioningServiceName
-
string
预配服务的名称。
- resourceGroupName
-
string
资源组的名称。
选项参数。