az mission virtual-enclave

Note

This reference is part of the mission extension for the Azure CLI (version 2.75.0 or higher). The extension will automatically install the first time you run an az mission virtual-enclave command. Learn more about extensions.

Manage Virtual Enclave.

Commands

Name	Description	Type	Status
az mission virtual-enclave create	Create a EnclaveResource.	Extension	GA
az mission virtual-enclave delete	Delete a EnclaveResource.	Extension	GA
az mission virtual-enclave enclave-endpoint	Manage Enclave Endpoint.	Extension	GA
az mission virtual-enclave enclave-endpoint create	Create a EnclaveEndpointResource.	Extension	GA
az mission virtual-enclave enclave-endpoint delete	Delete a EnclaveEndpointResource.	Extension	GA
az mission virtual-enclave enclave-endpoint list	List EnclaveEndpointResource resources by subscription ID.	Extension	GA
az mission virtual-enclave enclave-endpoint show	Get a EnclaveEndpointResource.	Extension	GA
az mission virtual-enclave enclave-endpoint update	Update a EnclaveEndpointResource.	Extension	GA
az mission virtual-enclave enclave-endpoint wait	Place the CLI in a waiting state until a condition is met.	Extension	GA
az mission virtual-enclave identity	Manage Identity.	Extension	GA
az mission virtual-enclave identity assign	Assign the user or system managed identities.	Extension	GA
az mission virtual-enclave identity remove	Remove the user or system managed identities.	Extension	GA
az mission virtual-enclave identity show	Show the details of managed identities.	Extension	GA
az mission virtual-enclave identity wait	Place the CLI in a waiting state until a condition is met.	Extension	GA
az mission virtual-enclave list	List EnclaveResource resources by subscription ID.	Extension	GA
az mission virtual-enclave show	Get a EnclaveResource.	Extension	GA
az mission virtual-enclave update	Update a EnclaveResource.	Extension	GA
az mission virtual-enclave wait	Place the CLI in a waiting state until a condition is met.	Extension	GA
az mission virtual-enclave workload	Manage Workload.	Extension	GA
az mission virtual-enclave workload create	Create a WorkloadResource.	Extension	GA
az mission virtual-enclave workload delete	Delete a WorkloadResource.	Extension	GA
az mission virtual-enclave workload list	List WorkloadResource resources by subscription ID.	Extension	GA
az mission virtual-enclave workload show	Get a WorkloadResource.	Extension	GA
az mission virtual-enclave workload update	Update a WorkloadResource.	Extension	GA
az mission virtual-enclave workload wait	Place the CLI in a waiting state until a condition is met.	Extension	GA

az mission virtual-enclave create

Create a EnclaveResource.

az mission virtual-enclave create --name --virtual-enclave-name
                                  --resource-group
                                  [--acquire-policy-token]
                                  [--approval-settings]
                                  [--bastion-enabled {0, 1, f, false, n, no, t, true, y, yes}]
                                  [--change-reference]
                                  [--community-resource-id]
                                  [--dedicated-hub-resource-id]
                                  [--enclave-default-settings]
                                  [--enclave-role-assignments]
                                  [--enclave-virtual-network]
                                  [--governed-service-list]
                                  [--location]
                                  [--maintenance-mode-configuration]
                                  [--mi-system-assigned --system-assigned]
                                  [--mi-user-assigned --user-assigned]
                                  [--monitoring-settings]
                                  [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                  [--rbac-inheritance {Disabled, Enabled}]
                                  [--tags]
                                  [--workload-resource-visibility {Disabled, Enabled}]
                                  [--workload-role-assignments]

Examples

VirtualEnclave_CreateOrUpdate

az mission virtual-enclave create --resource-group rgopenapi --virtual-enclave-name TestMyEnclave --type SystemAssigned,UserAssigned --user-assigned-identities "{/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1:{}}" --enclave-virtual-network "{network-size:small,custom-cidr-range:10.0.0.0/24,subnet-configurations:[{subnet-name:test,network-prefix-size:26}],allow-subnet-communication:True}" --community-resource-id /subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestMyRg/providers/microsoft.mission/communities/TestMyCommunity --enclave-default-settings "{diagnostic-destination:Both}" --maintenance-mode-configuration "{mode:Off,principals:[{id:355a6bb0-abc0-4cba-000d-12a345b678c9,type:User}],justification:Off}" --dedicated-hub-resource-id /subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/TestResourceGroup/providers/Microsoft.Mission/communities/TestMyCommunity/dedicatedHubs/TestDedicatedHub --bastion-enabled True --workload-resource-visibility Disabled --rbac-inheritance Disabled --enclave-role-assignments "[{roleDefinitionId:b24988ac-6180-42a0-ab88-20f7382dd24c,principals:[{id:355a6bb0-abc0-4cba-000d-12a345b678c9,type:User},{id:355a6bb0-abc0-4cba-000d-12a345b678c0,type:User}],condition:'@RoleDefinition.Name StringNotEquals '/Owner'/'},{roleDefinitionId:18d7d88d-d35e-4fb5-a5c3-7773c20a72d9,principals:[{id:355a6bb0-abc0-4cba-000d-12a345b678c9,type:User}]}]" --workload-role-assignments "[{roleDefinitionId:d73bb868-a0df-4d4d-bd69-98a00b01fccb,principals:[{id:01234567-89ab-ef01-2345-0123456789ab,type:Group}],condition:'@RoleDefinition.Name StringNotEquals '/Owner'/'},{roleDefinitionId:fb879df8-f326-4884-b1cf-06f3ad86be52,principals:[{id:01234567-89ab-ef01-2345-0123456789ab,type:Group}]}]" --approval-settings "{enclave-endpoint-update:{approvalPolicy:Required,minimumApproversRequired:1,mandatoryApprovers:[{approverEntraId:00000000-0000-0000-0000-000000000001}]},connection-creation:{approvalPolicy:Required,minimumApproversRequired:2,mandatoryApprovers:[{approverEntraId:00000000-0000-0000-0000-000000000002}]},connection-update:{approvalPolicy:Required,minimumApproversRequired:1},enclave-maintenance-mode:{approvalPolicy:NotRequired}}" --monitoring-settings "{diagnostic-destinations:[{destinationType:CommunityWorkspace},{destinationType:EnclaveWorkspace,diagnosticSettingsName:customName},{destinationType:CustomWorkspace,customWorkspaceResourceId:/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/rgopenapi/providers/Microsoft.OperationalInsights/workspaces/CustomWorkspace,diagnosticSettingsName:customName},{destinationType:CustomWorkspace,customWorkspaceResourceId:/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/rgopenapi/providers/Microsoft.OperationalInsights/workspaces/CustomWorkspace,diagnosticSettingsName:customName}],flow-log-destination:{destinationType:CustomWorkspace,customWorkspaceResourceId:/subscriptions/c64f6eca-bdc5-4bc2-88d6-f8f1dc23f86c/resourceGroups/rgopenapi/providers/Microsoft.OperationalInsights/workspaces/CustomWorkspace,diagnosticSettingsName:customName}}" --tags "{Tag1:Value1}" --location westcentralus

Required Parameters

--name --virtual-enclave-name -n

The name of the enclaveResource Resource.

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--approval-settings

Approval requirements for various actions on the enclave's resources. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--bastion-enabled

Deploy Bastion service (True or False).

Property	Value
Parameter group:	Properties Arguments
Default value:	False
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--community-resource-id

Community Resource Id.

Property	Value
Parameter group:	Properties Arguments

--dedicated-hub-resource-id

DedicatedHub Resource ID.

Property	Value
Parameter group:	Properties Arguments

--enclave-default-settings

Enclave default settings. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--enclave-role-assignments

Enclave role assignments Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--enclave-virtual-network

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

Property	Value
Parameter group:	Properties Arguments

--governed-service-list

Enclave specific policies Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--location -l

The geo-location where the resource lives When not specified, the location of the resource group will be used.

Property	Value
Parameter group:	Resource Arguments

--maintenance-mode-configuration

Maintenance Mode configuration. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--mi-system-assigned --system-assigned

Set the system managed identity.

Property	Value
Parameter group:	Identity Arguments

--mi-user-assigned --user-assigned

Set the user managed identities. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Identity Arguments

--monitoring-settings

Virtual Enclave Monitoring Settings for diagnostic and virtual network flow logs Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

--rbac-inheritance

Controls whether standard Azure RBAC role inheritance applies to the workload resource group(s).

Property	Value
Parameter group:	Properties Arguments
Default value:	Disabled
Accepted values:	Disabled, Enabled

--tags

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

Property	Value
Parameter group:	Resource Arguments

--workload-resource-visibility

Specifies whether resources in the workload resource group(s) are visible through standard RBAC.

Property	Value
Parameter group:	Properties Arguments
Default value:	Disabled
Accepted values:	Disabled, Enabled

--workload-role-assignments

Workload role assignments Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties 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 mission virtual-enclave delete

Delete a EnclaveResource.

az mission virtual-enclave delete [--acquire-policy-token]
                                  [--change-reference]
                                  [--ids]
                                  [--name --virtual-enclave-name]
                                  [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                  [--resource-group]
                                  [--subscription]
                                  [--yes]

Examples

VirtualEnclave_Delete

az mission virtual-enclave delete --resource-group rgopenapi --virtual-enclave-name TestMyEnclave

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

--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 --virtual-enclave-name -n

The name of the enclaveResource Resource.

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 mission virtual-enclave list

List EnclaveResource resources by subscription ID.

az mission virtual-enclave list [--max-items]
                                [--next-token]
                                [--resource-group]

Examples

VirtualEnclave_ListBySubscription

az mission virtual-enclave list

VirtualEnclave_ListByResourceGroup

az mission virtual-enclave list --resource-group rgopenapi

Optional Parameters

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

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

Property	Value
Parameter group:	Pagination Arguments

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property	Value
Parameter group:	Pagination Arguments

--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 mission virtual-enclave show

Get a EnclaveResource.

az mission virtual-enclave show [--ids]
                                [--name --virtual-enclave-name]
                                [--resource-group]
                                [--subscription]

Examples

VirtualEnclave_Get

az mission virtual-enclave show --resource-group rgopenapi --virtual-enclave-name TestMyEnclave

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

Property	Value
Parameter group:	Resource Id Arguments

--name --virtual-enclave-name -n

The name of the enclaveResource Resource.

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 mission virtual-enclave update

Update a EnclaveResource.

az mission virtual-enclave update [--acquire-policy-token]
                                  [--add]
                                  [--approval-settings]
                                  [--bastion-enabled {0, 1, f, false, n, no, t, true, y, yes}]
                                  [--change-reference]
                                  [--dedicated-hub-resource-id]
                                  [--enclave-default-settings]
                                  [--enclave-role-assignments]
                                  [--enclave-virtual-network]
                                  [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                  [--governed-service-list]
                                  [--ids]
                                  [--maintenance-mode-configuration]
                                  [--monitoring-settings]
                                  [--name --virtual-enclave-name]
                                  [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                  [--rbac-inheritance {Disabled, Enabled}]
                                  [--remove]
                                  [--resource-group]
                                  [--set]
                                  [--subscription]
                                  [--tags]
                                  [--workload-resource-visibility {Disabled, Enabled}]
                                  [--workload-role-assignments]

Examples

VirtualEnclave_CreateOrUpdate

az mission virtual-enclave update --resource-group rgopenapi --virtual-enclave-name TestMyEnclave

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

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

Property	Value
Parameter group:	Generic Update Arguments

--approval-settings

Approval requirements for various actions on the enclave's resources. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--bastion-enabled

Deploy Bastion service (True or False).

Property	Value
Parameter group:	Properties Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--dedicated-hub-resource-id

DedicatedHub Resource ID.

Property	Value
Parameter group:	Properties Arguments

--enclave-default-settings

Enclave default settings. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--enclave-role-assignments

Enclave role assignments Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--enclave-virtual-network

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

Property	Value
Parameter group:	Properties Arguments

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Property	Value
Parameter group:	Generic Update Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--governed-service-list

Enclave specific policies Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--ids

Property	Value
Parameter group:	Resource Id Arguments

--maintenance-mode-configuration

Maintenance Mode configuration. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--monitoring-settings

Virtual Enclave Monitoring Settings for diagnostic and virtual network flow logs Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--name --virtual-enclave-name -n

The name of the enclaveResource Resource.

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

--rbac-inheritance

Controls whether standard Azure RBAC role inheritance applies to the workload resource group(s).

Property	Value
Parameter group:	Properties Arguments
Accepted values:	Disabled, Enabled

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Property	Value
Parameter group:	Generic Update 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

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Property	Value
Parameter group:	Generic Update 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:	Resource Arguments

--workload-resource-visibility

Specifies whether resources in the workload resource group(s) are visible through standard RBAC.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	Disabled, Enabled

--workload-role-assignments

Workload role assignments Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties 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 mission virtual-enclave wait

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

az mission virtual-enclave wait [--acquire-policy-token]
                                [--change-reference]
                                [--created]
                                [--custom]
                                [--deleted]
                                [--exists]
                                [--ids]
                                [--interval]
                                [--name --virtual-enclave-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.

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

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

Property	Value
Parameter group:	Resource Id Arguments

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--name --virtual-enclave-name -n

The name of the enclaveResource Resource.

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

Feedback

Was this page helpful?