1. Packages
  2. Cloudamqp Provider
  3. API Docs
  4. PrivatelinkAzure
CloudAMQP v3.21.0 published on Tuesday, Apr 8, 2025 by Pulumi

cloudamqp.PrivatelinkAzure

Explore with Pulumi AI

Import

cloudamqp_privatelink_azure can be imported using CloudAMQP instance identifier. To retrieve the

identifier, use [CloudAMQP API list intances].

From Terraform v1.5.0, the import block can be used to import this resource:

hcl

import {

to = cloudamqp_privatelink_azure.privatelink

id = cloudamqp_instance.instance.id

}

Or use Terraform CLI:

$ pulumi import cloudamqp:index/privatelinkAzure:PrivatelinkAzure privatelink <id>`
Copy

cloudamqp_privatelink_aws can be imported using CloudAMQP instance identifier.

Create PrivatelinkAzure Resource

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

Constructor syntax

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

@overload
def PrivatelinkAzure(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     approved_subscriptions: Optional[Sequence[str]] = None,
                     instance_id: Optional[int] = None,
                     sleep: Optional[int] = None,
                     timeout: Optional[int] = None)
func NewPrivatelinkAzure(ctx *Context, name string, args PrivatelinkAzureArgs, opts ...ResourceOption) (*PrivatelinkAzure, error)
public PrivatelinkAzure(string name, PrivatelinkAzureArgs args, CustomResourceOptions? opts = null)
public PrivatelinkAzure(String name, PrivatelinkAzureArgs args)
public PrivatelinkAzure(String name, PrivatelinkAzureArgs args, CustomResourceOptions options)
type: cloudamqp:PrivatelinkAzure
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. PrivatelinkAzureArgs
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. PrivatelinkAzureArgs
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. PrivatelinkAzureArgs
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. PrivatelinkAzureArgs
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. PrivatelinkAzureArgs
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 privatelinkAzureResource = new CloudAmqp.PrivatelinkAzure("privatelinkAzureResource", new()
{
    ApprovedSubscriptions = new[]
    {
        "string",
    },
    InstanceId = 0,
    Sleep = 0,
    Timeout = 0,
});
Copy
example, err := cloudamqp.NewPrivatelinkAzure(ctx, "privatelinkAzureResource", &cloudamqp.PrivatelinkAzureArgs{
	ApprovedSubscriptions: pulumi.StringArray{
		pulumi.String("string"),
	},
	InstanceId: pulumi.Int(0),
	Sleep:      pulumi.Int(0),
	Timeout:    pulumi.Int(0),
})
Copy
var privatelinkAzureResource = new PrivatelinkAzure("privatelinkAzureResource", PrivatelinkAzureArgs.builder()
    .approvedSubscriptions("string")
    .instanceId(0)
    .sleep(0)
    .timeout(0)
    .build());
Copy
privatelink_azure_resource = cloudamqp.PrivatelinkAzure("privatelinkAzureResource",
    approved_subscriptions=["string"],
    instance_id=0,
    sleep=0,
    timeout=0)
Copy
const privatelinkAzureResource = new cloudamqp.PrivatelinkAzure("privatelinkAzureResource", {
    approvedSubscriptions: ["string"],
    instanceId: 0,
    sleep: 0,
    timeout: 0,
});
Copy
type: cloudamqp:PrivatelinkAzure
properties:
    approvedSubscriptions:
        - string
    instanceId: 0
    sleep: 0
    timeout: 0
Copy

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

ApprovedSubscriptions This property is required. List<string>
Approved subscriptions to access the endpoint service. See format below.
InstanceId
This property is required.
Changes to this property will trigger replacement.
int
The CloudAMQP instance identifier.
Sleep int

Configurable sleep time (seconds) when enable PrivateLink. Default set to 10 seconds.

Note: Available from [v1.29.0]

Timeout int

Configurable timeout time (seconds) when enable PrivateLink. Default set to 1800 seconds.

Note: Available from [v1.29.0]

Approved subscriptions format (GUID): XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

ApprovedSubscriptions This property is required. []string
Approved subscriptions to access the endpoint service. See format below.
InstanceId
This property is required.
Changes to this property will trigger replacement.
int
The CloudAMQP instance identifier.
Sleep int

Configurable sleep time (seconds) when enable PrivateLink. Default set to 10 seconds.

Note: Available from [v1.29.0]

Timeout int

Configurable timeout time (seconds) when enable PrivateLink. Default set to 1800 seconds.

Note: Available from [v1.29.0]

Approved subscriptions format (GUID): XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

approvedSubscriptions This property is required. List<String>
Approved subscriptions to access the endpoint service. See format below.
instanceId
This property is required.
Changes to this property will trigger replacement.
Integer
The CloudAMQP instance identifier.
sleep Integer

Configurable sleep time (seconds) when enable PrivateLink. Default set to 10 seconds.

Note: Available from [v1.29.0]

timeout Integer

Configurable timeout time (seconds) when enable PrivateLink. Default set to 1800 seconds.

Note: Available from [v1.29.0]

Approved subscriptions format (GUID): XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

approvedSubscriptions This property is required. string[]
Approved subscriptions to access the endpoint service. See format below.
instanceId
This property is required.
Changes to this property will trigger replacement.
number
The CloudAMQP instance identifier.
sleep number

Configurable sleep time (seconds) when enable PrivateLink. Default set to 10 seconds.

Note: Available from [v1.29.0]

timeout number

Configurable timeout time (seconds) when enable PrivateLink. Default set to 1800 seconds.

Note: Available from [v1.29.0]

Approved subscriptions format (GUID): XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

approved_subscriptions This property is required. Sequence[str]
Approved subscriptions to access the endpoint service. See format below.
instance_id
This property is required.
Changes to this property will trigger replacement.
int
The CloudAMQP instance identifier.
sleep int

Configurable sleep time (seconds) when enable PrivateLink. Default set to 10 seconds.

Note: Available from [v1.29.0]

timeout int

Configurable timeout time (seconds) when enable PrivateLink. Default set to 1800 seconds.

Note: Available from [v1.29.0]

Approved subscriptions format (GUID): XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

approvedSubscriptions This property is required. List<String>
Approved subscriptions to access the endpoint service. See format below.
instanceId
This property is required.
Changes to this property will trigger replacement.
Number
The CloudAMQP instance identifier.
sleep Number

Configurable sleep time (seconds) when enable PrivateLink. Default set to 10 seconds.

Note: Available from [v1.29.0]

timeout Number

Configurable timeout time (seconds) when enable PrivateLink. Default set to 1800 seconds.

Note: Available from [v1.29.0]

Approved subscriptions format (GUID): XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
ServerName string
Name of the server having the PrivateLink enabled.
ServiceName string
Service name (alias) of the PrivateLink, needed when creating the endpoint.
Status string
PrivateLink status [enable, pending, disable]
Id string
The provider-assigned unique ID for this managed resource.
ServerName string
Name of the server having the PrivateLink enabled.
ServiceName string
Service name (alias) of the PrivateLink, needed when creating the endpoint.
Status string
PrivateLink status [enable, pending, disable]
id String
The provider-assigned unique ID for this managed resource.
serverName String
Name of the server having the PrivateLink enabled.
serviceName String
Service name (alias) of the PrivateLink, needed when creating the endpoint.
status String
PrivateLink status [enable, pending, disable]
id string
The provider-assigned unique ID for this managed resource.
serverName string
Name of the server having the PrivateLink enabled.
serviceName string
Service name (alias) of the PrivateLink, needed when creating the endpoint.
status string
PrivateLink status [enable, pending, disable]
id str
The provider-assigned unique ID for this managed resource.
server_name str
Name of the server having the PrivateLink enabled.
service_name str
Service name (alias) of the PrivateLink, needed when creating the endpoint.
status str
PrivateLink status [enable, pending, disable]
id String
The provider-assigned unique ID for this managed resource.
serverName String
Name of the server having the PrivateLink enabled.
serviceName String
Service name (alias) of the PrivateLink, needed when creating the endpoint.
status String
PrivateLink status [enable, pending, disable]

Look up Existing PrivatelinkAzure Resource

Get an existing PrivatelinkAzure 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?: PrivatelinkAzureState, opts?: CustomResourceOptions): PrivatelinkAzure
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        approved_subscriptions: Optional[Sequence[str]] = None,
        instance_id: Optional[int] = None,
        server_name: Optional[str] = None,
        service_name: Optional[str] = None,
        sleep: Optional[int] = None,
        status: Optional[str] = None,
        timeout: Optional[int] = None) -> PrivatelinkAzure
func GetPrivatelinkAzure(ctx *Context, name string, id IDInput, state *PrivatelinkAzureState, opts ...ResourceOption) (*PrivatelinkAzure, error)
public static PrivatelinkAzure Get(string name, Input<string> id, PrivatelinkAzureState? state, CustomResourceOptions? opts = null)
public static PrivatelinkAzure get(String name, Output<String> id, PrivatelinkAzureState state, CustomResourceOptions options)
resources:  _:    type: cloudamqp:PrivatelinkAzure    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
ApprovedSubscriptions List<string>
Approved subscriptions to access the endpoint service. See format below.
InstanceId Changes to this property will trigger replacement. int
The CloudAMQP instance identifier.
ServerName string
Name of the server having the PrivateLink enabled.
ServiceName string
Service name (alias) of the PrivateLink, needed when creating the endpoint.
Sleep int

Configurable sleep time (seconds) when enable PrivateLink. Default set to 10 seconds.

Note: Available from [v1.29.0]

Status string
PrivateLink status [enable, pending, disable]
Timeout int

Configurable timeout time (seconds) when enable PrivateLink. Default set to 1800 seconds.

Note: Available from [v1.29.0]

Approved subscriptions format (GUID): XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

ApprovedSubscriptions []string
Approved subscriptions to access the endpoint service. See format below.
InstanceId Changes to this property will trigger replacement. int
The CloudAMQP instance identifier.
ServerName string
Name of the server having the PrivateLink enabled.
ServiceName string
Service name (alias) of the PrivateLink, needed when creating the endpoint.
Sleep int

Configurable sleep time (seconds) when enable PrivateLink. Default set to 10 seconds.

Note: Available from [v1.29.0]

Status string
PrivateLink status [enable, pending, disable]
Timeout int

Configurable timeout time (seconds) when enable PrivateLink. Default set to 1800 seconds.

Note: Available from [v1.29.0]

Approved subscriptions format (GUID): XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

approvedSubscriptions List<String>
Approved subscriptions to access the endpoint service. See format below.
instanceId Changes to this property will trigger replacement. Integer
The CloudAMQP instance identifier.
serverName String
Name of the server having the PrivateLink enabled.
serviceName String
Service name (alias) of the PrivateLink, needed when creating the endpoint.
sleep Integer

Configurable sleep time (seconds) when enable PrivateLink. Default set to 10 seconds.

Note: Available from [v1.29.0]

status String
PrivateLink status [enable, pending, disable]
timeout Integer

Configurable timeout time (seconds) when enable PrivateLink. Default set to 1800 seconds.

Note: Available from [v1.29.0]

Approved subscriptions format (GUID): XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

approvedSubscriptions string[]
Approved subscriptions to access the endpoint service. See format below.
instanceId Changes to this property will trigger replacement. number
The CloudAMQP instance identifier.
serverName string
Name of the server having the PrivateLink enabled.
serviceName string
Service name (alias) of the PrivateLink, needed when creating the endpoint.
sleep number

Configurable sleep time (seconds) when enable PrivateLink. Default set to 10 seconds.

Note: Available from [v1.29.0]

status string
PrivateLink status [enable, pending, disable]
timeout number

Configurable timeout time (seconds) when enable PrivateLink. Default set to 1800 seconds.

Note: Available from [v1.29.0]

Approved subscriptions format (GUID): XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

approved_subscriptions Sequence[str]
Approved subscriptions to access the endpoint service. See format below.
instance_id Changes to this property will trigger replacement. int
The CloudAMQP instance identifier.
server_name str
Name of the server having the PrivateLink enabled.
service_name str
Service name (alias) of the PrivateLink, needed when creating the endpoint.
sleep int

Configurable sleep time (seconds) when enable PrivateLink. Default set to 10 seconds.

Note: Available from [v1.29.0]

status str
PrivateLink status [enable, pending, disable]
timeout int

Configurable timeout time (seconds) when enable PrivateLink. Default set to 1800 seconds.

Note: Available from [v1.29.0]

Approved subscriptions format (GUID): XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

approvedSubscriptions List<String>
Approved subscriptions to access the endpoint service. See format below.
instanceId Changes to this property will trigger replacement. Number
The CloudAMQP instance identifier.
serverName String
Name of the server having the PrivateLink enabled.
serviceName String
Service name (alias) of the PrivateLink, needed when creating the endpoint.
sleep Number

Configurable sleep time (seconds) when enable PrivateLink. Default set to 10 seconds.

Note: Available from [v1.29.0]

status String
PrivateLink status [enable, pending, disable]
timeout Number

Configurable timeout time (seconds) when enable PrivateLink. Default set to 1800 seconds.

Note: Available from [v1.29.0]

Approved subscriptions format (GUID): XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

Package Details

Repository
CloudAMQP pulumi/pulumi-cloudamqp
License
Apache-2.0
Notes
This Pulumi package is based on the cloudamqp Terraform Provider.