azure-native.iotoperationsdataprocessor.Pipeline
Explore with Pulumi AI
A Pipeline 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 Pipeline Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Pipeline(name: string, args: PipelineArgs, opts?: CustomResourceOptions);
@overload
def Pipeline(resource_name: str,
args: PipelineArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Pipeline(resource_name: str,
opts: Optional[ResourceOptions] = None,
enabled: Optional[bool] = None,
extended_location: Optional[ExtendedLocationArgs] = None,
input: Optional[PipelineInputArgs] = None,
instance_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
stages: Optional[Mapping[str, PipelineStageArgs]] = None,
description: Optional[str] = None,
location: Optional[str] = None,
pipeline_name: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None)
func NewPipeline(ctx *Context, name string, args PipelineArgs, opts ...ResourceOption) (*Pipeline, error)
public Pipeline(string name, PipelineArgs args, CustomResourceOptions? opts = null)
public Pipeline(String name, PipelineArgs args)
public Pipeline(String name, PipelineArgs args, CustomResourceOptions options)
type: azure-native:iotoperationsdataprocessor:Pipeline
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. PipelineArgs - 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. PipelineArgs - 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. PipelineArgs - 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. PipelineArgs - 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. PipelineArgs - 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 examplepipelineResourceResourceFromIotoperationsdataprocessor = new AzureNative.IoTOperationsDataProcessor.Pipeline("examplepipelineResourceResourceFromIotoperationsdataprocessor", new()
{
Enabled = false,
ExtendedLocation = new AzureNative.IoTOperationsDataProcessor.Inputs.ExtendedLocationArgs
{
Name = "string",
Type = "string",
},
Input = new AzureNative.IoTOperationsDataProcessor.Inputs.PipelineInputArgs
{
Next = new[]
{
"string",
},
Type = "string",
Description = "string",
},
InstanceName = "string",
ResourceGroupName = "string",
Stages =
{
{ "string", new AzureNative.IoTOperationsDataProcessor.Inputs.PipelineStageArgs
{
Type = "string",
Description = "string",
Next = new[]
{
"string",
},
} },
},
Description = "string",
Location = "string",
PipelineName = "string",
Tags =
{
{ "string", "string" },
},
});
example, err := iotoperationsdataprocessor.NewPipeline(ctx, "examplepipelineResourceResourceFromIotoperationsdataprocessor", &iotoperationsdataprocessor.PipelineArgs{
Enabled: pulumi.Bool(false),
ExtendedLocation: &iotoperationsdataprocessor.ExtendedLocationArgs{
Name: pulumi.String("string"),
Type: pulumi.String("string"),
},
Input: &iotoperationsdataprocessor.PipelineInputTypeArgs{
Next: pulumi.StringArray{
pulumi.String("string"),
},
Type: pulumi.String("string"),
Description: pulumi.String("string"),
},
InstanceName: pulumi.String("string"),
ResourceGroupName: pulumi.String("string"),
Stages: iotoperationsdataprocessor.PipelineStageMap{
"string": &iotoperationsdataprocessor.PipelineStageArgs{
Type: pulumi.String("string"),
Description: pulumi.String("string"),
Next: pulumi.StringArray{
pulumi.String("string"),
},
},
},
Description: pulumi.String("string"),
Location: pulumi.String("string"),
PipelineName: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var examplepipelineResourceResourceFromIotoperationsdataprocessor = new Pipeline("examplepipelineResourceResourceFromIotoperationsdataprocessor", PipelineArgs.builder()
.enabled(false)
.extendedLocation(ExtendedLocationArgs.builder()
.name("string")
.type("string")
.build())
.input(PipelineInputArgs.builder()
.next("string")
.type("string")
.description("string")
.build())
.instanceName("string")
.resourceGroupName("string")
.stages(Map.of("string", Map.ofEntries(
Map.entry("type", "string"),
Map.entry("description", "string"),
Map.entry("next", "string")
)))
.description("string")
.location("string")
.pipelineName("string")
.tags(Map.of("string", "string"))
.build());
examplepipeline_resource_resource_from_iotoperationsdataprocessor = azure_native.iotoperationsdataprocessor.Pipeline("examplepipelineResourceResourceFromIotoperationsdataprocessor",
enabled=False,
extended_location={
"name": "string",
"type": "string",
},
input={
"next": ["string"],
"type": "string",
"description": "string",
},
instance_name="string",
resource_group_name="string",
stages={
"string": {
"type": "string",
"description": "string",
"next": ["string"],
},
},
description="string",
location="string",
pipeline_name="string",
tags={
"string": "string",
})
const examplepipelineResourceResourceFromIotoperationsdataprocessor = new azure_native.iotoperationsdataprocessor.Pipeline("examplepipelineResourceResourceFromIotoperationsdataprocessor", {
enabled: false,
extendedLocation: {
name: "string",
type: "string",
},
input: {
next: ["string"],
type: "string",
description: "string",
},
instanceName: "string",
resourceGroupName: "string",
stages: {
string: {
type: "string",
description: "string",
next: ["string"],
},
},
description: "string",
location: "string",
pipelineName: "string",
tags: {
string: "string",
},
});
type: azure-native:iotoperationsdataprocessor:Pipeline
properties:
description: string
enabled: false
extendedLocation:
name: string
type: string
input:
description: string
next:
- string
type: string
instanceName: string
location: string
pipelineName: string
resourceGroupName: string
stages:
string:
description: string
next:
- string
type: string
tags:
string: string
Pipeline 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 Pipeline resource accepts the following input properties:
- Enabled
This property is required. bool - Flag indicating whether the pipeline should be running or not.
- 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.
- Input
This property is required. Pulumi.Azure Native. Io TOperations Data Processor. Inputs. Pipeline Input - Information about where to pull input data from.
- 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.
- Stages
This property is required. Dictionary<string, Pulumi.Azure Native. Io TOperations Data Processor. Inputs. Pipeline Stage Args> - Map of stage ids to stage configurations for all pipeline processing and output stages.
- Description string
- Detailed description of the Pipeline.
- Location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- Pipeline
Name Changes to this property will trigger replacement.
- Name of pipeline
- Dictionary<string, string>
- Resource tags.
- Enabled
This property is required. bool - Flag indicating whether the pipeline should be running or not.
- Extended
Location This property is required. Changes to this property will trigger replacement.
Location Args - Edge location of the resource.
- Input
This property is required. PipelineInput Type Args - Information about where to pull input data from.
- 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.
- Stages
This property is required. map[string]PipelineStage Args - Map of stage ids to stage configurations for all pipeline processing and output stages.
- Description string
- Detailed description of the Pipeline.
- Location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- Pipeline
Name Changes to this property will trigger replacement.
- Name of pipeline
- map[string]string
- Resource tags.
- enabled
This property is required. Boolean - Flag indicating whether the pipeline should be running or not.
- extended
Location This property is required. Changes to this property will trigger replacement.
Location - Edge location of the resource.
- input
This property is required. PipelineInput - Information about where to pull input data from.
- 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.
- stages
This property is required. Map<String,PipelineStage Args> - Map of stage ids to stage configurations for all pipeline processing and output stages.
- description String
- Detailed description of the Pipeline.
- location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- pipeline
Name Changes to this property will trigger replacement.
- Name of pipeline
- Map<String,String>
- Resource tags.
- enabled
This property is required. boolean - Flag indicating whether the pipeline should be running or not.
- extended
Location This property is required. Changes to this property will trigger replacement.
Location - Edge location of the resource.
- input
This property is required. PipelineInput - Information about where to pull input data from.
- 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.
- stages
This property is required. {[key: string]: PipelineStage Args} - Map of stage ids to stage configurations for all pipeline processing and output stages.
- description string
- Detailed description of the Pipeline.
- location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- pipeline
Name Changes to this property will trigger replacement.
- Name of pipeline
- {[key: string]: string}
- Resource tags.
- enabled
This property is required. bool - Flag indicating whether the pipeline should be running or not.
- extended_
location This property is required. Changes to this property will trigger replacement.
Location Args - Edge location of the resource.
- input
This property is required. PipelineInput Args - Information about where to pull input data from.
- 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.
- stages
This property is required. Mapping[str, PipelineStage Args] - Map of stage ids to stage configurations for all pipeline processing and output stages.
- description str
- Detailed description of the Pipeline.
- location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- pipeline_
name Changes to this property will trigger replacement.
- Name of pipeline
- Mapping[str, str]
- Resource tags.
- enabled
This property is required. Boolean - Flag indicating whether the pipeline should be running or not.
- extended
Location This property is required. Changes to this property will trigger replacement.
- Edge location of the resource.
- input
This property is required. Property Map - Information about where to pull input data from.
- 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.
- stages
This property is required. Map<Property Map> - Map of stage ids to stage configurations for all pipeline processing and output stages.
- description String
- Detailed description of the Pipeline.
- location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- pipeline
Name Changes to this property will trigger replacement.
- Name of pipeline
- Map<String>
- Resource tags.
Outputs
All input properties are implicitly available as output properties. Additionally, the Pipeline 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
ExtendedLocation, ExtendedLocationArgs
ExtendedLocationResponse, ExtendedLocationResponseArgs
PipelineInput, PipelineInputArgs
- Next
This property is required. List<string> - Next stage in the pipeline.
- Type
This property is required. string - ARM resource type.
- Description string
- Description for stage.
- Next
This property is required. []string - Next stage in the pipeline.
- Type
This property is required. string - ARM resource type.
- Description string
- Description for stage.
- next
This property is required. List<String> - Next stage in the pipeline.
- type
This property is required. String - ARM resource type.
- description String
- Description for stage.
- next
This property is required. string[] - Next stage in the pipeline.
- type
This property is required. string - ARM resource type.
- description string
- Description for stage.
- next
This property is required. Sequence[str] - Next stage in the pipeline.
- type
This property is required. str - ARM resource type.
- description str
- Description for stage.
- next
This property is required. List<String> - Next stage in the pipeline.
- type
This property is required. String - ARM resource type.
- description String
- Description for stage.
PipelineInputResponse, PipelineInputResponseArgs
- Next
This property is required. List<string> - Next stage in the pipeline.
- Type
This property is required. string - ARM resource type.
- Description string
- Description for stage.
- Next
This property is required. []string - Next stage in the pipeline.
- Type
This property is required. string - ARM resource type.
- Description string
- Description for stage.
- next
This property is required. List<String> - Next stage in the pipeline.
- type
This property is required. String - ARM resource type.
- description String
- Description for stage.
- next
This property is required. string[] - Next stage in the pipeline.
- type
This property is required. string - ARM resource type.
- description string
- Description for stage.
- next
This property is required. Sequence[str] - Next stage in the pipeline.
- type
This property is required. str - ARM resource type.
- description str
- Description for stage.
- next
This property is required. List<String> - Next stage in the pipeline.
- type
This property is required. String - ARM resource type.
- description String
- Description for stage.
PipelineStage, PipelineStageArgs
- Type
This property is required. string - ARM resource type.
- Description string
- Description for stage.
- Next List<string>
- Next stage in the pipeline. Not required if output stage.
- Type
This property is required. string - ARM resource type.
- Description string
- Description for stage.
- Next []string
- Next stage in the pipeline. Not required if output stage.
- type
This property is required. String - ARM resource type.
- description String
- Description for stage.
- next List<String>
- Next stage in the pipeline. Not required if output stage.
- type
This property is required. string - ARM resource type.
- description string
- Description for stage.
- next string[]
- Next stage in the pipeline. Not required if output stage.
- type
This property is required. str - ARM resource type.
- description str
- Description for stage.
- next Sequence[str]
- Next stage in the pipeline. Not required if output stage.
- type
This property is required. String - ARM resource type.
- description String
- Description for stage.
- next List<String>
- Next stage in the pipeline. Not required if output stage.
PipelineStageResponse, PipelineStageResponseArgs
- Type
This property is required. string - ARM resource type.
- Description string
- Description for stage.
- Next List<string>
- Next stage in the pipeline. Not required if output stage.
- Type
This property is required. string - ARM resource type.
- Description string
- Description for stage.
- Next []string
- Next stage in the pipeline. Not required if output stage.
- type
This property is required. String - ARM resource type.
- description String
- Description for stage.
- next List<String>
- Next stage in the pipeline. Not required if output stage.
- type
This property is required. string - ARM resource type.
- description string
- Description for stage.
- next string[]
- Next stage in the pipeline. Not required if output stage.
- type
This property is required. str - ARM resource type.
- description str
- Description for stage.
- next Sequence[str]
- Next stage in the pipeline. Not required if output stage.
- type
This property is required. String - ARM resource type.
- description String
- Description for stage.
- next List<String>
- Next stage in the pipeline. Not required if output stage.
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:Pipeline IoTOperationsDataProcessor-pipeline-name /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperationsDataProcessor/instances/{instanceName}/pipelines/{pipelineName}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0