notification_registrations

Creates, updates, deletes, gets or lists a notification_registrations resource.

Overview

Name	notification_registrations
Type	Resource
Id	azure.provider_hub.notification_registrations

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved the notification registration.

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties	object
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list_by_provider_registration

Successfully retrieved the notification registrations.

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties	object
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, providerNamespace, notificationRegistrationName		Gets the notification registration details.
list_by_provider_registration	select	subscriptionId, providerNamespace		Gets the list of the notification registrations for the given provider.
create_or_update	insert	subscriptionId, providerNamespace, notificationRegistrationName		Creates or updates a notification registration.
delete	delete	subscriptionId, providerNamespace, notificationRegistrationName		Deletes a notification registration.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
notificationRegistrationName	string	The notification registration.
providerNamespace	string	The name of the resource provider hosted within ProviderHub.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Gets the notification registration details.

SELECT
id,
name,
properties,
type
FROM azure.provider_hub.notification_registrations
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND providerNamespace = '{{ providerNamespace }}' -- required
AND notificationRegistrationName = '{{ notificationRegistrationName }}' -- required
;

list_by_provider_registration

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

SELECT
id,
name,
properties,
type
FROM azure.provider_hub.notification_registrations
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND providerNamespace = '{{ providerNamespace }}' -- required
;

INSERT examples

create_or_update

Creates or updates a notification registration.

INSERT INTO azure.provider_hub.notification_registrations (
data__properties,
subscriptionId,
providerNamespace,
notificationRegistrationName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ providerNamespace }}',
'{{ notificationRegistrationName }}'
RETURNING
id,
name,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: notification_registrations
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the notification_registrations resource.
    - name: providerNamespace
      value: string
      description: Required parameter for the notification_registrations resource.
    - name: notificationRegistrationName
      value: string
      description: Required parameter for the notification_registrations resource.
    - name: properties
      value: object

DELETE examples

delete

Deletes a notification registration.

DELETE FROM azure.provider_hub.notification_registrations
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND providerNamespace = '{{ providerNamespace }}' --required
AND notificationRegistrationName = '{{ notificationRegistrationName }}' --required
;