|
1 | 1 | # `azd` Demo Extension |
2 | 2 |
|
3 | | -An AZD Demo extension |
| 3 | +An AZD Demo extension with custom commands showcasing current capabilities of the `azd` extension framework. |
| 4 | + |
| 5 | +> [!IMPORTANT] |
| 6 | +> Ensure the extensions alpha feature has been enabled. |
| 7 | +> |
| 8 | +> Run `azd config set alpha.extensions on` |
| 9 | +
|
| 10 | +## Installation |
| 11 | + |
| 12 | +Run `azd ext install microsoft.azd.demo` |
| 13 | + |
| 14 | +## Commands |
| 15 | + |
| 16 | +### `context` |
| 17 | + |
| 18 | +Run `context` within an initialized `azd` project. |
| 19 | +The command will show metadata about the current project, selected environment and any deployed resources. |
| 20 | + |
| 21 | +#### Usage: `azd demo context` |
| 22 | + |
| 23 | +### `prompt` |
| 24 | + |
| 25 | +Run the `prompt` command to see an example of using `azd` styled prompts within your application written in any language. |
| 26 | +This features UX as a service via gRPC. |
| 27 | + |
| 28 | +#### Usage: `azd demo prompt` |
| 29 | + |
| 30 | +#### PromptSubscription |
| 31 | + |
| 32 | +Displays a single select prompt allowing selection of an Azure subscription based on the current logged in user. |
| 33 | + |
| 34 | +#### PromptLocation |
| 35 | + |
| 36 | +Displays a single select prompt allowing selection of a list of Azure locations for the current logged in user and subscription. |
| 37 | + |
| 38 | +#### PromptResourceGroup |
| 39 | + |
| 40 | +Displays a single select allowing the selection of Azure resource groups for the current logged in user and subscription. |
| 41 | + |
| 42 | +#### Confirm |
| 43 | + |
| 44 | +Display a yes/no prompt for a boolean value |
| 45 | + |
| 46 | +#### Prompt |
| 47 | + |
| 48 | +Displays a standard text input prompt for options. |
| 49 | + |
| 50 | +#### Select |
| 51 | + |
| 52 | +Displays a single select prompt with configurable choices. |
| 53 | + |
| 54 | +#### MultiSelect |
| 55 | + |
| 56 | +Displays a multi select prompt with configurable choices. |
| 57 | + |
| 58 | +#### PromptSubscriptionResource |
| 59 | + |
| 60 | +Displays a list of Azure resources based on the current logged in user, and subscription filtered by resource type and kind. |
| 61 | + |
| 62 | +#### PromptResourceGroupResource |
| 63 | + |
| 64 | +Displays a list of Azure resources based on the current logged in user, subscription and resource group filtered by resource type and kind. |
| 65 | + |
| 66 | +### `listen` |
| 67 | + |
| 68 | +This `listen` command is required when your extension leverages `LifecycleEvents` capability. |
| 69 | + |
| 70 | +#### Usage: `azd demo listen` |
| 71 | + |
| 72 | +This command is invoked by `azd` to allow your extension to subscribe to lifecycle events within the current `azd` project and services. |
0 commit comments