Skip to content

Commit 43bf220

Browse files
author
Maddie Clayton
authored
Merge pull request Azure#8991 from ahamad-MS/master
Azure Event Grid: Enhance help text for Endpoint per customer feedback
2 parents 5742bbf + 47ad30f commit 43bf220

File tree

4 files changed

+10
-5
lines changed

4 files changed

+10
-5
lines changed

src/EventGrid/EventGrid/ChangeLog.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
- Additional information about change #1
1919
-->
2020
## Upcoming Release
21+
* Updated the help text for endpoint to indicate that resources should be created before using the create/update event subscription cmdlets.
2122

2223
## Version 1.1.0
2324
* Updated to use the 2019-01-01 API version.

src/EventGrid/EventGrid/Utilities/EventGridConstants.cs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,8 @@ class EventGridConstants
3131
public const string LabelsHelp = "Labels for the event subscription.";
3232
public const string EndpointTypeHelp = "Endpoint Type. This can be webhook, eventhub, storagequeue, or hybridconnection. Default value is webhook.";
3333
public const string EndpointHelp = "Event subscription destination endpoint. This can be a webhook URL, or the Azure resource ID of an EventHub, storage queue or hybridconnection. For example, the resource ID for a hybrid connection " +
34-
"takes the following form: /subscriptions/[Azure Subscription ID]/resourceGroups/[ResourceGroupName]/providers/Microsoft.Relay/namespaces/[NamespaceName]/hybridConnections/[HybridConnectionName].";
34+
"takes the following form: /subscriptions/[Azure Subscription ID]/resourceGroups/[ResourceGroupName]/providers/Microsoft.Relay/namespaces/[NamespaceName]/hybridConnections/[HybridConnectionName]. It is expected that " +
35+
"the destination endpoint to be created and available for use before executing any Event Grid cmdlets.";
3536
public const string ResourceGroupNameHelp = "The name of the resource group.";
3637
public const string TopicNameHelp = "EventGrid topic name.";
3738
public const string TopicTypeNameHelp = "EventGrid topic type name.";

src/EventGrid/EventGrid/help/New-AzEventGridSubscription.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,8 @@ Accept wildcard characters: False
147147
148148
### -Endpoint
149149
Event subscription destination endpoint.
150-
This can be a webhook URL or the Azure resource ID of an EventHub.
150+
This can be a webhook URL, or the Azure resource ID of an EventHub, storage queue or hybridconnection. For example, the resource ID for a hybrid connection takes the following form: /subscriptions/[Azure Subscription ID]/resourceGroups/[ResourceGroupName]/providers/Microsoft.Relay/namespaces/[NamespaceName]/hybridConnections/[HybridConnectionName]. It is expected that the destination endpoint to be created and available for use before executing any Event Grid cmdlets.
151+
151152
152153
```yaml
153154
Type: System.String
@@ -175,7 +176,8 @@ Accept wildcard characters: False
175176
176177
### -EndpointType
177178
Endpoint Type.
178-
This can be webhook or eventhub
179+
This can be webhook, eventhub, storagequeue, or hybridconnection. Default value is webhook.
180+
179181
180182
```yaml
181183
Type: System.String

src/EventGrid/EventGrid/help/Update-AzEventGridSubscription.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,8 @@ Accept wildcard characters: False
115115
116116
### -Endpoint
117117
Event subscription destination endpoint.
118-
This can be a webhook URL or the Azure resource ID of an EventHub.
118+
This can be a webhook URL, or the Azure resource ID of an EventHub, storage queue or hybridconnection. For example, the resource ID for a hybrid connection takes the following form: /subscriptions/[Azure Subscription ID]/resourceGroups/[ResourceGroupName]/providers/Microsoft.Relay/namespaces/[NamespaceName]/hybridConnections/[HybridConnectionName]. It is expected that the destination endpoint to be created and available for use before executing any Event Grid cmdlets.
119+
119120
120121
```yaml
121122
Type: System.String
@@ -131,7 +132,7 @@ Accept wildcard characters: False
131132
132133
### -EndpointType
133134
Endpoint Type.
134-
This can be webhook or eventhub
135+
This can be webhook, eventhub, storagequeue, or hybridconnection. Default value is webhook.
135136
136137
```yaml
137138
Type: System.String

0 commit comments

Comments
 (0)