Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. azuredatatransfer
  5. getConnection
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.3.0 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.azuredatatransfer.getConnection

Explore with Pulumi AI

azure-native logo
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.3.0 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-azure-native

    Gets connection 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 getConnection

    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 getConnection(args: GetConnectionArgs, opts?: InvokeOptions): Promise<GetConnectionResult>
function getConnectionOutput(args: GetConnectionOutputArgs, opts?: InvokeOptions): Output<GetConnectionResult>
    def get_connection(connection_name: Optional[str] = None,
                   resource_group_name: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetConnectionResult
def get_connection_output(connection_name: Optional[pulumi.Input[str]] = None,
                   resource_group_name: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetConnectionResult]
    func LookupConnection(ctx *Context, args *LookupConnectionArgs, opts ...InvokeOption) (*LookupConnectionResult, error)
func LookupConnectionOutput(ctx *Context, args *LookupConnectionOutputArgs, opts ...InvokeOption) LookupConnectionResultOutput

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

    public static class GetConnection 
{
    public static Task<GetConnectionResult> InvokeAsync(GetConnectionArgs args, InvokeOptions? opts = null)
    public static Output<GetConnectionResult> Invoke(GetConnectionInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetConnectionResult> getConnection(GetConnectionArgs args, InvokeOptions options)
public static Output<GetConnectionResult> getConnection(GetConnectionArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:azuredatatransfer:getConnection
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ConnectionName string
    The name for the connection that is to be requested.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ConnectionName string
    The name for the connection that is to be requested.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    connectionName String
    The name for the connection that is to be requested.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    connectionName string
    The name for the connection that is to be requested.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    connection_name str
    The name for the connection that is to be requested.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    connectionName String
    The name for the connection that is to be requested.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getConnection 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.ConnectionPropertiesResponse
    Properties of connection
    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 ConnectionPropertiesResponse
    Properties of connection
    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 ConnectionPropertiesResponse
    Properties of connection
    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 ConnectionPropertiesResponse
    Properties of connection
    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 ConnectionPropertiesResponse
    Properties of connection
    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 connection
    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

    ConnectionPropertiesResponse

    Approver string
    Approver of this connection request
    DateSubmitted string
    The timestamp that this connection request was submitted at
    LinkStatus string
    Link status of the current connection
    LinkedConnectionId string
    Resource ID of the linked connection
    Pipeline string
    Pipeline to use to transfer data
    ProvisioningState string
    Provisioning state of the connection
    Status string
    Status of the connection
    StatusReason string
    Reason for status
    Direction string
    Direction of data movement
    FlowTypes List<string>
    The flow types being requested for this connection
    Justification string
    Justification for the connection request
    Pin string
    PIN to link requests together
    Policies List<string>
    The policies for this connection
    PrimaryContact string
    The primary contact for this connection request
    RemoteSubscriptionId string
    Subscription ID to link cloud subscriptions together
    RequirementId string
    Requirement ID of the connection
    SchemaUris List<string>
    The schema URIs for this connection
    Schemas List<Pulumi.AzureNative.AzureDataTransfer.Inputs.SchemaResponse>
    The schemas for this connection
    SecondaryContacts List<string>
    The secondary contacts for this connection request
    Approver string
    Approver of this connection request
    DateSubmitted string
    The timestamp that this connection request was submitted at
    LinkStatus string
    Link status of the current connection
    LinkedConnectionId string
    Resource ID of the linked connection
    Pipeline string
    Pipeline to use to transfer data
    ProvisioningState string
    Provisioning state of the connection
    Status string
    Status of the connection
    StatusReason string
    Reason for status
    Direction string
    Direction of data movement
    FlowTypes []string
    The flow types being requested for this connection
    Justification string
    Justification for the connection request
    Pin string
    PIN to link requests together
    Policies []string
    The policies for this connection
    PrimaryContact string
    The primary contact for this connection request
    RemoteSubscriptionId string
    Subscription ID to link cloud subscriptions together
    RequirementId string
    Requirement ID of the connection
    SchemaUris []string
    The schema URIs for this connection
    Schemas []SchemaResponse
    The schemas for this connection
    SecondaryContacts []string
    The secondary contacts for this connection request
    approver String
    Approver of this connection request
    dateSubmitted String
    The timestamp that this connection request was submitted at
    linkStatus String
    Link status of the current connection
    linkedConnectionId String
    Resource ID of the linked connection
    pipeline String
    Pipeline to use to transfer data
    provisioningState String
    Provisioning state of the connection
    status String
    Status of the connection
    statusReason String
    Reason for status
    direction String
    Direction of data movement
    flowTypes List<String>
    The flow types being requested for this connection
    justification String
    Justification for the connection request
    pin String
    PIN to link requests together
    policies List<String>
    The policies for this connection
    primaryContact String
    The primary contact for this connection request
    remoteSubscriptionId String
    Subscription ID to link cloud subscriptions together
    requirementId String
    Requirement ID of the connection
    schemaUris List<String>
    The schema URIs for this connection
    schemas List<SchemaResponse>
    The schemas for this connection
    secondaryContacts List<String>
    The secondary contacts for this connection request
    approver string
    Approver of this connection request
    dateSubmitted string
    The timestamp that this connection request was submitted at
    linkStatus string
    Link status of the current connection
    linkedConnectionId string
    Resource ID of the linked connection
    pipeline string
    Pipeline to use to transfer data
    provisioningState string
    Provisioning state of the connection
    status string
    Status of the connection
    statusReason string
    Reason for status
    direction string
    Direction of data movement
    flowTypes string[]
    The flow types being requested for this connection
    justification string
    Justification for the connection request
    pin string
    PIN to link requests together
    policies string[]
    The policies for this connection
    primaryContact string
    The primary contact for this connection request
    remoteSubscriptionId string
    Subscription ID to link cloud subscriptions together
    requirementId string
    Requirement ID of the connection
    schemaUris string[]
    The schema URIs for this connection
    schemas SchemaResponse[]
    The schemas for this connection
    secondaryContacts string[]
    The secondary contacts for this connection request
    approver str
    Approver of this connection request
    date_submitted str
    The timestamp that this connection request was submitted at
    link_status str
    Link status of the current connection
    linked_connection_id str
    Resource ID of the linked connection
    pipeline str
    Pipeline to use to transfer data
    provisioning_state str
    Provisioning state of the connection
    status str
    Status of the connection
    status_reason str
    Reason for status
    direction str
    Direction of data movement
    flow_types Sequence[str]
    The flow types being requested for this connection
    justification str
    Justification for the connection request
    pin str
    PIN to link requests together
    policies Sequence[str]
    The policies for this connection
    primary_contact str
    The primary contact for this connection request
    remote_subscription_id str
    Subscription ID to link cloud subscriptions together
    requirement_id str
    Requirement ID of the connection
    schema_uris Sequence[str]
    The schema URIs for this connection
    schemas Sequence[SchemaResponse]
    The schemas for this connection
    secondary_contacts Sequence[str]
    The secondary contacts for this connection request
    approver String
    Approver of this connection request
    dateSubmitted String
    The timestamp that this connection request was submitted at
    linkStatus String
    Link status of the current connection
    linkedConnectionId String
    Resource ID of the linked connection
    pipeline String
    Pipeline to use to transfer data
    provisioningState String
    Provisioning state of the connection
    status String
    Status of the connection
    statusReason String
    Reason for status
    direction String
    Direction of data movement
    flowTypes List<String>
    The flow types being requested for this connection
    justification String
    Justification for the connection request
    pin String
    PIN to link requests together
    policies List<String>
    The policies for this connection
    primaryContact String
    The primary contact for this connection request
    remoteSubscriptionId String
    Subscription ID to link cloud subscriptions together
    requirementId String
    Requirement ID of the connection
    schemaUris List<String>
    The schema URIs for this connection
    schemas List<Property Map>
    The schemas for this connection
    secondaryContacts List<String>
    The secondary contacts for this connection request

    SchemaResponse

    ConnectionId string
    Connection ID associated with this schema
    Content string
    Content of the schema
    Direction string
    The direction of the schema.
    Id string
    ID associated with this schema
    Name string
    Name of the schema
    SchemaType string
    The Schema Type
    SchemaUri string
    Uri containing SAS token for the zipped schema
    Status string
    Status of the schema
    ConnectionId string
    Connection ID associated with this schema
    Content string
    Content of the schema
    Direction string
    The direction of the schema.
    Id string
    ID associated with this schema
    Name string
    Name of the schema
    SchemaType string
    The Schema Type
    SchemaUri string
    Uri containing SAS token for the zipped schema
    Status string
    Status of the schema
    connectionId String
    Connection ID associated with this schema
    content String
    Content of the schema
    direction String
    The direction of the schema.
    id String
    ID associated with this schema
    name String
    Name of the schema
    schemaType String
    The Schema Type
    schemaUri String
    Uri containing SAS token for the zipped schema
    status String
    Status of the schema
    connectionId string
    Connection ID associated with this schema
    content string
    Content of the schema
    direction string
    The direction of the schema.
    id string
    ID associated with this schema
    name string
    Name of the schema
    schemaType string
    The Schema Type
    schemaUri string
    Uri containing SAS token for the zipped schema
    status string
    Status of the schema
    connection_id str
    Connection ID associated with this schema
    content str
    Content of the schema
    direction str
    The direction of the schema.
    id str
    ID associated with this schema
    name str
    Name of the schema
    schema_type str
    The Schema Type
    schema_uri str
    Uri containing SAS token for the zipped schema
    status str
    Status of the schema
    connectionId String
    Connection ID associated with this schema
    content String
    Content of the schema
    direction String
    The direction of the schema.
    id String
    ID associated with this schema
    name String
    Name of the schema
    schemaType String
    The Schema Type
    schemaUri String
    Uri containing SAS token for the zipped schema
    status String
    Status of the schema

    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 v2 docs if using the v2 version of this package.
    Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi
    pulumi/pulumi-azure-native