Skip to content

Commit 4a8afe5

Browse files
authored
AzureEventGrid - Updated docs about accessKey is alternative (#137)
1 parent 681ca7b commit 4a8afe5

File tree

2 files changed

+17
-15
lines changed

2 files changed

+17
-15
lines changed

src/NLog.Extensions.AzureEventGrid/EventGridTarget.cs

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -53,27 +53,27 @@ public class EventGridTarget : AsyncTaskTarget
5353
public Layout DataSchema { get; set; }
5454

5555
/// <summary>
56-
/// Input for AzureKeyCredential for EventGridPublisherClient constructor
57-
/// </summary>
58-
public Layout AccessKey { get; set; }
59-
60-
/// <summary>
61-
/// Alternative to AccessKey. Input for <see cref="Azure.Identity.DefaultAzureCredential"/>
56+
/// Input for <see cref="Azure.Identity.DefaultAzureCredential"/>
6257
/// </summary>
6358
public Layout TenantIdentity { get; set; }
6459

6560
/// <summary>
66-
/// Alternative to AccessKey. Input for <see cref="Azure.Identity.DefaultAzureCredential"/>
61+
/// Input for <see cref="Azure.Identity.DefaultAzureCredential"/>
6762
/// </summary>
6863
public Layout ResourceIdentity { get; set; }
6964

7065
/// <summary>
71-
/// Alternative to AccessKey. Input for <see cref="Azure.Identity.DefaultAzureCredential"/> with ManagedIdentityClientId
66+
/// Input for <see cref="Azure.Identity.DefaultAzureCredential"/> with ManagedIdentityClientId
7267
/// </summary>
7368
public Layout ClientIdentity { get; set; }
7469

7570
/// <summary>
76-
/// Alternative to AccessKey. Input for AzureSasCredential for EventGridPublisherClient constructor
71+
/// Alternative to DefaultAzureCredential. Input for AzureKeyCredential for EventGridPublisherClient constructor
72+
/// </summary>
73+
public Layout AccessKey { get; set; }
74+
75+
/// <summary>
76+
/// Alternative to DefaultAzureCredential. Input for AzureSasCredential for EventGridPublisherClient constructor
7777
/// </summary>
7878
public Layout SharedAccessSignature { get; set; }
7979

src/NLog.Extensions.AzureEventGrid/README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@
1717
name="String"
1818
layout="Layout"
1919
topic="Layout"
20-
cloudEventSource="Layout" <!-- Only for CloudEvent -->
21-
gridEventSubject="Layout" <!-- Only for EventGridEvent -->
20+
cloudEventSource="Layout"
21+
gridEventSubject="Layout"
2222
eventType="Layout"
2323
contentType="Layout"
2424
dataSchema="Layout"
@@ -46,13 +46,15 @@ _contentType_ - Content type of the data-payload. [Layout](https://github.com/NL
4646

4747
_dataSchema_ - Schema version of the data-payload. [Layout](https://github.com/NLog/NLog/wiki/Layouts)
4848

49-
_accessKey_ - Input for AzureKeyCredential. [Layout](https://github.com/NLog/NLog/wiki/Layouts)
49+
_tenantIdentity_ - Input for DefaultAzureCredential. [Layout](https://github.com/NLog/NLog/wiki/Layouts)
5050

51-
_tenantIdentity_ - Alternative to AccessKey. Input for DefaultAzureCredential.
51+
_resourceIdentity_ - Input for DefaultAzureCredential as ManagedIdentityResourceId. [Layout](https://github.com/NLog/NLog/wiki/Layouts)
5252

53-
_resourceIdentity_ - Alternative to AccessKey. Input for DefaultAzureCredential as ManagedIdentityResourceId.
53+
_clientIdentity_ - Input for DefaultAzureCredential as ManagedIdentityClientId. [Layout](https://github.com/NLog/NLog/wiki/Layouts)
5454

55-
_clientIdentity_ - Alternative to AccessKey. Input for DefaultAzureCredential as ManagedIdentityClientId.
55+
_accessKey_ - Alternative to DefaultAzureCredential. Input for AzureKeyCredential. [Layout](https://github.com/NLog/NLog/wiki/Layouts)
56+
57+
_sharedAccessSignature_ - Alternative to DefaultAzureCredential. Input for AzureSasCredential. [Layout](https://github.com/NLog/NLog/wiki/Layouts)
5658

5759
### Retry Policy
5860

0 commit comments

Comments
 (0)