1. Packages
  2. Azure Native
  3. API Docs
  4. peering
  5. RegisteredPrefix
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.RegisteredPrefix

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

    The customer’s prefix that is registered by the peering service provider. Azure REST API version: 2022-10-01. Prior API version in Azure Native 1.x: 2021-01-01.

    Example Usage

    Create or update a registered prefix for the peering

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var registeredPrefix = new AzureNative.Peering.RegisteredPrefix("registeredPrefix", new()
        {
            PeeringName = "peeringName",
            Prefix = "10.22.20.0/24",
            RegisteredPrefixName = "registeredPrefixName",
            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.NewRegisteredPrefix(ctx, "registeredPrefix", &peering.RegisteredPrefixArgs{
    			PeeringName:          pulumi.String("peeringName"),
    			Prefix:               pulumi.String("10.22.20.0/24"),
    			RegisteredPrefixName: pulumi.String("registeredPrefixName"),
    			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.RegisteredPrefix;
    import com.pulumi.azurenative.peering.RegisteredPrefixArgs;
    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 registeredPrefix = new RegisteredPrefix("registeredPrefix", RegisteredPrefixArgs.builder()
                .peeringName("peeringName")
                .prefix("10.22.20.0/24")
                .registeredPrefixName("registeredPrefixName")
                .resourceGroupName("rgName")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    registered_prefix = azure_native.peering.RegisteredPrefix("registeredPrefix",
        peering_name="peeringName",
        prefix="10.22.20.0/24",
        registered_prefix_name="registeredPrefixName",
        resource_group_name="rgName")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const registeredPrefix = new azure_native.peering.RegisteredPrefix("registeredPrefix", {
        peeringName: "peeringName",
        prefix: "10.22.20.0/24",
        registeredPrefixName: "registeredPrefixName",
        resourceGroupName: "rgName",
    });
    
    resources:
      registeredPrefix:
        type: azure-native:peering:RegisteredPrefix
        properties:
          peeringName: peeringName
          prefix: 10.22.20.0/24
          registeredPrefixName: registeredPrefixName
          resourceGroupName: rgName
    

    Create RegisteredPrefix Resource

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

    Constructor syntax

    new RegisteredPrefix(name: string, args: RegisteredPrefixArgs, opts?: CustomResourceOptions);
    @overload
    def RegisteredPrefix(resource_name: str,
                         args: RegisteredPrefixArgs,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def RegisteredPrefix(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         peering_name: Optional[str] = None,
                         resource_group_name: Optional[str] = None,
                         prefix: Optional[str] = None,
                         registered_prefix_name: Optional[str] = None)
    func NewRegisteredPrefix(ctx *Context, name string, args RegisteredPrefixArgs, opts ...ResourceOption) (*RegisteredPrefix, error)
    public RegisteredPrefix(string name, RegisteredPrefixArgs args, CustomResourceOptions? opts = null)
    public RegisteredPrefix(String name, RegisteredPrefixArgs args)
    public RegisteredPrefix(String name, RegisteredPrefixArgs args, CustomResourceOptions options)
    
    type: azure-native:peering:RegisteredPrefix
    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 RegisteredPrefixArgs
    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 RegisteredPrefixArgs
    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 RegisteredPrefixArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RegisteredPrefixArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RegisteredPrefixArgs
    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 registeredPrefixResource = new AzureNative.Peering.RegisteredPrefix("registeredPrefixResource", new()
    {
        PeeringName = "string",
        ResourceGroupName = "string",
        Prefix = "string",
        RegisteredPrefixName = "string",
    });
    
    example, err := peering.NewRegisteredPrefix(ctx, "registeredPrefixResource", &peering.RegisteredPrefixArgs{
    PeeringName: pulumi.String("string"),
    ResourceGroupName: pulumi.String("string"),
    Prefix: pulumi.String("string"),
    RegisteredPrefixName: pulumi.String("string"),
    })
    
    var registeredPrefixResource = new RegisteredPrefix("registeredPrefixResource", RegisteredPrefixArgs.builder()
        .peeringName("string")
        .resourceGroupName("string")
        .prefix("string")
        .registeredPrefixName("string")
        .build());
    
    registered_prefix_resource = azure_native.peering.RegisteredPrefix("registeredPrefixResource",
        peering_name="string",
        resource_group_name="string",
        prefix="string",
        registered_prefix_name="string")
    
    const registeredPrefixResource = new azure_native.peering.RegisteredPrefix("registeredPrefixResource", {
        peeringName: "string",
        resourceGroupName: "string",
        prefix: "string",
        registeredPrefixName: "string",
    });
    
    type: azure-native:peering:RegisteredPrefix
    properties:
        peeringName: string
        prefix: string
        registeredPrefixName: string
        resourceGroupName: string
    

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

    PeeringName string
    The name of the peering.
    ResourceGroupName string
    The name of the resource group.
    Prefix string
    The customer's prefix from which traffic originates.
    RegisteredPrefixName string
    The name of the registered prefix.
    PeeringName string
    The name of the peering.
    ResourceGroupName string
    The name of the resource group.
    Prefix string
    The customer's prefix from which traffic originates.
    RegisteredPrefixName string
    The name of the registered prefix.
    peeringName String
    The name of the peering.
    resourceGroupName String
    The name of the resource group.
    prefix String
    The customer's prefix from which traffic originates.
    registeredPrefixName String
    The name of the registered prefix.
    peeringName string
    The name of the peering.
    resourceGroupName string
    The name of the resource group.
    prefix string
    The customer's prefix from which traffic originates.
    registeredPrefixName string
    The name of the registered prefix.
    peering_name str
    The name of the peering.
    resource_group_name str
    The name of the resource group.
    prefix str
    The customer's prefix from which traffic originates.
    registered_prefix_name str
    The name of the registered prefix.
    peeringName String
    The name of the peering.
    resourceGroupName String
    The name of the resource group.
    prefix String
    The customer's prefix from which traffic originates.
    registeredPrefixName String
    The name of the registered prefix.

    Outputs

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

    ErrorMessage string
    The error message associated with the validation state, if any.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource.
    PeeringServicePrefixKey string
    The peering service prefix key that is to be shared with the customer.
    PrefixValidationState string
    The prefix validation state.
    ProvisioningState string
    The provisioning state of the resource.
    Type string
    The type of the resource.
    ErrorMessage string
    The error message associated with the validation state, if any.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the resource.
    PeeringServicePrefixKey string
    The peering service prefix key that is to be shared with the customer.
    PrefixValidationState string
    The prefix validation state.
    ProvisioningState string
    The provisioning state of the resource.
    Type string
    The type of the resource.
    errorMessage String
    The error message associated with the validation state, if any.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource.
    peeringServicePrefixKey String
    The peering service prefix key that is to be shared with the customer.
    prefixValidationState String
    The prefix validation state.
    provisioningState String
    The provisioning state of the resource.
    type String
    The type of the resource.
    errorMessage string
    The error message associated with the validation state, if any.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the resource.
    peeringServicePrefixKey string
    The peering service prefix key that is to be shared with the customer.
    prefixValidationState string
    The prefix validation state.
    provisioningState string
    The provisioning state of the resource.
    type string
    The type of the resource.
    error_message str
    The error message associated with the validation state, if any.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the resource.
    peering_service_prefix_key str
    The peering service prefix key that is to be shared with the customer.
    prefix_validation_state str
    The prefix validation state.
    provisioning_state str
    The provisioning state of the resource.
    type str
    The type of the resource.
    errorMessage String
    The error message associated with the validation state, if any.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the resource.
    peeringServicePrefixKey String
    The peering service prefix key that is to be shared with the customer.
    prefixValidationState String
    The prefix validation state.
    provisioningState String
    The provisioning state of the resource.
    type String
    The type of the resource.

    Import

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

    $ pulumi import azure-native:peering:RegisteredPrefix registeredPrefixName /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Peering/peerings/{peeringName}/registeredPrefixes/{registeredPrefixName} 
    

    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