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
Name | Description | Type | Status |
---|---|---|---|
az providerhub notification-registration create |
Create a notification registration. |
Extension | GA |
az providerhub notification-registration delete |
Deletes a notification registration. |
Extension | GA |
az providerhub notification-registration list |
Gets the list of the notification registrations for the given provider. |
Extension | GA |
az providerhub notification-registration show |
Gets the notification registration details. |
Extension | GA |
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
The notification registration.
The name of the resource provider hosted within ProviderHub.
Optional Parameters
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.
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).
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).
Usage: --notification-endpoints notification-destination=XX locations=XX
Multiple actions can be specified by using more than one --notification-endpoints argument.
Determines how the notifications are sent to the RP. The two available modes are EventHub and Webhook.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az providerhub notification-registration delete
Deletes a notification registration.
az providerhub notification-registration delete [--ids]
[--name]
[--provider-namespace]
[--subscription]
[--yes]
Examples
NotificationRegistrations_Delete
az providerhub notification-registration delete --name "testNotificationRegistration" --provider-namespace "Microsoft.Contoso"
Optional Parameters
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
The notification registration.
The name of the resource provider hosted within ProviderHub.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
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
The name of the resource provider hosted within ProviderHub.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az providerhub notification-registration show
Gets the notification registration details.
az providerhub notification-registration show [--ids]
[--name]
[--provider-namespace]
[--subscription]
Examples
NotificationRegistrations_Get
az providerhub notification-registration show --name "testNotificationRegistration" --provider-namespace "Microsoft.Contoso"
Optional Parameters
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
The notification registration.
The name of the resource provider hosted within ProviderHub.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for