1. Packages
  2. Azure Classic
  3. API Docs
  4. apimanagement
  5. NotificationRecipientUser

We recommend using Azure Native.

Azure Classic v5.57.0 published on Tuesday, Nov 28, 2023 by Pulumi

azure.apimanagement.NotificationRecipientUser

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.57.0 published on Tuesday, Nov 28, 2023 by Pulumi

    Manages a API Management Notification Recipient User.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
        {
            Location = "West Europe",
        });
    
        var exampleService = new Azure.ApiManagement.Service("exampleService", new()
        {
            Location = exampleResourceGroup.Location,
            ResourceGroupName = exampleResourceGroup.Name,
            PublisherName = "My Company",
            PublisherEmail = "company@terraform.io",
            SkuName = "Developer_1",
        });
    
        var exampleUser = new Azure.ApiManagement.User("exampleUser", new()
        {
            UserId = "123",
            ApiManagementName = exampleService.Name,
            ResourceGroupName = exampleResourceGroup.Name,
            FirstName = "Example",
            LastName = "User",
            Email = "foo@bar.com",
            State = "active",
        });
    
        var exampleNotificationRecipientUser = new Azure.ApiManagement.NotificationRecipientUser("exampleNotificationRecipientUser", new()
        {
            ApiManagementId = exampleService.Id,
            NotificationType = "AccountClosedPublisher",
            UserId = exampleUser.UserId,
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/apimanagement"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleService, err := apimanagement.NewService(ctx, "exampleService", &apimanagement.ServiceArgs{
    			Location:          exampleResourceGroup.Location,
    			ResourceGroupName: exampleResourceGroup.Name,
    			PublisherName:     pulumi.String("My Company"),
    			PublisherEmail:    pulumi.String("company@terraform.io"),
    			SkuName:           pulumi.String("Developer_1"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleUser, err := apimanagement.NewUser(ctx, "exampleUser", &apimanagement.UserArgs{
    			UserId:            pulumi.String("123"),
    			ApiManagementName: exampleService.Name,
    			ResourceGroupName: exampleResourceGroup.Name,
    			FirstName:         pulumi.String("Example"),
    			LastName:          pulumi.String("User"),
    			Email:             pulumi.String("foo@bar.com"),
    			State:             pulumi.String("active"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = apimanagement.NewNotificationRecipientUser(ctx, "exampleNotificationRecipientUser", &apimanagement.NotificationRecipientUserArgs{
    			ApiManagementId:  exampleService.ID(),
    			NotificationType: pulumi.String("AccountClosedPublisher"),
    			UserId:           exampleUser.UserId,
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azure.core.ResourceGroup;
    import com.pulumi.azure.core.ResourceGroupArgs;
    import com.pulumi.azure.apimanagement.Service;
    import com.pulumi.azure.apimanagement.ServiceArgs;
    import com.pulumi.azure.apimanagement.User;
    import com.pulumi.azure.apimanagement.UserArgs;
    import com.pulumi.azure.apimanagement.NotificationRecipientUser;
    import com.pulumi.azure.apimanagement.NotificationRecipientUserArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()        
                .location("West Europe")
                .build());
    
            var exampleService = new Service("exampleService", ServiceArgs.builder()        
                .location(exampleResourceGroup.location())
                .resourceGroupName(exampleResourceGroup.name())
                .publisherName("My Company")
                .publisherEmail("company@terraform.io")
                .skuName("Developer_1")
                .build());
    
            var exampleUser = new User("exampleUser", UserArgs.builder()        
                .userId("123")
                .apiManagementName(exampleService.name())
                .resourceGroupName(exampleResourceGroup.name())
                .firstName("Example")
                .lastName("User")
                .email("foo@bar.com")
                .state("active")
                .build());
    
            var exampleNotificationRecipientUser = new NotificationRecipientUser("exampleNotificationRecipientUser", NotificationRecipientUserArgs.builder()        
                .apiManagementId(exampleService.id())
                .notificationType("AccountClosedPublisher")
                .userId(exampleUser.userId())
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure as azure
    
    example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
    example_service = azure.apimanagement.Service("exampleService",
        location=example_resource_group.location,
        resource_group_name=example_resource_group.name,
        publisher_name="My Company",
        publisher_email="company@terraform.io",
        sku_name="Developer_1")
    example_user = azure.apimanagement.User("exampleUser",
        user_id="123",
        api_management_name=example_service.name,
        resource_group_name=example_resource_group.name,
        first_name="Example",
        last_name="User",
        email="foo@bar.com",
        state="active")
    example_notification_recipient_user = azure.apimanagement.NotificationRecipientUser("exampleNotificationRecipientUser",
        api_management_id=example_service.id,
        notification_type="AccountClosedPublisher",
        user_id=example_user.user_id)
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
    const exampleService = new azure.apimanagement.Service("exampleService", {
        location: exampleResourceGroup.location,
        resourceGroupName: exampleResourceGroup.name,
        publisherName: "My Company",
        publisherEmail: "company@terraform.io",
        skuName: "Developer_1",
    });
    const exampleUser = new azure.apimanagement.User("exampleUser", {
        userId: "123",
        apiManagementName: exampleService.name,
        resourceGroupName: exampleResourceGroup.name,
        firstName: "Example",
        lastName: "User",
        email: "foo@bar.com",
        state: "active",
    });
    const exampleNotificationRecipientUser = new azure.apimanagement.NotificationRecipientUser("exampleNotificationRecipientUser", {
        apiManagementId: exampleService.id,
        notificationType: "AccountClosedPublisher",
        userId: exampleUser.userId,
    });
    
    resources:
      exampleResourceGroup:
        type: azure:core:ResourceGroup
        properties:
          location: West Europe
      exampleService:
        type: azure:apimanagement:Service
        properties:
          location: ${exampleResourceGroup.location}
          resourceGroupName: ${exampleResourceGroup.name}
          publisherName: My Company
          publisherEmail: company@terraform.io
          skuName: Developer_1
      exampleUser:
        type: azure:apimanagement:User
        properties:
          userId: '123'
          apiManagementName: ${exampleService.name}
          resourceGroupName: ${exampleResourceGroup.name}
          firstName: Example
          lastName: User
          email: foo@bar.com
          state: active
      exampleNotificationRecipientUser:
        type: azure:apimanagement:NotificationRecipientUser
        properties:
          apiManagementId: ${exampleService.id}
          notificationType: AccountClosedPublisher
          userId: ${exampleUser.userId}
    

    Create NotificationRecipientUser Resource

    new NotificationRecipientUser(name: string, args: NotificationRecipientUserArgs, opts?: CustomResourceOptions);
    @overload
    def NotificationRecipientUser(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  api_management_id: Optional[str] = None,
                                  notification_type: Optional[str] = None,
                                  user_id: Optional[str] = None)
    @overload
    def NotificationRecipientUser(resource_name: str,
                                  args: NotificationRecipientUserArgs,
                                  opts: Optional[ResourceOptions] = None)
    func NewNotificationRecipientUser(ctx *Context, name string, args NotificationRecipientUserArgs, opts ...ResourceOption) (*NotificationRecipientUser, error)
    public NotificationRecipientUser(string name, NotificationRecipientUserArgs args, CustomResourceOptions? opts = null)
    public NotificationRecipientUser(String name, NotificationRecipientUserArgs args)
    public NotificationRecipientUser(String name, NotificationRecipientUserArgs args, CustomResourceOptions options)
    
    type: azure:apimanagement:NotificationRecipientUser
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args NotificationRecipientUserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args NotificationRecipientUserArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args NotificationRecipientUserArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NotificationRecipientUserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NotificationRecipientUserArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    NotificationRecipientUser Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The NotificationRecipientUser resource accepts the following input properties:

    ApiManagementId string

    The ID of the API Management Service from which to create this Notification Recipient User. Changing this forces a new API Management Notification Recipient User to be created.

    NotificationType string

    The Notification Name to be received. Changing this forces a new API Management Notification Recipient User to be created. Possible values are AccountClosedPublisher, BCC, NewApplicationNotificationMessage, NewIssuePublisherNotificationMessage, PurchasePublisherNotificationMessage, QuotaLimitApproachingPublisherNotificationMessage, and RequestPublisherNotificationMessage.

    UserId string

    The recipient user ID. Changing this forces a new API Management Notification Recipient User to be created.

    ApiManagementId string

    The ID of the API Management Service from which to create this Notification Recipient User. Changing this forces a new API Management Notification Recipient User to be created.

    NotificationType string

    The Notification Name to be received. Changing this forces a new API Management Notification Recipient User to be created. Possible values are AccountClosedPublisher, BCC, NewApplicationNotificationMessage, NewIssuePublisherNotificationMessage, PurchasePublisherNotificationMessage, QuotaLimitApproachingPublisherNotificationMessage, and RequestPublisherNotificationMessage.

    UserId string

    The recipient user ID. Changing this forces a new API Management Notification Recipient User to be created.

    apiManagementId String

    The ID of the API Management Service from which to create this Notification Recipient User. Changing this forces a new API Management Notification Recipient User to be created.

    notificationType String

    The Notification Name to be received. Changing this forces a new API Management Notification Recipient User to be created. Possible values are AccountClosedPublisher, BCC, NewApplicationNotificationMessage, NewIssuePublisherNotificationMessage, PurchasePublisherNotificationMessage, QuotaLimitApproachingPublisherNotificationMessage, and RequestPublisherNotificationMessage.

    userId String

    The recipient user ID. Changing this forces a new API Management Notification Recipient User to be created.

    apiManagementId string

    The ID of the API Management Service from which to create this Notification Recipient User. Changing this forces a new API Management Notification Recipient User to be created.

    notificationType string

    The Notification Name to be received. Changing this forces a new API Management Notification Recipient User to be created. Possible values are AccountClosedPublisher, BCC, NewApplicationNotificationMessage, NewIssuePublisherNotificationMessage, PurchasePublisherNotificationMessage, QuotaLimitApproachingPublisherNotificationMessage, and RequestPublisherNotificationMessage.

    userId string

    The recipient user ID. Changing this forces a new API Management Notification Recipient User to be created.

    api_management_id str

    The ID of the API Management Service from which to create this Notification Recipient User. Changing this forces a new API Management Notification Recipient User to be created.

    notification_type str

    The Notification Name to be received. Changing this forces a new API Management Notification Recipient User to be created. Possible values are AccountClosedPublisher, BCC, NewApplicationNotificationMessage, NewIssuePublisherNotificationMessage, PurchasePublisherNotificationMessage, QuotaLimitApproachingPublisherNotificationMessage, and RequestPublisherNotificationMessage.

    user_id str

    The recipient user ID. Changing this forces a new API Management Notification Recipient User to be created.

    apiManagementId String

    The ID of the API Management Service from which to create this Notification Recipient User. Changing this forces a new API Management Notification Recipient User to be created.

    notificationType String

    The Notification Name to be received. Changing this forces a new API Management Notification Recipient User to be created. Possible values are AccountClosedPublisher, BCC, NewApplicationNotificationMessage, NewIssuePublisherNotificationMessage, PurchasePublisherNotificationMessage, QuotaLimitApproachingPublisherNotificationMessage, and RequestPublisherNotificationMessage.

    userId String

    The recipient user ID. Changing this forces a new API Management Notification Recipient User to be created.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the NotificationRecipientUser resource produces the following output properties:

    Id string

    The provider-assigned unique ID for this managed resource.

    Id string

    The provider-assigned unique ID for this managed resource.

    id String

    The provider-assigned unique ID for this managed resource.

    id string

    The provider-assigned unique ID for this managed resource.

    id str

    The provider-assigned unique ID for this managed resource.

    id String

    The provider-assigned unique ID for this managed resource.

    Look up Existing NotificationRecipientUser Resource

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

    public static get(name: string, id: Input<ID>, state?: NotificationRecipientUserState, opts?: CustomResourceOptions): NotificationRecipientUser
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            api_management_id: Optional[str] = None,
            notification_type: Optional[str] = None,
            user_id: Optional[str] = None) -> NotificationRecipientUser
    func GetNotificationRecipientUser(ctx *Context, name string, id IDInput, state *NotificationRecipientUserState, opts ...ResourceOption) (*NotificationRecipientUser, error)
    public static NotificationRecipientUser Get(string name, Input<string> id, NotificationRecipientUserState? state, CustomResourceOptions? opts = null)
    public static NotificationRecipientUser get(String name, Output<String> id, NotificationRecipientUserState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ApiManagementId string

    The ID of the API Management Service from which to create this Notification Recipient User. Changing this forces a new API Management Notification Recipient User to be created.

    NotificationType string

    The Notification Name to be received. Changing this forces a new API Management Notification Recipient User to be created. Possible values are AccountClosedPublisher, BCC, NewApplicationNotificationMessage, NewIssuePublisherNotificationMessage, PurchasePublisherNotificationMessage, QuotaLimitApproachingPublisherNotificationMessage, and RequestPublisherNotificationMessage.

    UserId string

    The recipient user ID. Changing this forces a new API Management Notification Recipient User to be created.

    ApiManagementId string

    The ID of the API Management Service from which to create this Notification Recipient User. Changing this forces a new API Management Notification Recipient User to be created.

    NotificationType string

    The Notification Name to be received. Changing this forces a new API Management Notification Recipient User to be created. Possible values are AccountClosedPublisher, BCC, NewApplicationNotificationMessage, NewIssuePublisherNotificationMessage, PurchasePublisherNotificationMessage, QuotaLimitApproachingPublisherNotificationMessage, and RequestPublisherNotificationMessage.

    UserId string

    The recipient user ID. Changing this forces a new API Management Notification Recipient User to be created.

    apiManagementId String

    The ID of the API Management Service from which to create this Notification Recipient User. Changing this forces a new API Management Notification Recipient User to be created.

    notificationType String

    The Notification Name to be received. Changing this forces a new API Management Notification Recipient User to be created. Possible values are AccountClosedPublisher, BCC, NewApplicationNotificationMessage, NewIssuePublisherNotificationMessage, PurchasePublisherNotificationMessage, QuotaLimitApproachingPublisherNotificationMessage, and RequestPublisherNotificationMessage.

    userId String

    The recipient user ID. Changing this forces a new API Management Notification Recipient User to be created.

    apiManagementId string

    The ID of the API Management Service from which to create this Notification Recipient User. Changing this forces a new API Management Notification Recipient User to be created.

    notificationType string

    The Notification Name to be received. Changing this forces a new API Management Notification Recipient User to be created. Possible values are AccountClosedPublisher, BCC, NewApplicationNotificationMessage, NewIssuePublisherNotificationMessage, PurchasePublisherNotificationMessage, QuotaLimitApproachingPublisherNotificationMessage, and RequestPublisherNotificationMessage.

    userId string

    The recipient user ID. Changing this forces a new API Management Notification Recipient User to be created.

    api_management_id str

    The ID of the API Management Service from which to create this Notification Recipient User. Changing this forces a new API Management Notification Recipient User to be created.

    notification_type str

    The Notification Name to be received. Changing this forces a new API Management Notification Recipient User to be created. Possible values are AccountClosedPublisher, BCC, NewApplicationNotificationMessage, NewIssuePublisherNotificationMessage, PurchasePublisherNotificationMessage, QuotaLimitApproachingPublisherNotificationMessage, and RequestPublisherNotificationMessage.

    user_id str

    The recipient user ID. Changing this forces a new API Management Notification Recipient User to be created.

    apiManagementId String

    The ID of the API Management Service from which to create this Notification Recipient User. Changing this forces a new API Management Notification Recipient User to be created.

    notificationType String

    The Notification Name to be received. Changing this forces a new API Management Notification Recipient User to be created. Possible values are AccountClosedPublisher, BCC, NewApplicationNotificationMessage, NewIssuePublisherNotificationMessage, PurchasePublisherNotificationMessage, QuotaLimitApproachingPublisherNotificationMessage, and RequestPublisherNotificationMessage.

    userId String

    The recipient user ID. Changing this forces a new API Management Notification Recipient User to be created.

    Import

    API Management Notification Recipient Users can be imported using the resource id, e.g.

     $ pulumi import azure:apimanagement/notificationRecipientUser:NotificationRecipientUser example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.ApiManagement/service/service1/notifications/notificationName1/recipientUsers/userid1
    

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the azurerm Terraform Provider.

    azure logo

    We recommend using Azure Native.

    Azure Classic v5.57.0 published on Tuesday, Nov 28, 2023 by Pulumi