1. Packages
  2. HCP
  3. API Docs
  4. AzurePeeringConnection
HashiCorp Cloud Platform (HCP) v0.1.14 published on Friday, Dec 2, 2022 by Grapl Security

hcp.AzurePeeringConnection

Explore with Pulumi AI

hcp logo
HashiCorp Cloud Platform (HCP) v0.1.14 published on Friday, Dec 2, 2022 by Grapl Security

    Note: This data source is currently in public beta.

    The Azure peering connection resource allows you to manage a peering connection between an HVN and a peer Azure VNet.

    Create AzurePeeringConnection Resource

    new AzurePeeringConnection(name: string, args: AzurePeeringConnectionArgs, opts?: CustomResourceOptions);
    @overload
    def AzurePeeringConnection(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               hvn_link: Optional[str] = None,
                               peer_resource_group_name: Optional[str] = None,
                               peer_subscription_id: Optional[str] = None,
                               peer_tenant_id: Optional[str] = None,
                               peer_vnet_name: Optional[str] = None,
                               peer_vnet_region: Optional[str] = None,
                               peering_id: Optional[str] = None)
    @overload
    def AzurePeeringConnection(resource_name: str,
                               args: AzurePeeringConnectionArgs,
                               opts: Optional[ResourceOptions] = None)
    func NewAzurePeeringConnection(ctx *Context, name string, args AzurePeeringConnectionArgs, opts ...ResourceOption) (*AzurePeeringConnection, error)
    public AzurePeeringConnection(string name, AzurePeeringConnectionArgs args, CustomResourceOptions? opts = null)
    public AzurePeeringConnection(String name, AzurePeeringConnectionArgs args)
    public AzurePeeringConnection(String name, AzurePeeringConnectionArgs args, CustomResourceOptions options)
    
    type: hcp:AzurePeeringConnection
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args AzurePeeringConnectionArgs
    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 AzurePeeringConnectionArgs
    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 AzurePeeringConnectionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AzurePeeringConnectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AzurePeeringConnectionArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    HvnLink string

    The self_link of the HashiCorp Virtual Network (HVN).

    PeerResourceGroupName string

    The resource group name of the peer VNet in Azure.

    PeerSubscriptionId string

    The subscription ID of the peer VNet in Azure.

    PeerTenantId string

    The tenant ID of the peer VNet in Azure.

    PeerVnetName string

    The name of the peer VNet in Azure.

    PeerVnetRegion string

    The region of the peer VNet in Azure.

    PeeringId string

    The ID of the peering connection.

    HvnLink string

    The self_link of the HashiCorp Virtual Network (HVN).

    PeerResourceGroupName string

    The resource group name of the peer VNet in Azure.

    PeerSubscriptionId string

    The subscription ID of the peer VNet in Azure.

    PeerTenantId string

    The tenant ID of the peer VNet in Azure.

    PeerVnetName string

    The name of the peer VNet in Azure.

    PeerVnetRegion string

    The region of the peer VNet in Azure.

    PeeringId string

    The ID of the peering connection.

    hvnLink String

    The self_link of the HashiCorp Virtual Network (HVN).

    peerResourceGroupName String

    The resource group name of the peer VNet in Azure.

    peerSubscriptionId String

    The subscription ID of the peer VNet in Azure.

    peerTenantId String

    The tenant ID of the peer VNet in Azure.

    peerVnetName String

    The name of the peer VNet in Azure.

    peerVnetRegion String

    The region of the peer VNet in Azure.

    peeringId String

    The ID of the peering connection.

    hvnLink string

    The self_link of the HashiCorp Virtual Network (HVN).

    peerResourceGroupName string

    The resource group name of the peer VNet in Azure.

    peerSubscriptionId string

    The subscription ID of the peer VNet in Azure.

    peerTenantId string

    The tenant ID of the peer VNet in Azure.

    peerVnetName string

    The name of the peer VNet in Azure.

    peerVnetRegion string

    The region of the peer VNet in Azure.

    peeringId string

    The ID of the peering connection.

    hvn_link str

    The self_link of the HashiCorp Virtual Network (HVN).

    peer_resource_group_name str

    The resource group name of the peer VNet in Azure.

    peer_subscription_id str

    The subscription ID of the peer VNet in Azure.

    peer_tenant_id str

    The tenant ID of the peer VNet in Azure.

    peer_vnet_name str

    The name of the peer VNet in Azure.

    peer_vnet_region str

    The region of the peer VNet in Azure.

    peering_id str

    The ID of the peering connection.

    hvnLink String

    The self_link of the HashiCorp Virtual Network (HVN).

    peerResourceGroupName String

    The resource group name of the peer VNet in Azure.

    peerSubscriptionId String

    The subscription ID of the peer VNet in Azure.

    peerTenantId String

    The tenant ID of the peer VNet in Azure.

    peerVnetName String

    The name of the peer VNet in Azure.

    peerVnetRegion String

    The region of the peer VNet in Azure.

    peeringId String

    The ID of the peering connection.

    Outputs

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

    ApplicationId string

    The ID of the Azure application whose credentials are used to peer the HCP HVN's underlying VNet with the customer VNet.

    AzurePeeringId string

    The peering connection ID used by Azure.

    CreatedAt string

    The time that the peering connection was created.

    ExpiresAt string

    The time after which the peering connection will be considered expired if it hasn't transitioned into ACCEPTED or ACTIVE state.

    Id string

    The provider-assigned unique ID for this managed resource.

    OrganizationId string

    The ID of the HCP organization where the peering connection is located. Always matches the HVN's organization.

    ProjectId string

    The ID of the HCP project where the peering connection is located. Always matches the HVN's project.

    SelfLink string

    A unique URL identifying the peering connection.

    State string

    The state of the Azure peering connection.

    ApplicationId string

    The ID of the Azure application whose credentials are used to peer the HCP HVN's underlying VNet with the customer VNet.

    AzurePeeringId string

    The peering connection ID used by Azure.

    CreatedAt string

    The time that the peering connection was created.

    ExpiresAt string

    The time after which the peering connection will be considered expired if it hasn't transitioned into ACCEPTED or ACTIVE state.

    Id string

    The provider-assigned unique ID for this managed resource.

    OrganizationId string

    The ID of the HCP organization where the peering connection is located. Always matches the HVN's organization.

    ProjectId string

    The ID of the HCP project where the peering connection is located. Always matches the HVN's project.

    SelfLink string

    A unique URL identifying the peering connection.

    State string

    The state of the Azure peering connection.

    applicationId String

    The ID of the Azure application whose credentials are used to peer the HCP HVN's underlying VNet with the customer VNet.

    azurePeeringId String

    The peering connection ID used by Azure.

    createdAt String

    The time that the peering connection was created.

    expiresAt String

    The time after which the peering connection will be considered expired if it hasn't transitioned into ACCEPTED or ACTIVE state.

    id String

    The provider-assigned unique ID for this managed resource.

    organizationId String

    The ID of the HCP organization where the peering connection is located. Always matches the HVN's organization.

    projectId String

    The ID of the HCP project where the peering connection is located. Always matches the HVN's project.

    selfLink String

    A unique URL identifying the peering connection.

    state String

    The state of the Azure peering connection.

    applicationId string

    The ID of the Azure application whose credentials are used to peer the HCP HVN's underlying VNet with the customer VNet.

    azurePeeringId string

    The peering connection ID used by Azure.

    createdAt string

    The time that the peering connection was created.

    expiresAt string

    The time after which the peering connection will be considered expired if it hasn't transitioned into ACCEPTED or ACTIVE state.

    id string

    The provider-assigned unique ID for this managed resource.

    organizationId string

    The ID of the HCP organization where the peering connection is located. Always matches the HVN's organization.

    projectId string

    The ID of the HCP project where the peering connection is located. Always matches the HVN's project.

    selfLink string

    A unique URL identifying the peering connection.

    state string

    The state of the Azure peering connection.

    application_id str

    The ID of the Azure application whose credentials are used to peer the HCP HVN's underlying VNet with the customer VNet.

    azure_peering_id str

    The peering connection ID used by Azure.

    created_at str

    The time that the peering connection was created.

    expires_at str

    The time after which the peering connection will be considered expired if it hasn't transitioned into ACCEPTED or ACTIVE state.

    id str

    The provider-assigned unique ID for this managed resource.

    organization_id str

    The ID of the HCP organization where the peering connection is located. Always matches the HVN's organization.

    project_id str

    The ID of the HCP project where the peering connection is located. Always matches the HVN's project.

    self_link str

    A unique URL identifying the peering connection.

    state str

    The state of the Azure peering connection.

    applicationId String

    The ID of the Azure application whose credentials are used to peer the HCP HVN's underlying VNet with the customer VNet.

    azurePeeringId String

    The peering connection ID used by Azure.

    createdAt String

    The time that the peering connection was created.

    expiresAt String

    The time after which the peering connection will be considered expired if it hasn't transitioned into ACCEPTED or ACTIVE state.

    id String

    The provider-assigned unique ID for this managed resource.

    organizationId String

    The ID of the HCP organization where the peering connection is located. Always matches the HVN's organization.

    projectId String

    The ID of the HCP project where the peering connection is located. Always matches the HVN's project.

    selfLink String

    A unique URL identifying the peering connection.

    state String

    The state of the Azure peering connection.

    Look up Existing AzurePeeringConnection Resource

    Get an existing AzurePeeringConnection resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: AzurePeeringConnectionState, opts?: CustomResourceOptions): AzurePeeringConnection
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            application_id: Optional[str] = None,
            azure_peering_id: Optional[str] = None,
            created_at: Optional[str] = None,
            expires_at: Optional[str] = None,
            hvn_link: Optional[str] = None,
            organization_id: Optional[str] = None,
            peer_resource_group_name: Optional[str] = None,
            peer_subscription_id: Optional[str] = None,
            peer_tenant_id: Optional[str] = None,
            peer_vnet_name: Optional[str] = None,
            peer_vnet_region: Optional[str] = None,
            peering_id: Optional[str] = None,
            project_id: Optional[str] = None,
            self_link: Optional[str] = None,
            state: Optional[str] = None) -> AzurePeeringConnection
    func GetAzurePeeringConnection(ctx *Context, name string, id IDInput, state *AzurePeeringConnectionState, opts ...ResourceOption) (*AzurePeeringConnection, error)
    public static AzurePeeringConnection Get(string name, Input<string> id, AzurePeeringConnectionState? state, CustomResourceOptions? opts = null)
    public static AzurePeeringConnection get(String name, Output<String> id, AzurePeeringConnectionState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ApplicationId string

    The ID of the Azure application whose credentials are used to peer the HCP HVN's underlying VNet with the customer VNet.

    AzurePeeringId string

    The peering connection ID used by Azure.

    CreatedAt string

    The time that the peering connection was created.

    ExpiresAt string

    The time after which the peering connection will be considered expired if it hasn't transitioned into ACCEPTED or ACTIVE state.

    HvnLink string

    The self_link of the HashiCorp Virtual Network (HVN).

    OrganizationId string

    The ID of the HCP organization where the peering connection is located. Always matches the HVN's organization.

    PeerResourceGroupName string

    The resource group name of the peer VNet in Azure.

    PeerSubscriptionId string

    The subscription ID of the peer VNet in Azure.

    PeerTenantId string

    The tenant ID of the peer VNet in Azure.

    PeerVnetName string

    The name of the peer VNet in Azure.

    PeerVnetRegion string

    The region of the peer VNet in Azure.

    PeeringId string

    The ID of the peering connection.

    ProjectId string

    The ID of the HCP project where the peering connection is located. Always matches the HVN's project.

    SelfLink string

    A unique URL identifying the peering connection.

    State string

    The state of the Azure peering connection.

    ApplicationId string

    The ID of the Azure application whose credentials are used to peer the HCP HVN's underlying VNet with the customer VNet.

    AzurePeeringId string

    The peering connection ID used by Azure.

    CreatedAt string

    The time that the peering connection was created.

    ExpiresAt string

    The time after which the peering connection will be considered expired if it hasn't transitioned into ACCEPTED or ACTIVE state.

    HvnLink string

    The self_link of the HashiCorp Virtual Network (HVN).

    OrganizationId string

    The ID of the HCP organization where the peering connection is located. Always matches the HVN's organization.

    PeerResourceGroupName string

    The resource group name of the peer VNet in Azure.

    PeerSubscriptionId string

    The subscription ID of the peer VNet in Azure.

    PeerTenantId string

    The tenant ID of the peer VNet in Azure.

    PeerVnetName string

    The name of the peer VNet in Azure.

    PeerVnetRegion string

    The region of the peer VNet in Azure.

    PeeringId string

    The ID of the peering connection.

    ProjectId string

    The ID of the HCP project where the peering connection is located. Always matches the HVN's project.

    SelfLink string

    A unique URL identifying the peering connection.

    State string

    The state of the Azure peering connection.

    applicationId String

    The ID of the Azure application whose credentials are used to peer the HCP HVN's underlying VNet with the customer VNet.

    azurePeeringId String

    The peering connection ID used by Azure.

    createdAt String

    The time that the peering connection was created.

    expiresAt String

    The time after which the peering connection will be considered expired if it hasn't transitioned into ACCEPTED or ACTIVE state.

    hvnLink String

    The self_link of the HashiCorp Virtual Network (HVN).

    organizationId String

    The ID of the HCP organization where the peering connection is located. Always matches the HVN's organization.

    peerResourceGroupName String

    The resource group name of the peer VNet in Azure.

    peerSubscriptionId String

    The subscription ID of the peer VNet in Azure.

    peerTenantId String

    The tenant ID of the peer VNet in Azure.

    peerVnetName String

    The name of the peer VNet in Azure.

    peerVnetRegion String

    The region of the peer VNet in Azure.

    peeringId String

    The ID of the peering connection.

    projectId String

    The ID of the HCP project where the peering connection is located. Always matches the HVN's project.

    selfLink String

    A unique URL identifying the peering connection.

    state String

    The state of the Azure peering connection.

    applicationId string

    The ID of the Azure application whose credentials are used to peer the HCP HVN's underlying VNet with the customer VNet.

    azurePeeringId string

    The peering connection ID used by Azure.

    createdAt string

    The time that the peering connection was created.

    expiresAt string

    The time after which the peering connection will be considered expired if it hasn't transitioned into ACCEPTED or ACTIVE state.

    hvnLink string

    The self_link of the HashiCorp Virtual Network (HVN).

    organizationId string

    The ID of the HCP organization where the peering connection is located. Always matches the HVN's organization.

    peerResourceGroupName string

    The resource group name of the peer VNet in Azure.

    peerSubscriptionId string

    The subscription ID of the peer VNet in Azure.

    peerTenantId string

    The tenant ID of the peer VNet in Azure.

    peerVnetName string

    The name of the peer VNet in Azure.

    peerVnetRegion string

    The region of the peer VNet in Azure.

    peeringId string

    The ID of the peering connection.

    projectId string

    The ID of the HCP project where the peering connection is located. Always matches the HVN's project.

    selfLink string

    A unique URL identifying the peering connection.

    state string

    The state of the Azure peering connection.

    application_id str

    The ID of the Azure application whose credentials are used to peer the HCP HVN's underlying VNet with the customer VNet.

    azure_peering_id str

    The peering connection ID used by Azure.

    created_at str

    The time that the peering connection was created.

    expires_at str

    The time after which the peering connection will be considered expired if it hasn't transitioned into ACCEPTED or ACTIVE state.

    hvn_link str

    The self_link of the HashiCorp Virtual Network (HVN).

    organization_id str

    The ID of the HCP organization where the peering connection is located. Always matches the HVN's organization.

    peer_resource_group_name str

    The resource group name of the peer VNet in Azure.

    peer_subscription_id str

    The subscription ID of the peer VNet in Azure.

    peer_tenant_id str

    The tenant ID of the peer VNet in Azure.

    peer_vnet_name str

    The name of the peer VNet in Azure.

    peer_vnet_region str

    The region of the peer VNet in Azure.

    peering_id str

    The ID of the peering connection.

    project_id str

    The ID of the HCP project where the peering connection is located. Always matches the HVN's project.

    self_link str

    A unique URL identifying the peering connection.

    state str

    The state of the Azure peering connection.

    applicationId String

    The ID of the Azure application whose credentials are used to peer the HCP HVN's underlying VNet with the customer VNet.

    azurePeeringId String

    The peering connection ID used by Azure.

    createdAt String

    The time that the peering connection was created.

    expiresAt String

    The time after which the peering connection will be considered expired if it hasn't transitioned into ACCEPTED or ACTIVE state.

    hvnLink String

    The self_link of the HashiCorp Virtual Network (HVN).

    organizationId String

    The ID of the HCP organization where the peering connection is located. Always matches the HVN's organization.

    peerResourceGroupName String

    The resource group name of the peer VNet in Azure.

    peerSubscriptionId String

    The subscription ID of the peer VNet in Azure.

    peerTenantId String

    The tenant ID of the peer VNet in Azure.

    peerVnetName String

    The name of the peer VNet in Azure.

    peerVnetRegion String

    The region of the peer VNet in Azure.

    peeringId String

    The ID of the peering connection.

    projectId String

    The ID of the HCP project where the peering connection is located. Always matches the HVN's project.

    selfLink String

    A unique URL identifying the peering connection.

    state String

    The state of the Azure peering connection.

    Import

    The import ID is {hvn_id}:{peering_id}

     $ pulumi import hcp:index/azurePeeringConnection:AzurePeeringConnection peer main-hvn:199e7e96-4d5f-4456-91f3-b6cc71f1e561
    

    Package Details

    Repository
    hcp grapl-security/pulumi-hcp
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the hcp Terraform Provider.

    hcp logo
    HashiCorp Cloud Platform (HCP) v0.1.14 published on Friday, Dec 2, 2022 by Grapl Security