az codespace plan

  • Reference

Manage Codespace plans.

Commands

az codespace plan create

Create a Codespace plan.
az codespace plan delete

Delete a Codespace plan.
az codespace plan list

List Codespace plans.
az codespace plan show

Show details of a Codespace plan.

az codespace plan create

Create a Codespace plan.

az codespace plan create --name
                         --resource-group
                         [--default-instance-type]
                         [--default-suspend-after {120, 30, 5, 60}]
                         [--location]
                         [--subnet]
                         [--tags]

Examples

Create a plan in same region as resource group

az codespace plan create -g my-rg -n my-plan

Create a plan in a specific region

az codespace plan create -g my-rg -n my-plan -l westus2

Create a plan with tags

az codespace plan create -g my-rg -n my-plan --tags tagname=tagvalue

Create a plan with a default instance type

az codespace plan create -g my-rg -n my-plan --default-instance-type premiumLinux

Create a plan with a default suspend after

az codespace plan create -g my-rg -n my-plan --default-suspend-after 120

Create a plan associated with a subnet

az codespace plan create -g my-rg -n my-plan --subnet /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet/subnets/default

Required Parameters

--name -n

Name of the Codespace plan.

--resource-group -g

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

Optional Parameters

--default-instance-type

Default Instance Type for Codespaces in this plan.

--default-suspend-after

Default minutes Codespaces in this plan should suspend after.

accepted values: 120, 30, 5, 60
--location -l

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

--subnet

Resource ID of an existing subnet. If specified, all Codespaces in this plan will be created in this subnet. The subnet must be in the same region as the plan.

--tags

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

az codespace plan delete

Delete a Codespace plan.

az codespace plan delete --name
                         --resource-group
                         [--yes]

Examples

Delete a plan

az codespace plan delete -g my-rg -n my-plan

Required Parameters

--name -n

Name of the Codespace plan.

--resource-group -g

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

Optional Parameters

--yes -y

Do not prompt for confirmation.

az codespace plan list

List Codespace plans.

az codespace plan list [--resource-group]

Examples

List plans

az codespace plan list

List plans in a given resource group

az codespace plan list -g my-rg

Optional Parameters

--resource-group -g

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

az codespace plan show

Show details of a Codespace plan.

az codespace plan show --name
                       --resource-group

Examples

Show details of a plan

az codespace plan show -g my-rg -n my-plan

Required Parameters

--name -n

Name of the Codespace plan.

--resource-group -g

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