Azure Native v1.98.1, Mar 24 23

azure-native.web.Connection

API connection API Version: 2016-06-01.

Example Usage

Replace a connection

using System.Collections.Generic;
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 (
	web "github.com/pulumi/pulumi-azure-native/sdk/go/azure/web"
	"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:

ResourceGroupName string: The resource group
ConnectionName string: Connection name
Location string: Resource location
Properties Pulumi.AzureNative.Web.Inputs.ApiConnectionDefinitionPropertiesArgs
SubscriptionId string: Subscription Id
Tags Dictionary<string, string>: Resource tags

ResourceGroupName string: The resource group
ConnectionName string: Connection name
Location string: Resource location
Properties ApiConnectionDefinitionPropertiesArgs
SubscriptionId string: Subscription Id
Tags map[string]string: Resource tags

resourceGroupName String: The resource group
connectionName String: Connection name
location String: Resource location
properties ApiConnectionDefinitionPropertiesArgs
subscriptionId String: Subscription Id
tags Map<String,String>: Resource tags

resourceGroupName string: The resource group
connectionName string: Connection name
location string: Resource location
properties ApiConnectionDefinitionPropertiesArgs
subscriptionId string: Subscription Id
tags {[key: string]: string}: Resource tags

resource_group_name str: The resource group
connection_name str: Connection name
location str: Resource location
properties ApiConnectionDefinitionPropertiesArgs
subscription_id str: Subscription Id
tags Mapping[str, str]: Resource tags

resourceGroupName String: The resource group
connectionName String: Connection name
location String: Resource location
properties Property Map
subscriptionId String: Subscription Id
tags Map<String>: Resource tags

Outputs

All input properties are implicitly available as output properties. Additionally, the Connection resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.
Name string: Resource name
Type string: Resource type
Etag string: Resource ETag

Id string: The provider-assigned unique ID for this managed resource.
Name string: Resource name
Type string: Resource type
Etag string: Resource ETag

id String: The provider-assigned unique ID for this managed resource.
name String: Resource name
type String: Resource type
etag String: Resource ETag

id string: The provider-assigned unique ID for this managed resource.
name string: Resource name
type string: Resource type
etag string: Resource ETag

id str: The provider-assigned unique ID for this managed resource.
name str: Resource name
type str: Resource type
etag str: Resource ETag

id String: The provider-assigned unique ID for this managed resource.
name String: Resource name
type String: Resource type
etag String: Resource ETag

Supporting Types

ApiConnectionDefinitionProperties

Api Pulumi.AzureNative.Web.Inputs.ApiReference
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.ConnectionStatusDefinition>: Status of the connection
TestLinks List<Pulumi.AzureNative.Web.Inputs.ApiConnectionTestLink>: Links to test the API connection

Api ApiReference
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 []ConnectionStatusDefinition: Status of the connection
TestLinks []ApiConnectionTestLink: Links to test the API connection

api ApiReference
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<ConnectionStatusDefinition>: Status of the connection
testLinks List<ApiConnectionTestLink>: Links to test the API connection

api ApiReference
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 ConnectionStatusDefinition[]: Status of the connection
testLinks ApiConnectionTestLink[]: Links to test the API connection

api ApiReference
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[ConnectionStatusDefinition]: Status of the connection
test_links Sequence[ApiConnectionTestLink]: 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

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

ApiConnectionTestLink

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

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

ApiReference

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

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

ConnectionError

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

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

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

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

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

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

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

ConnectionStatusDefinition

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

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

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

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

error ConnectionError: 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

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

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/f34b22a3-2202-4fb1-b040-1332bd928c84/resourceGroups/testResourceGroup/providers/Microsoft.Web/connections/testManagedApi-1

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0