notificationhub

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-azure repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-azurerm repo.

class pulumi_azure.notificationhub.AuthorizationRule(resource_name, opts=None, listen=None, manage=None, name=None, namespace_name=None, notification_hub_name=None, resource_group_name=None, send=None, __props__=None, __name__=None, __opts__=None)

Manages an Authorization Rule associated with a Notification Hub within a Notification Hub Namespace.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • listen (pulumi.Input[bool]) – Does this Authorization Rule have Listen access to the Notification Hub? Defaults to false.

  • manage (pulumi.Input[bool]) – Does this Authorization Rule have Manage access to the Notification Hub? Defaults to false.

  • name (pulumi.Input[str]) – The name to use for this Authorization Rule. Changing this forces a new resource to be created.

  • namespace_name (pulumi.Input[str]) – The name of the Notification Hub Namespace in which the Notification Hub exists. Changing this forces a new resource to be created.

  • notification_hub_name (pulumi.Input[str]) – The name of the Notification Hub for which the Authorization Rule should be created. Changing this forces a new resource to be created.

  • resource_group_name (pulumi.Input[str]) – The name of the Resource Group in which the Notification Hub Namespace exists. Changing this forces a new resource to be created.

  • send (pulumi.Input[bool]) – Does this Authorization Rule have Send access to the Notification Hub? Defaults to false.

listen = None

Does this Authorization Rule have Listen access to the Notification Hub? Defaults to false.

manage = None

Does this Authorization Rule have Manage access to the Notification Hub? Defaults to false.

name = None

The name to use for this Authorization Rule. Changing this forces a new resource to be created.

namespace_name = None

The name of the Notification Hub Namespace in which the Notification Hub exists. Changing this forces a new resource to be created.

notification_hub_name = None

The name of the Notification Hub for which the Authorization Rule should be created. Changing this forces a new resource to be created.

primary_access_key = None

The Primary Access Key associated with this Authorization Rule.

resource_group_name = None

The name of the Resource Group in which the Notification Hub Namespace exists. Changing this forces a new resource to be created.

secondary_access_key = None

The Secondary Access Key associated with this Authorization Rule.

send = None

Does this Authorization Rule have Send access to the Notification Hub? Defaults to false.

static get(resource_name, id, opts=None, listen=None, manage=None, name=None, namespace_name=None, notification_hub_name=None, primary_access_key=None, resource_group_name=None, secondary_access_key=None, send=None)

Get an existing AuthorizationRule resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • listen (pulumi.Input[bool]) – Does this Authorization Rule have Listen access to the Notification Hub? Defaults to false.

  • manage (pulumi.Input[bool]) – Does this Authorization Rule have Manage access to the Notification Hub? Defaults to false.

  • name (pulumi.Input[str]) – The name to use for this Authorization Rule. Changing this forces a new resource to be created.

  • namespace_name (pulumi.Input[str]) – The name of the Notification Hub Namespace in which the Notification Hub exists. Changing this forces a new resource to be created.

  • notification_hub_name (pulumi.Input[str]) – The name of the Notification Hub for which the Authorization Rule should be created. Changing this forces a new resource to be created.

  • primary_access_key (pulumi.Input[str]) – The Primary Access Key associated with this Authorization Rule.

  • resource_group_name (pulumi.Input[str]) – The name of the Resource Group in which the Notification Hub Namespace exists. Changing this forces a new resource to be created.

  • secondary_access_key (pulumi.Input[str]) – The Secondary Access Key associated with this Authorization Rule.

  • send (pulumi.Input[bool]) – Does this Authorization Rule have Send access to the Notification Hub? Defaults to false.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_azure.notificationhub.AwaitableGetHubResult(apns_credentials=None, gcm_credentials=None, location=None, name=None, namespace_name=None, resource_group_name=None, id=None)
class pulumi_azure.notificationhub.AwaitableGetNamespaceResult(enabled=None, location=None, name=None, namespace_type=None, resource_group_name=None, servicebus_endpoint=None, sku=None, id=None)
class pulumi_azure.notificationhub.GetHubResult(apns_credentials=None, gcm_credentials=None, location=None, name=None, namespace_name=None, resource_group_name=None, id=None)

A collection of values returned by getHub.

apns_credentials = None

A apns_credential block as defined below.

gcm_credentials = None

A gcm_credential block as defined below.

location = None

The Azure Region in which this Notification Hub exists.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_azure.notificationhub.GetNamespaceResult(enabled=None, location=None, name=None, namespace_type=None, resource_group_name=None, servicebus_endpoint=None, sku=None, id=None)

A collection of values returned by getNamespace.

enabled = None

Is this Notification Hub Namespace enabled?

location = None

The Azure Region in which this Notification Hub Namespace exists.

name = None

(Required) The name of the SKU to use for this Notification Hub Namespace. Possible values are Free, Basic or Standard.

namespace_type = None

The Type of Namespace, such as Messaging or NotificationHub.

sku = None

A sku block as defined below.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_azure.notificationhub.Hub(resource_name, opts=None, apns_credential=None, gcm_credential=None, location=None, name=None, namespace_name=None, resource_group_name=None, __props__=None, __name__=None, __opts__=None)

Manages a Notification Hub within a Notification Hub Namespace.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • apns_credential (pulumi.Input[dict]) – A apns_credential block as defined below.

  • gcm_credential (pulumi.Input[dict]) – A gcm_credential block as defined below.

  • location (pulumi.Input[str]) – The Azure Region in which this Notification Hub Namespace exists. Changing this forces a new resource to be created.

  • name (pulumi.Input[str]) – The name to use for this Notification Hub. Changing this forces a new resource to be created.

  • namespace_name (pulumi.Input[str]) – The name of the Notification Hub Namespace in which to create this Notification Hub. Changing this forces a new resource to be created.

  • resource_group_name (pulumi.Input[str]) – The name of the Resource Group in which the Notification Hub Namespace exists. Changing this forces a new resource to be created.

The apns_credential object supports the following:

  • applicationMode (pulumi.Input[str])

  • bundleId (pulumi.Input[str])

  • key_id (pulumi.Input[str])

  • teamId (pulumi.Input[str])

  • token (pulumi.Input[str])

The gcm_credential object supports the following:

  • api_key (pulumi.Input[str])

apns_credential = None

A apns_credential block as defined below.

  • applicationMode (str)

  • bundleId (str)

  • key_id (str)

  • teamId (str)

  • token (str)

gcm_credential = None

A gcm_credential block as defined below.

  • api_key (str)

location = None

The Azure Region in which this Notification Hub Namespace exists. Changing this forces a new resource to be created.

name = None

The name to use for this Notification Hub. Changing this forces a new resource to be created.

namespace_name = None

The name of the Notification Hub Namespace in which to create this Notification Hub. Changing this forces a new resource to be created.

resource_group_name = None

The name of the Resource Group in which the Notification Hub Namespace exists. Changing this forces a new resource to be created.

static get(resource_name, id, opts=None, apns_credential=None, gcm_credential=None, location=None, name=None, namespace_name=None, resource_group_name=None)

Get an existing Hub resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • apns_credential (pulumi.Input[dict]) – A apns_credential block as defined below.

  • gcm_credential (pulumi.Input[dict]) – A gcm_credential block as defined below.

  • location (pulumi.Input[str]) – The Azure Region in which this Notification Hub Namespace exists. Changing this forces a new resource to be created.

  • name (pulumi.Input[str]) – The name to use for this Notification Hub. Changing this forces a new resource to be created.

  • namespace_name (pulumi.Input[str]) – The name of the Notification Hub Namespace in which to create this Notification Hub. Changing this forces a new resource to be created.

  • resource_group_name (pulumi.Input[str]) – The name of the Resource Group in which the Notification Hub Namespace exists. Changing this forces a new resource to be created.

The apns_credential object supports the following:

  • applicationMode (pulumi.Input[str])

  • bundleId (pulumi.Input[str])

  • key_id (pulumi.Input[str])

  • teamId (pulumi.Input[str])

  • token (pulumi.Input[str])

The gcm_credential object supports the following:

  • api_key (pulumi.Input[str])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_azure.notificationhub.Namespace(resource_name, opts=None, enabled=None, location=None, name=None, namespace_type=None, resource_group_name=None, sku=None, sku_name=None, __props__=None, __name__=None, __opts__=None)

Manages a Notification Hub Namespace.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • enabled (pulumi.Input[bool]) – Is this Notification Hub Namespace enabled? Defaults to true.

  • location (pulumi.Input[str]) – The Azure Region in which this Notification Hub Namespace should be created.

  • name (pulumi.Input[str]) – The name to use for this Notification Hub Namespace. Changing this forces a new resource to be created.

  • namespace_type (pulumi.Input[str]) – The Type of Namespace - possible values are Messaging or NotificationHub. Changing this forces a new resource to be created.

  • resource_group_name (pulumi.Input[str]) – The name of the Resource Group in which the Notification Hub Namespace should exist. Changing this forces a new resource to be created.

  • sku (pulumi.Input[dict]) – ) A sku block as described below.

  • sku_name (pulumi.Input[str]) – The name of the SKU to use for this Notification Hub Namespace. Possible values are Free, Basic or Standard. Changing this forces a new resource to be created.

The sku object supports the following:

  • name (pulumi.Input[str]) - The name to use for this Notification Hub Namespace. Changing this forces a new resource to be created.

enabled = None

Is this Notification Hub Namespace enabled? Defaults to true.

location = None

The Azure Region in which this Notification Hub Namespace should be created.

name = None

The name to use for this Notification Hub Namespace. Changing this forces a new resource to be created.

namespace_type = None

The Type of Namespace - possible values are Messaging or NotificationHub. Changing this forces a new resource to be created.

resource_group_name = None

The name of the Resource Group in which the Notification Hub Namespace should exist. Changing this forces a new resource to be created.

servicebus_endpoint = None

The ServiceBus Endpoint for this Notification Hub Namespace.

sku = None

) A sku block as described below.

  • name (str) - The name to use for this Notification Hub Namespace. Changing this forces a new resource to be created.

sku_name = None

The name of the SKU to use for this Notification Hub Namespace. Possible values are Free, Basic or Standard. Changing this forces a new resource to be created.

static get(resource_name, id, opts=None, enabled=None, location=None, name=None, namespace_type=None, resource_group_name=None, servicebus_endpoint=None, sku=None, sku_name=None)

Get an existing Namespace resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • enabled (pulumi.Input[bool]) – Is this Notification Hub Namespace enabled? Defaults to true.

  • location (pulumi.Input[str]) – The Azure Region in which this Notification Hub Namespace should be created.

  • name (pulumi.Input[str]) – The name to use for this Notification Hub Namespace. Changing this forces a new resource to be created.

  • namespace_type (pulumi.Input[str]) – The Type of Namespace - possible values are Messaging or NotificationHub. Changing this forces a new resource to be created.

  • resource_group_name (pulumi.Input[str]) – The name of the Resource Group in which the Notification Hub Namespace should exist. Changing this forces a new resource to be created.

  • servicebus_endpoint (pulumi.Input[str]) – The ServiceBus Endpoint for this Notification Hub Namespace.

  • sku (pulumi.Input[dict]) – ) A sku block as described below.

  • sku_name (pulumi.Input[str]) – The name of the SKU to use for this Notification Hub Namespace. Possible values are Free, Basic or Standard. Changing this forces a new resource to be created.

The sku object supports the following:

  • name (pulumi.Input[str]) - The name to use for this Notification Hub Namespace. Changing this forces a new resource to be created.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

pulumi_azure.notificationhub.get_hub(name=None, namespace_name=None, resource_group_name=None, opts=None)

Use this data source to access information about an existing Notification Hub within a Notification Hub Namespace.

Parameters
  • name (str) – Specifies the Name of the Notification Hub.

  • namespace_name (str) – Specifies the Name of the Notification Hub Namespace which contains the Notification Hub.

  • resource_group_name (str) – Specifies the Name of the Resource Group within which the Notification Hub exists.

pulumi_azure.notificationhub.get_namespace(name=None, resource_group_name=None, opts=None)

Use this data source to access information about an existing Notification Hub Namespace.

Parameters
  • name (str) – Specifies the Name of the Notification Hub Namespace.

  • resource_group_name (str) – Specifies the Name of the Resource Group within which the Notification Hub exists.