private_endpoint_connections
Creates, updates, deletes, gets or lists a private_endpoint_connections
resource.
Overview
Name | private_endpoint_connections |
Type | Resource |
Id | azure.dashboard.private_endpoint_connections |
Fields
The following fields are returned by SELECT
queries:
- get
- list
OK. Return the list of the private endpoint connections for Grafana resource.
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 |
properties | object | Resource properties. |
systemData | object | 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" |
OK. Return the list of the private endpoint connections for Grafana resource.
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 |
properties | object | Resource properties. |
systemData | object | 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" |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
get | select | subscriptionId , resourceGroupName , workspaceName , privateEndpointConnectionName | ||
list | select | subscriptionId , resourceGroupName , workspaceName | ||
delete | delete | subscriptionId , resourceGroupName , workspaceName , privateEndpointConnectionName | ||
approve | exec | subscriptionId , resourceGroupName , workspaceName , privateEndpointConnectionName |
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 |
---|---|---|
privateEndpointConnectionName | string | The private endpoint connection name of Azure Managed Grafana. |
resourceGroupName | string | The name of the resource group. The name is case insensitive. |
subscriptionId | string | The ID of the target subscription. |
workspaceName | string | The workspace name of Azure Managed Grafana. |
SELECT
examples
- get
- list
OK. Return the list of the private endpoint connections for Grafana resource.
SELECT
id,
name,
properties,
systemData,
type
FROM azure.dashboard.private_endpoint_connections
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND privateEndpointConnectionName = '{{ privateEndpointConnectionName }}' -- required
;
OK. Return the list of the private endpoint connections for Grafana resource.
SELECT
id,
name,
properties,
systemData,
type
FROM azure.dashboard.private_endpoint_connections
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
;
DELETE
examples
- delete
No description available.
DELETE FROM azure.dashboard.private_endpoint_connections
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND workspaceName = '{{ workspaceName }}' --required
AND privateEndpointConnectionName = '{{ privateEndpointConnectionName }}' --required
;
Lifecycle Methods
- approve
Created. The operation was successfully started and will complete asynchronously.
EXEC azure.dashboard.private_endpoint_connections.approve
@subscriptionId='{{ subscriptionId }}' --required,
@resourceGroupName='{{ resourceGroupName }}' --required,
@workspaceName='{{ workspaceName }}' --required,
@privateEndpointConnectionName='{{ privateEndpointConnectionName }}' --required
@@json=
'{
"properties": "{{ properties }}"
}'
;