Skip to content

Commit a81a7d4

Browse files
authored
[DPS][Public Preview] Provisioning Service SDK Update (#3492)
* Update enrollment for 2025-07-01-preview * add samples using credential policy name
1 parent 8606500 commit a81a7d4

File tree

8 files changed

+26
-3
lines changed

8 files changed

+26
-3
lines changed

provisioning/service/samples/getting started/EnrollmentGroupSample/EnrollmentGroupSample.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,9 @@ public async Task CreateEnrollmentGroupAsync()
3232
Attestation attestation = new SymmetricKeyAttestation(null, null); // let the service generate keys
3333
var group = new EnrollmentGroup(s_enrollmentGroupId, attestation);
3434

35+
// Optionally, set credentialPolicyName if you are using a certificate management service
36+
// group.CredentialPolicyName = "your-azure-device-registry-credential-policy-name";
37+
3538
group = await _provisioningServiceClient.CreateOrUpdateEnrollmentGroupAsync(group);
3639
Console.WriteLine($"Created {group.EnrollmentGroupId}: {JsonConvert.SerializeObject(group)}");
3740
}

provisioning/service/samples/getting started/EnrollmentGroupSample/EnrollmentGroupSample.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
</PropertyGroup>
88

99
<ItemGroup>
10-
<PackageReference Include="Microsoft.Azure.Devices.Provisioning.Service" Version="1.18.4" />
10+
<ProjectReference Include="..\..\..\src\Microsoft.Azure.Devices.Provisioning.Service.csproj" />
1111
<PackageReference Include="CommandLineParser" Version="2.9.1" />
1212
</ItemGroup>
1313

provisioning/service/samples/getting started/EnrollmentSample/IndividualEnrollmentSample.cs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,9 @@ public async Task CreateIndividualEnrollmentTpmAsync()
7171
["Brand"] = "Contoso",
7272
["Model"] = "SSC4",
7373
["Color"] = "White",
74-
})
74+
}),
75+
// Optionally, set credentialPolicyName if you are using a certificate management service
76+
// CredentialPolicyName = "your-azure-device-registry-credential-policy-name"
7577
};
7678

7779
Console.WriteLine("Adding new individualEnrollment...");

provisioning/service/samples/getting started/EnrollmentSample/IndividualEnrollmentSample.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
<ItemGroup>
1010
<PackageReference Include="CommandLineParser" Version="2.9.1" />
11-
<PackageReference Include="Microsoft.Azure.Devices.Provisioning.Service" Version="1.18.4" />
11+
<ProjectReference Include="..\..\..\src\Microsoft.Azure.Devices.Provisioning.Service.csproj" />
1212
</ItemGroup>
1313

1414
</Project>

provisioning/service/src/Config/EnrollmentGroup.cs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -268,6 +268,12 @@ public Attestation Attestation
268268
[JsonProperty(PropertyName = "iotHubHostName", DefaultValueHandling = DefaultValueHandling.Ignore)]
269269
public string IotHubHostName { get; set; }
270270

271+
/// <summary>
272+
/// Linked Azure Device Registry credential policy name (optional).
273+
/// </summary>
274+
[JsonProperty(PropertyName = "credentialPolicyName", DefaultValueHandling = DefaultValueHandling.Ignore)]
275+
public string CredentialPolicyName { get; set; }
276+
271277
/// <summary>
272278
/// Initial twin state.
273279
/// </summary>

provisioning/service/src/Config/IndividualEnrollment.cs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -194,6 +194,12 @@ internal IndividualEnrollment(
194194
[JsonProperty(PropertyName = "deviceId", DefaultValueHandling = DefaultValueHandling.Ignore)]
195195
public string DeviceId { get; set; }
196196

197+
/// <summary>
198+
/// Linked Azure Device Registry credential policy name (optional).
199+
/// </summary>
200+
[JsonProperty(PropertyName = "credentialPolicyName", DefaultValueHandling = DefaultValueHandling.Ignore)]
201+
public string CredentialPolicyName { get; set; }
202+
197203
/// <summary>
198204
/// Current registration state.
199205
/// </summary>

provisioning/service/tests/Config/EnrollmentGroupTests.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ public class EnrollmentGroupTests
1818
private const string SampleLastUpdatedDateTimeUTCString = "2017-11-14T12:34:18.321Z";
1919
private DateTime SampleLastUpdatedDateTimeUTC = new DateTime(2017, 11, 14, 12, 34, 18, 321, DateTimeKind.Utc);
2020
private const string SampleEtag = "00000000-0000-0000-0000-00000000000";
21+
private const string SampleCredentialPolicyName = "testCredentialPolicyName";
2122
private const string SamplePublicKeyCertificateString =
2223
"-----BEGIN CERTIFICATE-----\n" +
2324
"MIIBiDCCAS2gAwIBAgIFWks8LR4wCgYIKoZIzj0EAwIwNjEUMBIGA1UEAwwLcmlv\n" +
@@ -63,6 +64,7 @@ public class EnrollmentGroupTests
6364
" }\n" +
6465
" },\n" +
6566
" \"iotHubHostName\":\"" + SampleIotHubHostName + "\",\n" +
67+
" \"credentialPolicyName\":\"" + SampleCredentialPolicyName + "\",\n" +
6668
" \"initialTwin\":{\n" +
6769
" \"tags\":{\n" +
6870
" \"tag1\":\"val1\",\n" +
@@ -131,6 +133,7 @@ public void EnrollmentGroupConstructorJSONSucceed()
131133
Assert.AreEqual(SampleEnrollmentGroupId, enrollmentGroup.EnrollmentGroupId);
132134
Assert.IsTrue(enrollmentGroup.Attestation is X509Attestation);
133135
Assert.AreEqual(SampleIotHubHostName, enrollmentGroup.IotHubHostName);
136+
Assert.AreEqual(SampleCredentialPolicyName, enrollmentGroup.CredentialPolicyName);
134137
Assert.IsNotNull(enrollmentGroup.InitialTwinState);
135138
Assert.AreEqual(SampleProvisioningStatus, enrollmentGroup.ProvisioningStatus);
136139
Assert.AreEqual(SampleCreateDateTimeUTC, enrollmentGroup.CreatedDateTimeUtc);

provisioning/service/tests/Config/IndividualEnrollmentTests.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ public class IndividualEnrollmentTests
2020
private const string SampleLastUpdatedDateTimeUTCString = "2017-11-14T12:34:18.321Z";
2121
private DateTime SampleLastUpdatedDateTimeUTC = new DateTime(2017, 11, 14, 12, 34, 18, 321, DateTimeKind.Utc);
2222
private const string SampleEtag = "00000000-0000-0000-0000-00000000000";
23+
private const string SampleCredentialPolicyName = "testCredentialPolicyName";
2324
private DeviceCapabilities SampleEdgeCapabilityTrue = new DeviceCapabilities { IotEdge = true };
2425
private DeviceCapabilities SampleEdgeCapabilityFalse = new DeviceCapabilities { IotEdge = false };
2526
private const string SampleEndorsementKey =
@@ -69,6 +70,7 @@ public class IndividualEnrollmentTests
6970
" },\n" +
7071
" \"iotHubHostName\":\"" + SampleIotHubHostName + "\",\n" +
7172
" \"deviceId\":\"" + SampleDeviceId + "\",\n" +
73+
" \"credentialPolicyName\":\"" + SampleCredentialPolicyName + "\",\n" +
7274
" \"initialTwin\":{\n" +
7375
" \"tags\":{\n" +
7476
" \"tag1\":\"val1\",\n" +
@@ -266,6 +268,7 @@ public void IndividualEnrollmentConstructorWithoutCapabilitiesJSONSucceed()
266268
Assert.IsTrue(individualEnrollment.Attestation is X509Attestation);
267269
Assert.AreEqual(SampleDeviceId, individualEnrollment.DeviceId);
268270
Assert.AreEqual(SampleIotHubHostName, individualEnrollment.IotHubHostName);
271+
Assert.AreEqual(SampleCredentialPolicyName, individualEnrollment.CredentialPolicyName);
269272
Assert.IsNotNull(individualEnrollment.InitialTwinState);
270273
Assert.AreEqual(SampleProvisioningStatus, individualEnrollment.ProvisioningStatus);
271274
Assert.AreEqual(SampleCreateDateTimeUTC, individualEnrollment.CreatedDateTimeUtc);

0 commit comments

Comments
 (0)