region_share_networks

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

Overview

Name	region_share_networks
Type	Resource
Id	ovh.cloud_storage.region_share_networks

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string (uuid)	Share network ID
name	string	Share network name
network_id	string (uuid)	Private network ID (wire: networkId)
subnet_id	string (uuid)	Subnet ID (wire: subnetId)
availability_zone	string	Availability zone (wire: availabilityZone)
cidr	string (ip-block)	Subnet CIDR (example: 192.0.2.0/24)
created_at	string (date-time)	The date and timestamp when the resource was created (wire: createdAt)
description	string	Share network description
region	string	Region
updated_at	string (date-time)	The date and timestamp when the resource was last updated (wire: updatedAt)

list

Share network

Name	Datatype	Description
id	string (uuid)	Share network ID
name	string	Share network name
network_id	string (uuid)	Private network ID (wire: networkId)
subnet_id	string (uuid)	Subnet ID (wire: subnetId)
availability_zone	string	Availability zone (wire: availabilityZone)
cidr	string (ip-block)	Subnet CIDR (example: 192.0.2.0/24)
created_at	string (date-time)	The date and timestamp when the resource was created (wire: createdAt)
description	string	Share network description
region	string	Region
updated_at	string (date-time)	The date and timestamp when the resource was last updated (wire: updatedAt)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	region_name, share_network_id, service_name		Get share network
list	select	region_name, service_name		List share networks
create	insert	region_name, service_name, network_id, subnet_id		Create share network
delete	delete	region_name, share_network_id, service_name		Delete share network

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
api_host	string	The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})
region_name	string	Region name (wire: regionName)
service_name	string	The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.
share_network_id	string (uuid)	Share network ID (wire: shareNetworkId)

SELECT examples

get

Get share network

SELECT
id,
name,
network_id,
subnet_id,
availability_zone,
cidr,
created_at,
description,
region,
updated_at
FROM ovh.cloud_storage.region_share_networks
WHERE region_name = '{{ region_name }}' -- required
AND share_network_id = '{{ share_network_id }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

list

List share networks

SELECT
id,
name,
network_id,
subnet_id,
availability_zone,
cidr,
created_at,
description,
region,
updated_at
FROM ovh.cloud_storage.region_share_networks
WHERE region_name = '{{ region_name }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

INSERT examples

create

Create share network

INSERT INTO ovh.cloud_storage.region_share_networks (
availability_zone,
description,
name,
network_id,
subnet_id,
region_name,
service_name
)
SELECT 
'{{ availability_zone }}',
'{{ description }}',
'{{ name }}',
'{{ network_id }}' /* required */,
'{{ subnet_id }}' /* required */,
'{{ region_name }}',
'{{ service_name }}'
RETURNING
id,
name,
network_id,
subnet_id,
availability_zone,
cidr,
created_at,
description,
region,
updated_at
;

Manifest

# Description fields are for documentation purposes
- name: region_share_networks
props:
  - name: region_name
    value: "{{ region_name }}"
    description: Required parameter for the region_share_networks resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the region_share_networks resource.
  - name: availability_zone
    value: "{{ availability_zone }}"
    description: |
      Availability zone for the share network (required in 3AZ regions)
  - name: description
    value: "{{ description }}"
    description: |
      Share network description
  - name: name
    value: "{{ name }}"
    description: |
      Share network name
  - name: network_id
    value: "{{ network_id }}"
    description: |
      Private network ID
  - name: subnet_id
    value: "{{ subnet_id }}"
    description: |
      Subnet ID

DELETE examples

delete

Delete share network

DELETE FROM ovh.cloud_storage.region_share_networks
WHERE region_name = '{{ region_name }}' --required
AND share_network_id = '{{ share_network_id }}' --required
AND service_name = '{{ service_name }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set
;