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
                       [--acquire-policy-token]
                       [--change-reference]
                       [--tags]

Examples

Create an MCC Enterprise cache node on an existing MCC resource

az mcc ent node create --mcc-resource-name MyMccResource --cache-node-name MyCacheNode --host-os Linux --resource-group MyResourceGroup

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.

--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
--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 [--acquire-policy-token]
                       [--cache-node-name]
                       [--change-reference]
                       [--ids]
                       [--mcc-resource-name]
                       [--resource-group]
                       [--subscription]
                       [--yes]

Examples

Delete an MCC Enterprise cache node

az mcc ent node delete --mcc-resource-name MyMccResource --cache-node-name MyCacheNode --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.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--cache-node-name

Name of Microsoft Connected Cache for Enterprise cache node.

Property Value
Parameter group: Resource Id 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
--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 [--acquire-policy-token]
                                       [--cache-node-name]
                                       [--change-reference]
                                       [--ids]
                                       [--mcc-resource-name]
                                       [--resource-group]
                                       [--subscription]

Examples

Get the keys and details needed to deploy a cache node

az mcc ent node get-deployment-details --mcc-resource-name MyMccResource --cache-node-name MyCacheNode --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.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--cache-node-name

Name of Microsoft Connected Cache for Enterprise cache node.

Property Value
Parameter group: Resource Id 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
--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 every cache node attached to an MCC Enterprise resource

az mcc ent node list --mcc-resource-name MyMccResource --resource-group MyResourceGroup

List cache nodes with the full set of details

az mcc ent node list --mcc-resource-name MyMccResource --resource-group MyResourceGroup --expand-output

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 an MCC Enterprise cache node

az mcc ent node show --mcc-resource-name MyMccResource --cache-node-name MyCacheNode --resource-group MyResourceGroup

Show a cache node with the full set of details

az mcc ent node show --mcc-resource-name MyMccResource --cache-node-name MyCacheNode --resource-group MyResourceGroup --expand-output

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

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
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 [--acquire-policy-token]
                       [--add]
                       [--auto-update-day]
                       [--auto-update-ring {Beta, Stable}]
                       [--auto-update-time]
                       [--auto-update-week]
                       [--cache-drive]
                       [--cache-node-name]
                       [--change-reference]
                       [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                       [--ids]
                       [--mcc-resource-name]
                       [--proxy {Disabled, Enabled}]
                       [--proxy-host]
                       [--proxy-port]
                       [--remove]
                       [--resource-group]
                       [--set]
                       [--subscription]
                       [--tags]

Examples

Configure the cache drives of a cache node

az mcc ent node update --mcc-resource-name MyMccResource --cache-node-name MyCacheNode --resource-group MyResourceGroup --cache-drive "[{physical-path:/var/mcc,size-in-gb:200}]"

Move a cache node to the Stable update ring (an install schedule is required)

az mcc ent node update --mcc-resource-name MyMccResource --cache-node-name MyCacheNode --resource-group MyResourceGroup --auto-update-ring Stable --auto-update-day 2 --auto-update-week 3 --auto-update-time 02:00

Move a cache node to the Beta update ring (the schedule is managed by Microsoft)

az mcc ent node update --mcc-resource-name MyMccResource --cache-node-name MyCacheNode --resource-group MyResourceGroup --auto-update-ring Beta

Route a cache node through an outbound proxy

az mcc ent node update --mcc-resource-name MyMccResource --cache-node-name MyCacheNode --resource-group MyResourceGroup --proxy Enabled --proxy-host proxy.contoso.com --proxy-port 8080

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
--auto-update-day

Day of week that cache node will automatically install software update. Allowed values: 1-7. Only valid on the "Stable" update ring.

Property Value
Parameter group: Configuration Arguments
--auto-update-ring

Cache node automatic software update periodicity ring. Use "Stable" to choose the install schedule yourself, which requires --auto-update-day, --auto-update-week and --auto-update-time. Use "Beta" to let Microsoft manage the schedule, in which case those three arguments must not be provided.

Property Value
Parameter group: Configuration Arguments
Accepted values: Beta, Stable
--auto-update-time

Time of day in 24-hour time (hh:mm) that cache node will automatically install software update. Only valid on the "Stable" update ring.

Property Value
Parameter group: Configuration Arguments
--auto-update-week

Week of month that cache node will automatically install software update. Allowed values: 2-3. Only valid on the "Stable" update ring.

Property Value
Parameter group: Configuration Arguments
--cache-drive

The physical path and size of cache drive. For a Windows cache node exactly one drive is allowed and its physical path must be "/var/mcc"; a Linux cache node allows up to 9 drives. Size must be between 50 and 10000 GB. 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
--change-reference

The related change reference ID for this resource operation.

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

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

Enable or disable proxy. When enabled, provide --proxy-host and --proxy-port.

Property Value
Parameter group: Configuration Arguments
Accepted values: Disabled, Enabled
--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 [--acquire-policy-token]
                     [--cache-node-name]
                     [--change-reference]
                     [--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.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--cache-node-name

Name of Microsoft Connected Cache for Enterprise cache node.

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

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