azure-native.dashboard.ManagedPrivateEndpoint
Explore with Pulumi AI
The managed private endpoint resource type.
Uses Azure REST API version 2024-10-01. In version 2.x of the Azure Native provider, it used API version 2022-10-01-preview.
Other available API versions: 2022-10-01-preview, 2023-09-01, 2023-10-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native dashboard [ApiVersion]
. See the version guide for details.
Create ManagedPrivateEndpoint Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ManagedPrivateEndpoint(name: string, args: ManagedPrivateEndpointArgs, opts?: CustomResourceOptions);
@overload
def ManagedPrivateEndpoint(resource_name: str,
args: ManagedPrivateEndpointArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ManagedPrivateEndpoint(resource_name: str,
opts: Optional[ResourceOptions] = None,
resource_group_name: Optional[str] = None,
workspace_name: Optional[str] = None,
group_ids: Optional[Sequence[str]] = None,
location: Optional[str] = None,
managed_private_endpoint_name: Optional[str] = None,
private_link_resource_id: Optional[str] = None,
private_link_resource_region: Optional[str] = None,
private_link_service_url: Optional[str] = None,
request_message: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None)
func NewManagedPrivateEndpoint(ctx *Context, name string, args ManagedPrivateEndpointArgs, opts ...ResourceOption) (*ManagedPrivateEndpoint, error)
public ManagedPrivateEndpoint(string name, ManagedPrivateEndpointArgs args, CustomResourceOptions? opts = null)
public ManagedPrivateEndpoint(String name, ManagedPrivateEndpointArgs args)
public ManagedPrivateEndpoint(String name, ManagedPrivateEndpointArgs args, CustomResourceOptions options)
type: azure-native:dashboard:ManagedPrivateEndpoint
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. ManagedPrivateEndpointArgs - 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. ManagedPrivateEndpointArgs - 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. ManagedPrivateEndpointArgs - 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. ManagedPrivateEndpointArgs - 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. ManagedPrivateEndpointArgs - 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 managedPrivateEndpointResource = new AzureNative.Dashboard.ManagedPrivateEndpoint("managedPrivateEndpointResource", new()
{
ResourceGroupName = "string",
WorkspaceName = "string",
GroupIds = new[]
{
"string",
},
Location = "string",
ManagedPrivateEndpointName = "string",
PrivateLinkResourceId = "string",
PrivateLinkResourceRegion = "string",
PrivateLinkServiceUrl = "string",
RequestMessage = "string",
Tags =
{
{ "string", "string" },
},
});
example, err := dashboard.NewManagedPrivateEndpoint(ctx, "managedPrivateEndpointResource", &dashboard.ManagedPrivateEndpointArgs{
ResourceGroupName: pulumi.String("string"),
WorkspaceName: pulumi.String("string"),
GroupIds: pulumi.StringArray{
pulumi.String("string"),
},
Location: pulumi.String("string"),
ManagedPrivateEndpointName: pulumi.String("string"),
PrivateLinkResourceId: pulumi.String("string"),
PrivateLinkResourceRegion: pulumi.String("string"),
PrivateLinkServiceUrl: pulumi.String("string"),
RequestMessage: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var managedPrivateEndpointResource = new ManagedPrivateEndpoint("managedPrivateEndpointResource", ManagedPrivateEndpointArgs.builder()
.resourceGroupName("string")
.workspaceName("string")
.groupIds("string")
.location("string")
.managedPrivateEndpointName("string")
.privateLinkResourceId("string")
.privateLinkResourceRegion("string")
.privateLinkServiceUrl("string")
.requestMessage("string")
.tags(Map.of("string", "string"))
.build());
managed_private_endpoint_resource = azure_native.dashboard.ManagedPrivateEndpoint("managedPrivateEndpointResource",
resource_group_name="string",
workspace_name="string",
group_ids=["string"],
location="string",
managed_private_endpoint_name="string",
private_link_resource_id="string",
private_link_resource_region="string",
private_link_service_url="string",
request_message="string",
tags={
"string": "string",
})
const managedPrivateEndpointResource = new azure_native.dashboard.ManagedPrivateEndpoint("managedPrivateEndpointResource", {
resourceGroupName: "string",
workspaceName: "string",
groupIds: ["string"],
location: "string",
managedPrivateEndpointName: "string",
privateLinkResourceId: "string",
privateLinkResourceRegion: "string",
privateLinkServiceUrl: "string",
requestMessage: "string",
tags: {
string: "string",
},
});
type: azure-native:dashboard:ManagedPrivateEndpoint
properties:
groupIds:
- string
location: string
managedPrivateEndpointName: string
privateLinkResourceId: string
privateLinkResourceRegion: string
privateLinkServiceUrl: string
requestMessage: string
resourceGroupName: string
tags:
string: string
workspaceName: string
ManagedPrivateEndpoint 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 ManagedPrivateEndpoint resource accepts the following input properties:
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- Workspace
Name This property is required. Changes to this property will trigger replacement.
- The workspace name of Azure Managed Grafana.
- Group
Ids Changes to this property will trigger replacement.
- The group Ids of the managed private endpoint.
- Location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- Managed
Private Endpoint Name Changes to this property will trigger replacement.
- The managed private endpoint name of Azure Managed Grafana.
- Private
Link Resource Id Changes to this property will trigger replacement.
- The ARM resource ID of the resource for which the managed private endpoint is pointing to.
- Private
Link Resource Region Changes to this property will trigger replacement.
- The region of the resource to which the managed private endpoint is pointing to.
- Private
Link Service Url Changes to this property will trigger replacement.
- The URL of the data store behind the private link service. It would be the URL in the Grafana data source configuration page without the protocol and port.
- Request
Message Changes to this property will trigger replacement.
- User input request message of the managed private endpoint.
- Dictionary<string, string>
- Resource tags.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- Workspace
Name This property is required. Changes to this property will trigger replacement.
- The workspace name of Azure Managed Grafana.
- Group
Ids Changes to this property will trigger replacement.
- The group Ids of the managed private endpoint.
- Location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- Managed
Private Endpoint Name Changes to this property will trigger replacement.
- The managed private endpoint name of Azure Managed Grafana.
- Private
Link Resource Id Changes to this property will trigger replacement.
- The ARM resource ID of the resource for which the managed private endpoint is pointing to.
- Private
Link Resource Region Changes to this property will trigger replacement.
- The region of the resource to which the managed private endpoint is pointing to.
- Private
Link Service Url Changes to this property will trigger replacement.
- The URL of the data store behind the private link service. It would be the URL in the Grafana data source configuration page without the protocol and port.
- Request
Message Changes to this property will trigger replacement.
- User input request message of the managed private endpoint.
- map[string]string
- Resource tags.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- workspace
Name This property is required. Changes to this property will trigger replacement.
- The workspace name of Azure Managed Grafana.
- group
Ids Changes to this property will trigger replacement.
- The group Ids of the managed private endpoint.
- location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- managed
Private Endpoint Name Changes to this property will trigger replacement.
- The managed private endpoint name of Azure Managed Grafana.
- private
Link Resource Id Changes to this property will trigger replacement.
- The ARM resource ID of the resource for which the managed private endpoint is pointing to.
- private
Link Resource Region Changes to this property will trigger replacement.
- The region of the resource to which the managed private endpoint is pointing to.
- private
Link Service Url Changes to this property will trigger replacement.
- The URL of the data store behind the private link service. It would be the URL in the Grafana data source configuration page without the protocol and port.
- request
Message Changes to this property will trigger replacement.
- User input request message of the managed private endpoint.
- Map<String,String>
- Resource tags.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- workspace
Name This property is required. Changes to this property will trigger replacement.
- The workspace name of Azure Managed Grafana.
- group
Ids Changes to this property will trigger replacement.
- The group Ids of the managed private endpoint.
- location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- managed
Private Endpoint Name Changes to this property will trigger replacement.
- The managed private endpoint name of Azure Managed Grafana.
- private
Link Resource Id Changes to this property will trigger replacement.
- The ARM resource ID of the resource for which the managed private endpoint is pointing to.
- private
Link Resource Region Changes to this property will trigger replacement.
- The region of the resource to which the managed private endpoint is pointing to.
- private
Link Service Url Changes to this property will trigger replacement.
- The URL of the data store behind the private link service. It would be the URL in the Grafana data source configuration page without the protocol and port.
- request
Message Changes to this property will trigger replacement.
- User input request message of the managed private endpoint.
- {[key: string]: string}
- Resource tags.
- resource_
group_ name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- workspace_
name This property is required. Changes to this property will trigger replacement.
- The workspace name of Azure Managed Grafana.
- group_
ids Changes to this property will trigger replacement.
- The group Ids of the managed private endpoint.
- location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- managed_
private_ endpoint_ name Changes to this property will trigger replacement.
- The managed private endpoint name of Azure Managed Grafana.
- private_
link_ resource_ id Changes to this property will trigger replacement.
- The ARM resource ID of the resource for which the managed private endpoint is pointing to.
- private_
link_ resource_ region Changes to this property will trigger replacement.
- The region of the resource to which the managed private endpoint is pointing to.
- private_
link_ service_ url Changes to this property will trigger replacement.
- The URL of the data store behind the private link service. It would be the URL in the Grafana data source configuration page without the protocol and port.
- request_
message Changes to this property will trigger replacement.
- User input request message of the managed private endpoint.
- Mapping[str, str]
- Resource tags.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- workspace
Name This property is required. Changes to this property will trigger replacement.
- The workspace name of Azure Managed Grafana.
- group
Ids Changes to this property will trigger replacement.
- The group Ids of the managed private endpoint.
- location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- managed
Private Endpoint Name Changes to this property will trigger replacement.
- The managed private endpoint name of Azure Managed Grafana.
- private
Link Resource Id Changes to this property will trigger replacement.
- The ARM resource ID of the resource for which the managed private endpoint is pointing to.
- private
Link Resource Region Changes to this property will trigger replacement.
- The region of the resource to which the managed private endpoint is pointing to.
- private
Link Service Url Changes to this property will trigger replacement.
- The URL of the data store behind the private link service. It would be the URL in the Grafana data source configuration page without the protocol and port.
- request
Message Changes to this property will trigger replacement.
- User input request message of the managed private endpoint.
- Map<String>
- Resource tags.
Outputs
All input properties are implicitly available as output properties. Additionally, the ManagedPrivateEndpoint resource produces the following output properties:
- Azure
Api stringVersion - The Azure API version of the resource.
- Connection
State Pulumi.Azure Native. Dashboard. Outputs. Managed Private Endpoint Connection State Response - The state of managed private endpoint connection.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- Private
Link stringService Private IP - The private IP of private endpoint after approval. This property is empty before connection is approved.
- Provisioning
State string - Provisioning state of the resource.
- System
Data Pulumi.Azure Native. Dashboard. Outputs. System Data Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Azure
Api stringVersion - The Azure API version of the resource.
- Connection
State ManagedPrivate Endpoint Connection State Response - The state of managed private endpoint connection.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- Private
Link stringService Private IP - The private IP of private endpoint after approval. This property is empty before connection is approved.
- Provisioning
State string - Provisioning state of the resource.
- System
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- azure
Api StringVersion - The Azure API version of the resource.
- connection
State ManagedPrivate Endpoint Connection State Response - The state of managed private endpoint connection.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- private
Link StringService Private IP - The private IP of private endpoint after approval. This property is empty before connection is approved.
- provisioning
State String - Provisioning state of the resource.
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- azure
Api stringVersion - The Azure API version of the resource.
- connection
State ManagedPrivate Endpoint Connection State Response - The state of managed private endpoint connection.
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- The name of the resource
- private
Link stringService Private IP - The private IP of private endpoint after approval. This property is empty before connection is approved.
- provisioning
State string - Provisioning state of the resource.
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- azure_
api_ strversion - The Azure API version of the resource.
- connection_
state ManagedPrivate Endpoint Connection State Response - The state of managed private endpoint connection.
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- The name of the resource
- private_
link_ strservice_ private_ ip - The private IP of private endpoint after approval. This property is empty before connection is approved.
- provisioning_
state str - Provisioning state of the resource.
- system_
data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type str
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- azure
Api StringVersion - The Azure API version of the resource.
- connection
State Property Map - The state of managed private endpoint connection.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- private
Link StringService Private IP - The private IP of private endpoint after approval. This property is empty before connection is approved.
- provisioning
State String - Provisioning state of the resource.
- system
Data Property Map - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Supporting Types
ManagedPrivateEndpointConnectionStateResponse, ManagedPrivateEndpointConnectionStateResponseArgs
- Description
This property is required. string - Gets or sets the reason for approval/rejection of the connection.
- Status
This property is required. string - The approval/rejection status of managed private endpoint connection.
- Description
This property is required. string - Gets or sets the reason for approval/rejection of the connection.
- Status
This property is required. string - The approval/rejection status of managed private endpoint connection.
- description
This property is required. String - Gets or sets the reason for approval/rejection of the connection.
- status
This property is required. String - The approval/rejection status of managed private endpoint connection.
- description
This property is required. string - Gets or sets the reason for approval/rejection of the connection.
- status
This property is required. string - The approval/rejection status of managed private endpoint connection.
- description
This property is required. str - Gets or sets the reason for approval/rejection of the connection.
- status
This property is required. str - The approval/rejection status of managed private endpoint connection.
- description
This property is required. String - Gets or sets the reason for approval/rejection of the connection.
- status
This property is required. String - The approval/rejection status of managed private endpoint connection.
SystemDataResponse, SystemDataResponseArgs
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - 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_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - 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:dashboard:ManagedPrivateEndpoint myMPEName /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Dashboard/grafana/{workspaceName}/managedPrivateEndpoints/{managedPrivateEndpointName}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0