Skip to content
This repository was archived by the owner on Sep 10, 2024. It is now read-only.

Commit b4e4f75

Browse files
committed
chore: add remarks for az app dto
1 parent 2e61554 commit b4e4f75

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

src/Arcus.BackgroundJobs.AzureActiveDirectory/AzureApplication.cs

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,11 @@
44
namespace Arcus.BackgroundJobs.AzureActiveDirectory
55
{
66
/// <summary>
7-
/// Represents an <see cref="AzureApplication"/> from Azure Active Directory.
7+
/// Represents an application running on Azure, in an Azure Active Directory.
8+
/// <remarks>
9+
/// This model is used to publicly represent the client applications and is used during event tracking.
10+
/// Therefore, new values added here should be carefully considered as all data represented here is made public in the configured logging system.
11+
/// </remarks>
812
/// </summary>
913
public class AzureApplication
1014
{
@@ -18,7 +22,7 @@ public class AzureApplication
1822
/// <exception cref="ArgumentException">Thrown when the <paramref name="name"/> is blank.</exception>
1923
public AzureApplication(string name, Guid? keyId, DateTimeOffset? endDateTime, double remainingValidDays)
2024
{
21-
Guard.NotNullOrWhitespace(name, nameof(name));
25+
Guard.NotNullOrWhitespace(name, nameof(name), "Requires a name to describe the application running on Azure");
2226

2327
Name = name;
2428
KeyId = keyId;

0 commit comments

Comments
 (0)