Jaa

az confidentialledger managedccfs

  • Preview

Note

This reference is part of the managedccfs extension for the Azure CLI (version 2.45.0 or higher). The extension will automatically install the first time you run an az confidentialledger managedccfs command. Learn more about extensions.

Command group 'az confidentialledger' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Deploy and manage the Azure Managed CCF instances.

Commands

Name Description Type Status
az confidentialledger managedccfs create

Create an instance of the Azure Managed CCF service.

 Extension Preview
az confidentialledger managedccfs delete

Delete a Managed CCF instance.

 Extension Preview
az confidentialledger managedccfs list

View the Azure Managed CCF instances in a resource group.

 Extension Preview
az confidentialledger managedccfs show

View the details of an instance.

 Extension Preview
az confidentialledger managedccfs update

Patch a Managed CCF instance.

 Extension Preview
az confidentialledger managedccfs wait

Place the CLI in a waiting state until a condition is met.

 Extension Preview

az confidentialledger managedccfs create

Preview

Command group 'az confidentialledger managedccfs' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create an instance of the Azure Managed CCF service.

az confidentialledger managedccfs create --members
                                         --name
                                         --resource-group
                                         [--app-type]
                                         [--language-runtime]
                                         [--location]
                                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--node-count]
                                         [--tags]

Examples

Deploy an Azure Managed CCF instance with 3 CCF nodes and the sample JS application.

az confidentialledger managedccfs create --members "[{certificate:'c:/certs/member0_cert.pem',identifier:'member0',group:'group1'},{certificate:'c:/certs/member1_cert.pem',identifier:'member1',group:'group2'}]" --name mymccfinstance --resource-group mccfRG --app-type sample

Deploy an Azure Managed CCF instance with 3 CCF nodes and a custom JS application.

az confidentialledger managedccfs create --members "[{certificate:'c:/certs/member0_cert.pem',identifier:'member0'},{certificate:'c:/certs/member1_cert.pem',identifier:'member1'}]" --name mymccfinstance --resource-group mccfRG

Deploy an Azure Managed CCF instance with 5 CCF nodes and a custom JS application

az confidentialledger managedccfs create --members "[{certificate:'c:/certs/member0_cert.pem',identifier:'member0',group:'mygroup1'},{certificate:'c:/certs/member1_cert.pem',identifier:'member1'}]" --name mymccfinstance --resource-group mccfRG --node-count 5

Required Parameters

--members

Member details. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--name -n

A unique name for the instance.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--app-type

Set it to 'sample' to deploy the sample JS application.

Property Value
Default value: customImage
--language-runtime

The application language.

Property Value
Default value: JS
--location -l
Preview

The geo-location of the instance. Southcentralus is the only supported region. When not specified, the location of the resource group will be used.

Property Value
Parameter group: ManagedCCF Arguments
Default value: southcentralus
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--node-count
Preview

Node consensus requires odd number of nodes. Select a number between 3 and 9.

Property Value
Parameter group: Properties Arguments
Default value: 3
--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: ManagedCCF Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az confidentialledger managedccfs delete

Preview

Command group 'az confidentialledger managedccfs' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete a Managed CCF instance.

az confidentialledger managedccfs delete [--ids]
                                         [--name]
                                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--resource-group]
                                         [--subscription]
                                         [--yes]

Examples

Delete a Managed CCF instance

az confidentialledger managedccfs delete --name "myMccf" --resource-group "myResourceGroup"

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--name -n

A unique name for the instance.

Property Value
Parameter group: Resource Id Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
--yes -y

Do not prompt for confirmation.

Property Value
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az confidentialledger managedccfs list

Preview

Command group 'az confidentialledger managedccfs' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

View the Azure Managed CCF instances in a resource group.

az confidentialledger managedccfs list [--resource-group]

Examples

View the Managed CCF instances

az confidentialledger managedccfs list --resource-group "myResourceGroup"

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az confidentialledger managedccfs show

Preview

Command group 'az confidentialledger managedccfs' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

View the details of an instance.

az confidentialledger managedccfs show [--ids]
                                       [--name]
                                       [--resource-group]
                                       [--subscription]

Examples

View the details of a Managed CCF instance

az confidentialledger managedccfs show --name "myMccf" --resource-group "myResourceGroup"

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--name -n

A unique name for the instance.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az confidentialledger managedccfs update

Preview

Command group 'az confidentialledger managedccfs' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Patch a Managed CCF instance.

az confidentialledger managedccfs update [--deployment-type]
                                         [--ids]
                                         [--member-certificates]
                                         [--name]
                                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--node-count]
                                         [--resource-group]
                                         [--subscription]
                                         [--tags]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--deployment-type

Deployment Type of Managed CCF Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--member-certificates

List of member identity certificates for Managed CCF Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--name -n

A unique name for the instance.

Property Value
Parameter group: Resource Id Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--node-count
Preview

Node consensus requires odd number of nodes. Select a number between 3 and 9.

Property Value
Parameter group: Properties Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: ManagedCCF Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az confidentialledger managedccfs wait

Preview

Command group 'az confidentialledger managedccfs' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Place the CLI in a waiting state until a condition is met.

az confidentialledger managedccfs wait [--created]
                                       [--custom]
                                       [--deleted]
                                       [--exists]
                                       [--ids]
                                       [--interval]
                                       [--name]
                                       [--resource-group]
                                       [--subscription]
                                       [--timeout]
                                       [--updated]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property Value
Parameter group: Wait Condition Arguments
--deleted

Wait until deleted.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--exists

Wait until the resource exists.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--interval

Polling interval in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 30
--name -n

A unique name for the instance.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
--timeout

Maximum wait in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False