azure-native.iotoperationsdataprocessor.Dataset
Explore with Pulumi AI
A Dataset resource belonging to an Instance resource.
Uses Azure REST API version 2023-10-04-preview. In version 2.x of the Azure Native provider, it used API version 2023-10-04-preview.
Create Dataset Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Dataset(name: string, args: DatasetArgs, opts?: CustomResourceOptions);
@overload
def Dataset(resource_name: str,
args: DatasetArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Dataset(resource_name: str,
opts: Optional[ResourceOptions] = None,
extended_location: Optional[ExtendedLocationArgs] = None,
instance_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
dataset_name: Optional[str] = None,
description: Optional[str] = None,
keys: Optional[Mapping[str, DatasetPropertyKeyArgs]] = None,
location: Optional[str] = None,
payload: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
timestamp: Optional[str] = None,
ttl: Optional[str] = None)
func NewDataset(ctx *Context, name string, args DatasetArgs, opts ...ResourceOption) (*Dataset, error)
public Dataset(string name, DatasetArgs args, CustomResourceOptions? opts = null)
public Dataset(String name, DatasetArgs args)
public Dataset(String name, DatasetArgs args, CustomResourceOptions options)
type: azure-native:iotoperationsdataprocessor:Dataset
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. DatasetArgs - 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. DatasetArgs - 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. DatasetArgs - 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. DatasetArgs - 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. DatasetArgs - 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 azure_nativeDatasetResource = new AzureNative.IoTOperationsDataProcessor.Dataset("azure-nativeDatasetResource", new()
{
ExtendedLocation = new AzureNative.IoTOperationsDataProcessor.Inputs.ExtendedLocationArgs
{
Name = "string",
Type = "string",
},
InstanceName = "string",
ResourceGroupName = "string",
DatasetName = "string",
Description = "string",
Keys =
{
{ "string", new AzureNative.IoTOperationsDataProcessor.Inputs.DatasetPropertyKeyArgs
{
Path = "string",
PrimaryKey = false,
} },
},
Location = "string",
Payload = "string",
Tags =
{
{ "string", "string" },
},
Timestamp = "string",
Ttl = "string",
});
example, err := iotoperationsdataprocessor.NewDataset(ctx, "azure-nativeDatasetResource", &iotoperationsdataprocessor.DatasetArgs{
ExtendedLocation: &iotoperationsdataprocessor.ExtendedLocationArgs{
Name: pulumi.String("string"),
Type: pulumi.String("string"),
},
InstanceName: pulumi.String("string"),
ResourceGroupName: pulumi.String("string"),
DatasetName: pulumi.String("string"),
Description: pulumi.String("string"),
Keys: iotoperationsdataprocessor.DatasetPropertyKeyMap{
"string": &iotoperationsdataprocessor.DatasetPropertyKeyArgs{
Path: pulumi.String("string"),
PrimaryKey: pulumi.Bool(false),
},
},
Location: pulumi.String("string"),
Payload: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
Timestamp: pulumi.String("string"),
Ttl: pulumi.String("string"),
})
var azure_nativeDatasetResource = new com.pulumi.azurenative.iotoperationsdataprocessor.Dataset("azure-nativeDatasetResource", com.pulumi.azurenative.iotoperationsdataprocessor.DatasetArgs.builder()
.extendedLocation(ExtendedLocationArgs.builder()
.name("string")
.type("string")
.build())
.instanceName("string")
.resourceGroupName("string")
.datasetName("string")
.description("string")
.keys(Map.of("string", Map.ofEntries(
Map.entry("path", "string"),
Map.entry("primaryKey", false)
)))
.location("string")
.payload("string")
.tags(Map.of("string", "string"))
.timestamp("string")
.ttl("string")
.build());
azure_native_dataset_resource = azure_native.iotoperationsdataprocessor.Dataset("azure-nativeDatasetResource",
extended_location={
"name": "string",
"type": "string",
},
instance_name="string",
resource_group_name="string",
dataset_name="string",
description="string",
keys={
"string": {
"path": "string",
"primary_key": False,
},
},
location="string",
payload="string",
tags={
"string": "string",
},
timestamp="string",
ttl="string")
const azure_nativeDatasetResource = new azure_native.iotoperationsdataprocessor.Dataset("azure-nativeDatasetResource", {
extendedLocation: {
name: "string",
type: "string",
},
instanceName: "string",
resourceGroupName: "string",
datasetName: "string",
description: "string",
keys: {
string: {
path: "string",
primaryKey: false,
},
},
location: "string",
payload: "string",
tags: {
string: "string",
},
timestamp: "string",
ttl: "string",
});
type: azure-native:iotoperationsdataprocessor:Dataset
properties:
datasetName: string
description: string
extendedLocation:
name: string
type: string
instanceName: string
keys:
string:
path: string
primaryKey: false
location: string
payload: string
resourceGroupName: string
tags:
string: string
timestamp: string
ttl: string
Dataset 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 Dataset resource accepts the following input properties:
- Extended
Location This property is required. Changes to this property will trigger replacement.
Azure Native. Io TOperations Data Processor. Inputs. Extended Location - Edge location of the resource.
- Instance
Name This property is required. Changes to this property will trigger replacement.
- Name of instance.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- Dataset
Name Changes to this property will trigger replacement.
- Name of dataset.
- Description string
- Detailed description of the Dataset.
- Keys
Dictionary<string, Pulumi.
Azure Native. Io TOperations Data Processor. Inputs. Dataset Property Key Args> - List of keys that can be used for joining on enrich.
- Location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- Payload string
- Path to the payload in the message. Enrich will add only the payload to the enriched message, other fields will not be kept except for in the indexes.
- Dictionary<string, string>
- Resource tags.
- Timestamp string
- Path to an RFC3339 timestamp in the message. If no path is provided, the ingestion time of the record is used for time-based joins.
- Ttl string
- Time to live for individual records.
- Extended
Location This property is required. Changes to this property will trigger replacement.
Location Args - Edge location of the resource.
- Instance
Name This property is required. Changes to this property will trigger replacement.
- Name of instance.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- Dataset
Name Changes to this property will trigger replacement.
- Name of dataset.
- Description string
- Detailed description of the Dataset.
- Keys
map[string]Dataset
Property Key Args - List of keys that can be used for joining on enrich.
- Location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- Payload string
- Path to the payload in the message. Enrich will add only the payload to the enriched message, other fields will not be kept except for in the indexes.
- map[string]string
- Resource tags.
- Timestamp string
- Path to an RFC3339 timestamp in the message. If no path is provided, the ingestion time of the record is used for time-based joins.
- Ttl string
- Time to live for individual records.
- extended
Location This property is required. Changes to this property will trigger replacement.
Location - Edge location of the resource.
- instance
Name This property is required. Changes to this property will trigger replacement.
- Name of instance.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- dataset
Name Changes to this property will trigger replacement.
- Name of dataset.
- description String
- Detailed description of the Dataset.
- keys
Map<String,Dataset
Property Key Args> - List of keys that can be used for joining on enrich.
- location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- payload String
- Path to the payload in the message. Enrich will add only the payload to the enriched message, other fields will not be kept except for in the indexes.
- Map<String,String>
- Resource tags.
- timestamp String
- Path to an RFC3339 timestamp in the message. If no path is provided, the ingestion time of the record is used for time-based joins.
- ttl String
- Time to live for individual records.
- extended
Location This property is required. Changes to this property will trigger replacement.
Location - Edge location of the resource.
- instance
Name This property is required. Changes to this property will trigger replacement.
- Name of instance.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- dataset
Name Changes to this property will trigger replacement.
- Name of dataset.
- description string
- Detailed description of the Dataset.
- keys
{[key: string]: Dataset
Property Key Args} - List of keys that can be used for joining on enrich.
- location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- payload string
- Path to the payload in the message. Enrich will add only the payload to the enriched message, other fields will not be kept except for in the indexes.
- {[key: string]: string}
- Resource tags.
- timestamp string
- Path to an RFC3339 timestamp in the message. If no path is provided, the ingestion time of the record is used for time-based joins.
- ttl string
- Time to live for individual records.
- extended_
location This property is required. Changes to this property will trigger replacement.
Location Args - Edge location of the resource.
- instance_
name This property is required. Changes to this property will trigger replacement.
- Name of instance.
- resource_
group_ name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- dataset_
name Changes to this property will trigger replacement.
- Name of dataset.
- description str
- Detailed description of the Dataset.
- keys
Mapping[str, Dataset
Property Key Args] - List of keys that can be used for joining on enrich.
- location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- payload str
- Path to the payload in the message. Enrich will add only the payload to the enriched message, other fields will not be kept except for in the indexes.
- Mapping[str, str]
- Resource tags.
- timestamp str
- Path to an RFC3339 timestamp in the message. If no path is provided, the ingestion time of the record is used for time-based joins.
- ttl str
- Time to live for individual records.
- extended
Location This property is required. Changes to this property will trigger replacement.
- Edge location of the resource.
- instance
Name This property is required. Changes to this property will trigger replacement.
- Name of instance.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- dataset
Name Changes to this property will trigger replacement.
- Name of dataset.
- description String
- Detailed description of the Dataset.
- keys Map<Property Map>
- List of keys that can be used for joining on enrich.
- location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- payload String
- Path to the payload in the message. Enrich will add only the payload to the enriched message, other fields will not be kept except for in the indexes.
- Map<String>
- Resource tags.
- timestamp String
- Path to an RFC3339 timestamp in the message. If no path is provided, the ingestion time of the record is used for time-based joins.
- ttl String
- Time to live for individual records.
Outputs
All input properties are implicitly available as output properties. Additionally, the Dataset resource produces the following output properties:
- Azure
Api stringVersion - The Azure API version of the resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- Provisioning
State string - The status of the last operation.
- System
Data Pulumi.Azure Native. Io TOperations Data Processor. Outputs. System Data Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Azure
Api stringVersion - The Azure API version of the resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- Provisioning
State string - The status of the last operation.
- System
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- azure
Api StringVersion - The Azure API version of the resource.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- provisioning
State String - The status of the last operation.
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- azure
Api stringVersion - The Azure API version of the resource.
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- The name of the resource
- provisioning
State string - The status of the last operation.
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- azure_
api_ strversion - The Azure API version of the resource.
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- The name of the resource
- provisioning_
state str - The status of the last operation.
- system_
data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type str
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- azure
Api StringVersion - The Azure API version of the resource.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- provisioning
State String - The status of the last operation.
- system
Data Property Map - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Supporting Types
DatasetPropertyKey, DatasetPropertyKeyArgs
- Path
This property is required. string - Path to the input value from the message.
- Primary
Key bool - If true the property will be used as a primary key. At most one primary key can exists.
- Path
This property is required. string - Path to the input value from the message.
- Primary
Key bool - If true the property will be used as a primary key. At most one primary key can exists.
- path
This property is required. String - Path to the input value from the message.
- primary
Key Boolean - If true the property will be used as a primary key. At most one primary key can exists.
- path
This property is required. string - Path to the input value from the message.
- primary
Key boolean - If true the property will be used as a primary key. At most one primary key can exists.
- path
This property is required. str - Path to the input value from the message.
- primary_
key bool - If true the property will be used as a primary key. At most one primary key can exists.
- path
This property is required. String - Path to the input value from the message.
- primary
Key Boolean - If true the property will be used as a primary key. At most one primary key can exists.
DatasetPropertyKeyResponse, DatasetPropertyKeyResponseArgs
- Path
This property is required. string - Path to the input value from the message.
- Primary
Key bool - If true the property will be used as a primary key. At most one primary key can exists.
- Path
This property is required. string - Path to the input value from the message.
- Primary
Key bool - If true the property will be used as a primary key. At most one primary key can exists.
- path
This property is required. String - Path to the input value from the message.
- primary
Key Boolean - If true the property will be used as a primary key. At most one primary key can exists.
- path
This property is required. string - Path to the input value from the message.
- primary
Key boolean - If true the property will be used as a primary key. At most one primary key can exists.
- path
This property is required. str - Path to the input value from the message.
- primary_
key bool - If true the property will be used as a primary key. At most one primary key can exists.
- path
This property is required. String - Path to the input value from the message.
- primary
Key Boolean - If true the property will be used as a primary key. At most one primary key can exists.
ExtendedLocation, ExtendedLocationArgs
ExtendedLocationResponse, ExtendedLocationResponseArgs
SystemDataResponse, SystemDataResponseArgs
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - The type of identity that last modified the resource.
- created_
at str - The timestamp of resource creation (UTC).
- created_
by str - The identity that created the resource.
- created_
by_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:iotoperationsdataprocessor:Dataset IoTOperationsDataProcessor-dataset-name /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperationsDataProcessor/instances/{instanceName}/datasets/{datasetName}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0