Azure Native v2 v2.90.0, Mar 27 25

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.

Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

azure-native-v2.web.getConnection

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.

Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

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.

TypeScript
Python
Go
C#
Java
YAML

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,
                   subscription_id: 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,
                   subscription_id: 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:web:getConnection
  arguments:
    # arguments dictionary

The following arguments are supported:

ConnectionName string: Connection name
ResourceGroupName string: The resource group
SubscriptionId string: Subscription Id

ConnectionName string: Connection name
ResourceGroupName string: The resource group
SubscriptionId string: Subscription Id

connectionName String: Connection name
resourceGroupName String: The resource group
subscriptionId String: Subscription Id

connectionName string: Connection name
resourceGroupName string: The resource group
subscriptionId string: Subscription Id

connection_name str: Connection name
resource_group_name str: The resource group
subscription_id str: Subscription Id

connectionName String: Connection name
resourceGroupName String: The resource group
subscriptionId String: Subscription Id

getConnection Result

The following output properties are available:

Id string: Resource id
Name string: Resource name
Properties Pulumi.AzureNative.Web.Outputs.ApiConnectionDefinitionResponseProperties
Type string: Resource type
Etag string: Resource ETag
Location string: Resource location
Tags Dictionary<string, string>: Resource tags

Id string: Resource id
Name string: Resource name
Properties ApiConnectionDefinitionResponseProperties
Type string: Resource type
Etag string: Resource ETag
Location string: Resource location
Tags map[string]string: Resource tags

id String: Resource id
name String: Resource name
properties ApiConnectionDefinitionResponseProperties
type String: Resource type
etag String: Resource ETag
location String: Resource location
tags Map<String,String>: Resource tags

id string: Resource id
name string: Resource name
properties ApiConnectionDefinitionResponseProperties
type string: Resource type
etag string: Resource ETag
location string: Resource location
tags {[key: string]: string}: Resource tags

id str: Resource id
name str: Resource name
properties ApiConnectionDefinitionResponseProperties
type str: Resource type
etag str: Resource ETag
location str: Resource location
tags Mapping[str, str]: Resource tags

id String: Resource id
name String: Resource name
properties Property Map
type String: Resource type
etag String: Resource ETag
location String: Resource location
tags Map<String>: Resource tags

Supporting Types

ApiConnectionDefinitionResponseProperties

Api Pulumi.AzureNative.Web.Inputs.ApiReferenceResponse
ChangedTime string: Timestamp of last connection change
CreatedTime string: Timestamp of the connection creation
CustomParameterValues Dictionary<string, string>: Dictionary of custom parameter values
DisplayName string: Display name
NonSecretParameterValues Dictionary<string, string>: Dictionary of nonsecret parameter values
ParameterValues Dictionary<string, string>: Dictionary of parameter values
Statuses List<Pulumi.AzureNative.Web.Inputs.ConnectionStatusDefinitionResponse>: Status of the connection
TestLinks List<Pulumi.AzureNative.Web.Inputs.ApiConnectionTestLinkResponse>: Links to test the API connection

Api ApiReferenceResponse
ChangedTime string: Timestamp of last connection change
CreatedTime string: Timestamp of the connection creation
CustomParameterValues map[string]string: Dictionary of custom parameter values
DisplayName string: Display name
NonSecretParameterValues map[string]string: Dictionary of nonsecret parameter values
ParameterValues map[string]string: Dictionary of parameter values
Statuses []ConnectionStatusDefinitionResponse: Status of the connection
TestLinks []ApiConnectionTestLinkResponse: Links to test the API connection

api ApiReferenceResponse
changedTime String: Timestamp of last connection change
createdTime String: Timestamp of the connection creation
customParameterValues Map<String,String>: Dictionary of custom parameter values
displayName String: Display name
nonSecretParameterValues Map<String,String>: Dictionary of nonsecret parameter values
parameterValues Map<String,String>: Dictionary of parameter values
statuses List<ConnectionStatusDefinitionResponse>: Status of the connection
testLinks List<ApiConnectionTestLinkResponse>: Links to test the API connection

api ApiReferenceResponse
changedTime string: Timestamp of last connection change
createdTime string: Timestamp of the connection creation
customParameterValues {[key: string]: string}: Dictionary of custom parameter values
displayName string: Display name
nonSecretParameterValues {[key: string]: string}: Dictionary of nonsecret parameter values
parameterValues {[key: string]: string}: Dictionary of parameter values
statuses ConnectionStatusDefinitionResponse[]: Status of the connection
testLinks ApiConnectionTestLinkResponse[]: Links to test the API connection

api ApiReferenceResponse
changed_time str: Timestamp of last connection change
created_time str: Timestamp of the connection creation
custom_parameter_values Mapping[str, str]: Dictionary of custom parameter values
display_name str: Display name
non_secret_parameter_values Mapping[str, str]: Dictionary of nonsecret parameter values
parameter_values Mapping[str, str]: Dictionary of parameter values
statuses Sequence[ConnectionStatusDefinitionResponse]: Status of the connection
test_links Sequence[ApiConnectionTestLinkResponse]: Links to test the API connection

api Property Map
changedTime String: Timestamp of last connection change
createdTime String: Timestamp of the connection creation
customParameterValues Map<String>: Dictionary of custom parameter values
displayName String: Display name
nonSecretParameterValues Map<String>: Dictionary of nonsecret parameter values
parameterValues Map<String>: Dictionary of parameter values
statuses List<Property Map>: Status of the connection
testLinks List<Property Map>: Links to test the API connection

ApiConnectionTestLinkResponse

Method string: HTTP Method
RequestUri string: Test link request URI

Method string: HTTP Method
RequestUri string: Test link request URI

method String: HTTP Method
requestUri String: Test link request URI

method string: HTTP Method
requestUri string: Test link request URI

method str: HTTP Method
request_uri str: Test link request URI

method String: HTTP Method
requestUri String: Test link request URI

ApiReferenceResponse

BrandColor string: Brand color
Description string: The custom API description
DisplayName string: The display name
IconUri string: The icon URI
Id string: Resource reference id
Name string: The name of the API
Swagger object: The JSON representation of the swagger
Type string: Resource reference type

BrandColor string: Brand color
Description string: The custom API description
DisplayName string: The display name
IconUri string: The icon URI
Id string: Resource reference id
Name string: The name of the API
Swagger interface{}: The JSON representation of the swagger
Type string: Resource reference type

brandColor String: Brand color
description String: The custom API description
displayName String: The display name
iconUri String: The icon URI
id String: Resource reference id
name String: The name of the API
swagger Object: The JSON representation of the swagger
type String: Resource reference type

brandColor string: Brand color
description string: The custom API description
displayName string: The display name
iconUri string: The icon URI
id string: Resource reference id
name string: The name of the API
swagger any: The JSON representation of the swagger
type string: Resource reference type

brand_color str: Brand color
description str: The custom API description
display_name str: The display name
icon_uri str: The icon URI
id str: Resource reference id
name str: The name of the API
swagger Any: The JSON representation of the swagger
type str: Resource reference type

brandColor String: Brand color
description String: The custom API description
displayName String: The display name
iconUri String: The icon URI
id String: Resource reference id
name String: The name of the API
swagger Any: The JSON representation of the swagger
type String: Resource reference type

ConnectionErrorResponse

Id string: Resource id
Name string: Resource name
Type string: Resource type
Code string: Code of the status
Etag string: Resource ETag
Location string: Resource location
Message string: Description of the status
Tags Dictionary<string, string>: Resource tags

Id string: Resource id
Name string: Resource name
Type string: Resource type
Code string: Code of the status
Etag string: Resource ETag
Location string: Resource location
Message string: Description of the status
Tags map[string]string: Resource tags

id String: Resource id
name String: Resource name
type String: Resource type
code String: Code of the status
etag String: Resource ETag
location String: Resource location
message String: Description of the status
tags Map<String,String>: Resource tags

id string: Resource id
name string: Resource name
type string: Resource type
code string: Code of the status
etag string: Resource ETag
location string: Resource location
message string: Description of the status
tags {[key: string]: string}: Resource tags

id str: Resource id
name str: Resource name
type str: Resource type
code str: Code of the status
etag str: Resource ETag
location str: Resource location
message str: Description of the status
tags Mapping[str, str]: Resource tags

id String: Resource id
name String: Resource name
type String: Resource type
code String: Code of the status
etag String: Resource ETag
location String: Resource location
message String: Description of the status
tags Map<String>: Resource tags

ConnectionStatusDefinitionResponse

Error Pulumi.AzureNative.Web.Inputs.ConnectionErrorResponse: Connection error
Status string: The gateway status
Target string: Target of the error

Error ConnectionErrorResponse: Connection error
Status string: The gateway status
Target string: Target of the error

error ConnectionErrorResponse: Connection error
status String: The gateway status
target String: Target of the error

error ConnectionErrorResponse: Connection error
status string: The gateway status
target string: Target of the error

error ConnectionErrorResponse: Connection error
status str: The gateway status
target str: Target of the error

error Property Map: Connection error
status String: The gateway status
target String: Target of the error

Package Details

Repository: azure-native-v2 pulumi/pulumi-azure-native
License: Apache-2.0

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.

Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

pulumi/pulumi-azure-native

azure-native-v2.web.getConnection

On this page

On this page

Using getConnection

getConnection Result

Supporting Types

ApiConnectionDefinitionResponseProperties

ApiConnectionTestLinkResponse

ApiReferenceResponse

ConnectionErrorResponse

ConnectionStatusDefinitionResponse

Package Details

On this page

On this page