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
作成または更新するプロビジョニング サービスの説明。
options パラメーター。
戻り値
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
作成または更新するプロビジョニング サービスの説明。
options パラメーター。
戻り値
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
更新されたプロパティを含むプライベート エンドポイント接続
options パラメーター。
戻り値
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
更新されたプロパティを含むプライベート エンドポイント接続
options パラメーター。
戻り値
Promise<PrivateEndpointConnection>
beginDelete(string, string, IotDpsResourceDeleteOptionalParams)
プロビジョニング サービスを削除します。
function beginDelete(provisioningServiceName: string, resourceGroupName: string, options?: IotDpsResourceDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>パラメーター
- provisioningServiceName
-
string
削除するプロビジョニング サービスの名前。
- resourceGroupName
-
string
リソース グループ識別子。
options パラメーター。
戻り値
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
リソース グループ識別子。
options パラメーター。
戻り値
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
プライベート エンドポイント接続の名前
options パラメーター。
戻り値
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
プライベート エンドポイント接続の名前
options パラメーター。
戻り値
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
プロビジョニング サービス インスタンスに設定するようにタグ情報を更新しました。
options パラメーター。
戻り値
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
プロビジョニング サービス インスタンスに設定するようにタグ情報を更新しました。
options パラメーター。
戻り値
Promise<ProvisioningServiceDescription>
checkProvisioningServiceNameAvailability(OperationInputs, IotDpsResourceCheckProvisioningServiceNameAvailabilityOptionalParams)
プロビジョニング サービス名が使用可能かどうかを確認します。 これにより、名前が構文的に有効かどうか、および名前が使用可能かどうかが検証されます
function checkProvisioningServiceNameAvailability(argumentsParam: OperationInputs, options?: IotDpsResourceCheckProvisioningServiceNameAvailabilityOptionalParams): Promise<NameAvailabilityInfo>パラメーター
- argumentsParam
- OperationInputs
OperationInputs 構造体の name パラメーターを、確認するプロビジョニング サービスの名前に設定します。
options パラメーター。
戻り値
Promise<NameAvailabilityInfo>
get(string, string, IotDpsResourceGetOptionalParams)
SAS キーを使用せずにプロビジョニング サービスのメタデータを取得します。
function get(provisioningServiceName: string, resourceGroupName: string, options?: IotDpsResourceGetOptionalParams): Promise<ProvisioningServiceDescription>パラメーター
- provisioningServiceName
-
string
取得するプロビジョニング サービスの名前。
- resourceGroupName
-
string
リソース グループ名。
- options
- IotDpsResourceGetOptionalParams
options パラメーター。
戻り値
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
実行時間の長い操作の作成時に取得された、操作の状態をポーリングするために使用される非同期ヘッダー。
options パラメーター。
戻り値
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
プライベート エンドポイント接続の名前
options パラメーター。
戻り値
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
プライベート リンク リソースの名前
options パラメーター。
戻り値
Promise<GroupIdInformation>
listByResourceGroup(string, IotDpsResourceListByResourceGroupOptionalParams)
指定されたリソース グループ内のすべてのプロビジョニング サービスの一覧を取得します。
function listByResourceGroup(resourceGroupName: string, options?: IotDpsResourceListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ProvisioningServiceDescription, ProvisioningServiceDescription[], PageSettings>パラメーター
- resourceGroupName
-
string
リソース グループ識別子。
options パラメーター。
戻り値
listBySubscription(IotDpsResourceListBySubscriptionOptionalParams)
特定のサブスクリプション ID のすべてのプロビジョニング サービスを一覧表示します。
function listBySubscription(options?: IotDpsResourceListBySubscriptionOptionalParams): PagedAsyncIterableIterator<ProvisioningServiceDescription, ProvisioningServiceDescription[], PageSettings>パラメーター
options パラメーター。
戻り値
listKeys(string, string, IotDpsResourceListKeysOptionalParams)
プロビジョニング サービスのプライマリ キーとセカンダリ キーを一覧表示します。
function listKeys(provisioningServiceName: string, resourceGroupName: string, options?: IotDpsResourceListKeysOptionalParams): PagedAsyncIterableIterator<SharedAccessSignatureAuthorizationRuleAccessRightsDescription, SharedAccessSignatureAuthorizationRuleAccessRightsDescription[], PageSettings>パラメーター
- provisioningServiceName
-
string
共有アクセス キーを取得するプロビジョニング サービス名。
- resourceGroupName
-
string
リソース グループ名
options パラメーター。
戻り値
listKeysForKeyName(string, string, string, IotDpsResourceListKeysForKeyNameOptionalParams)
特定のキー名の主キーとセカンダリ キーを一覧表示する
function listKeysForKeyName(provisioningServiceName: string, keyName: string, resourceGroupName: string, options?: IotDpsResourceListKeysForKeyNameOptionalParams): Promise<SharedAccessSignatureAuthorizationRuleAccessRightsDescription>パラメーター
- provisioningServiceName
-
string
プロビジョニング サービスの名前。
- keyName
-
string
キー値を取得する論理キー名。
- resourceGroupName
-
string
プロビジョニング サービスを含むリソース グループの名前。
options パラメーター。
戻り値
listPrivateEndpointConnections(string, string, IotDpsResourceListPrivateEndpointConnectionsOptionalParams)
プライベート エンドポイント接続のプロパティを一覧表示する
function listPrivateEndpointConnections(resourceGroupName: string, resourceName: string, options?: IotDpsResourceListPrivateEndpointConnectionsOptionalParams): Promise<IotDpsResourceListPrivateEndpointConnectionsResponse>パラメーター
- resourceGroupName
-
string
プロビジョニング サービスを含むリソース グループの名前。
- resourceName
-
string
プロビジョニング サービスの名前。
options パラメーター。
戻り値
listPrivateLinkResources(string, string, IotDpsResourceListPrivateLinkResourcesOptionalParams)
特定のプロビジョニング サービスのプライベート リンク リソースを一覧表示する
function listPrivateLinkResources(resourceGroupName: string, resourceName: string, options?: IotDpsResourceListPrivateLinkResourcesOptionalParams): Promise<PrivateLinkResources>パラメーター
- resourceGroupName
-
string
プロビジョニング サービスを含むリソース グループの名前。
- resourceName
-
string
プロビジョニング サービスの名前。
options パラメーター。
戻り値
Promise<PrivateLinkResources>
listValidSkus(string, string, IotDpsResourceListValidSkusOptionalParams)
プロビジョニング サービスの有効な SKU とレベルの一覧を取得します。
function listValidSkus(provisioningServiceName: string, resourceGroupName: string, options?: IotDpsResourceListValidSkusOptionalParams): PagedAsyncIterableIterator<IotDpsSkuDefinition, IotDpsSkuDefinition[], PageSettings>パラメーター
- provisioningServiceName
-
string
プロビジョニング サービスの名前。
- resourceGroupName
-
string
リソース グループの名前。
options パラメーター。