1. Packages
  2. Azure Native
  3. API Docs
  4. peering
  5. PeeringService
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.49.1 published on Tuesday, Jul 9, 2024 by Pulumi

azure-native.peering.PeeringService

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.49.1 published on Tuesday, Jul 9, 2024 by Pulumi

    Peering Service Azure REST API version: 2022-10-01. Prior API version in Azure Native 1.x: 2021-01-01.

    Example Usage

    Create a peering service

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var peeringService = new AzureNative.Peering.PeeringService("peeringService", new()
        {
            Location = "eastus",
            PeeringServiceLocation = "state1",
            PeeringServiceName = "peeringServiceName",
            PeeringServiceProvider = "serviceProvider1",
            ProviderBackupPeeringLocation = "peeringLocation2",
            ProviderPrimaryPeeringLocation = "peeringLocation1",
            ResourceGroupName = "rgName",
        });
    
    });
    
    package main
    
    import (
    	peering "github.com/pulumi/pulumi-azure-native-sdk/peering/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := peering.NewPeeringService(ctx, "peeringService", &peering.PeeringServiceArgs{
    			Location:                       pulumi.String("eastus"),
    			PeeringServiceLocation:         pulumi.String("state1"),
    			PeeringServiceName:             pulumi.String("peeringServiceName"),
    			PeeringServiceProvider:         pulumi.String("serviceProvider1"),
    			ProviderBackupPeeringLocation:  pulumi.String("peeringLocation2"),
    			ProviderPrimaryPeeringLocation: pulumi.String("peeringLocation1"),
    			ResourceGroupName:              pulumi.String("rgName"),
    		})
    		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.peering.PeeringService;
    import com.pulumi.azurenative.peering.PeeringServiceArgs;
    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 peeringService = new PeeringService("peeringService", PeeringServiceArgs.builder()
                .location("eastus")
                .peeringServiceLocation("state1")
                .peeringServiceName("peeringServiceName")
                .peeringServiceProvider("serviceProvider1")
                .providerBackupPeeringLocation("peeringLocation2")
                .providerPrimaryPeeringLocation("peeringLocation1")
                .resourceGroupName("rgName")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    peering_service = azure_native.peering.PeeringService("peeringService",
        location="eastus",
        peering_service_location="state1",
        peering_service_name="peeringServiceName",
        peering_service_provider="serviceProvider1",
        provider_backup_peering_location="peeringLocation2",
        provider_primary_peering_location="peeringLocation1",
        resource_group_name="rgName")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const peeringService = new azure_native.peering.PeeringService("peeringService", {
        location: "eastus",
        peeringServiceLocation: "state1",
        peeringServiceName: "peeringServiceName",
        peeringServiceProvider: "serviceProvider1",
        providerBackupPeeringLocation: "peeringLocation2",
        providerPrimaryPeeringLocation: "peeringLocation1",
        resourceGroupName: "rgName",
    });
    
    resources:
      peeringService:
        type: azure-native:peering:PeeringService
        properties:
          location: eastus
          peeringServiceLocation: state1
          peeringServiceName: peeringServiceName
          peeringServiceProvider: serviceProvider1
          providerBackupPeeringLocation: peeringLocation2
          providerPrimaryPeeringLocation: peeringLocation1
          resourceGroupName: rgName
    

    Create PeeringService Resource

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

    Constructor syntax

    new PeeringService(name: string, args: PeeringServiceArgs, opts?: CustomResourceOptions);
    @overload
    def PeeringService(resource_name: str,
                       args: PeeringServiceArgs,
                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def PeeringService(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       resource_group_name: Optional[str] = None,
                       location: Optional[str] = None,
                       peering_service_location: Optional[str] = None,
                       peering_service_name: Optional[str] = None,
                       peering_service_provider: Optional[str] = None,
                       provider_backup_peering_location: Optional[str] = None,
                       provider_primary_peering_location: Optional[str] = None,
                       sku: Optional[PeeringServiceSkuArgs] = None,
                       tags: Optional[Mapping[str, str]] = None)
    func NewPeeringService(ctx *Context, name string, args PeeringServiceArgs, opts ...ResourceOption) (*PeeringService, error)
    public PeeringService(string name, PeeringServiceArgs args, CustomResourceOptions? opts = null)
    public PeeringService(String name, PeeringServiceArgs args)
    public PeeringService(String name, PeeringServiceArgs args, CustomResourceOptions options)
    
    type: azure-native:peering:PeeringService
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args PeeringServiceArgs
    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 PeeringServiceArgs
    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 PeeringServiceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PeeringServiceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PeeringServiceArgs
    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 peeringServiceResource = new AzureNative.Peering.PeeringService("peeringServiceResource", new()
    {
        ResourceGroupName = "string",
        Location = "string",
        PeeringServiceLocation = "string",
        PeeringServiceName = "string",
        PeeringServiceProvider = "string",
        ProviderBackupPeeringLocation = "string",
        ProviderPrimaryPeeringLocation = "string",
        Sku = new AzureNative.Peering.Inputs.PeeringServiceSkuArgs
        {
            Name = "string",
        },
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := peering.NewPeeringService(ctx, "peeringServiceResource", &peering.PeeringServiceArgs{
    ResourceGroupName: pulumi.String("string"),
    Location: pulumi.String("string"),
    PeeringServiceLocation: pulumi.String("string"),
    PeeringServiceName: pulumi.String("string"),
    PeeringServiceProvider: pulumi.String("string"),
    ProviderBackupPeeringLocation: pulumi.String("string"),
    ProviderPrimaryPeeringLocation: pulumi.String("string"),
    Sku: &peering.PeeringServiceSkuArgs{
    Name: pulumi.String("string"),
    },
    Tags: pulumi.StringMap{
    "string": pulumi.String("string"),
    },
    })
    
    var peeringServiceResource = new PeeringService("peeringServiceResource", PeeringServiceArgs.builder()
        .resourceGroupName("string")
        .location("string")
        .peeringServiceLocation("string")
        .peeringServiceName("string")
        .peeringServiceProvider("string")
        .providerBackupPeeringLocation("string")
        .providerPrimaryPeeringLocation("string")
        .sku(PeeringServiceSkuArgs.builder()
            .name("string")
            .build())
        .tags(Map.of("string", "string"))
        .build());
    
    peering_service_resource = azure_native.peering.PeeringService("peeringServiceResource",
        resource_group_name="string",
        location="string",
        peering_service_location="string",
        peering_service_name="string",
        peering_service_provider="string",
        provider_backup_peering_location="string",
        provider_primary_peering_location="string",
        sku={
            "name": "string",
        },
        tags={
            "string": "string",
        })
    
    const peeringServiceResource = new azure_native.peering.PeeringService("peeringServiceResource", {
        resourceGroupName: "string",
        location: "string",
        peeringServiceLocation: "string",
        peeringServiceName: "string",
        peeringServiceProvider: "string",
        providerBackupPeeringLocation: "string",
        providerPrimaryPeeringLocation: "string",
        sku: {
            name: "string",
        },
        tags: {
            string: "string",
        },
    });
    
    type: azure-native:peering:PeeringService
    properties:
        location: string
        peeringServiceLocation: string
        peeringServiceName: string
        peeringServiceProvider: string
        providerBackupPeeringLocation: string
        providerPrimaryPeeringLocation: string
        resourceGroupName: string
        sku:
            name: string
        tags:
            string: string
    

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

    ResourceGroupName string
    The name of the resource group.
    Location string
    The location of the resource.
    PeeringServiceLocation string
    The location (state/province) of the customer.
    PeeringServiceName string
    The name of the peering service.
    PeeringServiceProvider string
    The name of the service provider.
    ProviderBackupPeeringLocation string
    The backup peering (Microsoft/service provider) location to be used for customer traffic.
    ProviderPrimaryPeeringLocation string
    The primary peering (Microsoft/service provider) location to be used for customer traffic.
    Sku Pulumi.AzureNative.Peering.Inputs.PeeringServiceSku
    The SKU that defines the type of the peering service.
    Tags Dictionary<string, string>
    The resource tags.
    ResourceGroupName string
    The name of the resource group.
    Location string
    The location of the resource.
    PeeringServiceLocation string
    The location (state/province) of the customer.
    PeeringServiceName string
    The name of the peering service.
    PeeringServiceProvider string
    The name of the service provider.
    ProviderBackupPeeringLocation string
    The backup peering (Microsoft/service provider) location to be used for customer traffic.
    ProviderPrimaryPeeringLocation string
    The primary peering (Microsoft/service provider) location to be used for customer traffic.
    Sku PeeringServiceSkuArgs
    The SKU that defines the type of the peering service.
    Tags map[string]string
    The resource tags.
    resourceGroupName String
    The name of the resource group.
    location String
    The location of the resource.
    peeringServiceLocation String
    The location (state/province) of the customer.
    peeringServiceName String
    The name of the peering service.
    peeringServiceProvider String
    The name of the service provider.
    providerBackupPeeringLocation String
    The backup peering (Microsoft/service provider) location to be used for customer traffic.
    providerPrimaryPeeringLocation String
    The primary peering (Microsoft/service provider) location to be used for customer traffic.
    sku PeeringServiceSku
    The SKU that defines the type of the peering service.
    tags Map<String,String>
    The resource tags.
    resourceGroupName string
    The name of the resource group.
    location string
    The location of the resource.
    peeringServiceLocation string
    The location (state/province) of the customer.
    peeringServiceName string
    The name of the peering service.
    peeringServiceProvider string
    The name of the service provider.
    providerBackupPeeringLocation string
    The backup peering (Microsoft/service provider) location to be used for customer traffic.
    providerPrimaryPeeringLocation string
    The primary peering (Microsoft/service provider) location to be used for customer traffic.
    sku PeeringServiceSku
    The SKU that defines the type of the peering service.
    tags {[key: string]: string}
    The resource tags.
    resource_group_name str
    The name of the resource group.
    location str
    The location of the resource.
    peering_service_location str
    The location (state/province) of the customer.
    peering_service_name str
    The name of the peering service.
    peering_service_provider str
    The name of the service provider.
    provider_backup_peering_location str
    The backup peering (Microsoft/service provider) location to be used for customer traffic.
    provider_primary_peering_location str
    The primary peering (Microsoft/service provider) location to be used for customer traffic.
    sku PeeringServiceSkuArgs
    The SKU that defines the type of the peering service.
    tags Mapping[str, str]
    The resource tags.
    resourceGroupName String
    The name of the resource group.
    location String
    The location of the resource.
    peeringServiceLocation String
    The location (state/province) of the customer.
    peeringServiceName String
    The name of the peering service.
    peeringServiceProvider String
    The name of the service provider.
    providerBackupPeeringLocation String
    The backup peering (Microsoft/service provider) location to be used for customer traffic.
    providerPrimaryPeeringLocation String
    The primary peering (Microsoft/service provider) location to be used for customer traffic.
    sku Property Map
    The SKU that defines the type of the peering service.
    tags Map<String>
    The resource tags.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource.
    ProvisioningState string
    The provisioning state of the resource.
    Type string
    The type of the resource.
    LogAnalyticsWorkspaceProperties Pulumi.AzureNative.Peering.Outputs.LogAnalyticsWorkspacePropertiesResponse
    The Log Analytics Workspace Properties
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource.
    ProvisioningState string
    The provisioning state of the resource.
    Type string
    The type of the resource.
    LogAnalyticsWorkspaceProperties LogAnalyticsWorkspacePropertiesResponse
    The Log Analytics Workspace Properties
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource.
    provisioningState String
    The provisioning state of the resource.
    type String
    The type of the resource.
    logAnalyticsWorkspaceProperties LogAnalyticsWorkspacePropertiesResponse
    The Log Analytics Workspace Properties
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the resource.
    provisioningState string
    The provisioning state of the resource.
    type string
    The type of the resource.
    logAnalyticsWorkspaceProperties LogAnalyticsWorkspacePropertiesResponse
    The Log Analytics Workspace Properties
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the resource.
    provisioning_state str
    The provisioning state of the resource.
    type str
    The type of the resource.
    log_analytics_workspace_properties LogAnalyticsWorkspacePropertiesResponse
    The Log Analytics Workspace Properties
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource.
    provisioningState String
    The provisioning state of the resource.
    type String
    The type of the resource.
    logAnalyticsWorkspaceProperties Property Map
    The Log Analytics Workspace Properties

    Supporting Types

    LogAnalyticsWorkspacePropertiesResponse, LogAnalyticsWorkspacePropertiesResponseArgs

    ConnectedAgents List<string>
    The list of connected agents.
    Key string
    The Workspace Key.
    WorkspaceID string
    The Workspace ID.
    ConnectedAgents []string
    The list of connected agents.
    Key string
    The Workspace Key.
    WorkspaceID string
    The Workspace ID.
    connectedAgents List<String>
    The list of connected agents.
    key String
    The Workspace Key.
    workspaceID String
    The Workspace ID.
    connectedAgents string[]
    The list of connected agents.
    key string
    The Workspace Key.
    workspaceID string
    The Workspace ID.
    connected_agents Sequence[str]
    The list of connected agents.
    key str
    The Workspace Key.
    workspace_id str
    The Workspace ID.
    connectedAgents List<String>
    The list of connected agents.
    key String
    The Workspace Key.
    workspaceID String
    The Workspace ID.

    PeeringServiceSku, PeeringServiceSkuArgs

    Name string
    The name of the peering service SKU.
    Name string
    The name of the peering service SKU.
    name String
    The name of the peering service SKU.
    name string
    The name of the peering service SKU.
    name str
    The name of the peering service SKU.
    name String
    The name of the peering service SKU.

    PeeringServiceSkuResponse, PeeringServiceSkuResponseArgs

    Name string
    The name of the peering service SKU.
    Name string
    The name of the peering service SKU.
    name String
    The name of the peering service SKU.
    name string
    The name of the peering service SKU.
    name str
    The name of the peering service SKU.
    name String
    The name of the peering service SKU.

    Import

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

    $ pulumi import azure-native:peering:PeeringService peeringServiceName /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peeringServices/{peeringServiceName} 
    

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

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.49.1 published on Tuesday, Jul 9, 2024 by Pulumi