getProfile

The profile resource format. API Version: 2017-04-26.

Using getProfile

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getProfile(args: GetProfileArgs, opts?: InvokeOptions): Promise<GetProfileResult>
function getProfileOutput(args: GetProfileOutputArgs, opts?: InvokeOptions): Output<GetProfileResult>
def get_profile(hub_name: Optional[str] = None,
                locale_code: Optional[str] = None,
                profile_name: Optional[str] = None,
                resource_group_name: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetProfileResult
def get_profile_output(hub_name: Optional[pulumi.Input[str]] = None,
                locale_code: Optional[pulumi.Input[str]] = None,
                profile_name: Optional[pulumi.Input[str]] = None,
                resource_group_name: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetProfileResult]
func LookupProfile(ctx *Context, args *LookupProfileArgs, opts ...InvokeOption) (*LookupProfileResult, error)
func LookupProfileOutput(ctx *Context, args *LookupProfileOutputArgs, opts ...InvokeOption) LookupProfileResultOutput

> Note: This function is named LookupProfile in the Go SDK.

public static class GetProfile 
{
    public static Task<GetProfileResult> InvokeAsync(GetProfileArgs args, InvokeOptions? opts = null)
    public static Output<GetProfileResult> Invoke(GetProfileInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetProfileResult> getProfile(GetProfileArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: azure-native:customerinsights:getProfile
  arguments:
    # arguments dictionary

The following arguments are supported:

HubName string

The name of the hub.

ProfileName string

The name of the profile.

ResourceGroupName string

The name of the resource group.

LocaleCode string

Locale of profile to retrieve, default is en-us.

HubName string

The name of the hub.

ProfileName string

The name of the profile.

ResourceGroupName string

The name of the resource group.

LocaleCode string

Locale of profile to retrieve, default is en-us.

hubName String

The name of the hub.

profileName String

The name of the profile.

resourceGroupName String

The name of the resource group.

localeCode String

Locale of profile to retrieve, default is en-us.

hubName string

The name of the hub.

profileName string

The name of the profile.

resourceGroupName string

The name of the resource group.

localeCode string

Locale of profile to retrieve, default is en-us.

hub_name str

The name of the hub.

profile_name str

The name of the profile.

resource_group_name str

The name of the resource group.

locale_code str

Locale of profile to retrieve, default is en-us.

hubName String

The name of the hub.

profileName String

The name of the profile.

resourceGroupName String

The name of the resource group.

localeCode String

Locale of profile to retrieve, default is en-us.

getProfile Result

The following output properties are available:

Id string

Resource ID.

LastChangedUtc string

The last changed time for the type definition.

Name string

Resource name.

ProvisioningState string

Provisioning state.

TenantId string

The hub name.

Type string

Resource type.

ApiEntitySetName string

The api entity set name. This becomes the odata entity set name for the entity Type being referred in this object.

Attributes Dictionary<string, ImmutableArray<string>>

The attributes for the Type.

Description Dictionary<string, string>

Localized descriptions for the property.

DisplayName Dictionary<string, string>

Localized display names for the property.

EntityType string

Type of entity.

Fields List<Pulumi.AzureNative.CustomerInsights.Outputs.PropertyDefinitionResponse>

The properties of the Profile.

InstancesCount int

The instance count.

LargeImage string

Large Image associated with the Property or EntityType.

LocalizedAttributes Dictionary<string, ImmutableDictionary<string, string>>

Any custom localized attributes for the Type.

MediumImage string

Medium Image associated with the Property or EntityType.

SchemaItemTypeLink string

The schema org link. This helps ACI identify and suggest semantic models.

SmallImage string

Small Image associated with the Property or EntityType.

StrongIds List<Pulumi.AzureNative.CustomerInsights.Outputs.StrongIdResponse>

The strong IDs.

TimestampFieldName string

The timestamp property name. Represents the time when the interaction or profile update happened.

TypeName string

The name of the entity.

Id string

Resource ID.

LastChangedUtc string

The last changed time for the type definition.

Name string

Resource name.

ProvisioningState string

Provisioning state.

TenantId string

The hub name.

Type string

Resource type.

ApiEntitySetName string

The api entity set name. This becomes the odata entity set name for the entity Type being referred in this object.

Attributes map[string][]string

The attributes for the Type.

Description map[string]string

Localized descriptions for the property.

DisplayName map[string]string

Localized display names for the property.

EntityType string

Type of entity.

Fields []PropertyDefinitionResponse

The properties of the Profile.

InstancesCount int

The instance count.

LargeImage string

Large Image associated with the Property or EntityType.

LocalizedAttributes map[string]map[string]string

Any custom localized attributes for the Type.

MediumImage string

Medium Image associated with the Property or EntityType.

SchemaItemTypeLink string

The schema org link. This helps ACI identify and suggest semantic models.

SmallImage string

Small Image associated with the Property or EntityType.

StrongIds []StrongIdResponse

The strong IDs.

TimestampFieldName string

The timestamp property name. Represents the time when the interaction or profile update happened.

TypeName string

The name of the entity.

id String

Resource ID.

lastChangedUtc String

The last changed time for the type definition.

name String

Resource name.

provisioningState String

Provisioning state.

tenantId String

The hub name.

type String

Resource type.

apiEntitySetName String

The api entity set name. This becomes the odata entity set name for the entity Type being referred in this object.

attributes Map<String,List<String>>

The attributes for the Type.

description Map<String,String>

Localized descriptions for the property.

displayName Map<String,String>

Localized display names for the property.

entityType String

Type of entity.

fields List<PropertyDefinitionResponse>

The properties of the Profile.

instancesCount Integer

The instance count.

largeImage String

Large Image associated with the Property or EntityType.

localizedAttributes Map<String,Map<String,String>>

Any custom localized attributes for the Type.

mediumImage String

Medium Image associated with the Property or EntityType.

schemaItemTypeLink String

The schema org link. This helps ACI identify and suggest semantic models.

smallImage String

Small Image associated with the Property or EntityType.

strongIds List<StrongIdResponse>

The strong IDs.

timestampFieldName String

The timestamp property name. Represents the time when the interaction or profile update happened.

typeName String

The name of the entity.

id string

Resource ID.

lastChangedUtc string

The last changed time for the type definition.

name string

Resource name.

provisioningState string

Provisioning state.

tenantId string

The hub name.

type string

Resource type.

apiEntitySetName string

The api entity set name. This becomes the odata entity set name for the entity Type being referred in this object.

attributes {[key: string]: string[]}

The attributes for the Type.

description {[key: string]: string}

Localized descriptions for the property.

displayName {[key: string]: string}

Localized display names for the property.

entityType string

Type of entity.

fields PropertyDefinitionResponse[]

The properties of the Profile.

instancesCount number

The instance count.

largeImage string

Large Image associated with the Property or EntityType.

localizedAttributes {[key: string]: {[key: string]: string}}

Any custom localized attributes for the Type.

mediumImage string

Medium Image associated with the Property or EntityType.

schemaItemTypeLink string

The schema org link. This helps ACI identify and suggest semantic models.

smallImage string

Small Image associated with the Property or EntityType.

strongIds StrongIdResponse[]

The strong IDs.

timestampFieldName string

The timestamp property name. Represents the time when the interaction or profile update happened.

typeName string

The name of the entity.

id str

Resource ID.

last_changed_utc str

The last changed time for the type definition.

name str

Resource name.

provisioning_state str

Provisioning state.

tenant_id str

The hub name.

type str

Resource type.

api_entity_set_name str

The api entity set name. This becomes the odata entity set name for the entity Type being referred in this object.

attributes Mapping[str, Sequence[str]]

The attributes for the Type.

description Mapping[str, str]

Localized descriptions for the property.

display_name Mapping[str, str]

Localized display names for the property.

entity_type str

Type of entity.

fields Sequence[PropertyDefinitionResponse]

The properties of the Profile.

instances_count int

The instance count.

large_image str

Large Image associated with the Property or EntityType.

localized_attributes Mapping[str, Mapping[str, str]]

Any custom localized attributes for the Type.

medium_image str

Medium Image associated with the Property or EntityType.

schema_item_type_link str

The schema org link. This helps ACI identify and suggest semantic models.

small_image str

Small Image associated with the Property or EntityType.

strong_ids Sequence[StrongIdResponse]

The strong IDs.

timestamp_field_name str

The timestamp property name. Represents the time when the interaction or profile update happened.

type_name str

The name of the entity.

id String

Resource ID.

lastChangedUtc String

The last changed time for the type definition.

name String

Resource name.

provisioningState String

Provisioning state.

tenantId String

The hub name.

type String

Resource type.

apiEntitySetName String

The api entity set name. This becomes the odata entity set name for the entity Type being referred in this object.

attributes Map<List<String>>

The attributes for the Type.

description Map<String>

Localized descriptions for the property.

displayName Map<String>

Localized display names for the property.

entityType String

Type of entity.

fields List<Property Map>

The properties of the Profile.

instancesCount Number

The instance count.

largeImage String

Large Image associated with the Property or EntityType.

localizedAttributes Map<Map<String>>

Any custom localized attributes for the Type.

mediumImage String

Medium Image associated with the Property or EntityType.

schemaItemTypeLink String

The schema org link. This helps ACI identify and suggest semantic models.

smallImage String

Small Image associated with the Property or EntityType.

strongIds List<Property Map>

The strong IDs.

timestampFieldName String

The timestamp property name. Represents the time when the interaction or profile update happened.

typeName String

The name of the entity.

Supporting Types

DataSourcePrecedenceResponse

DataSourceReferenceId string

The data source reference id.

DataSourceType string

The data source type.

Id int

The data source ID.

Name string

The data source name

Status string

The data source status.

Precedence int

the precedence value.

DataSourceReferenceId string

The data source reference id.

DataSourceType string

The data source type.

Id int

The data source ID.

Name string

The data source name

Status string

The data source status.

Precedence int

the precedence value.

dataSourceReferenceId String

The data source reference id.

dataSourceType String

The data source type.

id Integer

The data source ID.

name String

The data source name

status String

The data source status.

precedence Integer

the precedence value.

dataSourceReferenceId string

The data source reference id.

dataSourceType string

The data source type.

id number

The data source ID.

name string

The data source name

status string

The data source status.

precedence number

the precedence value.

data_source_reference_id str

The data source reference id.

data_source_type str

The data source type.

id int

The data source ID.

name str

The data source name

status str

The data source status.

precedence int

the precedence value.

dataSourceReferenceId String

The data source reference id.

dataSourceType String

The data source type.

id Number

The data source ID.

name String

The data source name

status String

The data source status.

precedence Number

the precedence value.

ProfileEnumValidValuesFormatResponse

LocalizedValueNames Dictionary<string, string>

Localized names of the enum member.

Value int

The integer value of the enum member.

LocalizedValueNames map[string]string

Localized names of the enum member.

Value int

The integer value of the enum member.

localizedValueNames Map<String,String>

Localized names of the enum member.

value Integer

The integer value of the enum member.

localizedValueNames {[key: string]: string}

Localized names of the enum member.

value number

The integer value of the enum member.

localized_value_names Mapping[str, str]

Localized names of the enum member.

value int

The integer value of the enum member.

localizedValueNames Map<String>

Localized names of the enum member.

value Number

The integer value of the enum member.

PropertyDefinitionResponse

DataSourcePrecedenceRules List<Pulumi.AzureNative.CustomerInsights.Inputs.DataSourcePrecedenceResponse>

This is specific to interactions modeled as activities. Data sources are used to determine where data is stored and also in precedence rules.

FieldName string

Name of the property.

FieldType string

Type of the property.

ArrayValueSeparator string

Array value separator for properties with isArray set.

EnumValidValues List<Pulumi.AzureNative.CustomerInsights.Inputs.ProfileEnumValidValuesFormatResponse>

Describes valid values for an enum property.

IsArray bool

Indicates if the property is actually an array of the fieldType above on the data api.

IsAvailableInGraph bool

Whether property is available in graph or not.

IsEnum bool

Indicates if the property is an enum.

IsFlagEnum bool

Indicates if the property is an flag enum.

IsImage bool

Whether the property is an Image.

IsLocalizedString bool

Whether the property is a localized string.

IsName bool

Whether the property is a name or a part of name.

IsRequired bool

Whether property value is required on instances, IsRequired field only for Interaction. Profile Instance will not check for required field.

MaxLength int

Max length of string. Used only if type is string.

PropertyId string

The ID associated with the property.

SchemaItemPropLink string

URL encoded schema.org item prop link for the property.

DataSourcePrecedenceRules []DataSourcePrecedenceResponse

This is specific to interactions modeled as activities. Data sources are used to determine where data is stored and also in precedence rules.

FieldName string

Name of the property.

FieldType string

Type of the property.

ArrayValueSeparator string

Array value separator for properties with isArray set.

EnumValidValues []ProfileEnumValidValuesFormatResponse

Describes valid values for an enum property.

IsArray bool

Indicates if the property is actually an array of the fieldType above on the data api.

IsAvailableInGraph bool

Whether property is available in graph or not.

IsEnum bool

Indicates if the property is an enum.

IsFlagEnum bool

Indicates if the property is an flag enum.

IsImage bool

Whether the property is an Image.

IsLocalizedString bool

Whether the property is a localized string.

IsName bool

Whether the property is a name or a part of name.

IsRequired bool

Whether property value is required on instances, IsRequired field only for Interaction. Profile Instance will not check for required field.

MaxLength int

Max length of string. Used only if type is string.

PropertyId string

The ID associated with the property.

SchemaItemPropLink string

URL encoded schema.org item prop link for the property.

dataSourcePrecedenceRules List<DataSourcePrecedenceResponse>

This is specific to interactions modeled as activities. Data sources are used to determine where data is stored and also in precedence rules.

fieldName String

Name of the property.

fieldType String

Type of the property.

arrayValueSeparator String

Array value separator for properties with isArray set.

enumValidValues List<ProfileEnumValidValuesFormatResponse>

Describes valid values for an enum property.

isArray Boolean

Indicates if the property is actually an array of the fieldType above on the data api.

isAvailableInGraph Boolean

Whether property is available in graph or not.

isEnum Boolean

Indicates if the property is an enum.

isFlagEnum Boolean

Indicates if the property is an flag enum.

isImage Boolean

Whether the property is an Image.

isLocalizedString Boolean

Whether the property is a localized string.

isName Boolean

Whether the property is a name or a part of name.

isRequired Boolean

Whether property value is required on instances, IsRequired field only for Interaction. Profile Instance will not check for required field.

maxLength Integer

Max length of string. Used only if type is string.

propertyId String

The ID associated with the property.

schemaItemPropLink String

URL encoded schema.org item prop link for the property.

dataSourcePrecedenceRules DataSourcePrecedenceResponse[]

This is specific to interactions modeled as activities. Data sources are used to determine where data is stored and also in precedence rules.

fieldName string

Name of the property.

fieldType string

Type of the property.

arrayValueSeparator string

Array value separator for properties with isArray set.

enumValidValues ProfileEnumValidValuesFormatResponse[]

Describes valid values for an enum property.

isArray boolean

Indicates if the property is actually an array of the fieldType above on the data api.

isAvailableInGraph boolean

Whether property is available in graph or not.

isEnum boolean

Indicates if the property is an enum.

isFlagEnum boolean

Indicates if the property is an flag enum.

isImage boolean

Whether the property is an Image.

isLocalizedString boolean

Whether the property is a localized string.

isName boolean

Whether the property is a name or a part of name.

isRequired boolean

Whether property value is required on instances, IsRequired field only for Interaction. Profile Instance will not check for required field.

maxLength number

Max length of string. Used only if type is string.

propertyId string

The ID associated with the property.

schemaItemPropLink string

URL encoded schema.org item prop link for the property.

data_source_precedence_rules Sequence[DataSourcePrecedenceResponse]

This is specific to interactions modeled as activities. Data sources are used to determine where data is stored and also in precedence rules.

field_name str

Name of the property.

field_type str

Type of the property.

array_value_separator str

Array value separator for properties with isArray set.

enum_valid_values Sequence[ProfileEnumValidValuesFormatResponse]

Describes valid values for an enum property.

is_array bool

Indicates if the property is actually an array of the fieldType above on the data api.

is_available_in_graph bool

Whether property is available in graph or not.

is_enum bool

Indicates if the property is an enum.

is_flag_enum bool

Indicates if the property is an flag enum.

is_image bool

Whether the property is an Image.

is_localized_string bool

Whether the property is a localized string.

is_name bool

Whether the property is a name or a part of name.

is_required bool

Whether property value is required on instances, IsRequired field only for Interaction. Profile Instance will not check for required field.

max_length int

Max length of string. Used only if type is string.

property_id str

The ID associated with the property.

schema_item_prop_link str

URL encoded schema.org item prop link for the property.

dataSourcePrecedenceRules List<Property Map>

This is specific to interactions modeled as activities. Data sources are used to determine where data is stored and also in precedence rules.

fieldName String

Name of the property.

fieldType String

Type of the property.

arrayValueSeparator String

Array value separator for properties with isArray set.

enumValidValues List<Property Map>

Describes valid values for an enum property.

isArray Boolean

Indicates if the property is actually an array of the fieldType above on the data api.

isAvailableInGraph Boolean

Whether property is available in graph or not.

isEnum Boolean

Indicates if the property is an enum.

isFlagEnum Boolean

Indicates if the property is an flag enum.

isImage Boolean

Whether the property is an Image.

isLocalizedString Boolean

Whether the property is a localized string.

isName Boolean

Whether the property is a name or a part of name.

isRequired Boolean

Whether property value is required on instances, IsRequired field only for Interaction. Profile Instance will not check for required field.

maxLength Number

Max length of string. Used only if type is string.

propertyId String

The ID associated with the property.

schemaItemPropLink String

URL encoded schema.org item prop link for the property.

StrongIdResponse

KeyPropertyNames List<string>

The properties which make up the unique ID.

StrongIdName string

The Name identifying the strong ID.

Description Dictionary<string, string>

Localized descriptions.

DisplayName Dictionary<string, string>

Localized display name.

KeyPropertyNames []string

The properties which make up the unique ID.

StrongIdName string

The Name identifying the strong ID.

Description map[string]string

Localized descriptions.

DisplayName map[string]string

Localized display name.

keyPropertyNames List<String>

The properties which make up the unique ID.

strongIdName String

The Name identifying the strong ID.

description Map<String,String>

Localized descriptions.

displayName Map<String,String>

Localized display name.

keyPropertyNames string[]

The properties which make up the unique ID.

strongIdName string

The Name identifying the strong ID.

description {[key: string]: string}

Localized descriptions.

displayName {[key: string]: string}

Localized display name.

key_property_names Sequence[str]

The properties which make up the unique ID.

strong_id_name str

The Name identifying the strong ID.

description Mapping[str, str]

Localized descriptions.

display_name Mapping[str, str]

Localized display name.

keyPropertyNames List<String>

The properties which make up the unique ID.

strongIdName String

The Name identifying the strong ID.

description Map<String>

Localized descriptions.

displayName Map<String>

Localized display name.

Package Details

Repository
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0