azure-native.azuredatatransfer.getConnection
Explore with Pulumi AI
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 dictionaryThe following arguments are supported:
- Connection
Name string - The name for the connection that is to be requested.
 - Resource
Group stringName  - The name of the resource group. The name is case insensitive.
 
- Connection
Name string - The name for the connection that is to be requested.
 - Resource
Group stringName  - The name of the resource group. The name is case insensitive.
 
- connection
Name String - The name for the connection that is to be requested.
 - resource
Group StringName  - The name of the resource group. The name is case insensitive.
 
- connection
Name string - The name for the connection that is to be requested.
 - resource
Group stringName  - 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_ strname  - The name of the resource group. The name is case insensitive.
 
- connection
Name String - The name for the connection that is to be requested.
 - resource
Group StringName  - The name of the resource group. The name is case insensitive.
 
getConnection Result
The following output properties are available:
- Azure
Api stringVersion  - 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.
Azure Native. Azure Data Transfer. Outputs. Connection Properties Response  - Properties of connection
 - System
Data Pulumi.Azure Native. Azure Data Transfer. 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"
 - Dictionary<string, string>
 - Resource tags.
 
- Azure
Api stringVersion  - 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
Connection
Properties Response  - Properties of connection
 - 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"
 - map[string]string
 - Resource tags.
 
- azure
Api StringVersion  - 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
Connection
Properties Response  - Properties of connection
 - 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"
 - Map<String,String>
 - Resource tags.
 
- azure
Api stringVersion  - 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
Connection
Properties Response  - Properties of connection
 - 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"
 - {[key: string]: string}
 - Resource tags.
 
- azure_
api_ strversion  - 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
Connection
Properties Response  - Properties of connection
 - 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"
 - Mapping[str, str]
 - Resource tags.
 
- azure
Api StringVersion  - 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
 - 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"
 - Map<String>
 - Resource tags.
 
Supporting Types
ConnectionPropertiesResponse  
- Approver string
 - Approver of this connection request
 - Date
Submitted string - The timestamp that this connection request was submitted at
 - Link
Status string - Link status of the current connection
 - Linked
Connection stringId  - Resource ID of the linked connection
 - Pipeline string
 - Pipeline to use to transfer data
 - Provisioning
State string - Provisioning state of the connection
 - Status string
 - Status of the connection
 - Status
Reason string - Reason for status
 - Direction string
 - Direction of data movement
 - Flow
Types 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
 - Primary
Contact string - The primary contact for this connection request
 - Remote
Subscription stringId  - Subscription ID to link cloud subscriptions together
 - Requirement
Id string - Requirement ID of the connection
 - Schema
Uris List<string> - The schema URIs for this connection
 - Schemas
List<Pulumi.
Azure Native. Azure Data Transfer. Inputs. Schema Response>  - The schemas for this connection
 - Secondary
Contacts List<string> - The secondary contacts for this connection request
 
- Approver string
 - Approver of this connection request
 - Date
Submitted string - The timestamp that this connection request was submitted at
 - Link
Status string - Link status of the current connection
 - Linked
Connection stringId  - Resource ID of the linked connection
 - Pipeline string
 - Pipeline to use to transfer data
 - Provisioning
State string - Provisioning state of the connection
 - Status string
 - Status of the connection
 - Status
Reason string - Reason for status
 - Direction string
 - Direction of data movement
 - Flow
Types []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
 - Primary
Contact string - The primary contact for this connection request
 - Remote
Subscription stringId  - Subscription ID to link cloud subscriptions together
 - Requirement
Id string - Requirement ID of the connection
 - Schema
Uris []string - The schema URIs for this connection
 - Schemas
[]Schema
Response  - The schemas for this connection
 - Secondary
Contacts []string - The secondary contacts for this connection request
 
- approver String
 - Approver of this connection request
 - date
Submitted String - The timestamp that this connection request was submitted at
 - link
Status String - Link status of the current connection
 - linked
Connection StringId  - Resource ID of the linked connection
 - pipeline String
 - Pipeline to use to transfer data
 - provisioning
State String - Provisioning state of the connection
 - status String
 - Status of the connection
 - status
Reason String - Reason for status
 - direction String
 - Direction of data movement
 - flow
Types 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
 - primary
Contact String - The primary contact for this connection request
 - remote
Subscription StringId  - Subscription ID to link cloud subscriptions together
 - requirement
Id String - Requirement ID of the connection
 - schema
Uris List<String> - The schema URIs for this connection
 - schemas
List<Schema
Response>  - The schemas for this connection
 - secondary
Contacts List<String> - The secondary contacts for this connection request
 
- approver string
 - Approver of this connection request
 - date
Submitted string - The timestamp that this connection request was submitted at
 - link
Status string - Link status of the current connection
 - linked
Connection stringId  - Resource ID of the linked connection
 - pipeline string
 - Pipeline to use to transfer data
 - provisioning
State string - Provisioning state of the connection
 - status string
 - Status of the connection
 - status
Reason string - Reason for status
 - direction string
 - Direction of data movement
 - flow
Types 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
 - primary
Contact string - The primary contact for this connection request
 - remote
Subscription stringId  - Subscription ID to link cloud subscriptions together
 - requirement
Id string - Requirement ID of the connection
 - schema
Uris string[] - The schema URIs for this connection
 - schemas
Schema
Response[]  - The schemas for this connection
 - secondary
Contacts 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_ strid  - 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_ strid  - 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[Schema
Response]  - The schemas for this connection
 - secondary_
contacts Sequence[str] - The secondary contacts for this connection request
 
- approver String
 - Approver of this connection request
 - date
Submitted String - The timestamp that this connection request was submitted at
 - link
Status String - Link status of the current connection
 - linked
Connection StringId  - Resource ID of the linked connection
 - pipeline String
 - Pipeline to use to transfer data
 - provisioning
State String - Provisioning state of the connection
 - status String
 - Status of the connection
 - status
Reason String - Reason for status
 - direction String
 - Direction of data movement
 - flow
Types 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
 - primary
Contact String - The primary contact for this connection request
 - remote
Subscription StringId  - Subscription ID to link cloud subscriptions together
 - requirement
Id String - Requirement ID of the connection
 - schema
Uris List<String> - The schema URIs for this connection
 - schemas List<Property Map>
 - The schemas for this connection
 - secondary
Contacts List<String> - The secondary contacts for this connection request
 
SchemaResponse 
- Connection
Id 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
 - Schema
Type string - The Schema Type
 - Schema
Uri string - Uri containing SAS token for the zipped schema
 - Status string
 - Status of the schema
 
- Connection
Id 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
 - Schema
Type string - The Schema Type
 - Schema
Uri string - Uri containing SAS token for the zipped schema
 - Status string
 - Status of the schema
 
- connection
Id 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
 - schema
Type String - The Schema Type
 - schema
Uri String - Uri containing SAS token for the zipped schema
 - status String
 - Status of the schema
 
- connection
Id 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
 - schema
Type string - The Schema Type
 - schema
Uri 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
 
- connection
Id 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
 - schema
Type String - The Schema Type
 - schema
Uri String - Uri containing SAS token for the zipped schema
 - status String
 - Status of the schema
 
SystemDataResponse  
- 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.
 
Package Details
- Repository
 - Azure Native pulumi/pulumi-azure-native
 - License
 - Apache-2.0