az mcc ent node

Note

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

Microsoft Connected Cache for Enterprise cache node CLI commands.

Commands

Name	Description	Type	Status
az mcc ent node create	Creates a Microsoft Connected Cache for Enterprise cache node with specified parameters.	Extension	GA
az mcc ent node delete	Deletes a Microsoft Connected Cache for Enterprise cache node.	Extension	GA
az mcc ent node get-deployment-details	Retrieves Microsoft Connected Cache for Enterprise cache node details and keys needed to deploy cache node.	Extension	GA
az mcc ent node list	Retrieves relevant information about all Microsoft Connected Cache for Enterprise cache nodes under the Microsoft Connected Cache for Enterprise resource.	Extension	GA
az mcc ent node show	Retrieves relevant information for a Microsoft Connected Cache for Enterprise cache node.	Extension	GA
az mcc ent node update	Configures a Microsoft Connected Cache for Enterprise cache node with specified configuration parameters.	Extension	GA
az mcc ent node wait	Place the CLI in a waiting state until a condition is met.	Extension	GA

az mcc ent node create

Creates a Microsoft Connected Cache for Enterprise cache node with specified parameters.

az mcc ent node create --cache-node-name
                       --host-os {Eflow, Linux, Windows}
                       --mcc-resource-name
                       --resource-group
                       [--tags]

Examples

Create MCC Enterprise Cache Node

az mcc ent resource create --mcc-resource-name [MccResourceName] --cache-node-name [MccCacheNodeName] --host-os [WindowsOrLinux] --resource-group [MccResourceRgName]

Required Parameters

--cache-node-name

Name of Microsoft Connected Cache for Enterprise cache node.

--host-os

Host operating system of the cache node.

Property	Value
Parameter group:	Configuration Arguments
Accepted values:	Eflow, Linux, Windows

--mcc-resource-name

Name of Microsoft Connected Cache for Enterprise 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.

--tags

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

Property	Value
Parameter group:	Resource 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 mcc ent node delete

Deletes a Microsoft Connected Cache for Enterprise cache node.

az mcc ent node delete [--cache-node-name]
                       [--ids]
                       [--mcc-resource-name]
                       [--resource-group]
                       [--subscription]
                       [--yes]

Examples

Delete MCC Enterprise Cache Node

az mcc ent node delete --mcc-resource-name [MccResourceName] --cache-node-name [MccCacheNodeName] --resource-group [MccResourceRgName]

Optional Parameters

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

--cache-node-name

Name of Microsoft Connected Cache for Enterprise cache node.

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

--mcc-resource-name

Name of Microsoft Connected Cache for Enterprise 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

--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 mcc ent node get-deployment-details

Retrieves Microsoft Connected Cache for Enterprise cache node details and keys needed to deploy cache node.

az mcc ent node get-deployment-details [--cache-node-name]
                                       [--ids]
                                       [--mcc-resource-name]
                                       [--resource-group]
                                       [--subscription]

Examples

Get Deployment Details For MCC Enterprise Cache Node

az mcc ent node get-deployment-details --mcc-resource-name [MccResourceName] --cache-node-name [MccCacheNodeName] --resource-group [MccResourceRgName]

Optional Parameters

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

--cache-node-name

Name of Microsoft Connected Cache for Enterprise cache node.

Property	Value
Parameter group:	Resource Id Arguments

--ids

Property	Value
Parameter group:	Resource Id Arguments

--mcc-resource-name

Name of Microsoft Connected Cache for Enterprise 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 mcc ent node list

Retrieves relevant information about all Microsoft Connected Cache for Enterprise cache nodes under the Microsoft Connected Cache for Enterprise resource.

az mcc ent node list --mcc-resource-name
                     --resource-group
                     [--expand-output {0, 1, f, false, n, no, t, true, y, yes}]
                     [--max-items]
                     [--next-token]

Examples

List MCC Enterprise Cache Nodes Attached to a Resource

az mcc ent resource list --resource-group [MccResourceRgName]

Required Parameters

--mcc-resource-name

Name of Microsoft Connected Cache for Enterprise 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.

--expand-output

Use this flag to expand command output and see more details.

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

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

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 mcc ent node show

Retrieves relevant information for a Microsoft Connected Cache for Enterprise cache node.

az mcc ent node show [--cache-node-name]
                     [--expand-output {0, 1, f, false, n, no, t, true, y, yes}]
                     [--ids]
                     [--mcc-resource-name]
                     [--resource-group]
                     [--subscription]

Examples

Show MCC Enterprise Cache Node

az mcc ent node show --mcc-resource-name [MccResourceName] --cache-node-name [MccCacheNodeName] --resource-group [MccResourceRgName]

Optional Parameters

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

--cache-node-name

Name of Microsoft Connected Cache for Enterprise cache node.

Property	Value
Parameter group:	Resource Id Arguments

--expand-output

Use this flag to expand command output and see more details.

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

--ids

Property	Value
Parameter group:	Resource Id Arguments

--mcc-resource-name

Name of Microsoft Connected Cache for Enterprise 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 mcc ent node update

Configures a Microsoft Connected Cache for Enterprise cache node with specified configuration parameters.

az mcc ent node update [--add]
                       [--auto-update-day]
                       [--auto-update-ring {Fast, Preview, Slow}]
                       [--auto-update-time]
                       [--auto-update-week]
                       [--cache-drive]
                       [--cache-node-name]
                       [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                       [--ids]
                       [--mcc-resource-name]
                       [--proxy {Disabled, Enabled, None, Required}]
                       [--proxy-host]
                       [--proxy-port]
                       [--remove]
                       [--resource-group]
                       [--set]
                       [--subscription]
                       [--tags]

Examples

Update MCC Enterprise Cache Node

az mcc ent node update --mcc-resource-name [MccResourceName] --cache-node-name [MccCacheNodeName] --resource-group [MccResourceRgName] --cache-drive "[{physical-path:/var/mcc,size-in-gb:XX}]" --proxy [EnabledOrDisabled] --proxy-host [URLOrIPForProxy] --proxy-port [ProxyPortNumber] --auto-update-day [AutoUpdateDay] --auto-update-time [HH:mm] --auto-update-week [AutoUpdateWeekOfMonth] --auto-update-ring [SlowOrFastUpdateRing]

Optional Parameters

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

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

--auto-update-day

Day of week (1-7) that cache node will automatically install software update.

Property	Value
Parameter group:	Configuration Arguments

--auto-update-ring

Cache node automatic software update periodicity ring.

Property	Value
Parameter group:	Configuration Arguments
Accepted values:	Fast, Preview, Slow

--auto-update-time

Time of day in 24-hour time (hh:mm) that cache node will automatically install software update.

Property	Value
Parameter group:	Configuration Arguments

--auto-update-week

Week of month that cache node will automatically install software update. Allowed Values: 2-3.

Property	Value
Parameter group:	Configuration Arguments

--cache-drive

The physical path and size of cache drive. For Windows cache node physical path should be "/var/mcc". Minimum cache drive size should be 50gb. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Configuration Arguments

--cache-node-name

Name of Microsoft Connected Cache for Enterprise cache node.

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

--ids

Property	Value
Parameter group:	Resource Id Arguments

--mcc-resource-name

Name of Microsoft Connected Cache for Enterprise resource.

Property	Value
Parameter group:	Resource Id Arguments

--proxy

Enable or disable proxy. Allowed values "Enabled, Disabled". If proxy is enabled, provide proxy host and proxy port.

Property	Value
Parameter group:	Configuration Arguments
Accepted values:	Disabled, Enabled, None, Required

--proxy-host

Host proxy address configuration. Ex: xxx.xxx.x.x or http://exampleproxy.com.

Property	Value
Parameter group:	Configuration Arguments

--proxy-port

Port number for proxy host.

Property	Value
Parameter group:	Configuration Arguments

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

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 mcc ent node wait

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

az mcc ent node wait [--cache-node-name]
                     [--created]
                     [--custom]
                     [--deleted]
                     [--exists]
                     [--ids]
                     [--interval]
                     [--mcc-resource-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.

--cache-node-name

Name of Microsoft Connected Cache for Enterprise cache node.

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

--mcc-resource-name

Name of Microsoft Connected Cache for Enterprise 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

Share via

az mcc ent node

Commands

az mcc ent node create

Examples

Required Parameters

Optional Parameters

az mcc ent node delete

Examples

Optional Parameters

az mcc ent node get-deployment-details

Examples

Optional Parameters

az mcc ent node list

Examples

Required Parameters

Optional Parameters

az mcc ent node show

Examples

Optional Parameters

az mcc ent node update

Examples

Optional Parameters

az mcc ent node wait

Optional Parameters

Feedback