Remove-AzEventHubSchemaGroup

Deletes an EventHub schema group.

Syntax

Remove-AzEventHubSchemaGroup
      -Name <String>
      -NamespaceName <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      [-DefaultProfile <PSObject>]
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzEventHubSchemaGroup
      -InputObject <IEventHubIdentity>
      [-DefaultProfile <PSObject>]
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Deletes an EventHub schema group.

Examples

Example 1: Remove a Schema Group from an EventHub namespace

Remove-AzEventHubSchemaGroup -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name mySchemaGroup

Deletes a schema group mySchemaGroup from EventHub namespace myNamespace.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type:IEventHubIdentity
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False

-Name

The Schema Group name

Type:String
Aliases:SchemaGroupName
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-NamespaceName

The Namespace name

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-PassThru

Returns true when the command succeeds

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

Name of the resource group within the azure subscription.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-SubscriptionId

Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Type:String
Position:Named
Default value:(Get-AzContext).Subscription.Id
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Inputs

IEventHubIdentity

Outputs

Boolean

Notes

ALIASES

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

INPUTOBJECT <IEventHubIdentity>: Identity Parameter

  • [Alias <String>]: The Disaster Recovery configuration name
  • [ApplicationGroupName <String>]: The Application Group name
  • [AuthorizationRuleName <String>]: The authorization rule name.
  • [ClusterName <String>]: The name of the Event Hubs Cluster.
  • [ConsumerGroupName <String>]: The consumer group name
  • [EventHubName <String>]: The Event Hub name
  • [Id <String>]: Resource identity path
  • [NamespaceName <String>]: The Namespace name
  • [PrivateEndpointConnectionName <String>]: The PrivateEndpointConnection name
  • [ResourceAssociationName <String>]: The ResourceAssociation Name
  • [ResourceGroupName <String>]: Name of the resource group within the azure subscription.
  • [SchemaGroupName <String>]: The Schema Group name
  • [SubscriptionId <String>]: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.