private_endpoint
Creates, updates, deletes, gets or lists a private_endpoint resource.
Overview
| Name | private_endpoint |
| Type | Resource |
| Id | azure.recovery_services_backup.private_endpoint |
Fields
The following fields are returned by SELECT queries:
- get_operation_status
| Name | Datatype | Description |
|---|---|---|
id | string | ID of the operation. |
name | string | Name of the operation. |
endTime | string (date-time) | Operation end time. Format: ISO-8601. |
error | object | Error information related to this operation. |
objectType | string | This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. Required. Default value is None. |
startTime | string (date-time) | Operation start time. Format: ISO-8601. |
status | string | Operation status. Known values are: "Invalid", "InProgress", "Succeeded", "Failed", and "Canceled". (Invalid, InProgress, Succeeded, Failed, Canceled) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_operation_status | select | vault_name, resource_group_name, private_endpoint_connection_name, operation_id, subscription_id | Gets the operation status for a private endpoint connection. |
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 |
|---|---|---|
operation_id | string | The name of the PrivateEndpointConnectionResource. Required. |
private_endpoint_connection_name | string | The name of the PrivateEndpointConnectionResource. Required. |
resource_group_name | string | The name of the resource group. The name is case insensitive. Required. |
subscription_id | string | |
vault_name | string | vaults. Required. |
SELECT examples
- get_operation_status
Gets the operation status for a private endpoint connection.
SELECT
id,
name,
endTime,
error,
objectType,
startTime,
status
FROM azure.recovery_services_backup.private_endpoint
WHERE vault_name = '{{ vault_name }}' -- required
AND resource_group_name = '{{ resource_group_name }}' -- required
AND private_endpoint_connection_name = '{{ private_endpoint_connection_name }}' -- required
AND operation_id = '{{ operation_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;