managed_ccfs

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

Overview

Name	managed_ccfs
Type	Resource
Id	azure.confidential_ledger.managed_ccfs

Fields

The following fields are returned by SELECT queries:

get

The request was successful; response contains the Managed CCF

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Properties of Managed CCF Resource. (title: ManagedCCFProperties)
tags	object	Resource tags.

list_by_resource_group

The request was successful; response contains the Managed CCF

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Properties of Managed CCF Resource. (title: ManagedCCFProperties)
tags	object	Resource tags.

list_by_subscription

The request was successful; response contains the list of Managed CCF

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Properties of Managed CCF Resource. (title: ManagedCCFProperties)
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, appName		Retrieves the properties of a Managed CCF app.
list_by_resource_group	select	subscriptionId, resourceGroupName	$filter	Retrieves the properties of all Managed CCF apps.
list_by_subscription	select	subscriptionId	$filter	Retrieves the properties of all Managed CCF.
create	insert	subscriptionId, resourceGroupName, appName		Creates a Managed CCF with the specified Managed CCF parameters.
update	update	subscriptionId, resourceGroupName, appName		Updates properties of Managed CCF
delete	delete	subscriptionId, resourceGroupName, appName		Deletes an existing Managed CCF.
backup	exec	subscriptionId, resourceGroupName, appName, uri		Backs up a Managed CCF Resource.
restore	exec	subscriptionId, resourceGroupName, appName, fileShareName, restoreRegion, uri		Restores a Managed CCF 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
appName	string	Name of the Managed CCF
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.
$filter	string	The filter to apply on the list operation. eg. $filter=ledgerType eq 'Public'

SELECT examples

get

Retrieves the properties of a Managed CCF app.

SELECT
location,
properties,
tags
FROM azure.confidential_ledger.managed_ccfs
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND appName = '{{ appName }}' -- required
;

list_by_resource_group

Retrieves the properties of all Managed CCF apps.

SELECT
location,
properties,
tags
FROM azure.confidential_ledger.managed_ccfs
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND $filter = '{{ $filter }}'
;

list_by_subscription

Retrieves the properties of all Managed CCF.

SELECT
location,
properties,
tags
FROM azure.confidential_ledger.managed_ccfs
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND $filter = '{{ $filter }}'
;

INSERT examples

create

Creates a Managed CCF with the specified Managed CCF parameters.

INSERT INTO azure.confidential_ledger.managed_ccfs (
data__tags,
data__location,
data__properties,
subscriptionId,
resourceGroupName,
appName
)
SELECT 
'{{ tags }}',
'{{ location }}',
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ appName }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: managed_ccfs
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the managed_ccfs resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the managed_ccfs resource.
    - name: appName
      value: string
      description: Required parameter for the managed_ccfs resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives
    - name: properties
      value: object
      description: |
        Properties of Managed CCF Resource.

UPDATE examples

update

Updates properties of Managed CCF

UPDATE azure.confidential_ledger.managed_ccfs
SET 
data__tags = '{{ tags }}',
data__location = '{{ location }}',
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND appName = '{{ appName }}' --required
RETURNING
location,
properties,
tags;

DELETE examples

delete

Deletes an existing Managed CCF.

DELETE FROM azure.confidential_ledger.managed_ccfs
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND appName = '{{ appName }}' --required
;

Lifecycle Methods

backup

Backs up a Managed CCF Resource.

EXEC azure.confidential_ledger.managed_ccfs.backup 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@appName='{{ appName }}' --required 
@@json=
'{
"restoreRegion": "{{ restoreRegion }}", 
"uri": "{{ uri }}"
}'
;

restore

Restores a Managed CCF Resource.

EXEC azure.confidential_ledger.managed_ccfs.restore 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@appName='{{ appName }}' --required 
@@json=
'{
"fileShareName": "{{ fileShareName }}", 
"restoreRegion": "{{ restoreRegion }}", 
"uri": "{{ uri }}"
}'
;