This repository was archived by the owner on May 13, 2025. It is now read-only.
forked from Azure/azure-cli-extensions
-
Notifications
You must be signed in to change notification settings - Fork 17
Expand file tree
/
Copy path_help.py
More file actions
123 lines (110 loc) · 5.17 KB
/
_help.py
File metadata and controls
123 lines (110 loc) · 5.17 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
# coding=utf-8
# --------------------------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
# --------------------------------------------------------------------------------------------
from knack.help_files import helps # pylint: disable=unused-import
from . import consts
helps[f'{consts.EXTENSION_NAME}'] = """
type: group
short-summary: Commands to manage Kubernetes Extensions.
"""
helps[f'{consts.EXTENSION_NAME} create'] = f"""
type: command
short-summary: Create a Kubernetes Cluster Extension, including purchasing an extension Offer from Azure Marketplace (AKS only). Please refer to the example at the end to see how to create an extension or purchase an extension offer.
examples:
- name: Create a Kubernetes Extension
text: |-
az {consts.EXTENSION_NAME} create --resource-group my-resource-group \
--cluster-name mycluster --cluster-type connectedClusters --name myextension \
--extension-type microsoft.openservicemesh --scope cluster --release-train stable
- name: Create a Kubernetes Marketplace Extension
text: |-
az {consts.EXTENSION_NAME} create --resource-group my-resource-group \
--cluster-name mycluster --cluster-type managedClusters --name myextension \
--extension-type Contoso.AzureVoteKubernetesAppTest --scope cluster --release-train stable \
--plan-name testplan --plan-product kubernetest_apps_demo_offer --plan-publisher test_test_mix3pptest0011614206850774
"""
helps[f'{consts.EXTENSION_NAME} list'] = f"""
type: command
short-summary: List Kubernetes Extensions.
examples:
- name: List all Kubernetes Extensions on a cluster
text: |-
az {consts.EXTENSION_NAME} list --resource-group my-resource-group \
--cluster-name mycluster --cluster-type connectedClusters
"""
helps[f'{consts.EXTENSION_NAME} delete'] = f"""
type: command
short-summary: Delete a Kubernetes Extension.
examples:
- name: Delete an existing Kubernetes Extension
text: |-
az {consts.EXTENSION_NAME} delete --resource-group my-resource-group \
--cluster-name mycluster --cluster-type connectedClusters --name myextension
"""
helps[f'{consts.EXTENSION_NAME} show'] = f"""
type: command
short-summary: Show a Kubernetes Extension.
examples:
- name: Show details of a Kubernetes Extension
text: |-
az {consts.EXTENSION_NAME} show --resource-group my-resource-group \
--cluster-name mycluster --cluster-type connectedClusters --name myextension
"""
helps[f'{consts.EXTENSION_NAME} update'] = f"""
type: command
short-summary: Update mutable properties of a Kubernetes Extension.
long-summary: For update to ConfigSettings and ConfigProtectedSettings, please \
refer to documentation of the cluster extension service to check update to these \
properties is supported before updating these properties.
examples:
- name: Update a Kubernetes Extension
text: |-
az {consts.EXTENSION_NAME} update --resource-group my-resource-group \
--cluster-name mycluster --cluster-type connectedClusters \
--name myextension --auto-upgrade true/false --version extension-version \
--release-train stable --configuration-settings settings-key=settings-value \
--config-protected-settings protected-settings-key=protected-value \
--config-settings-file=config-settings-file \
--config-protected-file=protected-settings-file
"""
helps[f'{consts.EXTENSION_NAME} extension-types'] = """
type: group
short-summary: Commands to discover Kubernetes Extension Types.
"""
helps[f'{consts.EXTENSION_NAME} extension-types list'] = f"""
type: command
short-summary: List Kubernetes Extension Types.
examples:
- name: List Kubernetes Extension Types
text: |-
az {consts.EXTENSION_NAME} extension-types list --resource-group my-resource-group \
--cluster-name mycluster --cluster-type connectedClusters
"""
helps[f'{consts.EXTENSION_NAME} extension-types list-by-location'] = f"""
type: command
short-summary: List available Kubernetes Extension Types in a specified region.
examples:
- name: List Kubernetes Extension Types by location
text: |-
az {consts.EXTENSION_NAME} extension-types list-by-location --location eastus2euap
"""
helps[f'{consts.EXTENSION_NAME} extension-types show'] = f"""
type: command
short-summary: Show properties for a Kubernetes Extension Type.
examples:
- name: Show Kubernetes Extension Type
text: |-
az {consts.EXTENSION_NAME} extension-types show --resource-group my-resource-group \
--cluster-name mycluster --cluster-type connectedClusters --extension-type cassandradatacenteroperator
"""
helps[f'{consts.EXTENSION_NAME} extension-types list-versions'] = f"""
type: command
short-summary: List available versions for a Kubernetes Extension Type.
examples:
- name: List versions for an Extension Type
text: |-
az {consts.EXTENSION_NAME} extension-types list-versions --location eastus2euap \
--extension-type cassandradatacenteroperator
"""