Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Default Experiences #1536

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Default Experiences #1536

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b568923
Default Experiences
cameronking4 Sep 13, 2024
3b2ad0c
Update default-experiences.md
cameronking4 Sep 27, 2024
72a6ff3
Merge branch 'main' into AzurePortalDefaultExperiences
cameronking4 Sep 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions docs/howtos/Azure Portal/default-experiences.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Generating experiences in Azure Portal with TypeSpec

Go to the [TypeSpec guide](https://eng.ms/docs/products/azure-portal-framework-ibizafx/declarative/typespec) to learn how to customize your Azure Portal experience, generated by default for your ARM resource type. Azure Resource Providers can apply TypeSpec decorators to generate and brand Azure Portal experiences.
Copy link
Contributor

@yejee94 yejee94 Sep 27, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: "generated by default for your ARM resource type" bit confusing for me :)


![ts6 (1)](https://github.com/user-attachments/assets/ba080602-0edb-4317-bcae-7dffce687a80)

## About Default Experiences

Azure Portal generates end-to-end experiences automatically, providing Resource Providers with immediate UX in Azure Portal for their resource types. This pipeline runs offline and generates views and an asset for your resource type. These generated experiences done by Azure Portal based on resource type metadata are called "Default Experiences". Leveraging TypeSpec affords Resource Providers with an easy, declarative way of branding and promoting these experiences, as the generated default experience is hidden by default. [Learn more](https://eng.ms/docs/products/azure-portal-framework-ibizafx/declarative/generated)

#### Default experiences include:
| **Browse + Management** | |
| --- | --- |
| > Global Search | *Discover resource instances and browse view through search* |
| > All Resources | *Discover resource instances in All Resources and launch Overview UX* |
| > Browse | *Browse and manage resource instances in standard browse view* |
| **Overview UX** | |
| > Commands: | Refresh, Delete, Create, Open in mobile, CMD by REST-API-SPEC (w/out params) |
| > Tabs: | Get Started template, Properties, Monitoring, Recommendations |
| > Essentials | *Enable essentials control* |
| **Resource Menu** | |
| > Standard Framework Options: | Support + Troubleshooting, Activity Log, IAM, Tags, Monitoring, Diagnostics, etc. |
| > Properties view | *Enable properties view for resource* |
| > CLI / PS view | *Enable CLI / PS view for resource* |
| > Child Browse views | *View child resources in menu* |

![alt-text](https://github.com/Azure/portaldocs/raw/main/portal-sdk/media/top-extensions-autogeneration/GeneratedOverviewTabs.jpg "Overview blade breakdown")



## Promoting generated experiences to production
See [Promoting Default Experiences](https://eng.ms/docs/products/azure-portal-framework-ibizafx/declarative/promotion) to learn how to promote your default generated Portal experience using TypeSpec.
Loading