Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. web
  5. Connection
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.web.Connection

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

API connection

Uses Azure REST API version 2016-06-01. In version 2.x of the Azure Native provider, it used API version 2016-06-01.

Other available API versions: 2015-08-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native web [ApiVersion]. See the version guide for details.

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",
    });

});
Copy
package main

import (
	web "github.com/pulumi/pulumi-azure-native-sdk/web/v3"
	"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.ApiConnectionDefinitionPropertiesArgs{
				Api: &web.ApiReferenceArgs{
					Id: pulumi.String("/subscriptions/f34b22a3-2202-4fb1-b040-1332bd928c84/providers/Microsoft.Web/locations/centralus/managedApis/testManagedApi"),
				},
				CustomParameterValues: pulumi.StringMap{},
				DisplayName:           pulumi.String("testManagedApi"),
				ParameterValues:       pulumi.StringMap{},
			},
			ResourceGroupName: pulumi.String("testResourceGroup"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
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 com.pulumi.azurenative.web.inputs.ApiConnectionDefinitionPropertiesArgs;
import com.pulumi.azurenative.web.inputs.ApiReferenceArgs;
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(ApiConnectionDefinitionPropertiesArgs.builder()
                .api(ApiReferenceArgs.builder()
                    .id("/subscriptions/f34b22a3-2202-4fb1-b040-1332bd928c84/providers/Microsoft.Web/locations/centralus/managedApis/testManagedApi")
                    .build())
                .customParameterValues(Map.ofEntries(
                ))
                .displayName("testManagedApi")
                .parameterValues(Map.ofEntries(
                ))
                .build())
            .resourceGroupName("testResourceGroup")
            .build());

    }
}
Copy
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",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

connection = azure_native.web.Connection("connection",
    connection_name="testManagedApi",
    properties={
        "api": {
            "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")
Copy
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
Copy

Create Connection Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Connection(name: string, args: ConnectionArgs, opts?: CustomResourceOptions);
@overload
def Connection(resource_name: str,
               args: ConnectionArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def Connection(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               resource_group_name: Optional[str] = None,
               connection_name: Optional[str] = None,
               location: Optional[str] = None,
               properties: Optional[ApiConnectionDefinitionPropertiesArgs] = None,
               subscription_id: Optional[str] = None,
               tags: Optional[Mapping[str, str]] = 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.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ConnectionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. ConnectionArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ConnectionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ConnectionArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var exampleconnectionResourceResourceFromWeb = new AzureNative.Web.Connection("exampleconnectionResourceResourceFromWeb", new()
{
    ResourceGroupName = "string",
    ConnectionName = "string",
    Location = "string",
    Properties = new AzureNative.Web.Inputs.ApiConnectionDefinitionPropertiesArgs
    {
        Api = new AzureNative.Web.Inputs.ApiReferenceArgs
        {
            BrandColor = "string",
            Description = "string",
            DisplayName = "string",
            IconUri = "string",
            Id = "string",
            Name = "string",
            Swagger = "any",
            Type = "string",
        },
        ChangedTime = "string",
        CreatedTime = "string",
        CustomParameterValues = 
        {
            { "string", "string" },
        },
        DisplayName = "string",
        NonSecretParameterValues = 
        {
            { "string", "string" },
        },
        ParameterValues = 
        {
            { "string", "string" },
        },
        Statuses = new[]
        {
            new AzureNative.Web.Inputs.ConnectionStatusDefinitionArgs
            {
                Error = new AzureNative.Web.Inputs.ConnectionErrorArgs
                {
                    Code = "string",
                    Etag = "string",
                    Location = "string",
                    Message = "string",
                    Tags = 
                    {
                        { "string", "string" },
                    },
                },
                Status = "string",
                Target = "string",
            },
        },
        TestLinks = new[]
        {
            new AzureNative.Web.Inputs.ApiConnectionTestLinkArgs
            {
                Method = "string",
                RequestUri = "string",
            },
        },
    },
    SubscriptionId = "string",
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := web.NewConnection(ctx, "exampleconnectionResourceResourceFromWeb", &web.ConnectionArgs{
	ResourceGroupName: pulumi.String("string"),
	ConnectionName:    pulumi.String("string"),
	Location:          pulumi.String("string"),
	Properties: &web.ApiConnectionDefinitionPropertiesArgs{
		Api: &web.ApiReferenceArgs{
			BrandColor:  pulumi.String("string"),
			Description: pulumi.String("string"),
			DisplayName: pulumi.String("string"),
			IconUri:     pulumi.String("string"),
			Id:          pulumi.String("string"),
			Name:        pulumi.String("string"),
			Swagger:     pulumi.Any("any"),
			Type:        pulumi.String("string"),
		},
		ChangedTime: pulumi.String("string"),
		CreatedTime: pulumi.String("string"),
		CustomParameterValues: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
		DisplayName: pulumi.String("string"),
		NonSecretParameterValues: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
		ParameterValues: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
		Statuses: web.ConnectionStatusDefinitionArray{
			&web.ConnectionStatusDefinitionArgs{
				Error: &web.ConnectionErrorArgs{
					Code:     pulumi.String("string"),
					Etag:     pulumi.String("string"),
					Location: pulumi.String("string"),
					Message:  pulumi.String("string"),
					Tags: pulumi.StringMap{
						"string": pulumi.String("string"),
					},
				},
				Status: pulumi.String("string"),
				Target: pulumi.String("string"),
			},
		},
		TestLinks: web.ApiConnectionTestLinkArray{
			&web.ApiConnectionTestLinkArgs{
				Method:     pulumi.String("string"),
				RequestUri: pulumi.String("string"),
			},
		},
	},
	SubscriptionId: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var exampleconnectionResourceResourceFromWeb = new com.pulumi.azurenative.web.Connection("exampleconnectionResourceResourceFromWeb", com.pulumi.azurenative.web.ConnectionArgs.builder()
    .resourceGroupName("string")
    .connectionName("string")
    .location("string")
    .properties(ApiConnectionDefinitionPropertiesArgs.builder()
        .api(ApiReferenceArgs.builder()
            .brandColor("string")
            .description("string")
            .displayName("string")
            .iconUri("string")
            .id("string")
            .name("string")
            .swagger("any")
            .type("string")
            .build())
        .changedTime("string")
        .createdTime("string")
        .customParameterValues(Map.of("string", "string"))
        .displayName("string")
        .nonSecretParameterValues(Map.of("string", "string"))
        .parameterValues(Map.of("string", "string"))
        .statuses(ConnectionStatusDefinitionArgs.builder()
            .error(ConnectionErrorArgs.builder()
                .code("string")
                .etag("string")
                .location("string")
                .message("string")
                .tags(Map.of("string", "string"))
                .build())
            .status("string")
            .target("string")
            .build())
        .testLinks(ApiConnectionTestLinkArgs.builder()
            .method("string")
            .requestUri("string")
            .build())
        .build())
    .subscriptionId("string")
    .tags(Map.of("string", "string"))
    .build());
Copy
exampleconnection_resource_resource_from_web = azure_native.web.Connection("exampleconnectionResourceResourceFromWeb",
    resource_group_name="string",
    connection_name="string",
    location="string",
    properties={
        "api": {
            "brand_color": "string",
            "description": "string",
            "display_name": "string",
            "icon_uri": "string",
            "id": "string",
            "name": "string",
            "swagger": "any",
            "type": "string",
        },
        "changed_time": "string",
        "created_time": "string",
        "custom_parameter_values": {
            "string": "string",
        },
        "display_name": "string",
        "non_secret_parameter_values": {
            "string": "string",
        },
        "parameter_values": {
            "string": "string",
        },
        "statuses": [{
            "error": {
                "code": "string",
                "etag": "string",
                "location": "string",
                "message": "string",
                "tags": {
                    "string": "string",
                },
            },
            "status": "string",
            "target": "string",
        }],
        "test_links": [{
            "method": "string",
            "request_uri": "string",
        }],
    },
    subscription_id="string",
    tags={
        "string": "string",
    })
Copy
const exampleconnectionResourceResourceFromWeb = new azure_native.web.Connection("exampleconnectionResourceResourceFromWeb", {
    resourceGroupName: "string",
    connectionName: "string",
    location: "string",
    properties: {
        api: {
            brandColor: "string",
            description: "string",
            displayName: "string",
            iconUri: "string",
            id: "string",
            name: "string",
            swagger: "any",
            type: "string",
        },
        changedTime: "string",
        createdTime: "string",
        customParameterValues: {
            string: "string",
        },
        displayName: "string",
        nonSecretParameterValues: {
            string: "string",
        },
        parameterValues: {
            string: "string",
        },
        statuses: [{
            error: {
                code: "string",
                etag: "string",
                location: "string",
                message: "string",
                tags: {
                    string: "string",
                },
            },
            status: "string",
            target: "string",
        }],
        testLinks: [{
            method: "string",
            requestUri: "string",
        }],
    },
    subscriptionId: "string",
    tags: {
        string: "string",
    },
});
Copy
type: azure-native:web:Connection
properties:
    connectionName: string
    location: string
    properties:
        api:
            brandColor: string
            description: string
            displayName: string
            iconUri: string
            id: string
            name: string
            swagger: any
            type: string
        changedTime: string
        createdTime: string
        customParameterValues:
            string: string
        displayName: string
        nonSecretParameterValues:
            string: string
        parameterValues:
            string: string
        statuses:
            - error:
                code: string
                etag: string
                location: string
                message: string
                tags:
                    string: string
              status: string
              target: string
        testLinks:
            - method: string
              requestUri: string
    resourceGroupName: string
    subscriptionId: string
    tags:
        string: string
Copy

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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Connection resource accepts the following input properties:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group
ConnectionName Changes to this property will trigger replacement. string
Connection name
Location string
Resource location
Properties Pulumi.AzureNative.Web.Inputs.ApiConnectionDefinitionProperties
SubscriptionId Changes to this property will trigger replacement. string
Subscription Id
Tags Dictionary<string, string>
Resource tags
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group
ConnectionName Changes to this property will trigger replacement. string
Connection name
Location string
Resource location
Properties ApiConnectionDefinitionPropertiesArgs
SubscriptionId Changes to this property will trigger replacement. string
Subscription Id
Tags map[string]string
Resource tags
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The resource group
connectionName Changes to this property will trigger replacement. String
Connection name
location String
Resource location
properties ApiConnectionDefinitionProperties
subscriptionId Changes to this property will trigger replacement. String
Subscription Id
tags Map<String,String>
Resource tags
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group
connectionName Changes to this property will trigger replacement. string
Connection name
location string
Resource location
properties ApiConnectionDefinitionProperties
subscriptionId Changes to this property will trigger replacement. string
Subscription Id
tags {[key: string]: string}
Resource tags
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The resource group
connection_name Changes to this property will trigger replacement. str
Connection name
location str
Resource location
properties ApiConnectionDefinitionPropertiesArgs
subscription_id Changes to this property will trigger replacement. str
Subscription Id
tags Mapping[str, str]
Resource tags
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The resource group
connectionName Changes to this property will trigger replacement. String
Connection name
location String
Resource location
properties Property Map
subscriptionId Changes to this property will trigger replacement. 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:

AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
Resource name
Type string
Resource type
Etag string
Resource ETag
AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
Resource name
Type string
Resource type
Etag string
Resource ETag
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
Resource name
type String
Resource type
etag String
Resource ETag
azureApiVersion string
The Azure API version of the resource.
id string
The provider-assigned unique ID for this managed resource.
name string
Resource name
type string
Resource type
etag string
Resource ETag
azure_api_version str
The Azure API version of the resource.
id str
The provider-assigned unique ID for this managed resource.
name str
Resource name
type str
Resource type
etag str
Resource ETag
azureApiVersion String
The Azure API version of the resource.
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
, ApiConnectionDefinitionPropertiesArgs

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
, ApiConnectionDefinitionResponsePropertiesArgs

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
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
, ApiConnectionTestLinkResponseArgs

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
, ApiReferenceArgs

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
, ApiReferenceResponseArgs

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
, ConnectionErrorArgs

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
, ConnectionErrorResponseArgs

Id This property is required. string
Resource id
Name This property is required. string
Resource name
Type This property is required. 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 This property is required. string
Resource id
Name This property is required. string
Resource name
Type This property is required. 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 This property is required. String
Resource id
name This property is required. String
Resource name
type This property is required. 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 This property is required. string
Resource id
name This property is required. string
Resource name
type This property is required. 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 This property is required. str
Resource id
name This property is required. str
Resource name
type This property is required. 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 This property is required. String
Resource id
name This property is required. String
Resource name
type This property is required. 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
, ConnectionStatusDefinitionArgs

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
, ConnectionStatusDefinitionResponseArgs

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/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/connections/{connectionName}
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native