Skip to content
Original file line number Diff line number Diff line change
Expand Up @@ -15,24 +15,27 @@ Gets the details of an event subscription, or gets a list of all event subscript
### EventSubscriptionTopicNameParameterSet (Default)
```
Get-AzureRmEventGridSubscription [[-EventSubscriptionName] <String>] [[-ResourceGroupName] <String>]
[[-TopicName] <String>] [-IncludeFullEndpointUrl] [<CommonParameters>]
[[-TopicName] <String>] [-IncludeFullEndpointUrl] [-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
```

### ResourceIdEventSubscriptionParameterSet
```
Get-AzureRmEventGridSubscription [[-EventSubscriptionName] <String>] [-ResourceId] <String>
[-IncludeFullEndpointUrl] [<CommonParameters>]
[-IncludeFullEndpointUrl] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
```

### EventSubscriptionTopicTypeNameParameterSet
```
Get-AzureRmEventGridSubscription [[-ResourceGroupName] <String>] [[-TopicTypeName] <String>]
[[-Location] <String>] [-IncludeFullEndpointUrl] [<CommonParameters>]
[[-Location] <String>] [-IncludeFullEndpointUrl] [-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
```

### EventSubscriptionInputObjectSet
```
Get-AzureRmEventGridSubscription [-InputObject] <PSTopic> [<CommonParameters>]
Get-AzureRmEventGridSubscription [-InputObject] <PSTopic> [-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -121,6 +124,21 @@ Gets the list of all event subscriptions created for the specific resource group

## PARAMETERS

### -DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure

```yaml
Type: IAzureContextContainer
Parameter Sets: (All)
Aliases: AzureRmContext, AzureCredential

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -EventSubscriptionName
The name of the event subscription

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,22 @@ Gets the details of an Event Grid topic, or gets a list of all Event Grid topics

## SYNTAX

### TopicNameParameterSet (Default)
### ResourceGroupNameParameterSet (Default)
```
Get-AzureRmEventGridTopic [-ResourceGroupName] <String> [-Name] <String> [<CommonParameters>]
Get-AzureRmEventGridTopic [[-ResourceGroupName] <String>] [-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
```

### ResourceGroupNameParameterSet
### TopicNameParameterSet
```
Get-AzureRmEventGridTopic [[-ResourceGroupName] <String>] [<CommonParameters>]
Get-AzureRmEventGridTopic [-ResourceGroupName] <String> [-Name] <String>
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
```

### ResourceIdEventSubscriptionParameterSet
```
Get-AzureRmEventGridTopic [-ResourceId] <String> [<CommonParameters>]
Get-AzureRmEventGridTopic [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -64,6 +67,21 @@ List all the Event Grid topics in the subscription.

## PARAMETERS

### -DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure

```yaml
Type: IAzureContextContainer
Parameter Sets: (All)
Aliases: AzureRmContext, AzureCredential

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -Name
EventGrid Topic Name.

Expand All @@ -84,10 +102,10 @@ Resource Group Name.

```yaml
Type: String
Parameter Sets: TopicNameParameterSet
Parameter Sets: ResourceGroupNameParameterSet
Aliases: ResourceGroup

Required: True
Required: False
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Expand All @@ -96,10 +114,10 @@ Accept wildcard characters: False

```yaml
Type: String
Parameter Sets: ResourceGroupNameParameterSet
Parameter Sets: TopicNameParameterSet
Aliases: ResourceGroup

Required: False
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,20 @@ Gets the shared access keys used to publish events to an Event Grid topic.

### TopicNameParameterSet (Default)
```
Get-AzureRmEventGridTopicKey [-ResourceGroupName] <String> [-Name] <String> [<CommonParameters>]
Get-AzureRmEventGridTopicKey [-ResourceGroupName] <String> [-Name] <String>
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
```

### TopicInputObjectParameterSet
```
Get-AzureRmEventGridTopicKey [-InputObject] <PSTopic> [<CommonParameters>]
Get-AzureRmEventGridTopicKey [-InputObject] <PSTopic> [-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
```

### ResourceIdEventSubscriptionParameterSet
```
Get-AzureRmEventGridTopicKey [-ResourceId] <String> [<CommonParameters>]
Get-AzureRmEventGridTopicKey [-ResourceId] <String> [-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
```

## DESCRIPTION
Expand All @@ -48,6 +51,21 @@ Gets the shared access keys of Event Grid topic \`Topic1\` in resource group \`M

## PARAMETERS

### -DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure

```yaml
Type: IAzureContextContainer
Parameter Sets: (All)
Aliases: AzureRmContext, AzureCredential

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -InputObject
EventGrid Topic object.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ Gets the details about the topic types supported by Azure Event Grid.
## SYNTAX

```
Get-AzureRmEventGridTopicType [[-Name] <String>] [-IncludeEventTypeData] [<CommonParameters>]
Get-AzureRmEventGridTopicType [[-Name] <String>] [-IncludeEventTypeData]
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -47,6 +48,21 @@ Gets information about the StorageAccounts topic type, including the event types

## PARAMETERS

### -DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure

```yaml
Type: IAzureContextContainer
Parameter Sets: (All)
Aliases: AzureRmContext, AzureCredential

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -IncludeEventTypeData
If specified, the response will include the event types supported by a topic type.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,36 +12,36 @@ Creates a new Azure Event Grid Event Subscription to a topic, Azure resource, Az

## SYNTAX

### CustomTopicEventSubscriptionParameterSet (Default)
### ResourceGroupNameParameterSet (Default)
```
New-AzureRmEventGridSubscription [-EventSubscriptionName] <String> [-Endpoint] <String>
[-ResourceGroupName] <String> [-TopicName] <String> [[-EndpointType] <String>] [[-SubjectBeginsWith] <String>]
[[-ResourceGroupName] <String>] [[-EndpointType] <String>] [[-SubjectBeginsWith] <String>]
[[-SubjectEndsWith] <String>] [-SubjectCaseSensitive] [[-IncludedEventType] <String[]>] [[-Label] <String[]>]
[-WhatIf] [-Confirm] [<CommonParameters>]
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
```

### ResourceIdEventSubscriptionParameterSet
```
New-AzureRmEventGridSubscription [-ResourceId] <String> [-EventSubscriptionName] <String> [-Endpoint] <String>
[[-EndpointType] <String>] [[-SubjectBeginsWith] <String>] [[-SubjectEndsWith] <String>]
[-SubjectCaseSensitive] [[-IncludedEventType] <String[]>] [[-Label] <String[]>] [-WhatIf] [-Confirm]
[<CommonParameters>]
[-SubjectCaseSensitive] [[-IncludedEventType] <String[]>] [[-Label] <String[]>]
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
```

### EventSubscriptionInputObjectSet
```
New-AzureRmEventGridSubscription [-InputObject] <PSTopic> [-EventSubscriptionName] <String>
[-Endpoint] <String> [[-EndpointType] <String>] [[-SubjectBeginsWith] <String>] [[-SubjectEndsWith] <String>]
[-SubjectCaseSensitive] [[-IncludedEventType] <String[]>] [[-Label] <String[]>] [-WhatIf] [-Confirm]
[<CommonParameters>]
[-SubjectCaseSensitive] [[-IncludedEventType] <String[]>] [[-Label] <String[]>]
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
```

### ResourceGroupNameParameterSet
### CustomTopicEventSubscriptionParameterSet
```
New-AzureRmEventGridSubscription [-EventSubscriptionName] <String> [-Endpoint] <String>
[[-ResourceGroupName] <String>] [[-EndpointType] <String>] [[-SubjectBeginsWith] <String>]
[-ResourceGroupName] <String> [-TopicName] <String> [[-EndpointType] <String>] [[-SubjectBeginsWith] <String>]
[[-SubjectEndsWith] <String>] [-SubjectCaseSensitive] [[-IncludedEventType] <String[]>] [[-Label] <String[]>]
[-WhatIf] [-Confirm] [<CommonParameters>]
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -99,13 +99,28 @@ Creates a new event subscription \`EventSubscription1\` to an EventHub namespace

## PARAMETERS

### -DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure

```yaml
Type: IAzureContextContainer
Parameter Sets: (All)
Aliases: AzureRmContext, AzureCredential

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -Endpoint
Event subscription destination endpoint.
This can be a webhook URL or the Azure resource ID of an EventHub.

```yaml
Type: String
Parameter Sets: CustomTopicEventSubscriptionParameterSet, ResourceIdEventSubscriptionParameterSet, ResourceGroupNameParameterSet
Parameter Sets: ResourceGroupNameParameterSet, ResourceIdEventSubscriptionParameterSet, CustomTopicEventSubscriptionParameterSet
Aliases:

Required: True
Expand Down Expand Up @@ -133,7 +148,7 @@ This can be webhook or eventhub

```yaml
Type: String
Parameter Sets: CustomTopicEventSubscriptionParameterSet, ResourceIdEventSubscriptionParameterSet, ResourceGroupNameParameterSet
Parameter Sets: ResourceGroupNameParameterSet, ResourceIdEventSubscriptionParameterSet, CustomTopicEventSubscriptionParameterSet
Aliases:
Accepted values: webhook, eventhub

Expand Down Expand Up @@ -162,7 +177,7 @@ The name of the event subscription

```yaml
Type: String
Parameter Sets: CustomTopicEventSubscriptionParameterSet, ResourceIdEventSubscriptionParameterSet, ResourceGroupNameParameterSet
Parameter Sets: ResourceGroupNameParameterSet, ResourceIdEventSubscriptionParameterSet, CustomTopicEventSubscriptionParameterSet
Aliases:

Required: True
Expand All @@ -189,7 +204,7 @@ Filter that specifies a list of event types to include.If not specified, all eve

```yaml
Type: String[]
Parameter Sets: CustomTopicEventSubscriptionParameterSet, ResourceIdEventSubscriptionParameterSet, ResourceGroupNameParameterSet
Parameter Sets: ResourceGroupNameParameterSet, ResourceIdEventSubscriptionParameterSet, CustomTopicEventSubscriptionParameterSet
Aliases:

Required: False
Expand Down Expand Up @@ -231,7 +246,7 @@ Labels for the event subscription

```yaml
Type: String[]
Parameter Sets: CustomTopicEventSubscriptionParameterSet, ResourceIdEventSubscriptionParameterSet, ResourceGroupNameParameterSet
Parameter Sets: ResourceGroupNameParameterSet, ResourceIdEventSubscriptionParameterSet, CustomTopicEventSubscriptionParameterSet
Aliases:

Required: False
Expand All @@ -258,10 +273,10 @@ The resource group of the topic.

```yaml
Type: String
Parameter Sets: CustomTopicEventSubscriptionParameterSet
Parameter Sets: ResourceGroupNameParameterSet
Aliases: ResourceGroup

Required: True
Required: False
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Expand All @@ -270,10 +285,10 @@ Accept wildcard characters: False

```yaml
Type: String
Parameter Sets: ResourceGroupNameParameterSet
Parameter Sets: CustomTopicEventSubscriptionParameterSet
Aliases: ResourceGroup

Required: False
Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Expand Down Expand Up @@ -301,7 +316,7 @@ If not specified, events with all subject prefixes will be included.

```yaml
Type: String
Parameter Sets: CustomTopicEventSubscriptionParameterSet, ResourceIdEventSubscriptionParameterSet, ResourceGroupNameParameterSet
Parameter Sets: ResourceGroupNameParameterSet, ResourceIdEventSubscriptionParameterSet, CustomTopicEventSubscriptionParameterSet
Aliases:

Required: False
Expand Down Expand Up @@ -345,7 +360,7 @@ If not specified, events with all subject suffixes will be included.

```yaml
Type: String
Parameter Sets: CustomTopicEventSubscriptionParameterSet, ResourceIdEventSubscriptionParameterSet, ResourceGroupNameParameterSet
Parameter Sets: ResourceGroupNameParameterSet, ResourceIdEventSubscriptionParameterSet, CustomTopicEventSubscriptionParameterSet
Aliases:

Required: False
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Creates a new Azure Event Grid Topic.

```
New-AzureRmEventGridTopic [-ResourceGroupName] <String> [-Name] <String> [-Location] <String>
[[-Tag] <Hashtable>] [-WhatIf] [-Confirm] [<CommonParameters>]
[[-Tag] <Hashtable>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
```

## DESCRIPTION
Expand All @@ -38,6 +38,21 @@ Creates an Event Grid topic \`Topic1\` in the specified geographic location \`we

## PARAMETERS

### -DefaultProfile
The credentials, account, tenant, and subscription used for communication with azure

```yaml
Type: IAzureContextContainer
Parameter Sets: (All)
Aliases: AzureRmContext, AzureCredential

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -Location
The location of the topic

Expand Down
Loading