azure-native-v2.timeseriesinsights.ReferenceDataSet
Explore with Pulumi AI
A reference data set provides metadata about the events in an environment. Metadata in the reference data set will be joined with events as they are read from event sources. The metadata that makes up the reference data set is uploaded or modified through the Time Series Insights data plane APIs. Azure REST API version: 2020-05-15. Prior API version in Azure Native 1.x: 2020-05-15.
Other available API versions: 2021-06-30-preview.
Create ReferenceDataSet Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ReferenceDataSet(name: string, args: ReferenceDataSetArgs, opts?: CustomResourceOptions);
@overload
def ReferenceDataSet(resource_name: str,
args: ReferenceDataSetArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ReferenceDataSet(resource_name: str,
opts: Optional[ResourceOptions] = None,
environment_name: Optional[str] = None,
key_properties: Optional[Sequence[ReferenceDataSetKeyPropertyArgs]] = None,
resource_group_name: Optional[str] = None,
data_string_comparison_behavior: Optional[Union[str, DataStringComparisonBehavior]] = None,
location: Optional[str] = None,
reference_data_set_name: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None)
func NewReferenceDataSet(ctx *Context, name string, args ReferenceDataSetArgs, opts ...ResourceOption) (*ReferenceDataSet, error)
public ReferenceDataSet(string name, ReferenceDataSetArgs args, CustomResourceOptions? opts = null)
public ReferenceDataSet(String name, ReferenceDataSetArgs args)
public ReferenceDataSet(String name, ReferenceDataSetArgs args, CustomResourceOptions options)
type: azure-native:timeseriesinsights:ReferenceDataSet
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name
This property is required. string - The unique name of the resource.
- args
This property is required. ReferenceDataSetArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
This property is required. str - The unique name of the resource.
- args
This property is required. ReferenceDataSetArgs - The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. ReferenceDataSetArgs - The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. ReferenceDataSetArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name
This property is required. String - The unique name of the resource.
- args
This property is required. ReferenceDataSetArgs - 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 referenceDataSetResource = new AzureNative.Timeseriesinsights.ReferenceDataSet("referenceDataSetResource", new()
{
EnvironmentName = "string",
KeyProperties = new[]
{
{
{ "name", "string" },
{ "type", "string" },
},
},
ResourceGroupName = "string",
DataStringComparisonBehavior = "string",
Location = "string",
ReferenceDataSetName = "string",
Tags =
{
{ "string", "string" },
},
});
example, err := timeseriesinsights.NewReferenceDataSet(ctx, "referenceDataSetResource", ×eriesinsights.ReferenceDataSetArgs{
EnvironmentName: "string",
KeyProperties: []map[string]interface{}{
map[string]interface{}{
"name": "string",
"type": "string",
},
},
ResourceGroupName: "string",
DataStringComparisonBehavior: "string",
Location: "string",
ReferenceDataSetName: "string",
Tags: map[string]interface{}{
"string": "string",
},
})
var referenceDataSetResource = new ReferenceDataSet("referenceDataSetResource", ReferenceDataSetArgs.builder()
.environmentName("string")
.keyProperties(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.resourceGroupName("string")
.dataStringComparisonBehavior("string")
.location("string")
.referenceDataSetName("string")
.tags(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.build());
reference_data_set_resource = azure_native.timeseriesinsights.ReferenceDataSet("referenceDataSetResource",
environment_name=string,
key_properties=[{
name: string,
type: string,
}],
resource_group_name=string,
data_string_comparison_behavior=string,
location=string,
reference_data_set_name=string,
tags={
string: string,
})
const referenceDataSetResource = new azure_native.timeseriesinsights.ReferenceDataSet("referenceDataSetResource", {
environmentName: "string",
keyProperties: [{
name: "string",
type: "string",
}],
resourceGroupName: "string",
dataStringComparisonBehavior: "string",
location: "string",
referenceDataSetName: "string",
tags: {
string: "string",
},
});
type: azure-native:timeseriesinsights:ReferenceDataSet
properties:
dataStringComparisonBehavior: string
environmentName: string
keyProperties:
- name: string
type: string
location: string
referenceDataSetName: string
resourceGroupName: string
tags:
string: string
ReferenceDataSet 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 ReferenceDataSet resource accepts the following input properties:
- Environment
Name This property is required. Changes to this property will trigger replacement.
- The name of the Time Series Insights environment associated with the specified resource group.
- Key
Properties This property is required. List<Pulumi.Azure Native. Time Series Insights. Inputs. Reference Data Set Key Property> - The list of key properties for the reference data set.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- Name of an Azure Resource group.
- Data
String string | Pulumi.Comparison Behavior Azure Native. Time Series Insights. Data String Comparison Behavior - The reference data set key comparison behavior can be set using this property. By default, the value is 'Ordinal' - which means case sensitive key comparison will be performed while joining reference data with events or while adding new reference data. When 'OrdinalIgnoreCase' is set, case insensitive comparison will be used.
- Location
Changes to this property will trigger replacement.
- The location of the resource.
- Reference
Data Set Name Changes to this property will trigger replacement.
- Name of the reference data set.
- Dictionary<string, string>
- Key-value pairs of additional properties for the resource.
- Environment
Name This property is required. Changes to this property will trigger replacement.
- The name of the Time Series Insights environment associated with the specified resource group.
- Key
Properties This property is required. []ReferenceData Set Key Property Args - The list of key properties for the reference data set.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- Name of an Azure Resource group.
- Data
String string | DataComparison Behavior String Comparison Behavior - The reference data set key comparison behavior can be set using this property. By default, the value is 'Ordinal' - which means case sensitive key comparison will be performed while joining reference data with events or while adding new reference data. When 'OrdinalIgnoreCase' is set, case insensitive comparison will be used.
- Location
Changes to this property will trigger replacement.
- The location of the resource.
- Reference
Data Set Name Changes to this property will trigger replacement.
- Name of the reference data set.
- map[string]string
- Key-value pairs of additional properties for the resource.
- environment
Name This property is required. Changes to this property will trigger replacement.
- The name of the Time Series Insights environment associated with the specified resource group.
- key
Properties This property is required. List<ReferenceData Set Key Property> - The list of key properties for the reference data set.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- Name of an Azure Resource group.
- data
String String | DataComparison Behavior String Comparison Behavior - The reference data set key comparison behavior can be set using this property. By default, the value is 'Ordinal' - which means case sensitive key comparison will be performed while joining reference data with events or while adding new reference data. When 'OrdinalIgnoreCase' is set, case insensitive comparison will be used.
- location
Changes to this property will trigger replacement.
- The location of the resource.
- reference
Data Set Name Changes to this property will trigger replacement.
- Name of the reference data set.
- Map<String,String>
- Key-value pairs of additional properties for the resource.
- environment
Name This property is required. Changes to this property will trigger replacement.
- The name of the Time Series Insights environment associated with the specified resource group.
- key
Properties This property is required. ReferenceData Set Key Property[] - The list of key properties for the reference data set.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- Name of an Azure Resource group.
- data
String string | DataComparison Behavior String Comparison Behavior - The reference data set key comparison behavior can be set using this property. By default, the value is 'Ordinal' - which means case sensitive key comparison will be performed while joining reference data with events or while adding new reference data. When 'OrdinalIgnoreCase' is set, case insensitive comparison will be used.
- location
Changes to this property will trigger replacement.
- The location of the resource.
- reference
Data Set Name Changes to this property will trigger replacement.
- Name of the reference data set.
- {[key: string]: string}
- Key-value pairs of additional properties for the resource.
- environment_
name This property is required. Changes to this property will trigger replacement.
- The name of the Time Series Insights environment associated with the specified resource group.
- key_
properties This property is required. Sequence[ReferenceData Set Key Property Args] - The list of key properties for the reference data set.
- resource_
group_ name This property is required. Changes to this property will trigger replacement.
- Name of an Azure Resource group.
- data_
string_ str | Datacomparison_ behavior String Comparison Behavior - The reference data set key comparison behavior can be set using this property. By default, the value is 'Ordinal' - which means case sensitive key comparison will be performed while joining reference data with events or while adding new reference data. When 'OrdinalIgnoreCase' is set, case insensitive comparison will be used.
- location
Changes to this property will trigger replacement.
- The location of the resource.
- reference_
data_ set_ name Changes to this property will trigger replacement.
- Name of the reference data set.
- Mapping[str, str]
- Key-value pairs of additional properties for the resource.
- environment
Name This property is required. Changes to this property will trigger replacement.
- The name of the Time Series Insights environment associated with the specified resource group.
- key
Properties This property is required. List<Property Map> - The list of key properties for the reference data set.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- Name of an Azure Resource group.
- data
String String | "Ordinal" | "OrdinalComparison Behavior Ignore Case" - The reference data set key comparison behavior can be set using this property. By default, the value is 'Ordinal' - which means case sensitive key comparison will be performed while joining reference data with events or while adding new reference data. When 'OrdinalIgnoreCase' is set, case insensitive comparison will be used.
- location
Changes to this property will trigger replacement.
- The location of the resource.
- reference
Data Set Name Changes to this property will trigger replacement.
- Name of the reference data set.
- Map<String>
- Key-value pairs of additional properties for the resource.
Outputs
All input properties are implicitly available as output properties. Additionally, the ReferenceDataSet resource produces the following output properties:
- Creation
Time string - The time the resource was created.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- Resource name
- Provisioning
State string - Provisioning state of the resource.
- Type string
- Resource type
- Creation
Time string - The time the resource was created.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- Resource name
- Provisioning
State string - Provisioning state of the resource.
- Type string
- Resource type
- creation
Time String - The time the resource was created.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- Resource name
- provisioning
State String - Provisioning state of the resource.
- type String
- Resource type
- creation
Time string - The time the resource was created.
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- Resource name
- provisioning
State string - Provisioning state of the resource.
- type string
- Resource type
- creation_
time str - The time the resource was created.
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- Resource name
- provisioning_
state str - Provisioning state of the resource.
- type str
- Resource type
- creation
Time String - The time the resource was created.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- Resource name
- provisioning
State String - Provisioning state of the resource.
- type String
- Resource type
Supporting Types
DataStringComparisonBehavior, DataStringComparisonBehaviorArgs
- Ordinal
- Ordinal
- Ordinal
Ignore Case - OrdinalIgnoreCase
- Data
String Comparison Behavior Ordinal - Ordinal
- Data
String Comparison Behavior Ordinal Ignore Case - OrdinalIgnoreCase
- Ordinal
- Ordinal
- Ordinal
Ignore Case - OrdinalIgnoreCase
- Ordinal
- Ordinal
- Ordinal
Ignore Case - OrdinalIgnoreCase
- ORDINAL
- Ordinal
- ORDINAL_IGNORE_CASE
- OrdinalIgnoreCase
- "Ordinal"
- Ordinal
- "Ordinal
Ignore Case" - OrdinalIgnoreCase
ReferenceDataKeyPropertyType, ReferenceDataKeyPropertyTypeArgs
- String
- String
- Double
- Double
- Bool
- Bool
- Date
Time - DateTime
- Reference
Data Key Property Type String - String
- Reference
Data Key Property Type Double - Double
- Reference
Data Key Property Type Bool - Bool
- Reference
Data Key Property Type Date Time - DateTime
- String
- String
- Double
- Double
- Bool
- Bool
- Date
Time - DateTime
- String
- String
- Double
- Double
- Bool
- Bool
- Date
Time - DateTime
- STRING
- String
- DOUBLE
- Double
- BOOL
- Bool
- DATE_TIME
- DateTime
- "String"
- String
- "Double"
- Double
- "Bool"
- Bool
- "Date
Time" - DateTime
ReferenceDataSetKeyProperty, ReferenceDataSetKeyPropertyArgs
- Name string
- The name of the key property.
- Type
string | Pulumi.
Azure Native. Time Series Insights. Reference Data Key Property Type - The type of the key property.
- Name string
- The name of the key property.
- Type
string | Reference
Data Key Property Type - The type of the key property.
- name String
- The name of the key property.
- type
String | Reference
Data Key Property Type - The type of the key property.
- name string
- The name of the key property.
- type
string | Reference
Data Key Property Type - The type of the key property.
- name str
- The name of the key property.
- type
str | Reference
Data Key Property Type - The type of the key property.
- name String
- The name of the key property.
- type
String | "String" | "Double" | "Bool" | "Date
Time" - The type of the key property.
ReferenceDataSetKeyPropertyResponse, ReferenceDataSetKeyPropertyResponseArgs
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:timeseriesinsights:ReferenceDataSet rds1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments/{environmentName}/referenceDataSets/{referenceDataSetName}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- azure-native-v2 pulumi/pulumi-azure-native
- License
- Apache-2.0