az k8s-runtime service

Note

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

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

Manage Kubernetes runtime services of Arc Kubernetes clusters.

Commands

Name Description Type Status
az k8s-runtime service create

Create a Service.

Extension Preview
az k8s-runtime service delete

Delete a Service.

Extension Preview
az k8s-runtime service list

List Services by parent.

Extension Preview
az k8s-runtime service show

Get a Service.

Extension Preview

az k8s-runtime service create

Preview

Command group 'az k8s-runtime service' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create a Service.

az k8s-runtime service create --resource-uri
                              --service-name

Examples

Create a storageclass service

az k8s-runtime service create --resource-uri subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/example/providers/Microsoft.Kubernetes/connectedClusters/cluster1 --service-name storageclass

Required Parameters

--resource-uri

The fully qualified Azure Resource manager identifier of the resource.

--service-name

The name of the the service.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az k8s-runtime service delete

Preview

Command group 'az k8s-runtime service' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete a Service.

az k8s-runtime service delete --resource-uri
                              --service-name
                              [--yes]

Examples

Delete storage class service

az k8s-runtime service delete --resource-uri subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/example/providers/Microsoft.Kubernetes/connectedClusters/cluster1 --service-name storageclass

Required Parameters

--resource-uri

The fully qualified Azure Resource manager identifier of the resource.

--service-name

The name of the the service.

Optional Parameters

--yes -y

Do not prompt for confirmation.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az k8s-runtime service list

Preview

Command group 'az k8s-runtime service' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List Services by parent.

az k8s-runtime service list --resource-uri
                            [--max-items]
                            [--next-token]

Examples

List all services for a cluster

az k8s-runtime service list --resource-uri subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/example/providers/Microsoft.Kubernetes/connectedClusters/cluster1

Required Parameters

--resource-uri

The fully qualified Azure Resource manager identifier of the resource.

Optional Parameters

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

--next-token

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az k8s-runtime service show

Preview

Command group 'az k8s-runtime service' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get a Service.

az k8s-runtime service show --resource-uri
                            --service-name

Examples

Show storageclass service

az k8s-runtime service show --resource-uri subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/example/providers/Microsoft.Kubernetes/connectedClusters/cluster1 --service-name storageclass

Required Parameters

--resource-uri

The fully qualified Azure Resource manager identifier of the resource.

--service-name

The name of the the service.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.