azure-native.web.getConnection
Explore with Pulumi AI
Get a specific connection Azure REST API version: 2016-06-01.
Other available API versions: 2015-08-01-preview.
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,
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)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure-native:web:getConnection
arguments:
# arguments dictionary
The following arguments are supported:
- Connection
Name string Connection name
- Resource
Group stringName The resource group
- Subscription
Id string Subscription Id
- Connection
Name string Connection name
- Resource
Group stringName The resource group
- Subscription
Id string Subscription Id
- connection
Name String Connection name
- resource
Group StringName The resource group
- subscription
Id String Subscription Id
- connection
Name string Connection name
- resource
Group stringName The resource group
- subscription
Id string Subscription Id
- connection_
name str Connection name
- resource_
group_ strname The resource group
- subscription_
id str Subscription Id
- connection
Name String Connection name
- resource
Group StringName The resource group
- subscription
Id String Subscription Id
getConnection Result
The following output properties are available:
- Id string
Resource id
- Name string
Resource name
- Properties
Pulumi.
Azure Native. Web. Outputs. Api Connection Definition Response Properties - Type string
Resource type
- Etag string
Resource ETag
- Location string
Resource location
- Dictionary<string, string>
Resource tags
- Id string
Resource id
- Name string
Resource name
- Properties
Api
Connection Definition Response Properties - Type string
Resource type
- Etag string
Resource ETag
- Location string
Resource location
- map[string]string
Resource tags
- id String
Resource id
- name String
Resource name
- properties
Api
Connection Definition Response Properties - type String
Resource type
- etag String
Resource ETag
- location String
Resource location
- Map<String,String>
Resource tags
- id string
Resource id
- name string
Resource name
- properties
Api
Connection Definition Response Properties - type string
Resource type
- etag string
Resource ETag
- location string
Resource location
- {[key: string]: string}
Resource tags
- id str
Resource id
- name str
Resource name
- properties
Api
Connection Definition Response Properties - type str
Resource type
- etag str
Resource ETag
- location str
Resource location
- 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
- Map<String>
Resource tags
Supporting Types
ApiConnectionDefinitionResponseProperties
- Api
Pulumi.
Azure Native. Web. Inputs. Api Reference Response - Changed
Time string Timestamp of last connection change
- Created
Time string Timestamp of the connection creation
- Custom
Parameter Dictionary<string, string>Values Dictionary of custom parameter values
- Display
Name string Display name
- Non
Secret Dictionary<string, string>Parameter Values Dictionary of nonsecret parameter values
- Parameter
Values Dictionary<string, string> Dictionary of parameter values
- Statuses
List<Pulumi.
Azure Native. Web. Inputs. Connection Status Definition Response> Status of the connection
- Test
Links List<Pulumi.Azure Native. Web. Inputs. Api Connection Test Link Response> Links to test the API connection
- Api
Api
Reference Response - Changed
Time string Timestamp of last connection change
- Created
Time string Timestamp of the connection creation
- Custom
Parameter map[string]stringValues Dictionary of custom parameter values
- Display
Name string Display name
- Non
Secret map[string]stringParameter Values Dictionary of nonsecret parameter values
- Parameter
Values map[string]string Dictionary of parameter values
- Statuses
[]Connection
Status Definition Response Status of the connection
- Test
Links []ApiConnection Test Link Response Links to test the API connection
- api
Api
Reference Response - changed
Time String Timestamp of last connection change
- created
Time String Timestamp of the connection creation
- custom
Parameter Map<String,String>Values Dictionary of custom parameter values
- display
Name String Display name
- non
Secret Map<String,String>Parameter Values Dictionary of nonsecret parameter values
- parameter
Values Map<String,String> Dictionary of parameter values
- statuses
List<Connection
Status Definition Response> Status of the connection
- test
Links List<ApiConnection Test Link Response> Links to test the API connection
- api
Api
Reference Response - changed
Time string Timestamp of last connection change
- created
Time string Timestamp of the connection creation
- custom
Parameter {[key: string]: string}Values Dictionary of custom parameter values
- display
Name string Display name
- non
Secret {[key: string]: string}Parameter Values Dictionary of nonsecret parameter values
- parameter
Values {[key: string]: string} Dictionary of parameter values
- statuses
Connection
Status Definition Response[] Status of the connection
- test
Links ApiConnection Test Link Response[] Links to test the API connection
- api
Api
Reference Response - changed_
time str Timestamp of last connection change
- created_
time str Timestamp of the connection creation
- custom_
parameter_ Mapping[str, str]values Dictionary of custom parameter values
- display_
name str Display name
- non_
secret_ Mapping[str, str]parameter_ values Dictionary of nonsecret parameter values
- parameter_
values Mapping[str, str] Dictionary of parameter values
- statuses
Sequence[Connection
Status Definition Response] Status of the connection
- test_
links Sequence[ApiConnection Test Link Response] Links to test the API connection
- api Property Map
- changed
Time String Timestamp of last connection change
- created
Time String Timestamp of the connection creation
- custom
Parameter Map<String>Values Dictionary of custom parameter values
- display
Name String Display name
- non
Secret Map<String>Parameter Values Dictionary of nonsecret parameter values
- parameter
Values Map<String> Dictionary of parameter values
- statuses List<Property Map>
Status of the connection
- test
Links List<Property Map> Links to test the API connection
ApiConnectionTestLinkResponse
- Method string
HTTP Method
- Request
Uri string Test link request URI
- Method string
HTTP Method
- Request
Uri string Test link request URI
- method String
HTTP Method
- request
Uri String Test link request URI
- method string
HTTP Method
- request
Uri string Test link request URI
- method str
HTTP Method
- request_
uri str Test link request URI
- method String
HTTP Method
- request
Uri String Test link request URI
ApiReferenceResponse
- Brand
Color string Brand color
- Description string
The custom API description
- Display
Name string The display name
- Icon
Uri 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
- Brand
Color string Brand color
- Description string
The custom API description
- Display
Name string The display name
- Icon
Uri 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
- brand
Color String Brand color
- description String
The custom API description
- display
Name String The display name
- icon
Uri 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
- brand
Color string Brand color
- description string
The custom API description
- display
Name string The display name
- icon
Uri 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
- brand
Color String Brand color
- description String
The custom API description
- display
Name String The display name
- icon
Uri 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
ConnectionStatusDefinitionResponse
- Error
Pulumi.
Azure Native. Web. Inputs. Connection Error Response Connection error
- Status string
The gateway status
- Target string
Target of the error
- Error
Connection
Error Response Connection error
- Status string
The gateway status
- Target string
Target of the error
- error
Connection
Error Response Connection error
- status String
The gateway status
- target String
Target of the error
- error
Connection
Error Response Connection error
- status string
The gateway status
- target string
Target of the error
- error
Connection
Error Response 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 pulumi/pulumi-azure-native
- License
- Apache-2.0