azure-native.web.Connection
Explore with Pulumi AI
API connection Azure REST API version: 2016-06-01. Prior API version in Azure Native 1.x: 2016-06-01
Example Usage
Replace a connection
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var connection = new AzureNative.Web.Connection("connection", new()
{
ConnectionName = "testManagedApi",
Properties = new AzureNative.Web.Inputs.ApiConnectionDefinitionPropertiesArgs
{
Api = new AzureNative.Web.Inputs.ApiReferenceArgs
{
Id = "/subscriptions/f34b22a3-2202-4fb1-b040-1332bd928c84/providers/Microsoft.Web/locations/centralus/managedApis/testManagedApi",
},
CustomParameterValues = null,
DisplayName = "testManagedApi",
ParameterValues = null,
},
ResourceGroupName = "testResourceGroup",
});
});
package main
import (
"github.com/pulumi/pulumi-azure-native-sdk/web/v2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := web.NewConnection(ctx, "connection", &web.ConnectionArgs{
ConnectionName: pulumi.String("testManagedApi"),
Properties: web.ApiConnectionDefinitionResponseProperties{
Api: &web.ApiReferenceArgs{
Id: pulumi.String("/subscriptions/f34b22a3-2202-4fb1-b040-1332bd928c84/providers/Microsoft.Web/locations/centralus/managedApis/testManagedApi"),
},
CustomParameterValues: nil,
DisplayName: pulumi.String("testManagedApi"),
ParameterValues: nil,
},
ResourceGroupName: pulumi.String("testResourceGroup"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.web.Connection;
import com.pulumi.azurenative.web.ConnectionArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var connection = new Connection("connection", ConnectionArgs.builder()
.connectionName("testManagedApi")
.properties(Map.ofEntries(
Map.entry("api", Map.of("id", "/subscriptions/f34b22a3-2202-4fb1-b040-1332bd928c84/providers/Microsoft.Web/locations/centralus/managedApis/testManagedApi")),
Map.entry("customParameterValues", ),
Map.entry("displayName", "testManagedApi"),
Map.entry("parameterValues", )
))
.resourceGroupName("testResourceGroup")
.build());
}
}
import pulumi
import pulumi_azure_native as azure_native
connection = azure_native.web.Connection("connection",
connection_name="testManagedApi",
properties=azure_native.web.ApiConnectionDefinitionResponsePropertiesArgs(
api=azure_native.web.ApiReferenceArgs(
id="/subscriptions/f34b22a3-2202-4fb1-b040-1332bd928c84/providers/Microsoft.Web/locations/centralus/managedApis/testManagedApi",
),
custom_parameter_values={},
display_name="testManagedApi",
parameter_values={},
),
resource_group_name="testResourceGroup")
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const connection = new azure_native.web.Connection("connection", {
connectionName: "testManagedApi",
properties: {
api: {
id: "/subscriptions/f34b22a3-2202-4fb1-b040-1332bd928c84/providers/Microsoft.Web/locations/centralus/managedApis/testManagedApi",
},
customParameterValues: {},
displayName: "testManagedApi",
parameterValues: {},
},
resourceGroupName: "testResourceGroup",
});
resources:
connection:
type: azure-native:web:Connection
properties:
connectionName: testManagedApi
properties:
api:
id: /subscriptions/f34b22a3-2202-4fb1-b040-1332bd928c84/providers/Microsoft.Web/locations/centralus/managedApis/testManagedApi
customParameterValues: {}
displayName: testManagedApi
parameterValues: {}
resourceGroupName: testResourceGroup
Create Connection Resource
new Connection(name: string, args: ConnectionArgs, opts?: CustomResourceOptions);
@overload
def Connection(resource_name: str,
opts: Optional[ResourceOptions] = None,
connection_name: Optional[str] = None,
location: Optional[str] = None,
properties: Optional[ApiConnectionDefinitionPropertiesArgs] = None,
resource_group_name: Optional[str] = None,
subscription_id: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None)
@overload
def Connection(resource_name: str,
args: ConnectionArgs,
opts: Optional[ResourceOptions] = None)
func NewConnection(ctx *Context, name string, args ConnectionArgs, opts ...ResourceOption) (*Connection, error)
public Connection(string name, ConnectionArgs args, CustomResourceOptions? opts = null)
public Connection(String name, ConnectionArgs args)
public Connection(String name, ConnectionArgs args, CustomResourceOptions options)
type: azure-native:web:Connection
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ConnectionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ConnectionArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ConnectionArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ConnectionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ConnectionArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Connection Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Connection resource accepts the following input properties:
- Resource
Group stringName The resource group
- Connection
Name string Connection name
- Location string
Resource location
- Properties
Pulumi.
Azure Native. Web. Inputs. Api Connection Definition Properties - Subscription
Id string Subscription Id
- Dictionary<string, string>
Resource tags
- Resource
Group stringName The resource group
- Connection
Name string Connection name
- Location string
Resource location
- Properties
Api
Connection Definition Properties Args - Subscription
Id string Subscription Id
- map[string]string
Resource tags
- resource
Group StringName The resource group
- connection
Name String Connection name
- location String
Resource location
- properties
Api
Connection Definition Properties - subscription
Id String Subscription Id
- Map<String,String>
Resource tags
- resource
Group stringName The resource group
- connection
Name string Connection name
- location string
Resource location
- properties
Api
Connection Definition Properties - subscription
Id string Subscription Id
- {[key: string]: string}
Resource tags
- resource_
group_ strname The resource group
- connection_
name str Connection name
- location str
Resource location
- properties
Api
Connection Definition Properties Args - subscription_
id str Subscription Id
- Mapping[str, str]
Resource tags
- resource
Group StringName The resource group
- connection
Name String Connection name
- location String
Resource location
- properties Property Map
- subscription
Id String Subscription Id
- Map<String>
Resource tags
Outputs
All input properties are implicitly available as output properties. Additionally, the Connection resource produces the following output properties:
Supporting Types
ApiConnectionDefinitionProperties, ApiConnectionDefinitionPropertiesArgs
- Api
Pulumi.
Azure Native. Web. Inputs. Api Reference - 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> Status of the connection
- Test
Links List<Pulumi.Azure Native. Web. Inputs. Api Connection Test Link> Links to test the API connection
- Api
Api
Reference - 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 Status of the connection
- Test
Links []ApiConnection Test Link Links to test the API connection
- api
Api
Reference - 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> Status of the connection
- test
Links List<ApiConnection Test Link> Links to test the API connection
- api
Api
Reference - 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[] Status of the connection
- test
Links ApiConnection Test Link[] Links to test the API connection
- api
Api
Reference - 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] Status of the connection
- test_
links Sequence[ApiConnection Test Link] 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
ApiConnectionDefinitionResponseProperties, ApiConnectionDefinitionResponsePropertiesArgs
- 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
ApiConnectionTestLink, ApiConnectionTestLinkArgs
- 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
ApiConnectionTestLinkResponse, ApiConnectionTestLinkResponseArgs
- 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
ApiReference, ApiReferenceArgs
- 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
ApiReferenceResponse, ApiReferenceResponseArgs
- 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
ConnectionError, ConnectionErrorArgs
ConnectionErrorResponse, ConnectionErrorResponseArgs
ConnectionStatusDefinition, ConnectionStatusDefinitionArgs
- Error
Pulumi.
Azure Native. Web. Inputs. Connection Error Connection error
- Status string
The gateway status
- Target string
Target of the error
- Error
Connection
Error Connection error
- Status string
The gateway status
- Target string
Target of the error
- error
Connection
Error Connection error
- status String
The gateway status
- target String
Target of the error
- error
Connection
Error Connection error
- status string
The gateway status
- target string
Target of the error
- error
Connection
Error 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
ConnectionStatusDefinitionResponse, ConnectionStatusDefinitionResponseArgs
- 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
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:web:Connection testManagedApi-1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/connections/{connectionName}
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0