az confidentialledger

Note

This command group has commands that are defined in two or more extensions. Each extension will automatically install the first time you run an extension command. Learn more about extensions.

Manage Confidential Ledger.

Commands

Name	Description	Type	Status
az confidentialledger create	Creates a Confidential Ledger with the specified ledger parameters.	Extension	GA
az confidentialledger delete	Deletes an existing Confidential Ledger.	Extension	GA
az confidentialledger list	Retrieves the properties of all Confidential Ledgers. And Retrieves the properties of all Confidential Ledgers.	Extension	GA
az confidentialledger managedccfs	Deploy and manage the Azure Managed CCF instances.	Extension	Preview
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 show	Retrieves the properties of a Confidential Ledger.	Extension	GA
az confidentialledger update	Updates properties of Confidential Ledger.	Extension	GA
az confidentialledger wait	Place the CLI in a waiting state until a condition of the confidentialledger is met.	Extension	GA

az confidentialledger create

Creates a Confidential Ledger with the specified ledger parameters.

az confidentialledger create --ledger-name
                             --resource-group
                             [--aad-based-security-principals]
                             [--cert-based-security-principals]
                             [--ledger-type {Private, Public, Unknown}]
                             [--location]
                             [--no-wait]
                             [--tags]

Examples

ConfidentialLedgerCreate

az confidentialledger create --location "EastUS" --aad-based-security-principals ledger-role-name="Administrator" principal-id="34621747-6fc8-4771-a2eb-72f31c461f2e" tenant-id="bce123b9-2b7b-4975-8360-5ca0b9b1cd08" --cert-based-security-principals cert="-----BEGIN CERTIFICATE-----MIIBsjCCATigAwIBAgIUZWIbyG79TniQLd2UxJuU74tqrKcwCgYIKoZIzj0EAwMwEDEOMAwGA1UEAwwFdXNlcjAwHhcNMjEwMzE2MTgwNjExWhcNMjIwMzE2MTgwNjExWjAQMQ4wDAYDVQQDDAV1c2VyMDB2MBAGByqGSM49AgEGBSuBBAAiA2IABBiWSo/j8EFit7aUMm5lF+lUmCu+IgfnpFD+7QMgLKtxRJ3aGSqgS/GpqcYVGddnODtSarNE/HyGKUFUolLPQ5ybHcouUk0kyfA7XMeSoUA4lBz63Wha8wmXo+NdBRo39qNTMFEwHQYDVR0OBBYEFPtuhrwgGjDFHeUUT4nGsXaZn69KMB8GA1UdIwQYMBaAFPtuhrwgGjDFHeUUT4nGsXaZn69KMA8GA1UdEwEB/wQFMAMBAf8wCgYIKoZIzj0EAwMDaAAwZQIxAOnozm2CyqRwSSQLls5r+mUHRGRyXHXwYtM4Dcst/VEZdmS9fqvHRCHbjUlO/+HNfgIwMWZ4FmsjD3wnPxONOm9YdVn/PRD7SsPRPbOjwBiE4EBGaHDsLjYAGDSGi7NJnSkA-----END CERTIFICATE-----" ledger-role-name="Reader" --ledger-type "Public" --tags additionalProps1="additional properties" --name "DummyLedgerName" --resource-group "DummyResourceGroupName"

Required Parameters

--ledger-name --name -n

Name of the Confidential Ledger.

--resource-group -g

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

Optional Parameters

--aad-based-security-principals --aad-based-users

Array of all AAD based Security Principals.

Usage: --aad-based-security-principals principal-id=XX tenant-id=XX ledger-role-name=XX

principal-id: UUID/GUID based Principal Id of the Security Principal tenant-id: UUID/GUID based Tenant Id of the Security Principal ledger-role-name: LedgerRole associated with the Security Principal of Ledger

Multiple actions can be specified by using more than one --aad-based-security-principals argument.

--cert-based-security-principals --cert-based-users

Array of all cert based Security Principals.

Usage: --cert-based-security-principals cert=XX ledger-role-name=XX

cert: Public key of the user cert (.pem or .cer) ledger-role-name: LedgerRole associated with the Security Principal of Ledger

Multiple actions can be specified by using more than one --cert-based-security-principals argument.

--ledger-type

Type of Confidential Ledger.

accepted values: Private, Public, Unknown

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--no-wait

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

default value: False

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--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.

az confidentialledger delete

Deletes an existing Confidential Ledger.

az confidentialledger delete [--ids]
                             [--ledger-name]
                             [--no-wait]
                             [--resource-group]
                             [--subscription]
                             [--yes]

Examples

ConfidentialLedgerDelete

az confidentialledger delete --name "DummyLedgerName" --resource-group "DummyResourceGroupName"

Optional Parameters

--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.

--ledger-name --name -n

Name of the Confidential Ledger.

--no-wait

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

default value: False

--resource-group -g

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

--subscription

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

--yes -y

Do not prompt for confirmation.

default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--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.

az confidentialledger list

Retrieves the properties of all Confidential Ledgers. And Retrieves the properties of all Confidential Ledgers.

az confidentialledger list [--filter]
                           [--resource-group]

Examples

ConfidentialLedgerList

az confidentialledger list --resource-group "DummyResourceGroupName"

ConfidentialLedgerListBySub

az confidentialledger list

Optional Parameters

--filter

The filter to apply on the list operation. eg. $filter=ledgerType eq 'Public'.

--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.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--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.

az confidentialledger show

Retrieves the properties of a Confidential Ledger.

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

Examples

ConfidentialLedgerGet

az confidentialledger show --name "DummyLedgerName" --resource-group "DummyResourceGroupName"

Optional Parameters

--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.

--ledger-name --name -n

Name of the Confidential Ledger.

--resource-group -g

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

--subscription

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--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.

az confidentialledger update

Updates properties of Confidential Ledger.

az confidentialledger update [--aad-based-security-principals]
                             [--cert-based-security-principals]
                             [--ids]
                             [--ledger-name]
                             [--ledger-type {Private, Public, Unknown}]
                             [--location]
                             [--no-wait]
                             [--resource-group]
                             [--subscription]
                             [--tags]

Examples

ConfidentialLedgerUpdate

az confidentialledger update --location "EastUS" --aad-based-security-principals ledger-role-name="Administrator" principal-id="34621747-6fc8-4771-a2eb-72f31c461f2e" tenant-id="bce123b9-2b7b-4975-8360-5ca0b9b1cd08" --cert-based-security-principals cert="-----BEGIN CERTIFICATE-----\nMIIDUjCCAjqgAwIBAgIQJ2IrDBawSkiAbkBYmiAopDANBgkqhkiG9w0BAQsFADAmMSQwIgYDVQQDExtTeW50aGV0aWNzIExlZGdlciBVc2VyIENlcnQwHhcNMjAwOTIzMjIxODQ2WhcNMjEwOTIzMjIyODQ2WjAmMSQwIgYDVQQDExtTeW50aGV0aWNzIExlZGdlciBVc2VyIENlcnQwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCX2s/Eu4q/eQ63N+Ugeg5oAciZua/YCJr41c/696szvSY7Zg1SNJlW88/nbz70+QpO55OmqlEE3QCU+T0Vl/h0Gf//n1PYcoBbTGUnYEmV+fTTHict6rFiEwrGJ62tvcpYgwapInSLyEeUzjki0zhOLJ1OfRnYd1eGnFVMpE5aVjiS8Q5dmTEUyd51EIprGE8RYAW9aeWSwTH7gjHUsRlJnHKcdhaK/v5QKJnNu5bzPFUcpC0ZBcizoMPAtroLAD4B68Jl0z3op18MgZe6lRrVoWuxfqnk5GojuB/Vu8ohAZKoFhQ6NB6r+LL2AUs+Zr7Bt26IkEdR178n9JMEA4gHAgMBAAGjfDB6MA4GA1UdDwEB/wQEAwIFoDAJBgNVHRMEAjAAMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAfBgNVHSMEGDAWgBS/a7PU9iOfOKEyZCp11Oen5VSuuDAdBgNVHQ4EFgQUv2uz1PYjnzihMmQqddTnp+VUrrgwDQYJKoZIhvcNAQELBQADggEBAF5q2fDwnse8egXhfaJCqqM969E9gSacqFmASpoDJPRPEX7gqoO7v1ww7nqRtRDoRiBvo/yNk7jlSAkRN3nRRnZLZZ3MYQdmCr4FGyIqRg4Y94+nja+Du9pDD761rxRktMVPSOaAVM/E5DQvscDlPvlPYe9mkcrLCE4DXYpiMmLT8Tm55LJJq5m07dVDgzAIR1L/hmEcbK0pnLgzciMtMLxGO2udnyyW/UW9WxnjvrrD2JluTHH9mVbb+XQP1oFtlRBfH7aui1ZgWfKvxrdP4zdK9QoWSUvRux3TLsGmHRBjBMtqYDY3y5mB+aNjLelvWpeVb0m2aOSVXynrLwNCAVA=\n-----END CERTIFICATE-----" ledger-role-name="Reader" --ledger-type "Public" --tags additionProps2="additional property value" additionalProps1="additional properties" --name "DummyLedgerName" --resource-group "DummyResourceGroupName"

Optional Parameters

--aad-based-security-principals --aad-based-users

Array of all AAD based Security Principals.

Usage: --aad-based-security-principals principal-id=XX tenant-id=XX ledger-role-name=XX

principal-id: UUID/GUID based Principal Id of the Security Principal tenant-id: UUID/GUID based Tenant Id of the Security Principal ledger-role-name: LedgerRole associated with the Security Principal of Ledger

Multiple actions can be specified by using more than one --aad-based-security-principals argument.

--cert-based-security-principals --cert-based-users

Array of all cert based Security Principals.

Usage: --cert-based-security-principals cert=XX ledger-role-name=XX

cert: Public key of the user cert (.pem or .cer) ledger-role-name: LedgerRole associated with the Security Principal of Ledger

Multiple actions can be specified by using more than one --cert-based-security-principals argument.

--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.

--ledger-name --name -n

Name of the Confidential Ledger.

--ledger-type

Type of Confidential Ledger.

accepted values: Private, Public, Unknown

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--no-wait

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

default value: False

--resource-group -g

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

--subscription

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

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--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.

az confidentialledger wait

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

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

Examples

Pause executing next line of CLI script until the confidentialledger is successfully created.

az confidentialledger wait --name "DummyLedgerName" --resource-group "DummyResourceGroupName" --created

Pause executing next line of CLI script until the confidentialledger is successfully updated.

az confidentialledger wait --name "DummyLedgerName" --resource-group "DummyResourceGroupName" --updated

Pause executing next line of CLI script until the confidentialledger is successfully deleted.

az confidentialledger wait --name "DummyLedgerName" --resource-group "DummyResourceGroupName" --deleted

Optional Parameters

--created

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

default value: False

--custom

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

--deleted

Wait until deleted.

default value: False

--exists

Wait until the resource exists.

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.

--interval

Polling interval in seconds.

default value: 30

--ledger-name --name -n

Name of the Confidential Ledger.

--resource-group -g

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

--subscription

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

--timeout

Maximum wait in seconds.

default value: 3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--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.