postgres_instances

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

Overview

Name	postgres_instances
Type	Resource
Id	azure.azure_arc_data.postgres_instances

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.
admin	string	The instance admin.
basicLoginInformation	object	Username and password for basic authentication.
dataControllerId	string	The data controller id.
extendedLocation	object	The extendedLocation of the resource.
k8sRaw	object	The raw kubernetes information.
lastUploadedDate	string (date-time)	Last uploaded date from Kubernetes cluster. Defaults to current date time.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The provisioning state of the Azure Arc-enabled PostgreSQL instance.
sku	object	Resource sku.
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_by_resource_group

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.
admin	string	The instance admin.
basicLoginInformation	object	Username and password for basic authentication.
dataControllerId	string	The data controller id.
extendedLocation	object	The extendedLocation of the resource.
k8sRaw	object	The raw kubernetes information.
lastUploadedDate	string (date-time)	Last uploaded date from Kubernetes cluster. Defaults to current date time.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The provisioning state of the Azure Arc-enabled PostgreSQL instance.
sku	object	Resource sku.
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.
admin	string	The instance admin.
basicLoginInformation	object	Username and password for basic authentication.
dataControllerId	string	The data controller id.
extendedLocation	object	The extendedLocation of the resource.
k8sRaw	object	The raw kubernetes information.
lastUploadedDate	string (date-time)	Last uploaded date from Kubernetes cluster. Defaults to current date time.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The provisioning state of the Azure Arc-enabled PostgreSQL instance.
sku	object	Resource sku.
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, postgres_instance_name, subscription_id		Retrieves a postgres Instance resource.
list_by_resource_group	select	resource_group_name, subscription_id		List postgres Instance resources in the resource group. Get a postgres Instances list by Resource group name.
list	select	subscription_id		List postgres Instance resources in the subscription. List postgres Instance resources in the subscription.
create	insert	resource_group_name, postgres_instance_name, subscription_id, location, properties		Creates or replaces a postgres Instance resource.
update	update	resource_group_name, postgres_instance_name, subscription_id		Updates a postgres Instance resource.
delete	delete	resource_group_name, postgres_instance_name, subscription_id		Deletes a postgres Instance 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
postgres_instance_name	string	Name of Postgres Instance. Required.
resource_group_name	string	The name of the Azure resource group. Required.
subscription_id	string

SELECT examples

get

Retrieves a postgres Instance resource.

SELECT
id,
name,
admin,
basicLoginInformation,
dataControllerId,
extendedLocation,
k8sRaw,
lastUploadedDate,
location,
provisioningState,
sku,
systemData,
tags,
type
FROM azure.azure_arc_data.postgres_instances
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND postgres_instance_name = '{{ postgres_instance_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List postgres Instance resources in the resource group. Get a postgres Instances list by Resource group name.

SELECT
id,
name,
admin,
basicLoginInformation,
dataControllerId,
extendedLocation,
k8sRaw,
lastUploadedDate,
location,
provisioningState,
sku,
systemData,
tags,
type
FROM azure.azure_arc_data.postgres_instances
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List postgres Instance resources in the subscription. List postgres Instance resources in the subscription.

SELECT
id,
name,
admin,
basicLoginInformation,
dataControllerId,
extendedLocation,
k8sRaw,
lastUploadedDate,
location,
provisioningState,
sku,
systemData,
tags,
type
FROM azure.azure_arc_data.postgres_instances
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Creates or replaces a postgres Instance resource.

INSERT INTO azure.azure_arc_data.postgres_instances (
tags,
location,
extendedLocation,
properties,
sku,
resource_group_name,
postgres_instance_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ extendedLocation }}',
'{{ properties }}' /* required */,
'{{ sku }}',
'{{ resource_group_name }}',
'{{ postgres_instance_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
extendedLocation,
location,
properties,
sku,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: postgres_instances
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the postgres_instances resource.
  - name: postgres_instance_name
    value: "{{ postgres_instance_name }}"
    description: Required parameter for the postgres_instances resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the postgres_instances resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: extendedLocation
    description: |
      The extendedLocation of the resource.
    value:
      name: "{{ name }}"
      type: "{{ type }}"
  - name: properties
    description: |
      null. Required.
    value:
      dataControllerId: "{{ dataControllerId }}"
      admin: "{{ admin }}"
      basicLoginInformation:
        username: "{{ username }}"
        password: "{{ password }}"
      k8sRaw: "{{ k8sRaw }}"
      lastUploadedDate: "{{ lastUploadedDate }}"
      provisioningState: "{{ provisioningState }}"
  - name: sku
    description: |
      Resource sku.
    value:
      name: "{{ name }}"
      dev: {{ dev }}
      size: "{{ size }}"
      family: "{{ family }}"
      capacity: {{ capacity }}
      tier: "{{ tier }}"

UPDATE examples

update

Updates a postgres Instance resource.

UPDATE azure.azure_arc_data.postgres_instances
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND postgres_instance_name = '{{ postgres_instance_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
extendedLocation,
location,
properties,
sku,
systemData,
tags,
type;

DELETE examples

delete

Deletes a postgres Instance resource.

DELETE FROM azure.azure_arc_data.postgres_instances
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND postgres_instance_name = '{{ postgres_instance_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;