az providerhub notification-registration

Note

This reference is part of the providerhub extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an az providerhub notification-registration command. Learn more about extensions.

Manage notification registration with providerhub.

Commands

az providerhub notification-registration create

Create a notification registration.

az providerhub notification-registration delete

Deletes a notification registration.

az providerhub notification-registration list

Gets the list of the notification registrations for the given provider.

az providerhub notification-registration show

Gets the notification registration details.

az providerhub notification-registration create

Create a notification registration.

az providerhub notification-registration create --name
                                                --provider-namespace
                                                [--included-events]
                                                [--message-scope {NotSpecified, RegisteredSubscriptions}]
                                                [--notification-endpoints]
                                                [--notification-mode {EventHub, NotSpecified, WebHook}]

Examples

NotificationRegistrations_CreateOrUpdate

az providerhub notification-registration create --name "testNotificationRegistration" --included-events "*/write" "Microsoft.Contoso/employees/delete" --message-scope "RegisteredSubscriptions" --notification-endpoints locations="" locations="East US" notification-destination="/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mgmtexp-eastus/providers/Microsoft.EventHub/namespaces/unitedstates-mgmtexpint/eventhubs/armlinkednotifications" --notification-endpoints locations="North Europe" notification-destination="/subscriptions/00000000-0000-0000-0000-000000000000   /resourceGroups/mgmtexp-northeurope/providers/Microsoft.EventHub/namespaces/europe-mgmtexpint/eventhubs/armlinkednotifications" --notification-mode "EventHub" --provider-namespace "Microsoft.Contoso"

Required Parameters

--name --notification-registration-name -n

The notification registration.

--provider-namespace

The name of the resource provider hosted within ProviderHub.

Optional Parameters

--included-events

These are the events that the RP should be messaged on. The message format is in the form {RP Namespace}/{Resource Type}/{action}. The availabe actions are: write, delete and move/action.

--message-scope

Limits the messages that are sent to the RP. The default value is RegisteredSubscriptions. The available values are Global (all messages in Azure) and RegisteredSubscriptions (only messages in subscriptions registered by RP).

accepted values: NotSpecified, RegisteredSubscriptions
--notification-endpoints

These are the locations for the notification messages. Notifications will be sent to the region of the event resource's location (e.g. VM in East Us will send message to the specified endpoint in East US).

--notification-mode

Determines how the notifications are sent to the RP. The two available modes are EventHub and Webhook.

accepted values: EventHub, NotSpecified, WebHook

az providerhub notification-registration delete

Deletes a notification registration.

az providerhub notification-registration delete --name
                                                --provider-namespace
                                                [--yes]

Examples

NotificationRegistrations_Delete

az providerhub notification-registration delete --name "testNotificationRegistration" --provider-namespace "Microsoft.Contoso"

Required Parameters

--name --notification-registration-name -n

The notification registration.

--provider-namespace

The name of the resource provider hosted within ProviderHub.

Optional Parameters

--yes -y

Do not prompt for confirmation.

az providerhub notification-registration list

Gets the list of the notification registrations for the given provider.

az providerhub notification-registration list --provider-namespace

Examples

NotificationRegistrations_ListByProviderRegistration

az providerhub notification-registration list --provider-namespace "Microsoft.Contoso"

Required Parameters

--provider-namespace

The name of the resource provider hosted within ProviderHub.

az providerhub notification-registration show

Gets the notification registration details.

az providerhub notification-registration show --name
                                              --provider-namespace

Examples

NotificationRegistrations_Get

az providerhub notification-registration show --name "testNotificationRegistration" --provider-namespace "Microsoft.Contoso"

Required Parameters

--name --notification-registration-name -n

The notification registration.

--provider-namespace

The name of the resource provider hosted within ProviderHub.