Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Active Directory (Azure AD)
  3. API Docs
  4. UserFlowAttribute
Azure Active Directory (Azure AD) v6.0.1 published on Monday, Oct 14, 2024 by Pulumi
pulumi/pulumi-azuread

azuread.UserFlowAttribute

Explore with Pulumi AI

azuread logo
Azure Active Directory (Azure AD) v6.0.1 published on Monday, Oct 14, 2024 by Pulumi
pulumi/pulumi-azuread

    Manages user flow attributes in an Azure Active Directory (Azure AD) tenant.

    API Permissions

    The following API permissions are required in order to use this resource.

    When authenticated with a service principal, this resource requires the following application role: IdentityUserFlow.ReadWrite.All

    Example Usage

    Basic example

    import * as pulumi from "@pulumi/pulumi";
import * as azuread from "@pulumi/azuread";

const example = new azuread.UserFlowAttribute("example", {
    displayName: "Hobby",
    description: "Your hobby",
    dataType: "string",
});

    import pulumi
import pulumi_azuread as azuread

example = azuread.UserFlowAttribute("example",
    display_name="Hobby",
    description="Your hobby",
    data_type="string")

    package main

import (
	"github.com/pulumi/pulumi-azuread/sdk/v6/go/azuread"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := azuread.NewUserFlowAttribute(ctx, "example", &azuread.UserFlowAttributeArgs{
			DisplayName: pulumi.String("Hobby"),
			Description: pulumi.String("Your hobby"),
			DataType:    pulumi.String("string"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureAD = Pulumi.AzureAD;

return await Deployment.RunAsync(() => 
{
    var example = new AzureAD.UserFlowAttribute("example", new()
    {
        DisplayName = "Hobby",
        Description = "Your hobby",
        DataType = "string",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azuread.UserFlowAttribute;
import com.pulumi.azuread.UserFlowAttributeArgs;
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 example = new UserFlowAttribute("example", UserFlowAttributeArgs.builder()
            .displayName("Hobby")
            .description("Your hobby")
            .dataType("string")
            .build());

    }
}

    resources:
  example:
    type: azuread:UserFlowAttribute
    properties:
      displayName: Hobby
      description: Your hobby
      dataType: string

    Create UserFlowAttribute Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new UserFlowAttribute(name: string, args: UserFlowAttributeArgs, opts?: CustomResourceOptions);
    @overload
def UserFlowAttribute(resource_name: str,
                      args: UserFlowAttributeArgs,
                      opts: Optional[ResourceOptions] = None)

@overload
def UserFlowAttribute(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      data_type: Optional[str] = None,
                      description: Optional[str] = None,
                      display_name: Optional[str] = None)
    func NewUserFlowAttribute(ctx *Context, name string, args UserFlowAttributeArgs, opts ...ResourceOption) (*UserFlowAttribute, error)
    public UserFlowAttribute(string name, UserFlowAttributeArgs args, CustomResourceOptions? opts = null)
    public UserFlowAttribute(String name, UserFlowAttributeArgs args)
public UserFlowAttribute(String name, UserFlowAttributeArgs args, CustomResourceOptions options)

    type: azuread:UserFlowAttribute
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args UserFlowAttributeArgs
    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 UserFlowAttributeArgs
    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 UserFlowAttributeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UserFlowAttributeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UserFlowAttributeArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var userFlowAttributeResource = new AzureAD.UserFlowAttribute("userFlowAttributeResource", new()
{
    DataType = "string",
    Description = "string",
    DisplayName = "string",
});

    example, err := azuread.NewUserFlowAttribute(ctx, "userFlowAttributeResource", &azuread.UserFlowAttributeArgs{
	DataType:    pulumi.String("string"),
	Description: pulumi.String("string"),
	DisplayName: pulumi.String("string"),
})

    var userFlowAttributeResource = new UserFlowAttribute("userFlowAttributeResource", UserFlowAttributeArgs.builder()
    .dataType("string")
    .description("string")
    .displayName("string")
    .build());

    user_flow_attribute_resource = azuread.UserFlowAttribute("userFlowAttributeResource",
    data_type="string",
    description="string",
    display_name="string")

    const userFlowAttributeResource = new azuread.UserFlowAttribute("userFlowAttributeResource", {
    dataType: "string",
    description: "string",
    displayName: "string",
});

    type: azuread:UserFlowAttribute
properties:
    dataType: string
    description: string
    displayName: string

    UserFlowAttribute Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The UserFlowAttribute resource accepts the following input properties:

    DataType string
    The data type of the user flow attribute. Possible values are boolean, dateTime, int64, string or stringCollection. Changing this forces a new resource to be created.
    Description string
    The description of the user flow attribute that is shown to the user at the time of sign-up.
    DisplayName string
    The display name of the user flow attribute. Changing this forces a new resource to be created.
    DataType string
    The data type of the user flow attribute. Possible values are boolean, dateTime, int64, string or stringCollection. Changing this forces a new resource to be created.
    Description string
    The description of the user flow attribute that is shown to the user at the time of sign-up.
    DisplayName string
    The display name of the user flow attribute. Changing this forces a new resource to be created.
    dataType String
    The data type of the user flow attribute. Possible values are boolean, dateTime, int64, string or stringCollection. Changing this forces a new resource to be created.
    description String
    The description of the user flow attribute that is shown to the user at the time of sign-up.
    displayName String
    The display name of the user flow attribute. Changing this forces a new resource to be created.
    dataType string
    The data type of the user flow attribute. Possible values are boolean, dateTime, int64, string or stringCollection. Changing this forces a new resource to be created.
    description string
    The description of the user flow attribute that is shown to the user at the time of sign-up.
    displayName string
    The display name of the user flow attribute. Changing this forces a new resource to be created.
    data_type str
    The data type of the user flow attribute. Possible values are boolean, dateTime, int64, string or stringCollection. Changing this forces a new resource to be created.
    description str
    The description of the user flow attribute that is shown to the user at the time of sign-up.
    display_name str
    The display name of the user flow attribute. Changing this forces a new resource to be created.
    dataType String
    The data type of the user flow attribute. Possible values are boolean, dateTime, int64, string or stringCollection. Changing this forces a new resource to be created.
    description String
    The description of the user flow attribute that is shown to the user at the time of sign-up.
    displayName String
    The display name of the user flow attribute. Changing this forces a new resource to be created.

    Outputs

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

    AttributeType string
    The type of the user flow attribute. Values include builtIn, custom or required.
    Id string
    The provider-assigned unique ID for this managed resource.
    AttributeType string
    The type of the user flow attribute. Values include builtIn, custom or required.
    Id string
    The provider-assigned unique ID for this managed resource.
    attributeType String
    The type of the user flow attribute. Values include builtIn, custom or required.
    id String
    The provider-assigned unique ID for this managed resource.
    attributeType string
    The type of the user flow attribute. Values include builtIn, custom or required.
    id string
    The provider-assigned unique ID for this managed resource.
    attribute_type str
    The type of the user flow attribute. Values include builtIn, custom or required.
    id str
    The provider-assigned unique ID for this managed resource.
    attributeType String
    The type of the user flow attribute. Values include builtIn, custom or required.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing UserFlowAttribute Resource

    Get an existing UserFlowAttribute 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?: UserFlowAttributeState, opts?: CustomResourceOptions): UserFlowAttribute
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        attribute_type: Optional[str] = None,
        data_type: Optional[str] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None) -> UserFlowAttribute
    func GetUserFlowAttribute(ctx *Context, name string, id IDInput, state *UserFlowAttributeState, opts ...ResourceOption) (*UserFlowAttribute, error)
    public static UserFlowAttribute Get(string name, Input<string> id, UserFlowAttributeState? state, CustomResourceOptions? opts = null)
    public static UserFlowAttribute get(String name, Output<String> id, UserFlowAttributeState 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:
    AttributeType string
    The type of the user flow attribute. Values include builtIn, custom or required.
    DataType string
    The data type of the user flow attribute. Possible values are boolean, dateTime, int64, string or stringCollection. Changing this forces a new resource to be created.
    Description string
    The description of the user flow attribute that is shown to the user at the time of sign-up.
    DisplayName string
    The display name of the user flow attribute. Changing this forces a new resource to be created.
    AttributeType string
    The type of the user flow attribute. Values include builtIn, custom or required.
    DataType string
    The data type of the user flow attribute. Possible values are boolean, dateTime, int64, string or stringCollection. Changing this forces a new resource to be created.
    Description string
    The description of the user flow attribute that is shown to the user at the time of sign-up.
    DisplayName string
    The display name of the user flow attribute. Changing this forces a new resource to be created.
    attributeType String
    The type of the user flow attribute. Values include builtIn, custom or required.
    dataType String
    The data type of the user flow attribute. Possible values are boolean, dateTime, int64, string or stringCollection. Changing this forces a new resource to be created.
    description String
    The description of the user flow attribute that is shown to the user at the time of sign-up.
    displayName String
    The display name of the user flow attribute. Changing this forces a new resource to be created.
    attributeType string
    The type of the user flow attribute. Values include builtIn, custom or required.
    dataType string
    The data type of the user flow attribute. Possible values are boolean, dateTime, int64, string or stringCollection. Changing this forces a new resource to be created.
    description string
    The description of the user flow attribute that is shown to the user at the time of sign-up.
    displayName string
    The display name of the user flow attribute. Changing this forces a new resource to be created.
    attribute_type str
    The type of the user flow attribute. Values include builtIn, custom or required.
    data_type str
    The data type of the user flow attribute. Possible values are boolean, dateTime, int64, string or stringCollection. Changing this forces a new resource to be created.
    description str
    The description of the user flow attribute that is shown to the user at the time of sign-up.
    display_name str
    The display name of the user flow attribute. Changing this forces a new resource to be created.
    attributeType String
    The type of the user flow attribute. Values include builtIn, custom or required.
    dataType String
    The data type of the user flow attribute. Possible values are boolean, dateTime, int64, string or stringCollection. Changing this forces a new resource to be created.
    description String
    The description of the user flow attribute that is shown to the user at the time of sign-up.
    displayName String
    The display name of the user flow attribute. Changing this forces a new resource to be created.

    Import

    User flow attributes can be imported using the id, e.g.

    $ pulumi import azuread:index/userFlowAttribute:UserFlowAttribute example extension_ecc9f88db2924942b8a96f44873616fe_Hobbyjkorv

    -> This ID can be queried using the User Flow Attributes API.

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Active Directory (Azure AD) pulumi/pulumi-azuread
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azuread Terraform Provider.
    azuread logo
    Azure Active Directory (Azure AD) v6.0.1 published on Monday, Oct 14, 2024 by Pulumi
    pulumi/pulumi-azuread