notificationhub

package
v5.74.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 29, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AuthorizationRule

type AuthorizationRule struct {
	pulumi.CustomResourceState

	// Does this Authorization Rule have Listen access to the Notification Hub? Defaults to `false`.
	Listen pulumi.BoolPtrOutput `pulumi:"listen"`
	// Does this Authorization Rule have Manage access to the Notification Hub? Defaults to `false`.
	//
	// > **NOTE:** If `manage` is set to `true` then both `send` and `listen` must also be set to `true`.
	Manage pulumi.BoolPtrOutput `pulumi:"manage"`
	// The name to use for this Authorization Rule. Changing this forces a new resource to be created.
	Name pulumi.StringOutput `pulumi:"name"`
	// The name of the Notification Hub Namespace in which the Notification Hub exists. Changing this forces a new resource to be created.
	NamespaceName pulumi.StringOutput `pulumi:"namespaceName"`
	// The name of the Notification Hub for which the Authorization Rule should be created. Changing this forces a new resource to be created.
	NotificationHubName pulumi.StringOutput `pulumi:"notificationHubName"`
	// The Primary Access Key associated with this Authorization Rule.
	PrimaryAccessKey pulumi.StringOutput `pulumi:"primaryAccessKey"`
	// The name of the Resource Group in which the Notification Hub Namespace exists. Changing this forces a new resource to be created.
	ResourceGroupName pulumi.StringOutput `pulumi:"resourceGroupName"`
	// The Secondary Access Key associated with this Authorization Rule.
	SecondaryAccessKey pulumi.StringOutput `pulumi:"secondaryAccessKey"`
	// Does this Authorization Rule have Send access to the Notification Hub? Defaults to `false`.
	Send pulumi.BoolPtrOutput `pulumi:"send"`
}

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

## Example Usage

```go package main

import (

"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/notificationhub"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("notificationhub-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleNamespace, err := notificationhub.NewNamespace(ctx, "example", &notificationhub.NamespaceArgs{
			Name:              pulumi.String("myappnamespace"),
			ResourceGroupName: example.Name,
			Location:          example.Location,
			NamespaceType:     pulumi.String("NotificationHub"),
			SkuName:           pulumi.String("Free"),
		})
		if err != nil {
			return err
		}
		exampleHub, err := notificationhub.NewHub(ctx, "example", &notificationhub.HubArgs{
			Name:              pulumi.String("mynotificationhub"),
			NamespaceName:     exampleNamespace.Name,
			ResourceGroupName: example.Name,
			Location:          example.Location,
		})
		if err != nil {
			return err
		}
		_, err = notificationhub.NewAuthorizationRule(ctx, "example", &notificationhub.AuthorizationRuleArgs{
			Name:                pulumi.String("management-auth-rule"),
			NotificationHubName: exampleHub.Name,
			NamespaceName:       exampleNamespace.Name,
			ResourceGroupName:   example.Name,
			Manage:              pulumi.Bool(true),
			Send:                pulumi.Bool(true),
			Listen:              pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Notification Hub Authorization Rule can be imported using the `resource id`, e.g.

```sh $ pulumi import azure:notificationhub/authorizationRule:AuthorizationRule rule1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.NotificationHubs/namespaces/namespace1/notificationHubs/hub1/authorizationRules/rule1 ```

func GetAuthorizationRule

func GetAuthorizationRule(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *AuthorizationRuleState, opts ...pulumi.ResourceOption) (*AuthorizationRule, error)

GetAuthorizationRule gets an existing AuthorizationRule resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewAuthorizationRule

func NewAuthorizationRule(ctx *pulumi.Context,
	name string, args *AuthorizationRuleArgs, opts ...pulumi.ResourceOption) (*AuthorizationRule, error)

NewAuthorizationRule registers a new resource with the given unique name, arguments, and options.

func (*AuthorizationRule) ElementType

func (*AuthorizationRule) ElementType() reflect.Type

func (*AuthorizationRule) ToAuthorizationRuleOutput

func (i *AuthorizationRule) ToAuthorizationRuleOutput() AuthorizationRuleOutput

func (*AuthorizationRule) ToAuthorizationRuleOutputWithContext

func (i *AuthorizationRule) ToAuthorizationRuleOutputWithContext(ctx context.Context) AuthorizationRuleOutput

type AuthorizationRuleArgs

type AuthorizationRuleArgs struct {
	// Does this Authorization Rule have Listen access to the Notification Hub? Defaults to `false`.
	Listen pulumi.BoolPtrInput
	// Does this Authorization Rule have Manage access to the Notification Hub? Defaults to `false`.
	//
	// > **NOTE:** If `manage` is set to `true` then both `send` and `listen` must also be set to `true`.
	Manage pulumi.BoolPtrInput
	// The name to use for this Authorization Rule. Changing this forces a new resource to be created.
	Name pulumi.StringPtrInput
	// The name of the Notification Hub Namespace in which the Notification Hub exists. Changing this forces a new resource to be created.
	NamespaceName pulumi.StringInput
	// The name of the Notification Hub for which the Authorization Rule should be created. Changing this forces a new resource to be created.
	NotificationHubName pulumi.StringInput
	// The name of the Resource Group in which the Notification Hub Namespace exists. Changing this forces a new resource to be created.
	ResourceGroupName pulumi.StringInput
	// Does this Authorization Rule have Send access to the Notification Hub? Defaults to `false`.
	Send pulumi.BoolPtrInput
}

The set of arguments for constructing a AuthorizationRule resource.

func (AuthorizationRuleArgs) ElementType

func (AuthorizationRuleArgs) ElementType() reflect.Type

type AuthorizationRuleArray

type AuthorizationRuleArray []AuthorizationRuleInput

func (AuthorizationRuleArray) ElementType

func (AuthorizationRuleArray) ElementType() reflect.Type

func (AuthorizationRuleArray) ToAuthorizationRuleArrayOutput

func (i AuthorizationRuleArray) ToAuthorizationRuleArrayOutput() AuthorizationRuleArrayOutput

func (AuthorizationRuleArray) ToAuthorizationRuleArrayOutputWithContext

func (i AuthorizationRuleArray) ToAuthorizationRuleArrayOutputWithContext(ctx context.Context) AuthorizationRuleArrayOutput

type AuthorizationRuleArrayInput

type AuthorizationRuleArrayInput interface {
	pulumi.Input

	ToAuthorizationRuleArrayOutput() AuthorizationRuleArrayOutput
	ToAuthorizationRuleArrayOutputWithContext(context.Context) AuthorizationRuleArrayOutput
}

AuthorizationRuleArrayInput is an input type that accepts AuthorizationRuleArray and AuthorizationRuleArrayOutput values. You can construct a concrete instance of `AuthorizationRuleArrayInput` via:

AuthorizationRuleArray{ AuthorizationRuleArgs{...} }

type AuthorizationRuleArrayOutput

type AuthorizationRuleArrayOutput struct{ *pulumi.OutputState }

func (AuthorizationRuleArrayOutput) ElementType

func (AuthorizationRuleArrayOutput) Index

func (AuthorizationRuleArrayOutput) ToAuthorizationRuleArrayOutput

func (o AuthorizationRuleArrayOutput) ToAuthorizationRuleArrayOutput() AuthorizationRuleArrayOutput

func (AuthorizationRuleArrayOutput) ToAuthorizationRuleArrayOutputWithContext

func (o AuthorizationRuleArrayOutput) ToAuthorizationRuleArrayOutputWithContext(ctx context.Context) AuthorizationRuleArrayOutput

type AuthorizationRuleInput

type AuthorizationRuleInput interface {
	pulumi.Input

	ToAuthorizationRuleOutput() AuthorizationRuleOutput
	ToAuthorizationRuleOutputWithContext(ctx context.Context) AuthorizationRuleOutput
}

type AuthorizationRuleMap

type AuthorizationRuleMap map[string]AuthorizationRuleInput

func (AuthorizationRuleMap) ElementType

func (AuthorizationRuleMap) ElementType() reflect.Type

func (AuthorizationRuleMap) ToAuthorizationRuleMapOutput

func (i AuthorizationRuleMap) ToAuthorizationRuleMapOutput() AuthorizationRuleMapOutput

func (AuthorizationRuleMap) ToAuthorizationRuleMapOutputWithContext

func (i AuthorizationRuleMap) ToAuthorizationRuleMapOutputWithContext(ctx context.Context) AuthorizationRuleMapOutput

type AuthorizationRuleMapInput

type AuthorizationRuleMapInput interface {
	pulumi.Input

	ToAuthorizationRuleMapOutput() AuthorizationRuleMapOutput
	ToAuthorizationRuleMapOutputWithContext(context.Context) AuthorizationRuleMapOutput
}

AuthorizationRuleMapInput is an input type that accepts AuthorizationRuleMap and AuthorizationRuleMapOutput values. You can construct a concrete instance of `AuthorizationRuleMapInput` via:

AuthorizationRuleMap{ "key": AuthorizationRuleArgs{...} }

type AuthorizationRuleMapOutput

type AuthorizationRuleMapOutput struct{ *pulumi.OutputState }

func (AuthorizationRuleMapOutput) ElementType

func (AuthorizationRuleMapOutput) ElementType() reflect.Type

func (AuthorizationRuleMapOutput) MapIndex

func (AuthorizationRuleMapOutput) ToAuthorizationRuleMapOutput

func (o AuthorizationRuleMapOutput) ToAuthorizationRuleMapOutput() AuthorizationRuleMapOutput

func (AuthorizationRuleMapOutput) ToAuthorizationRuleMapOutputWithContext

func (o AuthorizationRuleMapOutput) ToAuthorizationRuleMapOutputWithContext(ctx context.Context) AuthorizationRuleMapOutput

type AuthorizationRuleOutput

type AuthorizationRuleOutput struct{ *pulumi.OutputState }

func (AuthorizationRuleOutput) ElementType

func (AuthorizationRuleOutput) ElementType() reflect.Type

func (AuthorizationRuleOutput) Listen added in v5.5.0

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

func (AuthorizationRuleOutput) Manage added in v5.5.0

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

> **NOTE:** If `manage` is set to `true` then both `send` and `listen` must also be set to `true`.

func (AuthorizationRuleOutput) Name added in v5.5.0

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

func (AuthorizationRuleOutput) NamespaceName added in v5.5.0

func (o AuthorizationRuleOutput) NamespaceName() pulumi.StringOutput

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

func (AuthorizationRuleOutput) NotificationHubName added in v5.5.0

func (o AuthorizationRuleOutput) NotificationHubName() pulumi.StringOutput

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

func (AuthorizationRuleOutput) PrimaryAccessKey added in v5.5.0

func (o AuthorizationRuleOutput) PrimaryAccessKey() pulumi.StringOutput

The Primary Access Key associated with this Authorization Rule.

func (AuthorizationRuleOutput) ResourceGroupName added in v5.5.0

func (o AuthorizationRuleOutput) ResourceGroupName() pulumi.StringOutput

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

func (AuthorizationRuleOutput) SecondaryAccessKey added in v5.5.0

func (o AuthorizationRuleOutput) SecondaryAccessKey() pulumi.StringOutput

The Secondary Access Key associated with this Authorization Rule.

func (AuthorizationRuleOutput) Send added in v5.5.0

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

func (AuthorizationRuleOutput) ToAuthorizationRuleOutput

func (o AuthorizationRuleOutput) ToAuthorizationRuleOutput() AuthorizationRuleOutput

func (AuthorizationRuleOutput) ToAuthorizationRuleOutputWithContext

func (o AuthorizationRuleOutput) ToAuthorizationRuleOutputWithContext(ctx context.Context) AuthorizationRuleOutput

type AuthorizationRuleState

type AuthorizationRuleState struct {
	// Does this Authorization Rule have Listen access to the Notification Hub? Defaults to `false`.
	Listen pulumi.BoolPtrInput
	// Does this Authorization Rule have Manage access to the Notification Hub? Defaults to `false`.
	//
	// > **NOTE:** If `manage` is set to `true` then both `send` and `listen` must also be set to `true`.
	Manage pulumi.BoolPtrInput
	// The name to use for this Authorization Rule. Changing this forces a new resource to be created.
	Name pulumi.StringPtrInput
	// The name of the Notification Hub Namespace in which the Notification Hub exists. Changing this forces a new resource to be created.
	NamespaceName pulumi.StringPtrInput
	// The name of the Notification Hub for which the Authorization Rule should be created. Changing this forces a new resource to be created.
	NotificationHubName pulumi.StringPtrInput
	// The Primary Access Key associated with this Authorization Rule.
	PrimaryAccessKey pulumi.StringPtrInput
	// The name of the Resource Group in which the Notification Hub Namespace exists. Changing this forces a new resource to be created.
	ResourceGroupName pulumi.StringPtrInput
	// The Secondary Access Key associated with this Authorization Rule.
	SecondaryAccessKey pulumi.StringPtrInput
	// Does this Authorization Rule have Send access to the Notification Hub? Defaults to `false`.
	Send pulumi.BoolPtrInput
}

func (AuthorizationRuleState) ElementType

func (AuthorizationRuleState) ElementType() reflect.Type

type GetHubApnsCredential

type GetHubApnsCredential struct {
	// The Application Mode which defines which server the APNS Messages should be sent to. Possible values are `Production` and `Sandbox`.
	ApplicationMode string `pulumi:"applicationMode"`
	// The Bundle ID of the iOS/macOS application to send push notifications for, such as `com.org.example`.
	BundleId string `pulumi:"bundleId"`
	// The Apple Push Notifications Service (APNS) Key.
	KeyId string `pulumi:"keyId"`
	// The ID of the team the Token.
	TeamId string `pulumi:"teamId"`
	// The Push Token associated with the Apple Developer Account.
	Token string `pulumi:"token"`
}

type GetHubApnsCredentialArgs

type GetHubApnsCredentialArgs struct {
	// The Application Mode which defines which server the APNS Messages should be sent to. Possible values are `Production` and `Sandbox`.
	ApplicationMode pulumi.StringInput `pulumi:"applicationMode"`
	// The Bundle ID of the iOS/macOS application to send push notifications for, such as `com.org.example`.
	BundleId pulumi.StringInput `pulumi:"bundleId"`
	// The Apple Push Notifications Service (APNS) Key.
	KeyId pulumi.StringInput `pulumi:"keyId"`
	// The ID of the team the Token.
	TeamId pulumi.StringInput `pulumi:"teamId"`
	// The Push Token associated with the Apple Developer Account.
	Token pulumi.StringInput `pulumi:"token"`
}

func (GetHubApnsCredentialArgs) ElementType

func (GetHubApnsCredentialArgs) ElementType() reflect.Type

func (GetHubApnsCredentialArgs) ToGetHubApnsCredentialOutput

func (i GetHubApnsCredentialArgs) ToGetHubApnsCredentialOutput() GetHubApnsCredentialOutput

func (GetHubApnsCredentialArgs) ToGetHubApnsCredentialOutputWithContext

func (i GetHubApnsCredentialArgs) ToGetHubApnsCredentialOutputWithContext(ctx context.Context) GetHubApnsCredentialOutput

type GetHubApnsCredentialArray

type GetHubApnsCredentialArray []GetHubApnsCredentialInput

func (GetHubApnsCredentialArray) ElementType

func (GetHubApnsCredentialArray) ElementType() reflect.Type

func (GetHubApnsCredentialArray) ToGetHubApnsCredentialArrayOutput

func (i GetHubApnsCredentialArray) ToGetHubApnsCredentialArrayOutput() GetHubApnsCredentialArrayOutput

func (GetHubApnsCredentialArray) ToGetHubApnsCredentialArrayOutputWithContext

func (i GetHubApnsCredentialArray) ToGetHubApnsCredentialArrayOutputWithContext(ctx context.Context) GetHubApnsCredentialArrayOutput

type GetHubApnsCredentialArrayInput

type GetHubApnsCredentialArrayInput interface {
	pulumi.Input

	ToGetHubApnsCredentialArrayOutput() GetHubApnsCredentialArrayOutput
	ToGetHubApnsCredentialArrayOutputWithContext(context.Context) GetHubApnsCredentialArrayOutput
}

GetHubApnsCredentialArrayInput is an input type that accepts GetHubApnsCredentialArray and GetHubApnsCredentialArrayOutput values. You can construct a concrete instance of `GetHubApnsCredentialArrayInput` via:

GetHubApnsCredentialArray{ GetHubApnsCredentialArgs{...} }

type GetHubApnsCredentialArrayOutput

type GetHubApnsCredentialArrayOutput struct{ *pulumi.OutputState }

func (GetHubApnsCredentialArrayOutput) ElementType

func (GetHubApnsCredentialArrayOutput) Index

func (GetHubApnsCredentialArrayOutput) ToGetHubApnsCredentialArrayOutput

func (o GetHubApnsCredentialArrayOutput) ToGetHubApnsCredentialArrayOutput() GetHubApnsCredentialArrayOutput

func (GetHubApnsCredentialArrayOutput) ToGetHubApnsCredentialArrayOutputWithContext

func (o GetHubApnsCredentialArrayOutput) ToGetHubApnsCredentialArrayOutputWithContext(ctx context.Context) GetHubApnsCredentialArrayOutput

type GetHubApnsCredentialInput

type GetHubApnsCredentialInput interface {
	pulumi.Input

	ToGetHubApnsCredentialOutput() GetHubApnsCredentialOutput
	ToGetHubApnsCredentialOutputWithContext(context.Context) GetHubApnsCredentialOutput
}

GetHubApnsCredentialInput is an input type that accepts GetHubApnsCredentialArgs and GetHubApnsCredentialOutput values. You can construct a concrete instance of `GetHubApnsCredentialInput` via:

GetHubApnsCredentialArgs{...}

type GetHubApnsCredentialOutput

type GetHubApnsCredentialOutput struct{ *pulumi.OutputState }

func (GetHubApnsCredentialOutput) ApplicationMode

func (o GetHubApnsCredentialOutput) ApplicationMode() pulumi.StringOutput

The Application Mode which defines which server the APNS Messages should be sent to. Possible values are `Production` and `Sandbox`.

func (GetHubApnsCredentialOutput) BundleId

The Bundle ID of the iOS/macOS application to send push notifications for, such as `com.org.example`.

func (GetHubApnsCredentialOutput) ElementType

func (GetHubApnsCredentialOutput) ElementType() reflect.Type

func (GetHubApnsCredentialOutput) KeyId

The Apple Push Notifications Service (APNS) Key.

func (GetHubApnsCredentialOutput) TeamId

The ID of the team the Token.

func (GetHubApnsCredentialOutput) ToGetHubApnsCredentialOutput

func (o GetHubApnsCredentialOutput) ToGetHubApnsCredentialOutput() GetHubApnsCredentialOutput

func (GetHubApnsCredentialOutput) ToGetHubApnsCredentialOutputWithContext

func (o GetHubApnsCredentialOutput) ToGetHubApnsCredentialOutputWithContext(ctx context.Context) GetHubApnsCredentialOutput

func (GetHubApnsCredentialOutput) Token

The Push Token associated with the Apple Developer Account.

type GetHubGcmCredential

type GetHubGcmCredential struct {
	// The API Key associated with the Google Cloud Messaging service.
	ApiKey string `pulumi:"apiKey"`
}

type GetHubGcmCredentialArgs

type GetHubGcmCredentialArgs struct {
	// The API Key associated with the Google Cloud Messaging service.
	ApiKey pulumi.StringInput `pulumi:"apiKey"`
}

func (GetHubGcmCredentialArgs) ElementType

func (GetHubGcmCredentialArgs) ElementType() reflect.Type

func (GetHubGcmCredentialArgs) ToGetHubGcmCredentialOutput

func (i GetHubGcmCredentialArgs) ToGetHubGcmCredentialOutput() GetHubGcmCredentialOutput

func (GetHubGcmCredentialArgs) ToGetHubGcmCredentialOutputWithContext

func (i GetHubGcmCredentialArgs) ToGetHubGcmCredentialOutputWithContext(ctx context.Context) GetHubGcmCredentialOutput

type GetHubGcmCredentialArray

type GetHubGcmCredentialArray []GetHubGcmCredentialInput

func (GetHubGcmCredentialArray) ElementType

func (GetHubGcmCredentialArray) ElementType() reflect.Type

func (GetHubGcmCredentialArray) ToGetHubGcmCredentialArrayOutput

func (i GetHubGcmCredentialArray) ToGetHubGcmCredentialArrayOutput() GetHubGcmCredentialArrayOutput

func (GetHubGcmCredentialArray) ToGetHubGcmCredentialArrayOutputWithContext

func (i GetHubGcmCredentialArray) ToGetHubGcmCredentialArrayOutputWithContext(ctx context.Context) GetHubGcmCredentialArrayOutput

type GetHubGcmCredentialArrayInput

type GetHubGcmCredentialArrayInput interface {
	pulumi.Input

	ToGetHubGcmCredentialArrayOutput() GetHubGcmCredentialArrayOutput
	ToGetHubGcmCredentialArrayOutputWithContext(context.Context) GetHubGcmCredentialArrayOutput
}

GetHubGcmCredentialArrayInput is an input type that accepts GetHubGcmCredentialArray and GetHubGcmCredentialArrayOutput values. You can construct a concrete instance of `GetHubGcmCredentialArrayInput` via:

GetHubGcmCredentialArray{ GetHubGcmCredentialArgs{...} }

type GetHubGcmCredentialArrayOutput

type GetHubGcmCredentialArrayOutput struct{ *pulumi.OutputState }

func (GetHubGcmCredentialArrayOutput) ElementType

func (GetHubGcmCredentialArrayOutput) Index

func (GetHubGcmCredentialArrayOutput) ToGetHubGcmCredentialArrayOutput

func (o GetHubGcmCredentialArrayOutput) ToGetHubGcmCredentialArrayOutput() GetHubGcmCredentialArrayOutput

func (GetHubGcmCredentialArrayOutput) ToGetHubGcmCredentialArrayOutputWithContext

func (o GetHubGcmCredentialArrayOutput) ToGetHubGcmCredentialArrayOutputWithContext(ctx context.Context) GetHubGcmCredentialArrayOutput

type GetHubGcmCredentialInput

type GetHubGcmCredentialInput interface {
	pulumi.Input

	ToGetHubGcmCredentialOutput() GetHubGcmCredentialOutput
	ToGetHubGcmCredentialOutputWithContext(context.Context) GetHubGcmCredentialOutput
}

GetHubGcmCredentialInput is an input type that accepts GetHubGcmCredentialArgs and GetHubGcmCredentialOutput values. You can construct a concrete instance of `GetHubGcmCredentialInput` via:

GetHubGcmCredentialArgs{...}

type GetHubGcmCredentialOutput

type GetHubGcmCredentialOutput struct{ *pulumi.OutputState }

func (GetHubGcmCredentialOutput) ApiKey

The API Key associated with the Google Cloud Messaging service.

func (GetHubGcmCredentialOutput) ElementType

func (GetHubGcmCredentialOutput) ElementType() reflect.Type

func (GetHubGcmCredentialOutput) ToGetHubGcmCredentialOutput

func (o GetHubGcmCredentialOutput) ToGetHubGcmCredentialOutput() GetHubGcmCredentialOutput

func (GetHubGcmCredentialOutput) ToGetHubGcmCredentialOutputWithContext

func (o GetHubGcmCredentialOutput) ToGetHubGcmCredentialOutputWithContext(ctx context.Context) GetHubGcmCredentialOutput

type GetNamespaceSku

type GetNamespaceSku struct {
	// Specifies the Name of the Notification Hub Namespace.
	Name string `pulumi:"name"`
}

type GetNamespaceSkuArgs

type GetNamespaceSkuArgs struct {
	// Specifies the Name of the Notification Hub Namespace.
	Name pulumi.StringInput `pulumi:"name"`
}

func (GetNamespaceSkuArgs) ElementType

func (GetNamespaceSkuArgs) ElementType() reflect.Type

func (GetNamespaceSkuArgs) ToGetNamespaceSkuOutput

func (i GetNamespaceSkuArgs) ToGetNamespaceSkuOutput() GetNamespaceSkuOutput

func (GetNamespaceSkuArgs) ToGetNamespaceSkuOutputWithContext

func (i GetNamespaceSkuArgs) ToGetNamespaceSkuOutputWithContext(ctx context.Context) GetNamespaceSkuOutput

type GetNamespaceSkuInput

type GetNamespaceSkuInput interface {
	pulumi.Input

	ToGetNamespaceSkuOutput() GetNamespaceSkuOutput
	ToGetNamespaceSkuOutputWithContext(context.Context) GetNamespaceSkuOutput
}

GetNamespaceSkuInput is an input type that accepts GetNamespaceSkuArgs and GetNamespaceSkuOutput values. You can construct a concrete instance of `GetNamespaceSkuInput` via:

GetNamespaceSkuArgs{...}

type GetNamespaceSkuOutput

type GetNamespaceSkuOutput struct{ *pulumi.OutputState }

func (GetNamespaceSkuOutput) ElementType

func (GetNamespaceSkuOutput) ElementType() reflect.Type

func (GetNamespaceSkuOutput) Name

Specifies the Name of the Notification Hub Namespace.

func (GetNamespaceSkuOutput) ToGetNamespaceSkuOutput

func (o GetNamespaceSkuOutput) ToGetNamespaceSkuOutput() GetNamespaceSkuOutput

func (GetNamespaceSkuOutput) ToGetNamespaceSkuOutputWithContext

func (o GetNamespaceSkuOutput) ToGetNamespaceSkuOutputWithContext(ctx context.Context) GetNamespaceSkuOutput

type Hub

type Hub struct {
	pulumi.CustomResourceState

	// A `apnsCredential` block as defined below.
	//
	// > **NOTE:** Removing the `apnsCredential` block will currently force a recreation of this resource [due to this bug in the Azure SDK for Go](https://github.com/Azure/azure-sdk-for-go/issues/2246) - we'll remove this limitation when the SDK bug is fixed.
	ApnsCredential HubApnsCredentialPtrOutput `pulumi:"apnsCredential"`
	// A `gcmCredential` block as defined below.
	//
	// > **NOTE:** Removing the `gcmCredential` block will currently force a recreation of this resource [due to this bug in the Azure SDK for Go](https://github.com/Azure/azure-sdk-for-go/issues/2246) - we'll remove this limitation when the SDK bug is fixed.
	GcmCredential HubGcmCredentialPtrOutput `pulumi:"gcmCredential"`
	// The Azure Region in which this Notification Hub Namespace exists. Changing this forces a new resource to be created.
	Location pulumi.StringOutput `pulumi:"location"`
	// The name to use for this Notification Hub. Changing this forces a new resource to be created.
	Name pulumi.StringOutput `pulumi:"name"`
	// The name of the Notification Hub Namespace in which to create this Notification Hub. Changing this forces a new resource to be created.
	NamespaceName pulumi.StringOutput `pulumi:"namespaceName"`
	// The name of the Resource Group in which the Notification Hub Namespace exists. Changing this forces a new resource to be created.
	ResourceGroupName pulumi.StringOutput `pulumi:"resourceGroupName"`
	// A mapping of tags to assign to the resource.
	Tags pulumi.StringMapOutput `pulumi:"tags"`
}

Manages a Notification Hub within a Notification Hub Namespace.

## Example Usage

```go package main

import (

"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/notificationhub"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("notificationhub-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleNamespace, err := notificationhub.NewNamespace(ctx, "example", &notificationhub.NamespaceArgs{
			Name:              pulumi.String("myappnamespace"),
			ResourceGroupName: example.Name,
			Location:          example.Location,
			NamespaceType:     pulumi.String("NotificationHub"),
			SkuName:           pulumi.String("Free"),
		})
		if err != nil {
			return err
		}
		_, err = notificationhub.NewHub(ctx, "example", &notificationhub.HubArgs{
			Name:              pulumi.String("mynotificationhub"),
			NamespaceName:     exampleNamespace.Name,
			ResourceGroupName: example.Name,
			Location:          example.Location,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Notification Hubs can be imported using the `resource id`, e.g.

```sh $ pulumi import azure:notificationhub/hub:Hub hub1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.NotificationHubs/namespaces/namespace1/notificationHubs/hub1 ```

func GetHub

func GetHub(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *HubState, opts ...pulumi.ResourceOption) (*Hub, error)

GetHub gets an existing Hub resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewHub

func NewHub(ctx *pulumi.Context,
	name string, args *HubArgs, opts ...pulumi.ResourceOption) (*Hub, error)

NewHub registers a new resource with the given unique name, arguments, and options.

func (*Hub) ElementType

func (*Hub) ElementType() reflect.Type

func (*Hub) ToHubOutput

func (i *Hub) ToHubOutput() HubOutput

func (*Hub) ToHubOutputWithContext

func (i *Hub) ToHubOutputWithContext(ctx context.Context) HubOutput

type HubApnsCredential

type HubApnsCredential struct {
	// The Application Mode which defines which server the APNS Messages should be sent to. Possible values are `Production` and `Sandbox`.
	ApplicationMode string `pulumi:"applicationMode"`
	// The Bundle ID of the iOS/macOS application to send push notifications for, such as `com.org.example`.
	BundleId string `pulumi:"bundleId"`
	// The Apple Push Notifications Service (APNS) Key.
	KeyId string `pulumi:"keyId"`
	// The ID of the team the Token.
	TeamId string `pulumi:"teamId"`
	// The Push Token associated with the Apple Developer Account. This is the contents of the `key` downloaded from [the Apple Developer Portal](https://developer.apple.com/account/ios/authkey/) between the `-----BEGIN PRIVATE KEY-----` and `-----END PRIVATE KEY-----` blocks.
	Token string `pulumi:"token"`
}

type HubApnsCredentialArgs

type HubApnsCredentialArgs struct {
	// The Application Mode which defines which server the APNS Messages should be sent to. Possible values are `Production` and `Sandbox`.
	ApplicationMode pulumi.StringInput `pulumi:"applicationMode"`
	// The Bundle ID of the iOS/macOS application to send push notifications for, such as `com.org.example`.
	BundleId pulumi.StringInput `pulumi:"bundleId"`
	// The Apple Push Notifications Service (APNS) Key.
	KeyId pulumi.StringInput `pulumi:"keyId"`
	// The ID of the team the Token.
	TeamId pulumi.StringInput `pulumi:"teamId"`
	// The Push Token associated with the Apple Developer Account. This is the contents of the `key` downloaded from [the Apple Developer Portal](https://developer.apple.com/account/ios/authkey/) between the `-----BEGIN PRIVATE KEY-----` and `-----END PRIVATE KEY-----` blocks.
	Token pulumi.StringInput `pulumi:"token"`
}

func (HubApnsCredentialArgs) ElementType

func (HubApnsCredentialArgs) ElementType() reflect.Type

func (HubApnsCredentialArgs) ToHubApnsCredentialOutput

func (i HubApnsCredentialArgs) ToHubApnsCredentialOutput() HubApnsCredentialOutput

func (HubApnsCredentialArgs) ToHubApnsCredentialOutputWithContext

func (i HubApnsCredentialArgs) ToHubApnsCredentialOutputWithContext(ctx context.Context) HubApnsCredentialOutput

func (HubApnsCredentialArgs) ToHubApnsCredentialPtrOutput

func (i HubApnsCredentialArgs) ToHubApnsCredentialPtrOutput() HubApnsCredentialPtrOutput

func (HubApnsCredentialArgs) ToHubApnsCredentialPtrOutputWithContext

func (i HubApnsCredentialArgs) ToHubApnsCredentialPtrOutputWithContext(ctx context.Context) HubApnsCredentialPtrOutput

type HubApnsCredentialInput

type HubApnsCredentialInput interface {
	pulumi.Input

	ToHubApnsCredentialOutput() HubApnsCredentialOutput
	ToHubApnsCredentialOutputWithContext(context.Context) HubApnsCredentialOutput
}

HubApnsCredentialInput is an input type that accepts HubApnsCredentialArgs and HubApnsCredentialOutput values. You can construct a concrete instance of `HubApnsCredentialInput` via:

HubApnsCredentialArgs{...}

type HubApnsCredentialOutput

type HubApnsCredentialOutput struct{ *pulumi.OutputState }

func (HubApnsCredentialOutput) ApplicationMode

func (o HubApnsCredentialOutput) ApplicationMode() pulumi.StringOutput

The Application Mode which defines which server the APNS Messages should be sent to. Possible values are `Production` and `Sandbox`.

func (HubApnsCredentialOutput) BundleId

The Bundle ID of the iOS/macOS application to send push notifications for, such as `com.org.example`.

func (HubApnsCredentialOutput) ElementType

func (HubApnsCredentialOutput) ElementType() reflect.Type

func (HubApnsCredentialOutput) KeyId

The Apple Push Notifications Service (APNS) Key.

func (HubApnsCredentialOutput) TeamId

The ID of the team the Token.

func (HubApnsCredentialOutput) ToHubApnsCredentialOutput

func (o HubApnsCredentialOutput) ToHubApnsCredentialOutput() HubApnsCredentialOutput

func (HubApnsCredentialOutput) ToHubApnsCredentialOutputWithContext

func (o HubApnsCredentialOutput) ToHubApnsCredentialOutputWithContext(ctx context.Context) HubApnsCredentialOutput

func (HubApnsCredentialOutput) ToHubApnsCredentialPtrOutput

func (o HubApnsCredentialOutput) ToHubApnsCredentialPtrOutput() HubApnsCredentialPtrOutput

func (HubApnsCredentialOutput) ToHubApnsCredentialPtrOutputWithContext

func (o HubApnsCredentialOutput) ToHubApnsCredentialPtrOutputWithContext(ctx context.Context) HubApnsCredentialPtrOutput

func (HubApnsCredentialOutput) Token

The Push Token associated with the Apple Developer Account. This is the contents of the `key` downloaded from [the Apple Developer Portal](https://developer.apple.com/account/ios/authkey/) between the `-----BEGIN PRIVATE KEY-----` and `-----END PRIVATE KEY-----` blocks.

type HubApnsCredentialPtrInput

type HubApnsCredentialPtrInput interface {
	pulumi.Input

	ToHubApnsCredentialPtrOutput() HubApnsCredentialPtrOutput
	ToHubApnsCredentialPtrOutputWithContext(context.Context) HubApnsCredentialPtrOutput
}

HubApnsCredentialPtrInput is an input type that accepts HubApnsCredentialArgs, HubApnsCredentialPtr and HubApnsCredentialPtrOutput values. You can construct a concrete instance of `HubApnsCredentialPtrInput` via:

        HubApnsCredentialArgs{...}

or:

        nil

type HubApnsCredentialPtrOutput

type HubApnsCredentialPtrOutput struct{ *pulumi.OutputState }

func (HubApnsCredentialPtrOutput) ApplicationMode

The Application Mode which defines which server the APNS Messages should be sent to. Possible values are `Production` and `Sandbox`.

func (HubApnsCredentialPtrOutput) BundleId

The Bundle ID of the iOS/macOS application to send push notifications for, such as `com.org.example`.

func (HubApnsCredentialPtrOutput) Elem

func (HubApnsCredentialPtrOutput) ElementType

func (HubApnsCredentialPtrOutput) ElementType() reflect.Type

func (HubApnsCredentialPtrOutput) KeyId

The Apple Push Notifications Service (APNS) Key.

func (HubApnsCredentialPtrOutput) TeamId

The ID of the team the Token.

func (HubApnsCredentialPtrOutput) ToHubApnsCredentialPtrOutput

func (o HubApnsCredentialPtrOutput) ToHubApnsCredentialPtrOutput() HubApnsCredentialPtrOutput

func (HubApnsCredentialPtrOutput) ToHubApnsCredentialPtrOutputWithContext

func (o HubApnsCredentialPtrOutput) ToHubApnsCredentialPtrOutputWithContext(ctx context.Context) HubApnsCredentialPtrOutput

func (HubApnsCredentialPtrOutput) Token

The Push Token associated with the Apple Developer Account. This is the contents of the `key` downloaded from [the Apple Developer Portal](https://developer.apple.com/account/ios/authkey/) between the `-----BEGIN PRIVATE KEY-----` and `-----END PRIVATE KEY-----` blocks.

type HubArgs

type HubArgs struct {
	// A `apnsCredential` block as defined below.
	//
	// > **NOTE:** Removing the `apnsCredential` block will currently force a recreation of this resource [due to this bug in the Azure SDK for Go](https://github.com/Azure/azure-sdk-for-go/issues/2246) - we'll remove this limitation when the SDK bug is fixed.
	ApnsCredential HubApnsCredentialPtrInput
	// A `gcmCredential` block as defined below.
	//
	// > **NOTE:** Removing the `gcmCredential` block will currently force a recreation of this resource [due to this bug in the Azure SDK for Go](https://github.com/Azure/azure-sdk-for-go/issues/2246) - we'll remove this limitation when the SDK bug is fixed.
	GcmCredential HubGcmCredentialPtrInput
	// The Azure Region in which this Notification Hub Namespace exists. Changing this forces a new resource to be created.
	Location pulumi.StringPtrInput
	// The name to use for this Notification Hub. Changing this forces a new resource to be created.
	Name pulumi.StringPtrInput
	// The name of the Notification Hub Namespace in which to create this Notification Hub. Changing this forces a new resource to be created.
	NamespaceName pulumi.StringInput
	// The name of the Resource Group in which the Notification Hub Namespace exists. Changing this forces a new resource to be created.
	ResourceGroupName pulumi.StringInput
	// A mapping of tags to assign to the resource.
	Tags pulumi.StringMapInput
}

The set of arguments for constructing a Hub resource.

func (HubArgs) ElementType

func (HubArgs) ElementType() reflect.Type

type HubArray

type HubArray []HubInput

func (HubArray) ElementType

func (HubArray) ElementType() reflect.Type

func (HubArray) ToHubArrayOutput

func (i HubArray) ToHubArrayOutput() HubArrayOutput

func (HubArray) ToHubArrayOutputWithContext

func (i HubArray) ToHubArrayOutputWithContext(ctx context.Context) HubArrayOutput

type HubArrayInput

type HubArrayInput interface {
	pulumi.Input

	ToHubArrayOutput() HubArrayOutput
	ToHubArrayOutputWithContext(context.Context) HubArrayOutput
}

HubArrayInput is an input type that accepts HubArray and HubArrayOutput values. You can construct a concrete instance of `HubArrayInput` via:

HubArray{ HubArgs{...} }

type HubArrayOutput

type HubArrayOutput struct{ *pulumi.OutputState }

func (HubArrayOutput) ElementType

func (HubArrayOutput) ElementType() reflect.Type

func (HubArrayOutput) Index

func (HubArrayOutput) ToHubArrayOutput

func (o HubArrayOutput) ToHubArrayOutput() HubArrayOutput

func (HubArrayOutput) ToHubArrayOutputWithContext

func (o HubArrayOutput) ToHubArrayOutputWithContext(ctx context.Context) HubArrayOutput

type HubGcmCredential

type HubGcmCredential struct {
	// The API Key associated with the Google Cloud Messaging service.
	ApiKey string `pulumi:"apiKey"`
}

type HubGcmCredentialArgs

type HubGcmCredentialArgs struct {
	// The API Key associated with the Google Cloud Messaging service.
	ApiKey pulumi.StringInput `pulumi:"apiKey"`
}

func (HubGcmCredentialArgs) ElementType

func (HubGcmCredentialArgs) ElementType() reflect.Type

func (HubGcmCredentialArgs) ToHubGcmCredentialOutput

func (i HubGcmCredentialArgs) ToHubGcmCredentialOutput() HubGcmCredentialOutput

func (HubGcmCredentialArgs) ToHubGcmCredentialOutputWithContext

func (i HubGcmCredentialArgs) ToHubGcmCredentialOutputWithContext(ctx context.Context) HubGcmCredentialOutput

func (HubGcmCredentialArgs) ToHubGcmCredentialPtrOutput

func (i HubGcmCredentialArgs) ToHubGcmCredentialPtrOutput() HubGcmCredentialPtrOutput

func (HubGcmCredentialArgs) ToHubGcmCredentialPtrOutputWithContext

func (i HubGcmCredentialArgs) ToHubGcmCredentialPtrOutputWithContext(ctx context.Context) HubGcmCredentialPtrOutput

type HubGcmCredentialInput

type HubGcmCredentialInput interface {
	pulumi.Input

	ToHubGcmCredentialOutput() HubGcmCredentialOutput
	ToHubGcmCredentialOutputWithContext(context.Context) HubGcmCredentialOutput
}

HubGcmCredentialInput is an input type that accepts HubGcmCredentialArgs and HubGcmCredentialOutput values. You can construct a concrete instance of `HubGcmCredentialInput` via:

HubGcmCredentialArgs{...}

type HubGcmCredentialOutput

type HubGcmCredentialOutput struct{ *pulumi.OutputState }

func (HubGcmCredentialOutput) ApiKey

The API Key associated with the Google Cloud Messaging service.

func (HubGcmCredentialOutput) ElementType

func (HubGcmCredentialOutput) ElementType() reflect.Type

func (HubGcmCredentialOutput) ToHubGcmCredentialOutput

func (o HubGcmCredentialOutput) ToHubGcmCredentialOutput() HubGcmCredentialOutput

func (HubGcmCredentialOutput) ToHubGcmCredentialOutputWithContext

func (o HubGcmCredentialOutput) ToHubGcmCredentialOutputWithContext(ctx context.Context) HubGcmCredentialOutput

func (HubGcmCredentialOutput) ToHubGcmCredentialPtrOutput

func (o HubGcmCredentialOutput) ToHubGcmCredentialPtrOutput() HubGcmCredentialPtrOutput

func (HubGcmCredentialOutput) ToHubGcmCredentialPtrOutputWithContext

func (o HubGcmCredentialOutput) ToHubGcmCredentialPtrOutputWithContext(ctx context.Context) HubGcmCredentialPtrOutput

type HubGcmCredentialPtrInput

type HubGcmCredentialPtrInput interface {
	pulumi.Input

	ToHubGcmCredentialPtrOutput() HubGcmCredentialPtrOutput
	ToHubGcmCredentialPtrOutputWithContext(context.Context) HubGcmCredentialPtrOutput
}

HubGcmCredentialPtrInput is an input type that accepts HubGcmCredentialArgs, HubGcmCredentialPtr and HubGcmCredentialPtrOutput values. You can construct a concrete instance of `HubGcmCredentialPtrInput` via:

        HubGcmCredentialArgs{...}

or:

        nil

type HubGcmCredentialPtrOutput

type HubGcmCredentialPtrOutput struct{ *pulumi.OutputState }

func (HubGcmCredentialPtrOutput) ApiKey

The API Key associated with the Google Cloud Messaging service.

func (HubGcmCredentialPtrOutput) Elem

func (HubGcmCredentialPtrOutput) ElementType

func (HubGcmCredentialPtrOutput) ElementType() reflect.Type

func (HubGcmCredentialPtrOutput) ToHubGcmCredentialPtrOutput

func (o HubGcmCredentialPtrOutput) ToHubGcmCredentialPtrOutput() HubGcmCredentialPtrOutput

func (HubGcmCredentialPtrOutput) ToHubGcmCredentialPtrOutputWithContext

func (o HubGcmCredentialPtrOutput) ToHubGcmCredentialPtrOutputWithContext(ctx context.Context) HubGcmCredentialPtrOutput

type HubInput

type HubInput interface {
	pulumi.Input

	ToHubOutput() HubOutput
	ToHubOutputWithContext(ctx context.Context) HubOutput
}

type HubMap

type HubMap map[string]HubInput

func (HubMap) ElementType

func (HubMap) ElementType() reflect.Type

func (HubMap) ToHubMapOutput

func (i HubMap) ToHubMapOutput() HubMapOutput

func (HubMap) ToHubMapOutputWithContext

func (i HubMap) ToHubMapOutputWithContext(ctx context.Context) HubMapOutput

type HubMapInput

type HubMapInput interface {
	pulumi.Input

	ToHubMapOutput() HubMapOutput
	ToHubMapOutputWithContext(context.Context) HubMapOutput
}

HubMapInput is an input type that accepts HubMap and HubMapOutput values. You can construct a concrete instance of `HubMapInput` via:

HubMap{ "key": HubArgs{...} }

type HubMapOutput

type HubMapOutput struct{ *pulumi.OutputState }

func (HubMapOutput) ElementType

func (HubMapOutput) ElementType() reflect.Type

func (HubMapOutput) MapIndex

func (o HubMapOutput) MapIndex(k pulumi.StringInput) HubOutput

func (HubMapOutput) ToHubMapOutput

func (o HubMapOutput) ToHubMapOutput() HubMapOutput

func (HubMapOutput) ToHubMapOutputWithContext

func (o HubMapOutput) ToHubMapOutputWithContext(ctx context.Context) HubMapOutput

type HubOutput

type HubOutput struct{ *pulumi.OutputState }

func (HubOutput) ApnsCredential added in v5.5.0

func (o HubOutput) ApnsCredential() HubApnsCredentialPtrOutput

A `apnsCredential` block as defined below.

> **NOTE:** Removing the `apnsCredential` block will currently force a recreation of this resource [due to this bug in the Azure SDK for Go](https://github.com/Azure/azure-sdk-for-go/issues/2246) - we'll remove this limitation when the SDK bug is fixed.

func (HubOutput) ElementType

func (HubOutput) ElementType() reflect.Type

func (HubOutput) GcmCredential added in v5.5.0

func (o HubOutput) GcmCredential() HubGcmCredentialPtrOutput

A `gcmCredential` block as defined below.

> **NOTE:** Removing the `gcmCredential` block will currently force a recreation of this resource [due to this bug in the Azure SDK for Go](https://github.com/Azure/azure-sdk-for-go/issues/2246) - we'll remove this limitation when the SDK bug is fixed.

func (HubOutput) Location added in v5.5.0

func (o HubOutput) Location() pulumi.StringOutput

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

func (HubOutput) Name added in v5.5.0

func (o HubOutput) Name() pulumi.StringOutput

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

func (HubOutput) NamespaceName added in v5.5.0

func (o HubOutput) NamespaceName() pulumi.StringOutput

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

func (HubOutput) ResourceGroupName added in v5.5.0

func (o HubOutput) ResourceGroupName() pulumi.StringOutput

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

func (HubOutput) Tags added in v5.5.0

func (o HubOutput) Tags() pulumi.StringMapOutput

A mapping of tags to assign to the resource.

func (HubOutput) ToHubOutput

func (o HubOutput) ToHubOutput() HubOutput

func (HubOutput) ToHubOutputWithContext

func (o HubOutput) ToHubOutputWithContext(ctx context.Context) HubOutput

type HubState

type HubState struct {
	// A `apnsCredential` block as defined below.
	//
	// > **NOTE:** Removing the `apnsCredential` block will currently force a recreation of this resource [due to this bug in the Azure SDK for Go](https://github.com/Azure/azure-sdk-for-go/issues/2246) - we'll remove this limitation when the SDK bug is fixed.
	ApnsCredential HubApnsCredentialPtrInput
	// A `gcmCredential` block as defined below.
	//
	// > **NOTE:** Removing the `gcmCredential` block will currently force a recreation of this resource [due to this bug in the Azure SDK for Go](https://github.com/Azure/azure-sdk-for-go/issues/2246) - we'll remove this limitation when the SDK bug is fixed.
	GcmCredential HubGcmCredentialPtrInput
	// The Azure Region in which this Notification Hub Namespace exists. Changing this forces a new resource to be created.
	Location pulumi.StringPtrInput
	// The name to use for this Notification Hub. Changing this forces a new resource to be created.
	Name pulumi.StringPtrInput
	// The name of the Notification Hub Namespace in which to create this Notification Hub. Changing this forces a new resource to be created.
	NamespaceName pulumi.StringPtrInput
	// The name of the Resource Group in which the Notification Hub Namespace exists. Changing this forces a new resource to be created.
	ResourceGroupName pulumi.StringPtrInput
	// A mapping of tags to assign to the resource.
	Tags pulumi.StringMapInput
}

func (HubState) ElementType

func (HubState) ElementType() reflect.Type

type LookupHubArgs

type LookupHubArgs struct {
	// Specifies the Name of the Notification Hub.
	Name string `pulumi:"name"`
	// Specifies the Name of the Notification Hub Namespace which contains the Notification Hub.
	NamespaceName string `pulumi:"namespaceName"`
	// Specifies the Name of the Resource Group within which the Notification Hub exists.
	ResourceGroupName string `pulumi:"resourceGroupName"`
}

A collection of arguments for invoking getHub.

type LookupHubOutputArgs

type LookupHubOutputArgs struct {
	// Specifies the Name of the Notification Hub.
	Name pulumi.StringInput `pulumi:"name"`
	// Specifies the Name of the Notification Hub Namespace which contains the Notification Hub.
	NamespaceName pulumi.StringInput `pulumi:"namespaceName"`
	// Specifies the Name of the Resource Group within which the Notification Hub exists.
	ResourceGroupName pulumi.StringInput `pulumi:"resourceGroupName"`
}

A collection of arguments for invoking getHub.

func (LookupHubOutputArgs) ElementType

func (LookupHubOutputArgs) ElementType() reflect.Type

type LookupHubResult

type LookupHubResult struct {
	// A `apnsCredential` block as defined below.
	ApnsCredentials []GetHubApnsCredential `pulumi:"apnsCredentials"`
	// A `gcmCredential` block as defined below.
	GcmCredentials []GetHubGcmCredential `pulumi:"gcmCredentials"`
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// The Azure Region in which this Notification Hub exists.
	Location          string `pulumi:"location"`
	Name              string `pulumi:"name"`
	NamespaceName     string `pulumi:"namespaceName"`
	ResourceGroupName string `pulumi:"resourceGroupName"`
	// A mapping of tags to assign to the resource.
	Tags map[string]string `pulumi:"tags"`
}

A collection of values returned by getHub.

func LookupHub

func LookupHub(ctx *pulumi.Context, args *LookupHubArgs, opts ...pulumi.InvokeOption) (*LookupHubResult, error)

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

## Example Usage

```go package main

import (

"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/notificationhub"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := notificationhub.LookupHub(ctx, &notificationhub.LookupHubArgs{
			Name:              "notification-hub",
			NamespaceName:     "namespace-name",
			ResourceGroupName: "resource-group-name",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("id", example.Id)
		return nil
	})
}

```

type LookupHubResultOutput

type LookupHubResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getHub.

func (LookupHubResultOutput) ApnsCredentials

A `apnsCredential` block as defined below.

func (LookupHubResultOutput) ElementType

func (LookupHubResultOutput) ElementType() reflect.Type

func (LookupHubResultOutput) GcmCredentials

A `gcmCredential` block as defined below.

func (LookupHubResultOutput) Id

The provider-assigned unique ID for this managed resource.

func (LookupHubResultOutput) Location

The Azure Region in which this Notification Hub exists.

func (LookupHubResultOutput) Name

func (LookupHubResultOutput) NamespaceName

func (o LookupHubResultOutput) NamespaceName() pulumi.StringOutput

func (LookupHubResultOutput) ResourceGroupName

func (o LookupHubResultOutput) ResourceGroupName() pulumi.StringOutput

func (LookupHubResultOutput) Tags

A mapping of tags to assign to the resource.

func (LookupHubResultOutput) ToLookupHubResultOutput

func (o LookupHubResultOutput) ToLookupHubResultOutput() LookupHubResultOutput

func (LookupHubResultOutput) ToLookupHubResultOutputWithContext

func (o LookupHubResultOutput) ToLookupHubResultOutputWithContext(ctx context.Context) LookupHubResultOutput

type LookupNamespaceArgs

type LookupNamespaceArgs struct {
	// Specifies the Name of the Notification Hub Namespace.
	Name string `pulumi:"name"`
	// Specifies the Name of the Resource Group within which the Notification Hub exists.
	ResourceGroupName string `pulumi:"resourceGroupName"`
}

A collection of arguments for invoking getNamespace.

type LookupNamespaceOutputArgs

type LookupNamespaceOutputArgs struct {
	// Specifies the Name of the Notification Hub Namespace.
	Name pulumi.StringInput `pulumi:"name"`
	// Specifies the Name of the Resource Group within which the Notification Hub exists.
	ResourceGroupName pulumi.StringInput `pulumi:"resourceGroupName"`
}

A collection of arguments for invoking getNamespace.

func (LookupNamespaceOutputArgs) ElementType

func (LookupNamespaceOutputArgs) ElementType() reflect.Type

type LookupNamespaceResult

type LookupNamespaceResult struct {
	// Is this Notification Hub Namespace enabled?
	Enabled bool `pulumi:"enabled"`
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// The Azure Region in which this Notification Hub Namespace exists.
	Location string `pulumi:"location"`
	// The name of the SKU to use for this Notification Hub Namespace. Possible values are `Free`, `Basic` or `Standard.`
	Name string `pulumi:"name"`
	// The Type of Namespace, such as `Messaging` or `NotificationHub`.
	NamespaceType      string `pulumi:"namespaceType"`
	ResourceGroupName  string `pulumi:"resourceGroupName"`
	ServicebusEndpoint string `pulumi:"servicebusEndpoint"`
	// A `sku` block as defined below.
	Sku GetNamespaceSku `pulumi:"sku"`
	// A mapping of tags to assign to the resource.
	Tags map[string]string `pulumi:"tags"`
}

A collection of values returned by getNamespace.

func LookupNamespace

func LookupNamespace(ctx *pulumi.Context, args *LookupNamespaceArgs, opts ...pulumi.InvokeOption) (*LookupNamespaceResult, error)

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

## Example Usage

```go package main

import (

"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/notificationhub"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := notificationhub.LookupNamespace(ctx, &notificationhub.LookupNamespaceArgs{
			Name:              "my-namespace",
			ResourceGroupName: "my-resource-group",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("servicebusEndpoint", example.ServicebusEndpoint)
		return nil
	})
}

```

type LookupNamespaceResultOutput

type LookupNamespaceResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getNamespace.

func (LookupNamespaceResultOutput) ElementType

func (LookupNamespaceResultOutput) Enabled

Is this Notification Hub Namespace enabled?

func (LookupNamespaceResultOutput) Id

The provider-assigned unique ID for this managed resource.

func (LookupNamespaceResultOutput) Location

The Azure Region in which this Notification Hub Namespace exists.

func (LookupNamespaceResultOutput) Name

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

func (LookupNamespaceResultOutput) NamespaceType

The Type of Namespace, such as `Messaging` or `NotificationHub`.

func (LookupNamespaceResultOutput) ResourceGroupName

func (o LookupNamespaceResultOutput) ResourceGroupName() pulumi.StringOutput

func (LookupNamespaceResultOutput) ServicebusEndpoint

func (o LookupNamespaceResultOutput) ServicebusEndpoint() pulumi.StringOutput

func (LookupNamespaceResultOutput) Sku

A `sku` block as defined below.

func (LookupNamespaceResultOutput) Tags

A mapping of tags to assign to the resource.

func (LookupNamespaceResultOutput) ToLookupNamespaceResultOutput

func (o LookupNamespaceResultOutput) ToLookupNamespaceResultOutput() LookupNamespaceResultOutput

func (LookupNamespaceResultOutput) ToLookupNamespaceResultOutputWithContext

func (o LookupNamespaceResultOutput) ToLookupNamespaceResultOutputWithContext(ctx context.Context) LookupNamespaceResultOutput

type Namespace

type Namespace struct {
	pulumi.CustomResourceState

	// Is this Notification Hub Namespace enabled? Defaults to `true`.
	Enabled pulumi.BoolPtrOutput `pulumi:"enabled"`
	// The Azure Region in which this Notification Hub Namespace should be created. Changing this forces a new resource to be created.
	Location pulumi.StringOutput `pulumi:"location"`
	// The name to use for this Notification Hub Namespace. Changing this forces a new resource to be created.
	Name pulumi.StringOutput `pulumi:"name"`
	// The Type of Namespace - possible values are `Messaging` or `NotificationHub`.
	NamespaceType pulumi.StringOutput `pulumi:"namespaceType"`
	// The name of the Resource Group in which the Notification Hub Namespace should exist. Changing this forces a new resource to be created.
	ResourceGroupName pulumi.StringOutput `pulumi:"resourceGroupName"`
	// The ServiceBus Endpoint for this Notification Hub Namespace.
	ServicebusEndpoint pulumi.StringOutput `pulumi:"servicebusEndpoint"`
	// The name of the SKU to use for this Notification Hub Namespace. Possible values are `Free`, `Basic` or `Standard`.
	SkuName pulumi.StringOutput `pulumi:"skuName"`
	// A mapping of tags to assign to the resource.
	Tags pulumi.StringMapOutput `pulumi:"tags"`
}

Manages a Notification Hub Namespace.

## Example Usage

```go package main

import (

"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/notificationhub"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("notificationhub-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		_, err = notificationhub.NewNamespace(ctx, "example", &notificationhub.NamespaceArgs{
			Name:              pulumi.String("myappnamespace"),
			ResourceGroupName: example.Name,
			Location:          example.Location,
			NamespaceType:     pulumi.String("NotificationHub"),
			SkuName:           pulumi.String("Free"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Notification Hub Namespaces can be imported using the `resource id`, e.g.

```sh $ pulumi import azure:notificationhub/namespace:Namespace namespace1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.NotificationHubs/namespaces/namespace1 ```

func GetNamespace

func GetNamespace(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *NamespaceState, opts ...pulumi.ResourceOption) (*Namespace, error)

GetNamespace gets an existing Namespace resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewNamespace

func NewNamespace(ctx *pulumi.Context,
	name string, args *NamespaceArgs, opts ...pulumi.ResourceOption) (*Namespace, error)

NewNamespace registers a new resource with the given unique name, arguments, and options.

func (*Namespace) ElementType

func (*Namespace) ElementType() reflect.Type

func (*Namespace) ToNamespaceOutput

func (i *Namespace) ToNamespaceOutput() NamespaceOutput

func (*Namespace) ToNamespaceOutputWithContext

func (i *Namespace) ToNamespaceOutputWithContext(ctx context.Context) NamespaceOutput

type NamespaceArgs

type NamespaceArgs struct {
	// Is this Notification Hub Namespace enabled? Defaults to `true`.
	Enabled pulumi.BoolPtrInput
	// The Azure Region in which this Notification Hub Namespace should be created. Changing this forces a new resource to be created.
	Location pulumi.StringPtrInput
	// The name to use for this Notification Hub Namespace. Changing this forces a new resource to be created.
	Name pulumi.StringPtrInput
	// The Type of Namespace - possible values are `Messaging` or `NotificationHub`.
	NamespaceType pulumi.StringInput
	// The name of the Resource Group in which the Notification Hub Namespace should exist. Changing this forces a new resource to be created.
	ResourceGroupName pulumi.StringInput
	// The name of the SKU to use for this Notification Hub Namespace. Possible values are `Free`, `Basic` or `Standard`.
	SkuName pulumi.StringInput
	// A mapping of tags to assign to the resource.
	Tags pulumi.StringMapInput
}

The set of arguments for constructing a Namespace resource.

func (NamespaceArgs) ElementType

func (NamespaceArgs) ElementType() reflect.Type

type NamespaceArray

type NamespaceArray []NamespaceInput

func (NamespaceArray) ElementType

func (NamespaceArray) ElementType() reflect.Type

func (NamespaceArray) ToNamespaceArrayOutput

func (i NamespaceArray) ToNamespaceArrayOutput() NamespaceArrayOutput

func (NamespaceArray) ToNamespaceArrayOutputWithContext

func (i NamespaceArray) ToNamespaceArrayOutputWithContext(ctx context.Context) NamespaceArrayOutput

type NamespaceArrayInput

type NamespaceArrayInput interface {
	pulumi.Input

	ToNamespaceArrayOutput() NamespaceArrayOutput
	ToNamespaceArrayOutputWithContext(context.Context) NamespaceArrayOutput
}

NamespaceArrayInput is an input type that accepts NamespaceArray and NamespaceArrayOutput values. You can construct a concrete instance of `NamespaceArrayInput` via:

NamespaceArray{ NamespaceArgs{...} }

type NamespaceArrayOutput

type NamespaceArrayOutput struct{ *pulumi.OutputState }

func (NamespaceArrayOutput) ElementType

func (NamespaceArrayOutput) ElementType() reflect.Type

func (NamespaceArrayOutput) Index

func (NamespaceArrayOutput) ToNamespaceArrayOutput

func (o NamespaceArrayOutput) ToNamespaceArrayOutput() NamespaceArrayOutput

func (NamespaceArrayOutput) ToNamespaceArrayOutputWithContext

func (o NamespaceArrayOutput) ToNamespaceArrayOutputWithContext(ctx context.Context) NamespaceArrayOutput

type NamespaceInput

type NamespaceInput interface {
	pulumi.Input

	ToNamespaceOutput() NamespaceOutput
	ToNamespaceOutputWithContext(ctx context.Context) NamespaceOutput
}

type NamespaceMap

type NamespaceMap map[string]NamespaceInput

func (NamespaceMap) ElementType

func (NamespaceMap) ElementType() reflect.Type

func (NamespaceMap) ToNamespaceMapOutput

func (i NamespaceMap) ToNamespaceMapOutput() NamespaceMapOutput

func (NamespaceMap) ToNamespaceMapOutputWithContext

func (i NamespaceMap) ToNamespaceMapOutputWithContext(ctx context.Context) NamespaceMapOutput

type NamespaceMapInput

type NamespaceMapInput interface {
	pulumi.Input

	ToNamespaceMapOutput() NamespaceMapOutput
	ToNamespaceMapOutputWithContext(context.Context) NamespaceMapOutput
}

NamespaceMapInput is an input type that accepts NamespaceMap and NamespaceMapOutput values. You can construct a concrete instance of `NamespaceMapInput` via:

NamespaceMap{ "key": NamespaceArgs{...} }

type NamespaceMapOutput

type NamespaceMapOutput struct{ *pulumi.OutputState }

func (NamespaceMapOutput) ElementType

func (NamespaceMapOutput) ElementType() reflect.Type

func (NamespaceMapOutput) MapIndex

func (NamespaceMapOutput) ToNamespaceMapOutput

func (o NamespaceMapOutput) ToNamespaceMapOutput() NamespaceMapOutput

func (NamespaceMapOutput) ToNamespaceMapOutputWithContext

func (o NamespaceMapOutput) ToNamespaceMapOutputWithContext(ctx context.Context) NamespaceMapOutput

type NamespaceOutput

type NamespaceOutput struct{ *pulumi.OutputState }

func (NamespaceOutput) ElementType

func (NamespaceOutput) ElementType() reflect.Type

func (NamespaceOutput) Enabled added in v5.5.0

func (o NamespaceOutput) Enabled() pulumi.BoolPtrOutput

Is this Notification Hub Namespace enabled? Defaults to `true`.

func (NamespaceOutput) Location added in v5.5.0

func (o NamespaceOutput) Location() pulumi.StringOutput

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

func (NamespaceOutput) Name added in v5.5.0

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

func (NamespaceOutput) NamespaceType added in v5.5.0

func (o NamespaceOutput) NamespaceType() pulumi.StringOutput

The Type of Namespace - possible values are `Messaging` or `NotificationHub`.

func (NamespaceOutput) ResourceGroupName added in v5.5.0

func (o NamespaceOutput) ResourceGroupName() pulumi.StringOutput

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

func (NamespaceOutput) ServicebusEndpoint added in v5.5.0

func (o NamespaceOutput) ServicebusEndpoint() pulumi.StringOutput

The ServiceBus Endpoint for this Notification Hub Namespace.

func (NamespaceOutput) SkuName added in v5.5.0

func (o NamespaceOutput) SkuName() pulumi.StringOutput

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

func (NamespaceOutput) Tags added in v5.5.0

A mapping of tags to assign to the resource.

func (NamespaceOutput) ToNamespaceOutput

func (o NamespaceOutput) ToNamespaceOutput() NamespaceOutput

func (NamespaceOutput) ToNamespaceOutputWithContext

func (o NamespaceOutput) ToNamespaceOutputWithContext(ctx context.Context) NamespaceOutput

type NamespaceState

type NamespaceState struct {
	// Is this Notification Hub Namespace enabled? Defaults to `true`.
	Enabled pulumi.BoolPtrInput
	// The Azure Region in which this Notification Hub Namespace should be created. Changing this forces a new resource to be created.
	Location pulumi.StringPtrInput
	// The name to use for this Notification Hub Namespace. Changing this forces a new resource to be created.
	Name pulumi.StringPtrInput
	// The Type of Namespace - possible values are `Messaging` or `NotificationHub`.
	NamespaceType pulumi.StringPtrInput
	// The name of the Resource Group in which the Notification Hub Namespace should exist. Changing this forces a new resource to be created.
	ResourceGroupName pulumi.StringPtrInput
	// The ServiceBus Endpoint for this Notification Hub Namespace.
	ServicebusEndpoint pulumi.StringPtrInput
	// The name of the SKU to use for this Notification Hub Namespace. Possible values are `Free`, `Basic` or `Standard`.
	SkuName pulumi.StringPtrInput
	// A mapping of tags to assign to the resource.
	Tags pulumi.StringMapInput
}

func (NamespaceState) ElementType

func (NamespaceState) ElementType() reflect.Type

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL