private_accesses

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

Overview

Name	private_accesses
Type	Resource
Id	azure.chaos.private_accesses

Fields

The following fields are returned by SELECT queries:

get_a_private_endpoint_connection

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.
groupIds	array	The group ids for the private endpoint resource.
privateEndpoint	object	The private endpoint resource.
privateLinkServiceConnectionState	object	A collection of information about the state of the connection between service consumer and provider. Required.
provisioningState	string	The provisioning state of the private endpoint connection resource. Known values are: "Succeeded", "Failed", "Canceled", "Creating", "Updating", "Deleting", and "Running". (Succeeded, Failed, Canceled, Creating, Updating, Deleting, Running)
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".

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.
location	string	The geo-location where the resource lives. Required.
privateEndpointConnections	array	A readonly collection of private endpoint connection. Currently only one endpoint connection is supported.
provisioningState	string	Most recent provisioning state for the given privateAccess resource. Known values are: "Succeeded", "Failed", "Canceled", "Creating", "Updating", "Deleting", and "Running". (Succeeded, Failed, Canceled, Creating, Updating, Deleting, Running)
publicNetworkAccess	string	Public Network Access Control for PrivateAccess resource. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
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.
location	string	The geo-location where the resource lives. Required.
privateEndpointConnections	array	A readonly collection of private endpoint connection. Currently only one endpoint connection is supported.
provisioningState	string	Most recent provisioning state for the given privateAccess resource. Known values are: "Succeeded", "Failed", "Canceled", "Creating", "Updating", "Deleting", and "Running". (Succeeded, Failed, Canceled, Creating, Updating, Deleting, Running)
publicNetworkAccess	string	Public Network Access Control for PrivateAccess resource. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
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_all

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.
location	string	The geo-location where the resource lives. Required.
privateEndpointConnections	array	A readonly collection of private endpoint connection. Currently only one endpoint connection is supported.
provisioningState	string	Most recent provisioning state for the given privateAccess resource. Known values are: "Succeeded", "Failed", "Canceled", "Creating", "Updating", "Deleting", and "Running". (Succeeded, Failed, Canceled, Creating, Updating, Deleting, Running)
publicNetworkAccess	string	Public Network Access Control for PrivateAccess resource. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
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_a_private_endpoint_connection	select	resource_group_name, private_access_name, private_endpoint_connection_name, subscription_id		Gets information about a private endpoint connection under a private access resource.
get	select	resource_group_name, private_access_name, subscription_id		Get a private access resource.
list	select	resource_group_name, subscription_id	continuationToken	Get a list of private access resources in a resource group.
list_all	select	subscription_id	continuationToken	Get a list of private access resources in a subscription.
create_or_update	insert	resource_group_name, private_access_name, subscription_id, location, properties		Create or update a private access.
update	update	resource_group_name, private_access_name, subscription_id		Patch a private access tags.
create_or_update	replace	resource_group_name, private_access_name, subscription_id, location, properties		Create or update a private access.
delete	delete	resource_group_name, private_access_name, subscription_id		Delete a private access.
list_private_endpoint_connections	exec	resource_group_name, private_access_name, subscription_id		List information about private endpoint connections under a private access resource.
get_private_link_resources	exec	resource_group_name, private_access_name, subscription_id		Gets the private link resources possible under private access resource.
delete_a_private_endpoint_connection	exec	resource_group_name, private_access_name, private_endpoint_connection_name, subscription_id		Deletes a private endpoint connection under a private access resource.

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
private_access_name	string	The name of the private access resource that is being created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters. Required.
private_endpoint_connection_name	string	The name of the private endpoint connection. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
continuationToken	string	String that sets the continuation token. Default value is None.

SELECT examples

get_a_private_endpoint_connection

Gets information about a private endpoint connection under a private access resource.

SELECT
id,
name,
groupIds,
privateEndpoint,
privateLinkServiceConnectionState,
provisioningState,
systemData,
type
FROM azure.chaos.private_accesses
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND private_access_name = '{{ private_access_name }}' -- required
AND private_endpoint_connection_name = '{{ private_endpoint_connection_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get

Get a private access resource.

SELECT
id,
name,
location,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
systemData,
tags,
type
FROM azure.chaos.private_accesses
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND private_access_name = '{{ private_access_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Get a list of private access resources in a resource group.

SELECT
id,
name,
location,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
systemData,
tags,
type
FROM azure.chaos.private_accesses
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND continuationToken = '{{ continuationToken }}'
;

list_all

Get a list of private access resources in a subscription.

SELECT
id,
name,
location,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
systemData,
tags,
type
FROM azure.chaos.private_accesses
WHERE subscription_id = '{{ subscription_id }}' -- required
AND continuationToken = '{{ continuationToken }}'
;

INSERT examples

create_or_update

Create or update a private access.

INSERT INTO azure.chaos.private_accesses (
tags,
location,
properties,
resource_group_name,
private_access_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ private_access_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: private_accesses
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the private_accesses resource.
  - name: private_access_name
    value: "{{ private_access_name }}"
    description: Required parameter for the private_accesses resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the private_accesses resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The resource-specific properties for this resource. Required.
    value:
      provisioningState: "{{ provisioningState }}"
      privateEndpointConnections:
        - id: "{{ id }}"
          name: "{{ name }}"
          type: "{{ type }}"
          systemData:
            createdBy: "{{ createdBy }}"
            createdByType: "{{ createdByType }}"
            createdAt: "{{ createdAt }}"
            lastModifiedBy: "{{ lastModifiedBy }}"
            lastModifiedByType: "{{ lastModifiedByType }}"
            lastModifiedAt: "{{ lastModifiedAt }}"
          properties:
            groupIds:
              - "{{ groupIds }}"
            privateEndpoint:
              id: "{{ id }}"
            privateLinkServiceConnectionState:
              status: "{{ status }}"
              description: "{{ description }}"
              actionsRequired: "{{ actionsRequired }}"
            provisioningState: "{{ provisioningState }}"
      publicNetworkAccess: "{{ publicNetworkAccess }}"

UPDATE examples

update

Patch a private access tags.

UPDATE azure.chaos.private_accesses
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND private_access_name = '{{ private_access_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create or update a private access.

REPLACE azure.chaos.private_accesses
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND private_access_name = '{{ private_access_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete a private access.

DELETE FROM azure.chaos.private_accesses
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND private_access_name = '{{ private_access_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_private_endpoint_connections

List information about private endpoint connections under a private access resource.

EXEC azure.chaos.private_accesses.list_private_endpoint_connections 
@resource_group_name='{{ resource_group_name }}' --required, 
@private_access_name='{{ private_access_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_private_link_resources

Gets the private link resources possible under private access resource.

EXEC azure.chaos.private_accesses.get_private_link_resources 
@resource_group_name='{{ resource_group_name }}' --required, 
@private_access_name='{{ private_access_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

delete_a_private_endpoint_connection

Deletes a private endpoint connection under a private access resource.

EXEC azure.chaos.private_accesses.delete_a_private_endpoint_connection 
@resource_group_name='{{ resource_group_name }}' --required, 
@private_access_name='{{ private_access_name }}' --required, 
@private_endpoint_connection_name='{{ private_endpoint_connection_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;