az keyvault ekm-connection

  • Preview

This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage External Key Manager (EKM) connection for a Managed HSM.

Commands

Name Description Type Status
az keyvault ekm-connection certificate

Manage EKM proxy certificate information.

 Core Preview
az keyvault ekm-connection certificate show

Show the EKM proxy client certificate.

 Core Preview
az keyvault ekm-connection check

Check connectivity and authentication with the EKM proxy.

 Core Preview
az keyvault ekm-connection create

Create the EKM connection.

 Core Preview
az keyvault ekm-connection delete

Delete the EKM connection.

 Core Preview
az keyvault ekm-connection show

Show the EKM connection.

 Core Preview
az keyvault ekm-connection update

Update the EKM connection.

 Core Preview

az keyvault ekm-connection check

Edit
Preview

Command group 'keyvault ekm-connection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Check connectivity and authentication with the EKM proxy.

az keyvault ekm-connection check [--acquire-policy-token]
                                 [--change-reference]
                                 [--hsm-name]
                                 [--id]

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--hsm-name

Name of the HSM. Can be omitted if --id is specified.

Property Value
Parameter group: HSM Id Arguments
--id

Full URI of the HSM.

Property Value
Parameter group: HSM 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.

--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 keyvault ekm-connection create

Edit
Preview

Command group 'keyvault ekm-connection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create the EKM connection.

az keyvault ekm-connection create --host
                                  --server-ca-certificate
                                  [--acquire-policy-token]
                                  [--change-reference]
                                  [--hsm-name]
                                  [--id]
                                  [--path-prefix]
                                  [--server-cn --server-subject-common-name]

Required Parameters

--host

EKM proxy host (FQDN or FQDN:port). If port is omitted, 443 is assumed.

Property Value
Parameter group: EKM Connection Arguments
--server-ca-certificate

Path(s) to server CA certificate(s) in PEM or DER format. Pass a single file containing a PEM chain (multiple certificate blocks), or multiple space-separated file paths (each PEM or DER).

Property Value
Parameter group: EKM Connection Arguments

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--hsm-name

Name of the HSM. Can be omitted if --id is specified.

Property Value
Parameter group: HSM Id Arguments
--id

Full URI of the HSM.

Property Value
Parameter group: HSM Id Arguments
--path-prefix

Optional path prefix to append to EKM proxy requests. Must start with "/".

Property Value
Parameter group: EKM Connection Arguments
--server-cn --server-subject-common-name

Optional expected Common Name (CN) for the EKM proxy server certificate.

Property Value
Parameter group: EKM Connection 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 keyvault ekm-connection delete

Edit
Preview

Command group 'keyvault ekm-connection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete the EKM connection.

az keyvault ekm-connection delete [--acquire-policy-token]
                                  [--change-reference]
                                  [--hsm-name]
                                  [--id]

Optional Parameters

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--hsm-name

Name of the HSM. Can be omitted if --id is specified.

Property Value
Parameter group: HSM Id Arguments
--id

Full URI of the HSM.

Property Value
Parameter group: HSM 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.

--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 keyvault ekm-connection show

Edit
Preview

Command group 'keyvault ekm-connection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Show the EKM connection.

az keyvault ekm-connection show [--hsm-name]
                                [--id]

Optional Parameters

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

--hsm-name

Name of the HSM. Can be omitted if --id is specified.

Property Value
Parameter group: HSM Id Arguments
--id

Full URI of the HSM.

Property Value
Parameter group: HSM 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.

--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 keyvault ekm-connection update

Edit
Preview

Command group 'keyvault ekm-connection' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update the EKM connection.

az keyvault ekm-connection update [--acquire-policy-token]
                                  [--change-reference]
                                  [--host]
                                  [--hsm-name]
                                  [--id]
                                  [--path-prefix]
                                  [--server-ca-certificate]
                                  [--server-cn --server-subject-common-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.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--host

EKM proxy host (FQDN or FQDN:port). If port is omitted, 443 is assumed.

Property Value
Parameter group: EKM Connection Arguments
--hsm-name

Name of the HSM. Can be omitted if --id is specified.

Property Value
Parameter group: HSM Id Arguments
--id

Full URI of the HSM.

Property Value
Parameter group: HSM Id Arguments
--path-prefix

Optional path prefix to append to EKM proxy requests. Must start with "/".

Property Value
Parameter group: EKM Connection Arguments
--server-ca-certificate

Path(s) to server CA certificate(s) in PEM or DER format. Pass a single file containing a PEM chain (multiple certificate blocks), or multiple space-separated file paths (each PEM or DER).

Property Value
Parameter group: EKM Connection Arguments
--server-cn --server-subject-common-name

Optional expected Common Name (CN) for the EKM proxy server certificate.

Property Value
Parameter group: EKM Connection 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