managed_private_endpoints

Creates, updates, deletes, gets or lists a managed_private_endpoints resource.

Overview

Name	managed_private_endpoints
Type	Resource
Id	azure.dashboard.managed_private_endpoints

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
connectionState	object	The state of managed private endpoint connection.
groupIds	array	The group Ids of the managed private endpoint.
location	string	The geo-location where the resource lives. Required.
privateLinkResourceId	string	The ARM resource ID of the resource for which the managed private endpoint is pointing to.
privateLinkResourceRegion	string	The region of the resource to which the managed private endpoint is pointing to.
privateLinkServicePrivateIP	string	The private IP of private endpoint after approval. This property is empty before connection is approved.
privateLinkServiceUrl	string	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.
provisioningState	string	Provisioning state of the resource. Known values are: "Accepted", "Creating", "Updating", "Deleting", "Succeeded", "Failed", "Canceled", "Deleted", and "NotSpecified". (Accepted, Creating, Updating, Deleting, Succeeded, Failed, Canceled, Deleted, NotSpecified)
requestMessage	string	User input request message of the managed private endpoint.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
connectionState	object	The state of managed private endpoint connection.
groupIds	array	The group Ids of the managed private endpoint.
location	string	The geo-location where the resource lives. Required.
privateLinkResourceId	string	The ARM resource ID of the resource for which the managed private endpoint is pointing to.
privateLinkResourceRegion	string	The region of the resource to which the managed private endpoint is pointing to.
privateLinkServicePrivateIP	string	The private IP of private endpoint after approval. This property is empty before connection is approved.
privateLinkServiceUrl	string	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.
provisioningState	string	Provisioning state of the resource. Known values are: "Accepted", "Creating", "Updating", "Deleting", "Succeeded", "Failed", "Canceled", "Deleted", and "NotSpecified". (Accepted, Creating, Updating, Deleting, Succeeded, Failed, Canceled, Deleted, NotSpecified)
requestMessage	string	User input request message of the managed private endpoint.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, workspace_name, managed_private_endpoint_name, subscription_id		Get a specific managed private endpoint of a grafana resource.
list	select	resource_group_name, workspace_name, subscription_id		List all managed private endpoints of a grafana resource.
create	insert	resource_group_name, workspace_name, managed_private_endpoint_name, subscription_id, location		Create or update a managed private endpoint for a grafana resource.
update	update	resource_group_name, workspace_name, managed_private_endpoint_name, subscription_id		Update a managed private endpoint for an existing grafana resource.
delete	delete	resource_group_name, workspace_name, managed_private_endpoint_name, subscription_id		Delete a managed private endpoint for a grafana resource.
refresh	exec	resource_group_name, workspace_name, subscription_id		Refresh and sync managed private endpoints of a grafana resource to latest state.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
managed_private_endpoint_name	string	The managed private endpoint name of Azure Managed Grafana. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
workspace_name	string	The workspace name of Azure Managed Grafana. Required.

SELECT examples

get

Get a specific managed private endpoint of a grafana resource.

SELECT
id,
name,
connectionState,
groupIds,
location,
privateLinkResourceId,
privateLinkResourceRegion,
privateLinkServicePrivateIP,
privateLinkServiceUrl,
provisioningState,
requestMessage,
systemData,
tags,
type
FROM azure.dashboard.managed_private_endpoints
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND managed_private_endpoint_name = '{{ managed_private_endpoint_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List all managed private endpoints of a grafana resource.

SELECT
id,
name,
connectionState,
groupIds,
location,
privateLinkResourceId,
privateLinkResourceRegion,
privateLinkServicePrivateIP,
privateLinkServiceUrl,
provisioningState,
requestMessage,
systemData,
tags,
type
FROM azure.dashboard.managed_private_endpoints
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Create or update a managed private endpoint for a grafana resource.

INSERT INTO azure.dashboard.managed_private_endpoints (
tags,
location,
properties,
resource_group_name,
workspace_name,
managed_private_endpoint_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ workspace_name }}',
'{{ managed_private_endpoint_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: managed_private_endpoints
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the managed_private_endpoints resource.
  - name: workspace_name
    value: "{{ workspace_name }}"
    description: Required parameter for the managed_private_endpoints resource.
  - name: managed_private_endpoint_name
    value: "{{ managed_private_endpoint_name }}"
    description: Required parameter for the managed_private_endpoints resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the managed_private_endpoints resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      Resource properties.
    value:
      provisioningState: "{{ provisioningState }}"
      privateLinkResourceId: "{{ privateLinkResourceId }}"
      privateLinkResourceRegion: "{{ privateLinkResourceRegion }}"
      groupIds:
        - "{{ groupIds }}"
      requestMessage: "{{ requestMessage }}"
      connectionState:
        status: "{{ status }}"
        description: "{{ description }}"
      privateLinkServiceUrl: "{{ privateLinkServiceUrl }}"
      privateLinkServicePrivateIP: "{{ privateLinkServicePrivateIP }}"

UPDATE examples

update

Update a managed private endpoint for an existing grafana resource.

UPDATE azure.dashboard.managed_private_endpoints
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND managed_private_endpoint_name = '{{ managed_private_endpoint_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete a managed private endpoint for a grafana resource.

DELETE FROM azure.dashboard.managed_private_endpoints
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND managed_private_endpoint_name = '{{ managed_private_endpoint_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

refresh

Refresh and sync managed private endpoints of a grafana resource to latest state.

EXEC azure.dashboard.managed_private_endpoints.refresh 
@resource_group_name='{{ resource_group_name }}' --required, 
@workspace_name='{{ workspace_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;