|
| 1 | +# -------------------------------------------------------------------------- |
| 2 | +# Copyright (c) Microsoft Corporation. All rights reserved. |
| 3 | +# Licensed under the MIT License. See License.txt in the project root for |
| 4 | +# license information. |
| 5 | +# |
| 6 | +# Code generated by Microsoft (R) AutoRest Code Generator. |
| 7 | +# Changes may cause incorrect behavior and will be lost if the code is |
| 8 | +# regenerated. |
| 9 | +# -------------------------------------------------------------------------- |
| 10 | + |
| 11 | +from knack.help_files import helps |
| 12 | + |
| 13 | + |
| 14 | +def get_deployment_template_help(): |
| 15 | + """Load deployment template help content.""" |
| 16 | + |
| 17 | + |
| 18 | +helps['ml deployment-template'] = """ |
| 19 | +type: group |
| 20 | +short-summary: Manage Azure ML deployment templates. |
| 21 | +long-summary: | |
| 22 | + Deployment templates are reusable templates that define deployment configurations for Azure ML. |
| 23 | + They support registry-based operations only (not workspace-based) and provide a way to |
| 24 | + standardize and share deployment configurations across teams and projects. |
| 25 | +""" |
| 26 | + |
| 27 | +helps['ml deployment-template list'] = """ |
| 28 | +type: command |
| 29 | +short-summary: List deployment templates in a registry. |
| 30 | +long-summary: | |
| 31 | + List all deployment templates available in the specified registry. This command |
| 32 | + returns all templates along with their metadata including name, version, description, and tags. |
| 33 | +examples: |
| 34 | + - name: List all deployment templates in a registry |
| 35 | + text: az ml deployment-template list --registry-name myregistry |
| 36 | + - name: List deployment templates with specific output format |
| 37 | + text: az ml deployment-template list --registry-name myregistry --output table |
| 38 | +""" |
| 39 | + |
| 40 | +helps['ml deployment-template get'] = """ |
| 41 | +type: command |
| 42 | +short-summary: Get a specific deployment template by name and version. |
| 43 | +long-summary: | |
| 44 | + Retrieve detailed information about a specific deployment template. If version is not |
| 45 | + specified, the latest version will be returned. |
| 46 | +examples: |
| 47 | + - name: Get a specific version of a deployment template |
| 48 | + text: az ml deployment-template get --name my-template --version 1 --registry-name myregistry |
| 49 | +""" |
| 50 | + |
| 51 | +helps['ml deployment-template create'] = """ |
| 52 | +type: command |
| 53 | +short-summary: Create a new deployment template from a YAML file. |
| 54 | +long-summary: | |
| 55 | + Create a new deployment template using a YAML configuration file. The YAML file should |
| 56 | + contain the complete deployment template definition including endpoints, parameters, and metadata. |
| 57 | + You can override specific values using command-line parameters. |
| 58 | +examples: |
| 59 | + - name: Create a deployment template from a YAML file |
| 60 | + text: az ml deployment-template create --file template.yml --registry-name myregistry |
| 61 | + - name: Create with name and version overrides |
| 62 | + text: az ml deployment-template create --file template.yml --name custom-template --version 2 --registry-name myregistry |
| 63 | + - name: Create without waiting for completion |
| 64 | + text: az ml deployment-template create --file template.yml --registry-name myregistry --no-wait |
| 65 | +""" |
| 66 | + |
| 67 | +helps['ml deployment-template update'] = """ |
| 68 | +type: command |
| 69 | +short-summary: Update specific fields of an existing deployment template. |
| 70 | +long-summary: | |
| 71 | + Update metadata fields (description and tags) of an existing deployment template without |
| 72 | + requiring a YAML file. This command follows Azure CLI conventions and only accepts specific |
| 73 | + field updates. Tags are merged with existing tags rather than replaced. |
| 74 | +
|
| 75 | + For structural changes to the deployment template (endpoints, deployment configuration, etc.), |
| 76 | + use the 'create' command with a YAML file. |
| 77 | +examples: |
| 78 | + - name: Update deployment template description |
| 79 | + text: az ml deployment-template update --name my-template --version 1 --registry-name myregistry --set "description=Updated description" |
| 80 | + - name: Update deployment template tags |
| 81 | + text: az ml deployment-template update --name my-template --version 1 --registry-name myregistry --set "tags=environment=production owner=ml-team" |
| 82 | + - name: Update both description and tags |
| 83 | + text: az ml deployment-template update --name my-template --version 1 --registry-name myregistry --set "description=Production template" --set "tags=status=active" |
| 84 | +""" |
| 85 | + |
| 86 | +helps['ml deployment-template archive'] = """ |
| 87 | +type: command |
| 88 | +short-summary: Archive a deployment template. |
| 89 | +long-summary: | |
| 90 | + Archive a deployment template to mark it as inactive. Archived templates are not |
| 91 | + returned in list operations by default. You can archive a specific version or all |
| 92 | + versions of a template. |
| 93 | +examples: |
| 94 | + - name: Archive a specific version |
| 95 | + text: az ml deployment-template archive --name my-template --version 1 --registry-name myregistry |
| 96 | + - name: Archive without waiting for completion |
| 97 | + text: az ml deployment-template archive --name my-template --version 1 --registry-name myregistry --no-wait |
| 98 | +""" |
| 99 | + |
| 100 | +helps['ml deployment-template restore'] = """ |
| 101 | +type: command |
| 102 | +short-summary: Restore an archived deployment template. |
| 103 | +long-summary: | |
| 104 | + Restore a previously archived deployment template to make it active again. Restored |
| 105 | + templates will appear in list operations. You can restore a specific version or all |
| 106 | + versions of a template. |
| 107 | +examples: |
| 108 | + - name: Restore a specific version |
| 109 | + text: az ml deployment-template restore --name my-template --version 1 --registry-name myregistry |
| 110 | + - name: Restore without waiting for completion |
| 111 | + text: az ml deployment-template restore --name my-template --version 1 --registry-name myregistry --no-wait |
| 112 | +""" |
0 commit comments