|
12 | 12 | from knack.help_files import helps |
13 | 13 |
|
14 | 14 |
|
| 15 | +helps['datadog marketplace-agreement'] = """ |
| 16 | + type: group |
| 17 | + short-summary: datadog marketplace-agreement |
| 18 | +""" |
| 19 | + |
| 20 | +helps['datadog marketplace-agreement list'] = """ |
| 21 | + type: command |
| 22 | + short-summary: "List Datadog marketplace agreements in the subscription." |
| 23 | + examples: |
| 24 | + - name: MarketplaceAgreements_List |
| 25 | + text: |- |
| 26 | + az datadog marketplace-agreement list |
| 27 | +""" |
| 28 | + |
| 29 | +helps['datadog marketplace-agreement create'] = """ |
| 30 | + type: command |
| 31 | + short-summary: "Create Datadog marketplace agreement in the subscription." |
| 32 | + parameters: |
| 33 | + - name: --properties |
| 34 | + short-summary: "Represents the properties of the resource." |
| 35 | + long-summary: | |
| 36 | + Usage: --properties publisher=XX product=XX plan=XX license-text-link=XX privacy-policy-link=XX \ |
| 37 | +retrieve-datetime=XX signature=XX accepted=XX |
| 38 | +
|
| 39 | + publisher: Publisher identifier string. |
| 40 | + product: Product identifier string. |
| 41 | + plan: Plan identifier string. |
| 42 | + license-text-link: Link to HTML with Microsoft and Publisher terms. |
| 43 | + privacy-policy-link: Link to the privacy policy of the publisher. |
| 44 | + retrieve-datetime: Date and time in UTC of when the terms were accepted. This is empty if Accepted is \ |
| 45 | +false. |
| 46 | + signature: Terms signature. |
| 47 | + accepted: If any version of the terms have been accepted, otherwise false. |
| 48 | + examples: |
| 49 | + - name: MarketplaceAgreements_Create |
| 50 | + text: |- |
| 51 | + az datadog marketplace-agreement create --properties accepted=true |
| 52 | +""" |
| 53 | + |
15 | 54 | helps['datadog api-key'] = """ |
16 | 55 | type: group |
17 | 56 | short-summary: datadog api-key |
|
94 | 133 |
|
95 | 134 | helps['datadog monitor list'] = """ |
96 | 135 | type: command |
97 | | - short-summary: "List all monitors under the specified subscription." |
| 136 | + short-summary: "List all monitors under the specified resource group. And List all monitors under the specified \ |
| 137 | +subscription." |
98 | 138 | examples: |
99 | 139 | - name: Monitors_ListByResourceGroup |
100 | 140 | text: |- |
101 | 141 | az datadog monitor list --resource-group "myResourceGroup" |
| 142 | + - name: Monitors_List |
| 143 | + text: |- |
| 144 | + az datadog monitor list |
102 | 145 | """ |
103 | 146 |
|
104 | 147 | helps['datadog monitor show'] = """ |
|
115 | 158 | short-summary: "Create a monitor resource." |
116 | 159 | parameters: |
117 | 160 | - name: --datadog-organization-properties |
| 161 | + short-summary: "Datadog organization properties" |
118 | 162 | long-summary: | |
119 | 163 | Usage: --datadog-organization-properties linking-auth-code=XX linking-client-id=XX enterprise-app-id=XX |
120 | 164 |
|
121 | 165 | linking-auth-code: The auth code used to linking to an existing datadog organization. |
122 | 166 | linking-client-id: The client_id from an existing in exchange for an auth token to link organization. |
123 | 167 | enterprise-app-id: The Id of the Enterprise App used for Single sign on. |
124 | 168 | - name: --user-info |
| 169 | + short-summary: "User info" |
125 | 170 | long-summary: | |
126 | 171 | Usage: --user-info name=XX email-address=XX phone-number=XX |
127 | 172 |
|
|
131 | 176 | examples: |
132 | 177 | - name: Monitors_Create |
133 | 178 | text: |- |
134 | | - az datadog monitor create --name "myMonitor" --location "West US 2" \ |
| 179 | + az datadog monitor create --name "myMonitor" --sku-name "myMonitor" --location "West US" \ |
135 | 180 | --datadog-organization-properties name="myOrg" enterprise-app-id="00000000-0000-0000-0000-000000000000" \ |
136 | 181 | linking-auth-code="someAuthCode" linking-client-id="00000000-0000-0000-0000-000000000000" subscription="pro" \ |
137 | | ---monitoring-status "Enabled" --user-info name="Alice" email-address="alice@microsoft.com" phone-number="123-456-7890" \ |
138 | | ---sku-name "drawdown_testing_20200904_Monthly" --tags Environment="Dev" --resource-group "myResourceGroup" |
| 182 | +--user-info name="Alice" email-address="alice@microsoft.com" phone-number="123-456-7890" --sku-name "free_Monthly" \ |
| 183 | +--tags Environment="Dev" --resource-group "myResourceGroup" |
139 | 184 | """ |
140 | 185 |
|
141 | 186 | helps['datadog monitor update'] = """ |
|
144 | 189 | examples: |
145 | 190 | - name: Monitors_Update |
146 | 191 | text: |- |
147 | | - az datadog monitor update --name "myMonitor" --monitoring-status "Enabled" --tags Environment="Dev" \ |
148 | | ---resource-group "myResourceGroup" |
| 192 | + az datadog monitor update --name "myMonitor" --tags Environment="Dev" --resource-group \ |
| 193 | +"myResourceGroup" |
149 | 194 | """ |
150 | 195 |
|
151 | 196 | helps['datadog monitor delete'] = """ |
|
223 | 268 | action: Valid actions for a filtering tag. Exclusion takes priority over inclusion. |
224 | 269 |
|
225 | 270 | Multiple actions can be specified by using more than one --metric-rules-filtering-tags argument. |
226 | | - - name: --log-rules-filtering-tags |
227 | | - short-summary: "List of filtering tags to be used for capturing logs. This only takes effect if \ |
228 | | -SendResourceLogs flag is enabled. If empty, all resources will be captured. If only Exclude action is specified, the \ |
229 | | -rules will apply to the list of all available resources. If Include actions are specified, the rules will only include \ |
230 | | -resources with the associated tags." |
231 | | - long-summary: | |
232 | | - Usage: --log-rules-filtering-tags name=XX value=XX action=XX |
233 | | -
|
234 | | - name: The name (also known as the key) of the tag. |
235 | | - value: The value of the tag. |
236 | | - action: Valid actions for a filtering tag. Exclusion takes priority over inclusion. |
237 | | -
|
238 | | - Multiple actions can be specified by using more than one --log-rules-filtering-tags argument. |
239 | 271 | examples: |
240 | 272 | - name: TagRules_CreateOrUpdate |
241 | 273 | text: |- |
242 | | - az datadog tag-rule create --monitor-name "myMonitor" --log-rules-filtering-tags name="Environment" \ |
243 | | -action="Include" value="Prod" --log-rules-filtering-tags name="Environment" action="Exclude" value="Dev" \ |
244 | | ---log-rules-send-aad-logs false --log-rules-send-resource-logs true --log-rules-send-subscription-logs true \ |
245 | | ---resource-group "myResourceGroup" --rule-set-name "default" |
| 274 | + az datadog tag-rule create --monitor-name "myMonitor" --log-rules-send-aad-logs false \ |
| 275 | +--log-rules-send-resource-logs true --log-rules-send-subscription-logs true --resource-group "myResourceGroup" \ |
| 276 | +--rule-set-name "default" |
246 | 277 | """ |
247 | 278 |
|
248 | 279 | helps['datadog tag-rule update'] = """ |
|
261 | 292 | action: Valid actions for a filtering tag. Exclusion takes priority over inclusion. |
262 | 293 |
|
263 | 294 | Multiple actions can be specified by using more than one --metric-rules-filtering-tags argument. |
264 | | - - name: --log-rules-filtering-tags |
265 | | - short-summary: "List of filtering tags to be used for capturing logs. This only takes effect if \ |
266 | | -SendResourceLogs flag is enabled. If empty, all resources will be captured. If only Exclude action is specified, the \ |
267 | | -rules will apply to the list of all available resources. If Include actions are specified, the rules will only include \ |
268 | | -resources with the associated tags." |
269 | | - long-summary: | |
270 | | - Usage: --log-rules-filtering-tags name=XX value=XX action=XX |
271 | | -
|
272 | | - name: The name (also known as the key) of the tag. |
273 | | - value: The value of the tag. |
274 | | - action: Valid actions for a filtering tag. Exclusion takes priority over inclusion. |
275 | | -
|
276 | | - Multiple actions can be specified by using more than one --log-rules-filtering-tags argument. |
277 | 295 | """ |
278 | 296 |
|
279 | 297 | helps['datadog sso-config'] = """ |
|
287 | 305 | examples: |
288 | 306 | - name: SingleSignOnConfigurations_List |
289 | 307 | text: |- |
290 | | - az datadog sso-config list --monitor-name "myMonitor" --resource-group \ |
291 | | -"myResourceGroup" |
| 308 | + az datadog sso-config list --monitor-name "myMonitor" --resource-group "myResourceGroup" |
292 | 309 | """ |
293 | 310 |
|
294 | 311 | helps['datadog sso-config show'] = """ |
|
297 | 314 | examples: |
298 | 315 | - name: SingleSignOnConfigurations_Get |
299 | 316 | text: |- |
300 | | - az datadog sso-config show --configuration-name "default" --monitor-name "myMonitor" \ |
301 | | ---resource-group "myResourceGroup" |
| 317 | + az datadog sso-config show --configuration-name "default" --monitor-name "myMonitor" --resource-group \ |
| 318 | +"myResourceGroup" |
302 | 319 | """ |
303 | 320 |
|
304 | 321 | helps['datadog sso-config create'] = """ |
|
315 | 332 | examples: |
316 | 333 | - name: SingleSignOnConfigurations_CreateOrUpdate |
317 | 334 | text: |- |
318 | | - az datadog sso-config create --configuration-name "default" --monitor-name \ |
319 | | -"myMonitor" --properties enterprise-app-id="00000000-0000-0000-0000-000000000000" single-sign-on-state="Enable" \ |
320 | | ---resource-group "myResourceGroup" |
| 335 | + az datadog sso-config create --configuration-name "default" --monitor-name "myMonitor" --properties \ |
| 336 | +enterprise-app-id="00000000-0000-0000-0000-000000000000" single-sign-on-state="Enable" --resource-group \ |
| 337 | +"myResourceGroup" |
321 | 338 | """ |
322 | 339 |
|
323 | 340 | helps['datadog sso-config update'] = """ |
324 | 341 | type: command |
325 | 342 | short-summary: "Configures single-sign-on for this resource." |
| 343 | + parameters: |
| 344 | + - name: --properties |
| 345 | + long-summary: | |
| 346 | + Usage: --properties single-sign-on-state=XX enterprise-app-id=XX single-sign-on-url=XX |
| 347 | +
|
| 348 | + single-sign-on-state: Various states of the SSO resource |
| 349 | + enterprise-app-id: The Id of the Enterprise App used for Single sign-on. |
| 350 | + single-sign-on-url: The login URL specific to this Datadog Organization. |
326 | 351 | """ |
327 | 352 |
|
328 | 353 | helps['datadog sso-config wait'] = """ |
329 | 354 | type: command |
330 | | - short-summary: Place the CLI in a waiting state until a condition of the datadog sso-config is \ |
331 | | -met. |
| 355 | + short-summary: Place the CLI in a waiting state until a condition of the datadog sso-config is met. |
332 | 356 | examples: |
333 | | - - name: Pause executing next line of CLI script until the datadog sso-config is successfully \ |
334 | | -created. |
| 357 | + - name: Pause executing next line of CLI script until the datadog sso-config is successfully created. |
335 | 358 | text: |- |
336 | | - az datadog sso-config wait --configuration-name "default" --monitor-name "myMonitor" \ |
337 | | ---resource-group "myResourceGroup" --created |
338 | | - - name: Pause executing next line of CLI script until the datadog sso-config is successfully \ |
339 | | -updated. |
| 359 | + az datadog sso-config wait --configuration-name "default" --monitor-name "myMonitor" --resource-group \ |
| 360 | +"myResourceGroup" --created |
| 361 | + - name: Pause executing next line of CLI script until the datadog sso-config is successfully updated. |
340 | 362 | text: |- |
341 | | - az datadog sso-config wait --configuration-name "default" --monitor-name "myMonitor" \ |
342 | | ---resource-group "myResourceGroup" --updated |
| 363 | + az datadog sso-config wait --configuration-name "default" --monitor-name "myMonitor" --resource-group \ |
| 364 | +"myResourceGroup" --updated |
343 | 365 | """ |
0 commit comments