Set-AzIoTDeviceProvisioningServiceEnrollmentGroup

リファレンス

モジュール:: Az.DeviceProvisioningServices

デバイス登録グループを更新します。

構文

Set-AzIoTDeviceProvisioningServiceEnrollmentGroup
   [-ResourceGroupName] <String>
   [-DpsName] <String>
   -Name <String>
   [-ReprovisionPolicy <PSReprovisionType>]
   [-EdgeEnabled <Boolean>]
   [-Tag <Hashtable>]
   [-Desired <Hashtable>]
   [-AllocationPolicy <PSAllocationPolicy>]
   [-ProvisioningStatus <PSProvisioningStatus>]
   [-IotHubHostName <String>]
   [-IotHub <String[]>]
   [-WebhookUrl <String>]
   [-ApiVersion <String>]
   [-PrimaryKey <String>]
   [-SecondaryKey <String>]
   [-PrimaryCertificate <String>]
   [-SecondaryCertificate <String>]
   [-RootCertificate]
   [-PrimaryCAName <String>]
   [-SecondaryCAName <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzIoTDeviceProvisioningServiceEnrollmentGroup
   [-DpsObject] <PSProvisioningServiceDescription>
   -Name <String>
   [-ReprovisionPolicy <PSReprovisionType>]
   [-EdgeEnabled <Boolean>]
   [-Tag <Hashtable>]
   [-Desired <Hashtable>]
   [-AllocationPolicy <PSAllocationPolicy>]
   [-ProvisioningStatus <PSProvisioningStatus>]
   [-IotHubHostName <String>]
   [-IotHub <String[]>]
   [-WebhookUrl <String>]
   [-ApiVersion <String>]
   [-PrimaryKey <String>]
   [-SecondaryKey <String>]
   [-PrimaryCertificate <String>]
   [-SecondaryCertificate <String>]
   [-RootCertificate]
   [-PrimaryCAName <String>]
   [-SecondaryCAName <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-AzIoTDeviceProvisioningServiceEnrollmentGroup
   [-ResourceId] <String>
   -Name <String>
   [-ReprovisionPolicy <PSReprovisionType>]
   [-EdgeEnabled <Boolean>]
   [-Tag <Hashtable>]
   [-Desired <Hashtable>]
   [-AllocationPolicy <PSAllocationPolicy>]
   [-ProvisioningStatus <PSProvisioningStatus>]
   [-IotHubHostName <String>]
   [-IotHub <String[]>]
   [-WebhookUrl <String>]
   [-ApiVersion <String>]
   [-PrimaryKey <String>]
   [-SecondaryKey <String>]
   [-PrimaryCertificate <String>]
   [-SecondaryCertificate <String>]
   [-RootCertificate]
   [-PrimaryCAName <String>]
   [-SecondaryCAName <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

説明

Azure IoT Hub Device Provisioning Service の登録グループを更新します。

例

例 1

Set-AzIoTDeviceProvisioningServiceEnrollmentGroup -ResourceGroupName "myresourcegroup" -DpsName "mydps" -Name "enroll1" -AllocationPolicy Hashed -IotHub "hub1","hub2"

登録グループの割り当てポリシーとハブを更新します。

例 2

$tag = @{}
$tag.Add("environment","updatedenv")
$desired = @{}
$desired.add("version_dps", "updateddps")
Set-AzIoTDeviceProvisioningServiceEnrollmentGroup -ResourceGroupName "myresourcegroup" -DpsName "mydps" -Name "enroll1" -tag $tag -Desired $desired

登録グループの初期ツイン状態を更新します。

例 3

Set-AzIoTDeviceProvisioningServiceEnrollmentGroup -ResourceGroupName "myresourcegroup" -DpsName "mydps" -Name "enroll1" -PrimaryKey "newPrimaryKey" -SecondaryKey "newSecondaryKey"

対称キー登録グループのプライマリキーとセカンダリキーを更新する

パラメーター

-AllocationPolicy

ハブに割り当てられたデバイスの割り当ての種類。

型:	PSAllocationPolicy
指定可能な値:	Hashed, GeoLatency, Static, Custom
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ApiVersion

カスタム割り当て要求のプロビジョニングサービスの API バージョン。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Confirm

コマンドレットを実行する前に確認を求めるメッセージが表示されます。

型:	SwitchParameter
Aliases:	cf
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-DefaultProfile

Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。

型:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Desired

初期ツインの必要なプロパティ。

型:	Hashtable
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-DpsName

IoT Device Provisioning Service の名前

型:	String
配置:	1
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-DpsObject

IoT Device Provisioning Service オブジェクト

型:	PSProvisioningServiceDescription
配置:	0
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-EdgeEnabled

エッジの有効化を示すフラグ。

型:	Boolean
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-IotHub

ターゲット IoT Hub のホスト名。複数の IoT Hub にスペース区切りリストを使用します。

型:	String[]
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-IotHubHostName

ターゲット IoT Hub のホスト名。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Name

登録グループの名前。

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-PrimaryCAName

プライマリルート CA 証明書の名前。ルート CA 証明書を使用した構成証明が必要な場合は、ルート CA 名を指定する必要があります。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-PrimaryCertificate

プライマリ証明書を含むファイルへのパス。 X509 証明書.cerファイルまたは .pem ファイルパスの Base-64 表現。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-PrimaryKey

base64 形式で格納されている主対称共有アクセスキー。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ProvisioningStatus

登録エントリを有効または無効にします。

型:	PSProvisioningStatus
指定可能な値:	Enabled, Disabled
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ReprovisionPolicy

異なる IoT ハブへの再プロビジョニング時に処理されるデバイスデータ。

型:	PSReprovisionType
指定可能な値:	reprovisionandmigratedata, reprovisionandresetdata, never
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ResourceGroupName

リソースグループの名前

型:	String
配置:	0
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ResourceId

IoT Device Provisioning Service リソース ID

型:	String
配置:	0
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-RootCertificate

ルート証明書を使用して X509attestation を作成できます。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-SecondaryCAName

セカンダリルート CA 証明書の名前。ルート CA 証明書を使用した構成証明が必要な場合は、ルート CA 名を指定する必要があります。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-SecondaryCertificate

セカンダリ証明書を含むファイルへのパス。 X509 証明書.cerファイルまたは .pem ファイルパスの Base-64 表現。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-SecondaryKey

base64 形式で格納されているセカンダリ対称共有アクセスキー。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Tag

初期ツインタグ。

型:	Hashtable
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-WebhookUrl

カスタム割り当て要求に使用される Webhook URL。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-WhatIf

コマンドレットを実行した場合の動作を示します。コマンドレットは実行されません。

型:	SwitchParameter
Aliases:	wi
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

入力

PSProvisioningServiceDescription

String

出力

PSEnrollmentGroup

次の方法で共有