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
對應至長時間執行作業的作業標識碼。 使用此來輪詢狀態。
- 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)
列出指定訂用帳戶標識碼的所有布建服務。
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
資源組名。
選項參數。