Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v1
  3. API Docs
  4. network
  5. ScopeConnection
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

azure-native.network.ScopeConnection

Explore with Pulumi AI

These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

The Scope Connections resource API Version: 2022-02-01-preview.

Example Usage

Create or Update Network Manager Scope Connection

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var scopeConnection = new AzureNative.Network.ScopeConnection("scopeConnection", new()
    {
        Description = "This is a scope connection to a cross tenant subscription.",
        NetworkManagerName = "testNetworkManager",
        ResourceGroupName = "rg1",
        ResourceId = "subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b",
        ScopeConnectionName = "TestScopeConnection",
        TenantId = "6babcaad-604b-40ac-a9d7-9fd97c0b779f",
    });

});
Copy
package main

import (
	network "github.com/pulumi/pulumi-azure-native-sdk/network"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := network.NewScopeConnection(ctx, "scopeConnection", &network.ScopeConnectionArgs{
			Description:         pulumi.String("This is a scope connection to a cross tenant subscription."),
			NetworkManagerName:  pulumi.String("testNetworkManager"),
			ResourceGroupName:   pulumi.String("rg1"),
			ResourceId:          pulumi.String("subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b"),
			ScopeConnectionName: pulumi.String("TestScopeConnection"),
			TenantId:            pulumi.String("6babcaad-604b-40ac-a9d7-9fd97c0b779f"),
		})
		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.network.ScopeConnection;
import com.pulumi.azurenative.network.ScopeConnectionArgs;
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 scopeConnection = new ScopeConnection("scopeConnection", ScopeConnectionArgs.builder()        
            .description("This is a scope connection to a cross tenant subscription.")
            .networkManagerName("testNetworkManager")
            .resourceGroupName("rg1")
            .resourceId("subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b")
            .scopeConnectionName("TestScopeConnection")
            .tenantId("6babcaad-604b-40ac-a9d7-9fd97c0b779f")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const scopeConnection = new azure_native.network.ScopeConnection("scopeConnection", {
    description: "This is a scope connection to a cross tenant subscription.",
    networkManagerName: "testNetworkManager",
    resourceGroupName: "rg1",
    resourceId: "subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b",
    scopeConnectionName: "TestScopeConnection",
    tenantId: "6babcaad-604b-40ac-a9d7-9fd97c0b779f",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

scope_connection = azure_native.network.ScopeConnection("scopeConnection",
    description="This is a scope connection to a cross tenant subscription.",
    network_manager_name="testNetworkManager",
    resource_group_name="rg1",
    resource_id="subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b",
    scope_connection_name="TestScopeConnection",
    tenant_id="6babcaad-604b-40ac-a9d7-9fd97c0b779f")
Copy
resources:
  scopeConnection:
    type: azure-native:network:ScopeConnection
    properties:
      description: This is a scope connection to a cross tenant subscription.
      networkManagerName: testNetworkManager
      resourceGroupName: rg1
      resourceId: subscriptions/f0dc2b34-dfad-40e4-83e0-2309fed8d00b
      scopeConnectionName: TestScopeConnection
      tenantId: 6babcaad-604b-40ac-a9d7-9fd97c0b779f
Copy

Create ScopeConnection Resource

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

Constructor syntax

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

@overload
def ScopeConnection(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    network_manager_name: Optional[str] = None,
                    resource_group_name: Optional[str] = None,
                    description: Optional[str] = None,
                    resource_id: Optional[str] = None,
                    scope_connection_name: Optional[str] = None,
                    tenant_id: Optional[str] = None)
func NewScopeConnection(ctx *Context, name string, args ScopeConnectionArgs, opts ...ResourceOption) (*ScopeConnection, error)
public ScopeConnection(string name, ScopeConnectionArgs args, CustomResourceOptions? opts = null)
public ScopeConnection(String name, ScopeConnectionArgs args)
public ScopeConnection(String name, ScopeConnectionArgs args, CustomResourceOptions options)

type: azure-native:network:ScopeConnection
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. ScopeConnectionArgs
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. ScopeConnectionArgs
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. ScopeConnectionArgs
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. ScopeConnectionArgs
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. ScopeConnectionArgs
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 scopeConnectionResource = new AzureNative.Network.ScopeConnection("scopeConnectionResource", new()
{
    NetworkManagerName = "string",
    ResourceGroupName = "string",
    Description = "string",
    ResourceId = "string",
    ScopeConnectionName = "string",
    TenantId = "string",
});
Copy
example, err := network.NewScopeConnection(ctx, "scopeConnectionResource", &network.ScopeConnectionArgs{
	NetworkManagerName:  "string",
	ResourceGroupName:   "string",
	Description:         "string",
	ResourceId:          "string",
	ScopeConnectionName: "string",
	TenantId:            "string",
})
Copy
var scopeConnectionResource = new ScopeConnection("scopeConnectionResource", ScopeConnectionArgs.builder()
    .networkManagerName("string")
    .resourceGroupName("string")
    .description("string")
    .resourceId("string")
    .scopeConnectionName("string")
    .tenantId("string")
    .build());
Copy
scope_connection_resource = azure_native.network.ScopeConnection("scopeConnectionResource",
    network_manager_name=string,
    resource_group_name=string,
    description=string,
    resource_id=string,
    scope_connection_name=string,
    tenant_id=string)
Copy
const scopeConnectionResource = new azure_native.network.ScopeConnection("scopeConnectionResource", {
    networkManagerName: "string",
    resourceGroupName: "string",
    description: "string",
    resourceId: "string",
    scopeConnectionName: "string",
    tenantId: "string",
});
Copy
type: azure-native:network:ScopeConnection
properties:
    description: string
    networkManagerName: string
    resourceGroupName: string
    resourceId: string
    scopeConnectionName: string
    tenantId: string
Copy

ScopeConnection 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 ScopeConnection resource accepts the following input properties:

NetworkManagerName
This property is required.
Changes to this property will trigger replacement.
string
The name of the network manager.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
Description string
A description of the scope connection.
ResourceId string
Resource ID.
ScopeConnectionName Changes to this property will trigger replacement. string
Name for the cross-tenant connection.
TenantId string
Tenant ID.
NetworkManagerName
This property is required.
Changes to this property will trigger replacement.
string
The name of the network manager.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
Description string
A description of the scope connection.
ResourceId string
Resource ID.
ScopeConnectionName Changes to this property will trigger replacement. string
Name for the cross-tenant connection.
TenantId string
Tenant ID.
networkManagerName
This property is required.
Changes to this property will trigger replacement.
String
The name of the network manager.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
description String
A description of the scope connection.
resourceId String
Resource ID.
scopeConnectionName Changes to this property will trigger replacement. String
Name for the cross-tenant connection.
tenantId String
Tenant ID.
networkManagerName
This property is required.
Changes to this property will trigger replacement.
string
The name of the network manager.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
description string
A description of the scope connection.
resourceId string
Resource ID.
scopeConnectionName Changes to this property will trigger replacement. string
Name for the cross-tenant connection.
tenantId string
Tenant ID.
network_manager_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the network manager.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group.
description str
A description of the scope connection.
resource_id str
Resource ID.
scope_connection_name Changes to this property will trigger replacement. str
Name for the cross-tenant connection.
tenant_id str
Tenant ID.
networkManagerName
This property is required.
Changes to this property will trigger replacement.
String
The name of the network manager.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
description String
A description of the scope connection.
resourceId String
Resource ID.
scopeConnectionName Changes to this property will trigger replacement. String
Name for the cross-tenant connection.
tenantId String
Tenant ID.

Outputs

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

Etag string
A unique read-only string that changes whenever the resource is updated.
Id string
The provider-assigned unique ID for this managed resource.
Name string
Resource name.
SystemData Pulumi.AzureNative.Network.Outputs.SystemDataResponse
The system metadata related to this resource.
Type string
Resource type.
Etag string
A unique read-only string that changes whenever the resource is updated.
Id string
The provider-assigned unique ID for this managed resource.
Name string
Resource name.
SystemData SystemDataResponse
The system metadata related to this resource.
Type string
Resource type.
etag String
A unique read-only string that changes whenever the resource is updated.
id String
The provider-assigned unique ID for this managed resource.
name String
Resource name.
systemData SystemDataResponse
The system metadata related to this resource.
type String
Resource type.
etag string
A unique read-only string that changes whenever the resource is updated.
id string
The provider-assigned unique ID for this managed resource.
name string
Resource name.
systemData SystemDataResponse
The system metadata related to this resource.
type string
Resource type.
etag str
A unique read-only string that changes whenever the resource is updated.
id str
The provider-assigned unique ID for this managed resource.
name str
Resource name.
system_data SystemDataResponse
The system metadata related to this resource.
type str
Resource type.
etag String
A unique read-only string that changes whenever the resource is updated.
id String
The provider-assigned unique ID for this managed resource.
name String
Resource name.
systemData Property Map
The system metadata related to this resource.
type String
Resource type.

Supporting Types

SystemDataResponse
, SystemDataResponseArgs

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The type of identity that last modified the resource.
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The type of identity that last modified the resource.
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The type of identity that last modified the resource.
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The type of identity that last modified the resource.
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The type of identity that last modified the resource.
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The type of identity that last modified the resource.
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:network:ScopeConnection TestScopeConnection /subscriptions/subscriptionC/resourceGroup/rg1/providers/Microsoft.Network/networkManagers/testNetworkManager/scopeConnections/TestScopeConnection
Copy

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

Package Details

Repository
azure-native-v1 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native