UNPKG

@azure-tools/typespec-azure-portal-core

Version:

TypeSpec Azure Portal Core library

azure.github.io/typespec-azure

111 lines (69 loc) • 3.07 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
# @azure-tools/typespec-azure-portal-core TypeSpec Azure Portal Core library ## Install ```bash npm install @azure-tools/typespec-azure-portal-core ``` ## Decorators ### Azure.Portal - [`@about`](#@about) - [`@browse`](#@browse) - [`@displayName`](#@displayname) - [`@marketplaceOffer`](#@marketplaceoffer) - [`@promotion`](#@promotion) #### `@about` Provides a Model describing about of ARM resource. ```typespec @Azure.Portal.about(options: Azure.Portal.AboutOptions) ``` ##### Target `Model` ##### Parameters | Name | Type | Description | | ------- | ------------------------------- | ------------------------------------------------------------------------ | | options | [`AboutOptions`](#aboutoptions) | Property options allows more detailed infomation about the resourceType. | #### `@browse` Provides a Model customizing browse view of ARM resource. ```typespec @Azure.Portal.browse(options: Azure.Portal.BrowseOptions) ``` ##### Target `Model` ##### Parameters | Name | Type | Description | | ------- | --------------------------------- | ------------------------------------------------------------------- | | options | [`BrowseOptions`](#browseoptions) | Property options provides browsing information of the resourceType. | #### `@displayName` Provides a Model Property a display name ```typespec @Azure.Portal.displayName(name: valueof string) ``` ##### Target `ModelProperty` ##### Parameters | Name | Type | Description | | ---- | ---------------- | ----------- | | name | `valueof string` | | #### `@marketplaceOffer` Provides a Model marketplace offer information of ARM resource. ```typespec @Azure.Portal.marketplaceOffer(options: Azure.Portal.MarketplaceOfferOptions) ``` ##### Target `Model` ##### Parameters | Name | Type | Description | | ------- | ----------------------------------------------------- | ---------------------------------------------------------------------------- | | options | [`MarketplaceOfferOptions`](#marketplaceofferoptions) | Property options provides marketplace offer information of the resourceType. | #### `@promotion` Provides a Model customizing deployment promotion apiVersion for ARM resource. The apiVersion will be used as a version to deploy to Portal. ```typespec @Azure.Portal.promotion(options: Azure.Portal.PromotionOptions) ``` ##### Target `Model` ##### Parameters | Name | Type | Description | | ------- | --------------------------------------- | -------------------------------------------------------------------- | | options | [`PromotionOptions`](#promotionoptions) | Property options provides promotion information of the resourceType. |