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
extendedLocation	object	The extendedLocation of the resource.
location	string	The geo-location where the resource lives
properties	object	null
sku	object	Resource sku.
tags	object	Resource tags.

list_by_resource_group

Name	Datatype	Description
extendedLocation	object	The extendedLocation of the resource.
location	string	The geo-location where the resource lives
properties	object	null
sku	object	Resource sku.
tags	object	Resource tags.

list

Name	Datatype	Description
extendedLocation	object	The extendedLocation of the resource.
location	string	The geo-location where the resource lives
properties	object	null
sku	object	Resource sku.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, postgresInstanceName	api-version	Retrieves a postgres Instance resource
list_by_resource_group	select	subscriptionId, resourceGroupName	api-version	Get a postgres Instances list by Resource group name.
list	select	subscriptionId	api-version
create	insert	subscriptionId, resourceGroupName, postgresInstanceName, data__properties	api-version	Creates or replaces a postgres Instance resource
update	update	subscriptionId, resourceGroupName, postgresInstanceName	api-version	Updates a postgres Instance resource
delete	delete	subscriptionId, resourceGroupName, postgresInstanceName	api-version	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
postgresInstanceName	string	Name of Postgres Instance
resourceGroupName	string	The name of the Azure resource group
subscriptionId	string	The ID of the Azure subscription
api-version	string	The API version to use for the request

SELECT examples

get

Retrieves a postgres Instance resource

SELECT
extendedLocation,
location,
properties,
sku,
tags
FROM azure.azure_arc_data.postgres_instances
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND postgresInstanceName = '{{ postgresInstanceName }}' -- required
AND api-version = '{{ api-version }}'
;

list_by_resource_group

Get a postgres Instances list by Resource group name.

SELECT
extendedLocation,
location,
properties,
sku,
tags
FROM azure.azure_arc_data.postgres_instances
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND api-version = '{{ api-version }}'
;

list

OK

SELECT
extendedLocation,
location,
properties,
sku,
tags
FROM azure.azure_arc_data.postgres_instances
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND api-version = '{{ api-version }}'
;

INSERT examples

create

Creates or replaces a postgres Instance resource

INSERT INTO azure.azure_arc_data.postgres_instances (
data__tags,
data__location,
data__extendedLocation,
data__properties,
data__sku,
subscriptionId,
resourceGroupName,
postgresInstanceName,
api-version
)
SELECT 
'{{ tags }}',
'{{ location }}',
'{{ extendedLocation }}',
'{{ properties }}' /* required */,
'{{ sku }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ postgresInstanceName }}',
'{{ api-version }}'
RETURNING
extendedLocation,
location,
properties,
sku,
tags
;

Manifest

# Description fields are for documentation purposes
- name: postgres_instances
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the postgres_instances resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the postgres_instances resource.
    - name: postgresInstanceName
      value: string
      description: Required parameter for the postgres_instances resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives
    - name: extendedLocation
      value: object
      description: |
        The extendedLocation of the resource.
    - name: properties
      value: object
      description: |
        null
    - name: sku
      value: object
      description: |
        Resource sku.
    - name: api-version
      value: string
      description: The API version to use for the request

UPDATE examples

update

Updates a postgres Instance resource

UPDATE azure.azure_arc_data.postgres_instances
SET 
data__tags = '{{ tags }}',
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND postgresInstanceName = '{{ postgresInstanceName }}' --required
AND api-version = '{{ api-version}}'
RETURNING
extendedLocation,
location,
properties,
sku,
tags;

DELETE examples

delete

Deletes a postgres Instance resource

DELETE FROM azure.azure_arc_data.postgres_instances
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND postgresInstanceName = '{{ postgresInstanceName }}' --required
AND api-version = '{{ api-version }}'
;