1. Packages
  2. Azure Native
  3. API Docs
  4. iotoperationsdataprocessor
  5. getDataset
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.38.0 published on Monday, Apr 22, 2024 by Pulumi

azure-native.iotoperationsdataprocessor.getDataset

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.38.0 published on Monday, Apr 22, 2024 by Pulumi

    Get a Dataset Azure REST API version: 2023-10-04-preview.

    Using getDataset

    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 getDataset(args: GetDatasetArgs, opts?: InvokeOptions): Promise<GetDatasetResult>
    function getDatasetOutput(args: GetDatasetOutputArgs, opts?: InvokeOptions): Output<GetDatasetResult>
    def get_dataset(dataset_name: Optional[str] = None,
                    instance_name: Optional[str] = None,
                    resource_group_name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetDatasetResult
    def get_dataset_output(dataset_name: Optional[pulumi.Input[str]] = None,
                    instance_name: Optional[pulumi.Input[str]] = None,
                    resource_group_name: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetDatasetResult]
    func LookupDataset(ctx *Context, args *LookupDatasetArgs, opts ...InvokeOption) (*LookupDatasetResult, error)
    func LookupDatasetOutput(ctx *Context, args *LookupDatasetOutputArgs, opts ...InvokeOption) LookupDatasetResultOutput

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

    public static class GetDataset 
    {
        public static Task<GetDatasetResult> InvokeAsync(GetDatasetArgs args, InvokeOptions? opts = null)
        public static Output<GetDatasetResult> Invoke(GetDatasetInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetDatasetResult> getDataset(GetDatasetArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:iotoperationsdataprocessor:getDataset
      arguments:
        # arguments dictionary

    The following arguments are supported:

    DatasetName string
    Name of dataset.
    InstanceName string
    Name of instance.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    DatasetName string
    Name of dataset.
    InstanceName string
    Name of instance.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    datasetName String
    Name of dataset.
    instanceName String
    Name of instance.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    datasetName string
    Name of dataset.
    instanceName string
    Name of instance.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    dataset_name str
    Name of dataset.
    instance_name str
    Name of instance.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    datasetName String
    Name of dataset.
    instanceName String
    Name of instance.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getDataset Result

    The following output properties are available:

    ExtendedLocation Pulumi.AzureNative.IoTOperationsDataProcessor.Outputs.ExtendedLocationResponse
    Edge location of the resource.
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    ProvisioningState string
    The status of the last operation.
    SystemData Pulumi.AzureNative.IoTOperationsDataProcessor.Outputs.SystemDataResponse
    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"
    Description string
    Detailed description of the Dataset.
    Keys Dictionary<string, Pulumi.AzureNative.IoTOperationsDataProcessor.Outputs.DatasetPropertyKeyResponse>
    List of keys that can be used for joining on enrich.
    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.
    Tags 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.
    ExtendedLocation ExtendedLocationResponse
    Edge location of the resource.
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    ProvisioningState string
    The status of the last operation.
    SystemData SystemDataResponse
    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"
    Description string
    Detailed description of the Dataset.
    Keys map[string]DatasetPropertyKeyResponse
    List of keys that can be used for joining on enrich.
    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.
    Tags 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.
    extendedLocation ExtendedLocationResponse
    Edge location of the resource.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    provisioningState String
    The status of the last operation.
    systemData SystemDataResponse
    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"
    description String
    Detailed description of the Dataset.
    keys Map<String,DatasetPropertyKeyResponse>
    List of keys that can be used for joining on enrich.
    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.
    tags 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.
    extendedLocation ExtendedLocationResponse
    Edge location of the resource.
    id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location string
    The geo-location where the resource lives
    name string
    The name of the resource
    provisioningState string
    The status of the last operation.
    systemData SystemDataResponse
    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"
    description string
    Detailed description of the Dataset.
    keys {[key: string]: DatasetPropertyKeyResponse}
    List of keys that can be used for joining on enrich.
    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.
    tags {[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 ExtendedLocationResponse
    Edge location of the resource.
    id str
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location str
    The geo-location where the resource lives
    name str
    The name of the resource
    provisioning_state str
    The status of the last operation.
    system_data SystemDataResponse
    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"
    description str
    Detailed description of the Dataset.
    keys Mapping[str, DatasetPropertyKeyResponse]
    List of keys that can be used for joining on enrich.
    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.
    tags 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.
    extendedLocation Property Map
    Edge location of the resource.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    provisioningState String
    The status of the last operation.
    systemData 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"
    description String
    Detailed description of the Dataset.
    keys Map<Property Map>
    List of keys that can be used for joining on enrich.
    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.
    tags 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.

    Supporting Types

    DatasetPropertyKeyResponse

    Path string
    Path to the input value from the message.
    PrimaryKey bool
    If true the property will be used as a primary key. At most one primary key can exists.
    Path string
    Path to the input value from the message.
    PrimaryKey bool
    If true the property will be used as a primary key. At most one primary key can exists.
    path String
    Path to the input value from the message.
    primaryKey Boolean
    If true the property will be used as a primary key. At most one primary key can exists.
    path string
    Path to the input value from the message.
    primaryKey boolean
    If true the property will be used as a primary key. At most one primary key can exists.
    path 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 String
    Path to the input value from the message.
    primaryKey Boolean
    If true the property will be used as a primary key. At most one primary key can exists.

    ExtendedLocationResponse

    Name string
    The name of the extended location.
    Type string
    The type of the extended location.
    Name string
    The name of the extended location.
    Type string
    The type of the extended location.
    name String
    The name of the extended location.
    type String
    The type of the extended location.
    name string
    The name of the extended location.
    type string
    The type of the extended location.
    name str
    The name of the extended location.
    type str
    The type of the extended location.
    name String
    The name of the extended location.
    type String
    The type of the extended location.

    SystemDataResponse

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    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_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.38.0 published on Monday, Apr 22, 2024 by Pulumi