file_containers

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

Overview

Name	file_containers
Type	Resource
Id	azure_stack.deployment_admin.file_containers

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	ID of the resource.
name	string	Name of the resource.
location	string	Location of the resource.
properties	object	File Container properties
type	string	Type of Resource.

list

Name	Datatype	Description
id	string	ID of the resource.
name	string	Name of the resource.
location	string	Location of the resource.
properties	object	File Container properties
type	string	Type of Resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, fileContainerId		Retrieves the specific file container details.
list	select	subscriptionId		Returns an array of file containers.
create	insert	subscriptionId, fileContainerId		Creates a new file container.
delete	delete	subscriptionId, fileContainerId		Delete an existing file container.

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
fileContainerId	string	The file container identifier.
subscriptionId	string	Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

SELECT examples

get

Retrieves the specific file container details.

SELECT
id,
name,
location,
properties,
type
FROM azure_stack.deployment_admin.file_containers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND fileContainerId = '{{ fileContainerId }}' -- required
;

list

Returns an array of file containers.

SELECT
id,
name,
location,
properties,
type
FROM azure_stack.deployment_admin.file_containers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create

Creates a new file container.

INSERT INTO azure_stack.deployment_admin.file_containers (
data__properties,
subscriptionId,
fileContainerId
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ fileContainerId }}'
RETURNING
id,
name,
location,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: file_containers
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the file_containers resource.
    - name: fileContainerId
      value: string
      description: Required parameter for the file_containers resource.
    - name: properties
      value: object
      description: |
        Specifies the file container body

DELETE examples

delete

Delete an existing file container.

DELETE FROM azure_stack.deployment_admin.file_containers
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND fileContainerId = '{{ fileContainerId }}' --required
;