1. Packages
  2. Azure Native
  3. API Docs
  4. azuredatatransfer
  5. getPipeline
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

azure-native.azuredatatransfer.getPipeline

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

Gets pipeline resource.

Uses Azure REST API version 2024-09-27.

Other available API versions: 2023-10-11-preview, 2024-01-25, 2024-05-07, 2024-09-11, 2025-03-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native azuredatatransfer [ApiVersion]. See the version guide for details.

Using getPipeline

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 getPipeline(args: GetPipelineArgs, opts?: InvokeOptions): Promise<GetPipelineResult>
function getPipelineOutput(args: GetPipelineOutputArgs, opts?: InvokeOptions): Output<GetPipelineResult>
Copy
def get_pipeline(pipeline_name: Optional[str] = None,
                 resource_group_name: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetPipelineResult
def get_pipeline_output(pipeline_name: Optional[pulumi.Input[str]] = None,
                 resource_group_name: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetPipelineResult]
Copy
func LookupPipeline(ctx *Context, args *LookupPipelineArgs, opts ...InvokeOption) (*LookupPipelineResult, error)
func LookupPipelineOutput(ctx *Context, args *LookupPipelineOutputArgs, opts ...InvokeOption) LookupPipelineResultOutput
Copy

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

public static class GetPipeline 
{
    public static Task<GetPipelineResult> InvokeAsync(GetPipelineArgs args, InvokeOptions? opts = null)
    public static Output<GetPipelineResult> Invoke(GetPipelineInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetPipelineResult> getPipeline(GetPipelineArgs args, InvokeOptions options)
public static Output<GetPipelineResult> getPipeline(GetPipelineArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:azuredatatransfer:getPipeline
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

PipelineName
This property is required.
Changes to this property will trigger replacement.
string
The name for the pipeline that is to be requested.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
PipelineName
This property is required.
Changes to this property will trigger replacement.
string
The name for the pipeline that is to be requested.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
pipelineName
This property is required.
Changes to this property will trigger replacement.
String
The name for the pipeline that is to be requested.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
pipelineName
This property is required.
Changes to this property will trigger replacement.
string
The name for the pipeline that is to be requested.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
pipeline_name
This property is required.
Changes to this property will trigger replacement.
str
The name for the pipeline that is to be requested.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
pipelineName
This property is required.
Changes to this property will trigger replacement.
String
The name for the pipeline that is to be requested.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.

getPipeline Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Location string
The geo-location where the resource lives
Name string
The name of the resource
Properties Pulumi.AzureNative.AzureDataTransfer.Outputs.PipelinePropertiesResponse
Properties of pipeline
SystemData Pulumi.AzureNative.AzureDataTransfer.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"
Tags Dictionary<string, string>
Resource tags.
AzureApiVersion string
The Azure API version of the resource.
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Location string
The geo-location where the resource lives
Name string
The name of the resource
Properties PipelinePropertiesResponse
Properties of pipeline
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"
Tags map[string]string
Resource tags.
azureApiVersion String
The Azure API version of the resource.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location String
The geo-location where the resource lives
name String
The name of the resource
properties PipelinePropertiesResponse
Properties of pipeline
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"
tags Map<String,String>
Resource tags.
azureApiVersion string
The Azure API version of the resource.
id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location string
The geo-location where the resource lives
name string
The name of the resource
properties PipelinePropertiesResponse
Properties of pipeline
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"
tags {[key: string]: string}
Resource tags.
azure_api_version str
The Azure API version of the resource.
id str
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location str
The geo-location where the resource lives
name str
The name of the resource
properties PipelinePropertiesResponse
Properties of pipeline
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"
tags Mapping[str, str]
Resource tags.
azureApiVersion String
The Azure API version of the resource.
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location String
The geo-location where the resource lives
name String
The name of the resource
properties Property Map
Properties of pipeline
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"
tags Map<String>
Resource tags.

Supporting Types

InternalMetadataPropertiesResponse

StatusSetBy This property is required. string
User that last set the approved status for this connection
OperationStatus Pulumi.AzureNative.AzureDataTransfer.Inputs.OperationStatusPropertiesResponse
Operation status associated with the last patch request
StatusSetBy This property is required. string
User that last set the approved status for this connection
OperationStatus OperationStatusPropertiesResponse
Operation status associated with the last patch request
statusSetBy This property is required. String
User that last set the approved status for this connection
operationStatus OperationStatusPropertiesResponse
Operation status associated with the last patch request
statusSetBy This property is required. string
User that last set the approved status for this connection
operationStatus OperationStatusPropertiesResponse
Operation status associated with the last patch request
status_set_by This property is required. str
User that last set the approved status for this connection
operation_status OperationStatusPropertiesResponse
Operation status associated with the last patch request
statusSetBy This property is required. String
User that last set the approved status for this connection
operationStatus Property Map
Operation status associated with the last patch request

OperationStatusPropertiesResponse

Id This property is required. string
Operation status ID of the last patch request for this connection.
Message This property is required. string
Message for the operation for the last patch request for this connection.
Status This property is required. string
Operation status for the last patch request for this connection.
Id This property is required. string
Operation status ID of the last patch request for this connection.
Message This property is required. string
Message for the operation for the last patch request for this connection.
Status This property is required. string
Operation status for the last patch request for this connection.
id This property is required. String
Operation status ID of the last patch request for this connection.
message This property is required. String
Message for the operation for the last patch request for this connection.
status This property is required. String
Operation status for the last patch request for this connection.
id This property is required. string
Operation status ID of the last patch request for this connection.
message This property is required. string
Message for the operation for the last patch request for this connection.
status This property is required. string
Operation status for the last patch request for this connection.
id This property is required. str
Operation status ID of the last patch request for this connection.
message This property is required. str
Message for the operation for the last patch request for this connection.
status This property is required. str
Operation status for the last patch request for this connection.
id This property is required. String
Operation status ID of the last patch request for this connection.
message This property is required. String
Message for the operation for the last patch request for this connection.
status This property is required. String
Operation status for the last patch request for this connection.

PipelineConnectionResponse

Etag This property is required. string
Connection etag inside pipeline
Id This property is required. string
Connection id inside pipeline
Location This property is required. string
Connection location inside pipeline
Name This property is required. string
Connection name inside pipeline
SystemData This property is required. Pulumi.AzureNative.AzureDataTransfer.Inputs.SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type This property is required. string
Connection type inside pipeline
Properties Pulumi.AzureNative.AzureDataTransfer.Inputs.PipelineConnectionResponseProperties
Connection properties inside pipeline
Etag This property is required. string
Connection etag inside pipeline
Id This property is required. string
Connection id inside pipeline
Location This property is required. string
Connection location inside pipeline
Name This property is required. string
Connection name inside pipeline
SystemData This property is required. SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type This property is required. string
Connection type inside pipeline
Properties PipelineConnectionResponseProperties
Connection properties inside pipeline
etag This property is required. String
Connection etag inside pipeline
id This property is required. String
Connection id inside pipeline
location This property is required. String
Connection location inside pipeline
name This property is required. String
Connection name inside pipeline
systemData This property is required. SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type This property is required. String
Connection type inside pipeline
properties PipelineConnectionResponseProperties
Connection properties inside pipeline
etag This property is required. string
Connection etag inside pipeline
id This property is required. string
Connection id inside pipeline
location This property is required. string
Connection location inside pipeline
name This property is required. string
Connection name inside pipeline
systemData This property is required. SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type This property is required. string
Connection type inside pipeline
properties PipelineConnectionResponseProperties
Connection properties inside pipeline
etag This property is required. str
Connection etag inside pipeline
id This property is required. str
Connection id inside pipeline
location This property is required. str
Connection location inside pipeline
name This property is required. str
Connection name inside pipeline
system_data This property is required. SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type This property is required. str
Connection type inside pipeline
properties PipelineConnectionResponseProperties
Connection properties inside pipeline
etag This property is required. String
Connection etag inside pipeline
id This property is required. String
Connection id inside pipeline
location This property is required. String
Connection location inside pipeline
name This property is required. String
Connection name inside pipeline
systemData This property is required. Property Map
Metadata pertaining to creation and last modification of the resource.
type This property is required. String
Connection type inside pipeline
properties Property Map
Connection properties inside pipeline

PipelineConnectionResponseProperties

InternalMetadata InternalMetadataPropertiesResponse
Internal metadata of the connection inside pipeline.
internalMetadata InternalMetadataPropertiesResponse
Internal metadata of the connection inside pipeline.
internalMetadata InternalMetadataPropertiesResponse
Internal metadata of the connection inside pipeline.
internal_metadata InternalMetadataPropertiesResponse
Internal metadata of the connection inside pipeline.
internalMetadata Property Map
Internal metadata of the connection inside pipeline.

PipelinePropertiesResponse

Connections This property is required. List<Pulumi.AzureNative.AzureDataTransfer.Inputs.PipelineConnectionResponse>
Connections associated with pipeline
ProvisioningState This property is required. string
Provisioning state of the pipeline
RemoteCloud This property is required. string
Remote cloud of the data to be transferred or received
DisplayName string
Display name of this pipeline
FlowTypes List<string>
The flow types allowed for this pipeline
Policies List<string>
The policies for this pipeline
Subscribers List<Pulumi.AzureNative.AzureDataTransfer.Inputs.SubscriberResponse>
Subscribers of this resource
Connections This property is required. []PipelineConnectionResponse
Connections associated with pipeline
ProvisioningState This property is required. string
Provisioning state of the pipeline
RemoteCloud This property is required. string
Remote cloud of the data to be transferred or received
DisplayName string
Display name of this pipeline
FlowTypes []string
The flow types allowed for this pipeline
Policies []string
The policies for this pipeline
Subscribers []SubscriberResponse
Subscribers of this resource
connections This property is required. List<PipelineConnectionResponse>
Connections associated with pipeline
provisioningState This property is required. String
Provisioning state of the pipeline
remoteCloud This property is required. String
Remote cloud of the data to be transferred or received
displayName String
Display name of this pipeline
flowTypes List<String>
The flow types allowed for this pipeline
policies List<String>
The policies for this pipeline
subscribers List<SubscriberResponse>
Subscribers of this resource
connections This property is required. PipelineConnectionResponse[]
Connections associated with pipeline
provisioningState This property is required. string
Provisioning state of the pipeline
remoteCloud This property is required. string
Remote cloud of the data to be transferred or received
displayName string
Display name of this pipeline
flowTypes string[]
The flow types allowed for this pipeline
policies string[]
The policies for this pipeline
subscribers SubscriberResponse[]
Subscribers of this resource
connections This property is required. Sequence[PipelineConnectionResponse]
Connections associated with pipeline
provisioning_state This property is required. str
Provisioning state of the pipeline
remote_cloud This property is required. str
Remote cloud of the data to be transferred or received
display_name str
Display name of this pipeline
flow_types Sequence[str]
The flow types allowed for this pipeline
policies Sequence[str]
The policies for this pipeline
subscribers Sequence[SubscriberResponse]
Subscribers of this resource
connections This property is required. List<Property Map>
Connections associated with pipeline
provisioningState This property is required. String
Provisioning state of the pipeline
remoteCloud This property is required. String
Remote cloud of the data to be transferred or received
displayName String
Display name of this pipeline
flowTypes List<String>
The flow types allowed for this pipeline
policies List<String>
The policies for this pipeline
subscribers List<Property Map>
Subscribers of this resource

SubscriberResponse

Email string
Email of the subscriber
Notifications double
Number specifying what notifications to receive
Email string
Email of the subscriber
Notifications float64
Number specifying what notifications to receive
email String
Email of the subscriber
notifications Double
Number specifying what notifications to receive
email string
Email of the subscriber
notifications number
Number specifying what notifications to receive
email str
Email of the subscriber
notifications float
Number specifying what notifications to receive
email String
Email of the subscriber
notifications Number
Number specifying what notifications to receive

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
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi