@azure/arm-domainregistration 1.0.0-alpha.20251120.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (248) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +115 -0
  3. package/dist/browser/domainRegistrationManagementClient.d.ts +24 -0
  4. package/dist/browser/domainRegistrationManagementClient.d.ts.map +1 -0
  5. package/dist/browser/domainRegistrationManagementClient.js +103 -0
  6. package/dist/browser/domainRegistrationManagementClient.js.map +1 -0
  7. package/dist/browser/index.d.ts +5 -0
  8. package/dist/browser/index.d.ts.map +1 -0
  9. package/dist/browser/index.js +10 -0
  10. package/dist/browser/index.js.map +1 -0
  11. package/dist/browser/lroImpl.d.ts +11 -0
  12. package/dist/browser/lroImpl.d.ts.map +1 -0
  13. package/dist/browser/lroImpl.js +20 -0
  14. package/dist/browser/lroImpl.js.map +1 -0
  15. package/dist/browser/models/index.d.ts +3096 -0
  16. package/dist/browser/models/index.d.ts.map +1 -0
  17. package/dist/browser/models/index.js +219 -0
  18. package/dist/browser/models/index.js.map +1 -0
  19. package/dist/browser/models/mappers.d.ts +147 -0
  20. package/dist/browser/models/mappers.d.ts.map +1 -0
  21. package/dist/browser/models/mappers.js +6638 -0
  22. package/dist/browser/models/mappers.js.map +1 -0
  23. package/dist/browser/models/parameters.d.ts +19 -0
  24. package/dist/browser/models/parameters.d.ts.map +1 -0
  25. package/dist/browser/models/parameters.js +150 -0
  26. package/dist/browser/models/parameters.js.map +1 -0
  27. package/dist/browser/operations/domainRegistrationProvider.d.ts +34 -0
  28. package/dist/browser/operations/domainRegistrationProvider.d.ts.map +1 -0
  29. package/dist/browser/operations/domainRegistrationProvider.js +113 -0
  30. package/dist/browser/operations/domainRegistrationProvider.js.map +1 -0
  31. package/dist/browser/operations/domains.d.ts +199 -0
  32. package/dist/browser/operations/domains.d.ts.map +1 -0
  33. package/dist/browser/operations/domains.js +859 -0
  34. package/dist/browser/operations/domains.js.map +1 -0
  35. package/dist/browser/operations/index.d.ts +4 -0
  36. package/dist/browser/operations/index.d.ts.map +1 -0
  37. package/dist/browser/operations/index.js +8 -0
  38. package/dist/browser/operations/index.js.map +1 -0
  39. package/dist/browser/operations/topLevelDomains.d.ts +62 -0
  40. package/dist/browser/operations/topLevelDomains.d.ts.map +1 -0
  41. package/dist/browser/operations/topLevelDomains.js +239 -0
  42. package/dist/browser/operations/topLevelDomains.js.map +1 -0
  43. package/dist/browser/operationsInterfaces/domainRegistrationProvider.d.ts +12 -0
  44. package/dist/browser/operationsInterfaces/domainRegistrationProvider.d.ts.map +1 -0
  45. package/dist/browser/operationsInterfaces/domainRegistrationProvider.js +4 -0
  46. package/dist/browser/operationsInterfaces/domainRegistrationProvider.js.map +1 -0
  47. package/dist/browser/operationsInterfaces/domains.d.ts +130 -0
  48. package/dist/browser/operationsInterfaces/domains.d.ts.map +1 -0
  49. package/dist/browser/operationsInterfaces/domains.js +4 -0
  50. package/dist/browser/operationsInterfaces/domains.js.map +1 -0
  51. package/dist/browser/operationsInterfaces/index.d.ts +4 -0
  52. package/dist/browser/operationsInterfaces/index.d.ts.map +1 -0
  53. package/dist/browser/operationsInterfaces/index.js +8 -0
  54. package/dist/browser/operationsInterfaces/index.js.map +1 -0
  55. package/dist/browser/operationsInterfaces/topLevelDomains.d.ts +24 -0
  56. package/dist/browser/operationsInterfaces/topLevelDomains.d.ts.map +1 -0
  57. package/dist/browser/operationsInterfaces/topLevelDomains.js +4 -0
  58. package/dist/browser/operationsInterfaces/topLevelDomains.js.map +1 -0
  59. package/dist/browser/package.json +3 -0
  60. package/dist/browser/pagingHelper.d.ts +13 -0
  61. package/dist/browser/pagingHelper.d.ts.map +1 -0
  62. package/dist/browser/pagingHelper.js +25 -0
  63. package/dist/browser/pagingHelper.js.map +1 -0
  64. package/dist/commonjs/domainRegistrationManagementClient.d.ts +24 -0
  65. package/dist/commonjs/domainRegistrationManagementClient.d.ts.map +1 -0
  66. package/dist/commonjs/domainRegistrationManagementClient.js +108 -0
  67. package/dist/commonjs/domainRegistrationManagementClient.js.map +1 -0
  68. package/dist/commonjs/index.d.ts +5 -0
  69. package/dist/commonjs/index.d.ts.map +1 -0
  70. package/dist/commonjs/index.js +16 -0
  71. package/dist/commonjs/index.js.map +1 -0
  72. package/dist/commonjs/lroImpl.d.ts +11 -0
  73. package/dist/commonjs/lroImpl.d.ts.map +1 -0
  74. package/dist/commonjs/lroImpl.js +23 -0
  75. package/dist/commonjs/lroImpl.js.map +1 -0
  76. package/dist/commonjs/models/index.d.ts +3096 -0
  77. package/dist/commonjs/models/index.d.ts.map +1 -0
  78. package/dist/commonjs/models/index.js +222 -0
  79. package/dist/commonjs/models/index.js.map +1 -0
  80. package/dist/commonjs/models/mappers.d.ts +147 -0
  81. package/dist/commonjs/models/mappers.d.ts.map +1 -0
  82. package/dist/commonjs/models/mappers.js +6643 -0
  83. package/dist/commonjs/models/mappers.js.map +1 -0
  84. package/dist/commonjs/models/parameters.d.ts +19 -0
  85. package/dist/commonjs/models/parameters.d.ts.map +1 -0
  86. package/dist/commonjs/models/parameters.js +153 -0
  87. package/dist/commonjs/models/parameters.js.map +1 -0
  88. package/dist/commonjs/operations/domainRegistrationProvider.d.ts +34 -0
  89. package/dist/commonjs/operations/domainRegistrationProvider.d.ts.map +1 -0
  90. package/dist/commonjs/operations/domainRegistrationProvider.js +118 -0
  91. package/dist/commonjs/operations/domainRegistrationProvider.js.map +1 -0
  92. package/dist/commonjs/operations/domains.d.ts +199 -0
  93. package/dist/commonjs/operations/domains.d.ts.map +1 -0
  94. package/dist/commonjs/operations/domains.js +864 -0
  95. package/dist/commonjs/operations/domains.js.map +1 -0
  96. package/dist/commonjs/operations/index.d.ts +4 -0
  97. package/dist/commonjs/operations/index.d.ts.map +1 -0
  98. package/dist/commonjs/operations/index.js +11 -0
  99. package/dist/commonjs/operations/index.js.map +1 -0
  100. package/dist/commonjs/operations/topLevelDomains.d.ts +62 -0
  101. package/dist/commonjs/operations/topLevelDomains.d.ts.map +1 -0
  102. package/dist/commonjs/operations/topLevelDomains.js +244 -0
  103. package/dist/commonjs/operations/topLevelDomains.js.map +1 -0
  104. package/dist/commonjs/operationsInterfaces/domainRegistrationProvider.d.ts +12 -0
  105. package/dist/commonjs/operationsInterfaces/domainRegistrationProvider.d.ts.map +1 -0
  106. package/dist/commonjs/operationsInterfaces/domainRegistrationProvider.js +5 -0
  107. package/dist/commonjs/operationsInterfaces/domainRegistrationProvider.js.map +1 -0
  108. package/dist/commonjs/operationsInterfaces/domains.d.ts +130 -0
  109. package/dist/commonjs/operationsInterfaces/domains.d.ts.map +1 -0
  110. package/dist/commonjs/operationsInterfaces/domains.js +5 -0
  111. package/dist/commonjs/operationsInterfaces/domains.js.map +1 -0
  112. package/dist/commonjs/operationsInterfaces/index.d.ts +4 -0
  113. package/dist/commonjs/operationsInterfaces/index.d.ts.map +1 -0
  114. package/dist/commonjs/operationsInterfaces/index.js +11 -0
  115. package/dist/commonjs/operationsInterfaces/index.js.map +1 -0
  116. package/dist/commonjs/operationsInterfaces/topLevelDomains.d.ts +24 -0
  117. package/dist/commonjs/operationsInterfaces/topLevelDomains.d.ts.map +1 -0
  118. package/dist/commonjs/operationsInterfaces/topLevelDomains.js +5 -0
  119. package/dist/commonjs/operationsInterfaces/topLevelDomains.js.map +1 -0
  120. package/dist/commonjs/package.json +3 -0
  121. package/dist/commonjs/pagingHelper.d.ts +13 -0
  122. package/dist/commonjs/pagingHelper.d.ts.map +1 -0
  123. package/dist/commonjs/pagingHelper.js +29 -0
  124. package/dist/commonjs/pagingHelper.js.map +1 -0
  125. package/dist/commonjs/tsdoc-metadata.json +11 -0
  126. package/dist/esm/domainRegistrationManagementClient.d.ts +24 -0
  127. package/dist/esm/domainRegistrationManagementClient.d.ts.map +1 -0
  128. package/dist/esm/domainRegistrationManagementClient.js +103 -0
  129. package/dist/esm/domainRegistrationManagementClient.js.map +1 -0
  130. package/dist/esm/index.d.ts +5 -0
  131. package/dist/esm/index.d.ts.map +1 -0
  132. package/dist/esm/index.js +10 -0
  133. package/dist/esm/index.js.map +1 -0
  134. package/dist/esm/lroImpl.d.ts +11 -0
  135. package/dist/esm/lroImpl.d.ts.map +1 -0
  136. package/dist/esm/lroImpl.js +20 -0
  137. package/dist/esm/lroImpl.js.map +1 -0
  138. package/dist/esm/models/index.d.ts +3096 -0
  139. package/dist/esm/models/index.d.ts.map +1 -0
  140. package/dist/esm/models/index.js +219 -0
  141. package/dist/esm/models/index.js.map +1 -0
  142. package/dist/esm/models/mappers.d.ts +147 -0
  143. package/dist/esm/models/mappers.d.ts.map +1 -0
  144. package/dist/esm/models/mappers.js +6638 -0
  145. package/dist/esm/models/mappers.js.map +1 -0
  146. package/dist/esm/models/parameters.d.ts +19 -0
  147. package/dist/esm/models/parameters.d.ts.map +1 -0
  148. package/dist/esm/models/parameters.js +150 -0
  149. package/dist/esm/models/parameters.js.map +1 -0
  150. package/dist/esm/operations/domainRegistrationProvider.d.ts +34 -0
  151. package/dist/esm/operations/domainRegistrationProvider.d.ts.map +1 -0
  152. package/dist/esm/operations/domainRegistrationProvider.js +113 -0
  153. package/dist/esm/operations/domainRegistrationProvider.js.map +1 -0
  154. package/dist/esm/operations/domains.d.ts +199 -0
  155. package/dist/esm/operations/domains.d.ts.map +1 -0
  156. package/dist/esm/operations/domains.js +859 -0
  157. package/dist/esm/operations/domains.js.map +1 -0
  158. package/dist/esm/operations/index.d.ts +4 -0
  159. package/dist/esm/operations/index.d.ts.map +1 -0
  160. package/dist/esm/operations/index.js +8 -0
  161. package/dist/esm/operations/index.js.map +1 -0
  162. package/dist/esm/operations/topLevelDomains.d.ts +62 -0
  163. package/dist/esm/operations/topLevelDomains.d.ts.map +1 -0
  164. package/dist/esm/operations/topLevelDomains.js +239 -0
  165. package/dist/esm/operations/topLevelDomains.js.map +1 -0
  166. package/dist/esm/operationsInterfaces/domainRegistrationProvider.d.ts +12 -0
  167. package/dist/esm/operationsInterfaces/domainRegistrationProvider.d.ts.map +1 -0
  168. package/dist/esm/operationsInterfaces/domainRegistrationProvider.js +4 -0
  169. package/dist/esm/operationsInterfaces/domainRegistrationProvider.js.map +1 -0
  170. package/dist/esm/operationsInterfaces/domains.d.ts +130 -0
  171. package/dist/esm/operationsInterfaces/domains.d.ts.map +1 -0
  172. package/dist/esm/operationsInterfaces/domains.js +4 -0
  173. package/dist/esm/operationsInterfaces/domains.js.map +1 -0
  174. package/dist/esm/operationsInterfaces/index.d.ts +4 -0
  175. package/dist/esm/operationsInterfaces/index.d.ts.map +1 -0
  176. package/dist/esm/operationsInterfaces/index.js +8 -0
  177. package/dist/esm/operationsInterfaces/index.js.map +1 -0
  178. package/dist/esm/operationsInterfaces/topLevelDomains.d.ts +24 -0
  179. package/dist/esm/operationsInterfaces/topLevelDomains.d.ts.map +1 -0
  180. package/dist/esm/operationsInterfaces/topLevelDomains.js +4 -0
  181. package/dist/esm/operationsInterfaces/topLevelDomains.js.map +1 -0
  182. package/dist/esm/package.json +3 -0
  183. package/dist/esm/pagingHelper.d.ts +13 -0
  184. package/dist/esm/pagingHelper.d.ts.map +1 -0
  185. package/dist/esm/pagingHelper.js +25 -0
  186. package/dist/esm/pagingHelper.js.map +1 -0
  187. package/dist/react-native/domainRegistrationManagementClient.d.ts +24 -0
  188. package/dist/react-native/domainRegistrationManagementClient.d.ts.map +1 -0
  189. package/dist/react-native/domainRegistrationManagementClient.js +103 -0
  190. package/dist/react-native/domainRegistrationManagementClient.js.map +1 -0
  191. package/dist/react-native/index.d.ts +5 -0
  192. package/dist/react-native/index.d.ts.map +1 -0
  193. package/dist/react-native/index.js +10 -0
  194. package/dist/react-native/index.js.map +1 -0
  195. package/dist/react-native/lroImpl.d.ts +11 -0
  196. package/dist/react-native/lroImpl.d.ts.map +1 -0
  197. package/dist/react-native/lroImpl.js +20 -0
  198. package/dist/react-native/lroImpl.js.map +1 -0
  199. package/dist/react-native/models/index.d.ts +3096 -0
  200. package/dist/react-native/models/index.d.ts.map +1 -0
  201. package/dist/react-native/models/index.js +219 -0
  202. package/dist/react-native/models/index.js.map +1 -0
  203. package/dist/react-native/models/mappers.d.ts +147 -0
  204. package/dist/react-native/models/mappers.d.ts.map +1 -0
  205. package/dist/react-native/models/mappers.js +6638 -0
  206. package/dist/react-native/models/mappers.js.map +1 -0
  207. package/dist/react-native/models/parameters.d.ts +19 -0
  208. package/dist/react-native/models/parameters.d.ts.map +1 -0
  209. package/dist/react-native/models/parameters.js +150 -0
  210. package/dist/react-native/models/parameters.js.map +1 -0
  211. package/dist/react-native/operations/domainRegistrationProvider.d.ts +34 -0
  212. package/dist/react-native/operations/domainRegistrationProvider.d.ts.map +1 -0
  213. package/dist/react-native/operations/domainRegistrationProvider.js +113 -0
  214. package/dist/react-native/operations/domainRegistrationProvider.js.map +1 -0
  215. package/dist/react-native/operations/domains.d.ts +199 -0
  216. package/dist/react-native/operations/domains.d.ts.map +1 -0
  217. package/dist/react-native/operations/domains.js +859 -0
  218. package/dist/react-native/operations/domains.js.map +1 -0
  219. package/dist/react-native/operations/index.d.ts +4 -0
  220. package/dist/react-native/operations/index.d.ts.map +1 -0
  221. package/dist/react-native/operations/index.js +8 -0
  222. package/dist/react-native/operations/index.js.map +1 -0
  223. package/dist/react-native/operations/topLevelDomains.d.ts +62 -0
  224. package/dist/react-native/operations/topLevelDomains.d.ts.map +1 -0
  225. package/dist/react-native/operations/topLevelDomains.js +239 -0
  226. package/dist/react-native/operations/topLevelDomains.js.map +1 -0
  227. package/dist/react-native/operationsInterfaces/domainRegistrationProvider.d.ts +12 -0
  228. package/dist/react-native/operationsInterfaces/domainRegistrationProvider.d.ts.map +1 -0
  229. package/dist/react-native/operationsInterfaces/domainRegistrationProvider.js +4 -0
  230. package/dist/react-native/operationsInterfaces/domainRegistrationProvider.js.map +1 -0
  231. package/dist/react-native/operationsInterfaces/domains.d.ts +130 -0
  232. package/dist/react-native/operationsInterfaces/domains.d.ts.map +1 -0
  233. package/dist/react-native/operationsInterfaces/domains.js +4 -0
  234. package/dist/react-native/operationsInterfaces/domains.js.map +1 -0
  235. package/dist/react-native/operationsInterfaces/index.d.ts +4 -0
  236. package/dist/react-native/operationsInterfaces/index.d.ts.map +1 -0
  237. package/dist/react-native/operationsInterfaces/index.js +8 -0
  238. package/dist/react-native/operationsInterfaces/index.js.map +1 -0
  239. package/dist/react-native/operationsInterfaces/topLevelDomains.d.ts +24 -0
  240. package/dist/react-native/operationsInterfaces/topLevelDomains.d.ts.map +1 -0
  241. package/dist/react-native/operationsInterfaces/topLevelDomains.js +4 -0
  242. package/dist/react-native/operationsInterfaces/topLevelDomains.js.map +1 -0
  243. package/dist/react-native/package.json +3 -0
  244. package/dist/react-native/pagingHelper.d.ts +13 -0
  245. package/dist/react-native/pagingHelper.d.ts.map +1 -0
  246. package/dist/react-native/pagingHelper.js +25 -0
  247. package/dist/react-native/pagingHelper.js.map +1 -0
  248. package/package.json +135 -0
@@ -0,0 +1,3096 @@
1
+ import type * as coreClient from "@azure/core-client";
2
+ /** Collection of Azure resource manager operation metadata. */
3
+ export interface CsmOperationCollection {
4
+ /** Collection of resources. */
5
+ value: CsmOperationDescription[];
6
+ /**
7
+ * Link to next page of resources.
8
+ * NOTE: This property will not be serialized. It can only be populated by the server.
9
+ */
10
+ readonly nextLink?: string;
11
+ }
12
+ /** Description of an operation available for Microsoft.Web resource provider. */
13
+ export interface CsmOperationDescription {
14
+ name?: string;
15
+ isDataAction?: boolean;
16
+ /** Meta data about operation used for display in portal. */
17
+ display?: CsmOperationDisplay;
18
+ origin?: string;
19
+ /** Properties available for a Microsoft.Web resource provider operation. */
20
+ properties?: CsmOperationDescriptionProperties;
21
+ }
22
+ /** Meta data about operation used for display in portal. */
23
+ export interface CsmOperationDisplay {
24
+ provider?: string;
25
+ resource?: string;
26
+ operation?: string;
27
+ description?: string;
28
+ }
29
+ /** Properties available for a Microsoft.Web resource provider operation. */
30
+ export interface CsmOperationDescriptionProperties {
31
+ /** Resource metrics service provided by Microsoft.Insights resource provider. */
32
+ serviceSpecification?: ServiceSpecification;
33
+ }
34
+ /** Resource metrics service provided by Microsoft.Insights resource provider. */
35
+ export interface ServiceSpecification {
36
+ metricSpecifications?: MetricSpecification[];
37
+ logSpecifications?: LogSpecification[];
38
+ }
39
+ /** Definition of a single resource metric. */
40
+ export interface MetricSpecification {
41
+ name?: string;
42
+ displayName?: string;
43
+ displayDescription?: string;
44
+ unit?: string;
45
+ aggregationType?: string;
46
+ supportsInstanceLevelAggregation?: boolean;
47
+ enableRegionalMdmAccount?: boolean;
48
+ sourceMdmAccount?: string;
49
+ sourceMdmNamespace?: string;
50
+ metricFilterPattern?: string;
51
+ fillGapWithZero?: boolean;
52
+ isInternal?: boolean;
53
+ dimensions?: Dimension[];
54
+ category?: string;
55
+ availabilities?: MetricAvailability[];
56
+ supportedTimeGrainTypes?: string[];
57
+ supportedAggregationTypes?: string[];
58
+ }
59
+ /**
60
+ * Dimension of a resource metric. For e.g. instance specific HTTP requests for a web app,
61
+ * where instance name is dimension of the metric HTTP request
62
+ */
63
+ export interface Dimension {
64
+ name?: string;
65
+ displayName?: string;
66
+ internalName?: string;
67
+ toBeExportedForShoebox?: boolean;
68
+ }
69
+ /** Retention policy of a resource metric. */
70
+ export interface MetricAvailability {
71
+ timeGrain?: string;
72
+ blobDuration?: string;
73
+ }
74
+ /** Log Definition of a single resource metric. */
75
+ export interface LogSpecification {
76
+ name?: string;
77
+ displayName?: string;
78
+ blobDuration?: string;
79
+ logFilterPattern?: string;
80
+ }
81
+ /** App Service error response. */
82
+ export interface DefaultErrorResponse {
83
+ /**
84
+ * Error model.
85
+ * NOTE: This property will not be serialized. It can only be populated by the server.
86
+ */
87
+ readonly error?: DefaultErrorResponseError;
88
+ }
89
+ /** Error model. */
90
+ export interface DefaultErrorResponseError {
91
+ /**
92
+ * Standardized string to programmatically identify the error.
93
+ * NOTE: This property will not be serialized. It can only be populated by the server.
94
+ */
95
+ readonly code?: string;
96
+ /**
97
+ * Detailed error description and debugging information.
98
+ * NOTE: This property will not be serialized. It can only be populated by the server.
99
+ */
100
+ readonly message?: string;
101
+ /**
102
+ * Detailed error description and debugging information.
103
+ * NOTE: This property will not be serialized. It can only be populated by the server.
104
+ */
105
+ readonly target?: string;
106
+ details?: DefaultErrorResponseErrorDetailsItem[];
107
+ /**
108
+ * More information to debug error.
109
+ * NOTE: This property will not be serialized. It can only be populated by the server.
110
+ */
111
+ readonly innererror?: string;
112
+ }
113
+ /** Detailed errors. */
114
+ export interface DefaultErrorResponseErrorDetailsItem {
115
+ /**
116
+ * Standardized string to programmatically identify the error.
117
+ * NOTE: This property will not be serialized. It can only be populated by the server.
118
+ */
119
+ readonly code?: string;
120
+ /**
121
+ * Detailed error description and debugging information.
122
+ * NOTE: This property will not be serialized. It can only be populated by the server.
123
+ */
124
+ readonly message?: string;
125
+ /**
126
+ * Detailed error description and debugging information.
127
+ * NOTE: This property will not be serialized. It can only be populated by the server.
128
+ */
129
+ readonly target?: string;
130
+ }
131
+ /** Identifies an object. */
132
+ export interface NameIdentifier {
133
+ /** Name of the object. */
134
+ name?: string;
135
+ }
136
+ /** Domain availability check result. */
137
+ export interface DomainAvailabilityCheckResult {
138
+ /** Name of the domain. */
139
+ name?: string;
140
+ /** <code>true</code> if domain can be purchased using CreateDomain API; otherwise, <code>false</code>. */
141
+ available?: boolean;
142
+ /** Valid values are Regular domain: Azure will charge the full price of domain registration, SoftDeleted: Purchasing this domain will simply restore it and this operation will not cost anything. */
143
+ domainType?: DomainType;
144
+ }
145
+ /** Collection of domains. */
146
+ export interface DomainCollection {
147
+ /** Collection of resources. */
148
+ value: Domain[];
149
+ /**
150
+ * Link to next page of resources.
151
+ * NOTE: This property will not be serialized. It can only be populated by the server.
152
+ */
153
+ readonly nextLink?: string;
154
+ }
155
+ /**
156
+ * Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois
157
+ * directories as per ICANN requirements.
158
+ */
159
+ export interface Contact {
160
+ /** Mailing address. */
161
+ addressMailing?: Address;
162
+ /** Email address. */
163
+ email: string;
164
+ /** Fax number. */
165
+ fax?: string;
166
+ /** Job title. */
167
+ jobTitle?: string;
168
+ /** First name. */
169
+ nameFirst: string;
170
+ /** Last name. */
171
+ nameLast: string;
172
+ /** Middle name. */
173
+ nameMiddle?: string;
174
+ /** Organization contact belongs to. */
175
+ organization?: string;
176
+ /** Phone number. */
177
+ phone: string;
178
+ }
179
+ /** Address information for domain registration. */
180
+ export interface Address {
181
+ /** First line of an Address. */
182
+ address1: string;
183
+ /** The second line of the Address. Optional. */
184
+ address2?: string;
185
+ /** The city for the address. */
186
+ city: string;
187
+ /** The country for the address. */
188
+ country: string;
189
+ /** The postal code for the address. */
190
+ postalCode: string;
191
+ /** The state or province for the address. */
192
+ state: string;
193
+ }
194
+ /** Details of a hostname derived from a domain. */
195
+ export interface HostName {
196
+ /** Name of the hostname. */
197
+ name?: string;
198
+ /** List of apps the hostname is assigned to. This list will have more than one app only if the hostname is pointing to a Traffic Manager. */
199
+ siteNames?: string[];
200
+ /** Name of the Azure resource the hostname is assigned to. If it is assigned to a Traffic Manager then it will be the Traffic Manager name otherwise it will be the app name. */
201
+ azureResourceName?: string;
202
+ /** Type of the Azure resource the hostname is assigned to. */
203
+ azureResourceType?: AzureResourceType;
204
+ /** Type of the DNS record. */
205
+ customHostNameDnsRecordType?: CustomHostNameDnsRecordType;
206
+ /** Type of the hostname. */
207
+ hostNameType?: HostNameType;
208
+ }
209
+ /** Domain purchase consent object, representing acceptance of applicable legal agreements. */
210
+ export interface DomainPurchaseConsent {
211
+ /** List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under <code>TopLevelDomain</code> resource. */
212
+ agreementKeys?: string[];
213
+ /** Client IP address. */
214
+ agreedBy?: string;
215
+ /** Timestamp when the agreements were accepted. */
216
+ agreedAt?: Date;
217
+ }
218
+ /** Azure resource. This resource is tracked in Azure Resource Manager */
219
+ export interface Resource {
220
+ /**
221
+ * Resource Id.
222
+ * NOTE: This property will not be serialized. It can only be populated by the server.
223
+ */
224
+ readonly id?: string;
225
+ /**
226
+ * Resource Name.
227
+ * NOTE: This property will not be serialized. It can only be populated by the server.
228
+ */
229
+ readonly name?: string;
230
+ /** Kind of resource. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference for details supported values for kind. */
231
+ kind?: string;
232
+ /** Resource Location. */
233
+ location: string;
234
+ /**
235
+ * Resource type.
236
+ * NOTE: This property will not be serialized. It can only be populated by the server.
237
+ */
238
+ readonly type?: string;
239
+ /** Resource tags. */
240
+ tags?: {
241
+ [propertyName: string]: string;
242
+ };
243
+ }
244
+ /** Single sign-on request information for domain management. */
245
+ export interface DomainControlCenterSsoRequest {
246
+ /**
247
+ * URL where the single sign-on request is to be made.
248
+ * NOTE: This property will not be serialized. It can only be populated by the server.
249
+ */
250
+ readonly url?: string;
251
+ /**
252
+ * Post parameter key.
253
+ * NOTE: This property will not be serialized. It can only be populated by the server.
254
+ */
255
+ readonly postParameterKey?: string;
256
+ /**
257
+ * Post parameter value. Client should use 'application/x-www-form-urlencoded' encoding for this value.
258
+ * NOTE: This property will not be serialized. It can only be populated by the server.
259
+ */
260
+ readonly postParameterValue?: string;
261
+ }
262
+ /** Domain recommendation search parameters. */
263
+ export interface DomainRecommendationSearchParameters {
264
+ /** Keywords to be used for generating domain recommendations. */
265
+ keywords?: string;
266
+ /** Maximum number of recommendations. */
267
+ maxDomainRecommendations?: number;
268
+ }
269
+ /** Collection of domain name identifiers. */
270
+ export interface NameIdentifierCollection {
271
+ /** Collection of resources. */
272
+ value: NameIdentifier[];
273
+ /**
274
+ * Link to next page of resources.
275
+ * NOTE: This property will not be serialized. It can only be populated by the server.
276
+ */
277
+ readonly nextLink?: string;
278
+ }
279
+ /** Azure proxy only resource. This resource is not tracked by Azure Resource Manager. */
280
+ export interface ProxyOnlyResource {
281
+ /**
282
+ * Resource Id.
283
+ * NOTE: This property will not be serialized. It can only be populated by the server.
284
+ */
285
+ readonly id?: string;
286
+ /**
287
+ * Resource Name.
288
+ * NOTE: This property will not be serialized. It can only be populated by the server.
289
+ */
290
+ readonly name?: string;
291
+ /** Kind of resource. */
292
+ kind?: string;
293
+ /**
294
+ * Resource type.
295
+ * NOTE: This property will not be serialized. It can only be populated by the server.
296
+ */
297
+ readonly type?: string;
298
+ }
299
+ /** Collection of domain ownership identifiers. */
300
+ export interface DomainOwnershipIdentifierCollection {
301
+ /** Collection of resources. */
302
+ value: DomainOwnershipIdentifier[];
303
+ /**
304
+ * Link to next page of resources.
305
+ * NOTE: This property will not be serialized. It can only be populated by the server.
306
+ */
307
+ readonly nextLink?: string;
308
+ }
309
+ /** Collection of Top-level domains. */
310
+ export interface TopLevelDomainCollection {
311
+ /** Collection of resources. */
312
+ value: TopLevelDomain[];
313
+ /**
314
+ * Link to next page of resources.
315
+ * NOTE: This property will not be serialized. It can only be populated by the server.
316
+ */
317
+ readonly nextLink?: string;
318
+ }
319
+ /** Options for retrieving the list of top level domain legal agreements. */
320
+ export interface TopLevelDomainAgreementOption {
321
+ /** If <code>true</code>, then the list of agreements will include agreements for domain privacy as well; otherwise, <code>false</code>. */
322
+ includePrivacy?: boolean;
323
+ /** If <code>true</code>, then the list of agreements will include agreements for domain transfer as well; otherwise, <code>false</code>. */
324
+ forTransfer?: boolean;
325
+ }
326
+ /** Collection of top-level domain legal agreements. */
327
+ export interface TldLegalAgreementCollection {
328
+ /** Collection of resources. */
329
+ value: TldLegalAgreement[];
330
+ /**
331
+ * Link to next page of resources.
332
+ * NOTE: This property will not be serialized. It can only be populated by the server.
333
+ */
334
+ readonly nextLink?: string;
335
+ }
336
+ /** Legal agreement for a top level domain. */
337
+ export interface TldLegalAgreement {
338
+ /** Unique identifier for the agreement. */
339
+ agreementKey: string;
340
+ /** Agreement title. */
341
+ title: string;
342
+ /** Agreement details. */
343
+ content: string;
344
+ /** URL where a copy of the agreement details is hosted. */
345
+ url?: string;
346
+ }
347
+ /** Information about the formal API definition for the app. */
348
+ export interface ApiDefinitionInfo {
349
+ /** The URL of the API definition. */
350
+ url?: string;
351
+ }
352
+ /** Azure API management (APIM) configuration linked to the app. */
353
+ export interface ApiManagementConfig {
354
+ /** APIM-Api Identifier. */
355
+ id?: string;
356
+ }
357
+ /** Description of an App Service Environment. */
358
+ export interface AppServiceEnvironment {
359
+ /**
360
+ * Provisioning state of the App Service Environment.
361
+ * NOTE: This property will not be serialized. It can only be populated by the server.
362
+ */
363
+ readonly provisioningState?: ProvisioningState;
364
+ /**
365
+ * Current status of the App Service Environment.
366
+ * NOTE: This property will not be serialized. It can only be populated by the server.
367
+ */
368
+ readonly status?: HostingEnvironmentStatus;
369
+ /** Description of the Virtual Network. */
370
+ virtualNetwork: VirtualNetworkProfile;
371
+ /** Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. */
372
+ internalLoadBalancingMode?: LoadBalancingMode;
373
+ /** Front-end VM size, e.g. "Medium", "Large". */
374
+ multiSize?: string;
375
+ /**
376
+ * Number of front-end instances.
377
+ * NOTE: This property will not be serialized. It can only be populated by the server.
378
+ */
379
+ readonly multiRoleCount?: number;
380
+ /** Number of IP SSL addresses reserved for the App Service Environment. */
381
+ ipsslAddressCount?: number;
382
+ /** DNS suffix of the App Service Environment. */
383
+ dnsSuffix?: string;
384
+ /**
385
+ * Maximum number of VMs in the App Service Environment.
386
+ * NOTE: This property will not be serialized. It can only be populated by the server.
387
+ */
388
+ readonly maximumNumberOfMachines?: number;
389
+ /** Scale factor for front-ends. */
390
+ frontEndScaleFactor?: number;
391
+ /**
392
+ * <code>true</code> if the App Service Environment is suspended; otherwise, <code>false</code>. The environment can be suspended, e.g. when the management endpoint is no longer available
393
+ * (most likely because NSG blocked the incoming traffic).
394
+ * NOTE: This property will not be serialized. It can only be populated by the server.
395
+ */
396
+ readonly suspended?: boolean;
397
+ /** Custom settings for changing the behavior of the App Service Environment. */
398
+ clusterSettings?: NameValuePair[];
399
+ /** User added ip ranges to whitelist on ASE db */
400
+ userWhitelistedIpRanges?: string[];
401
+ /**
402
+ * Flag that displays whether an ASE has linux workers or not
403
+ * NOTE: This property will not be serialized. It can only be populated by the server.
404
+ */
405
+ readonly hasLinuxWorkers?: boolean;
406
+ /** Upgrade Preference */
407
+ upgradePreference?: UpgradePreference;
408
+ /** Dedicated Host Count */
409
+ dedicatedHostCount?: number;
410
+ /** Whether or not this App Service Environment is zone-redundant. */
411
+ zoneRedundant?: boolean;
412
+ /** Full view of the custom domain suffix configuration for ASEv3. */
413
+ customDnsSuffixConfiguration?: CustomDnsSuffixConfiguration;
414
+ /** Full view of networking configuration for an ASE. */
415
+ networkingConfiguration?: AseV3NetworkingConfiguration;
416
+ /**
417
+ * Whether an upgrade is available for this App Service Environment.
418
+ * NOTE: This property will not be serialized. It can only be populated by the server.
419
+ */
420
+ readonly upgradeAvailability?: UpgradeAvailability;
421
+ }
422
+ /** Specification for using a Virtual Network. */
423
+ export interface VirtualNetworkProfile {
424
+ /** Resource id of the Virtual Network. */
425
+ id: string;
426
+ /**
427
+ * Name of the Virtual Network (read-only).
428
+ * NOTE: This property will not be serialized. It can only be populated by the server.
429
+ */
430
+ readonly name?: string;
431
+ /**
432
+ * Resource type of the Virtual Network (read-only).
433
+ * NOTE: This property will not be serialized. It can only be populated by the server.
434
+ */
435
+ readonly type?: string;
436
+ /** Subnet within the Virtual Network. */
437
+ subnet?: string;
438
+ }
439
+ /** Name value pair. */
440
+ export interface NameValuePair {
441
+ /** Pair name. */
442
+ name?: string;
443
+ /** Pair value. */
444
+ value?: string;
445
+ }
446
+ /** Specification for an App Service Environment to use for this resource. */
447
+ export interface HostingEnvironmentProfile {
448
+ /** Resource ID of the App Service Environment. */
449
+ id?: string;
450
+ /**
451
+ * Name of the App Service Environment.
452
+ * NOTE: This property will not be serialized. It can only be populated by the server.
453
+ */
454
+ readonly name?: string;
455
+ /**
456
+ * Resource type of the App Service Environment.
457
+ * NOTE: This property will not be serialized. It can only be populated by the server.
458
+ */
459
+ readonly type?: string;
460
+ }
461
+ /** Specification for a Kubernetes Environment to use for this resource. */
462
+ export interface KubeEnvironmentProfile {
463
+ /** Resource ID of the Kubernetes Environment. */
464
+ id?: string;
465
+ /**
466
+ * Name of the Kubernetes Environment.
467
+ * NOTE: This property will not be serialized. It can only be populated by the server.
468
+ */
469
+ readonly name?: string;
470
+ /**
471
+ * Resource type of the Kubernetes Environment.
472
+ * NOTE: This property will not be serialized. It can only be populated by the server.
473
+ */
474
+ readonly type?: string;
475
+ }
476
+ /** Description of a SKU for a scalable resource. */
477
+ export interface SkuDescription {
478
+ /** Name of the resource SKU. */
479
+ name?: string;
480
+ /** Service tier of the resource SKU. */
481
+ tier?: string;
482
+ /** Size specifier of the resource SKU. */
483
+ size?: string;
484
+ /** Family code of the resource SKU. */
485
+ family?: string;
486
+ /** Current number of instances assigned to the resource. */
487
+ capacity?: number;
488
+ /** Min, max, and default scale values of the SKU. */
489
+ skuCapacity?: SkuCapacity;
490
+ /** Locations of the SKU. */
491
+ locations?: string[];
492
+ /** Capabilities of the SKU, e.g., is traffic manager enabled? */
493
+ capabilities?: Capability[];
494
+ }
495
+ /** Description of the App Service plan scale options. */
496
+ export interface SkuCapacity {
497
+ /** Minimum number of workers for this App Service plan SKU. */
498
+ minimum?: number;
499
+ /** Maximum number of workers for this App Service plan SKU. */
500
+ maximum?: number;
501
+ /** Maximum number of Elastic workers for this App Service plan SKU. */
502
+ elasticMaximum?: number;
503
+ /** Default number of workers for this App Service plan SKU. */
504
+ default?: number;
505
+ /** Available scale configurations for an App Service plan. */
506
+ scaleType?: string;
507
+ }
508
+ /** Describes the capabilities/features allowed for a specific SKU. */
509
+ export interface Capability {
510
+ /** Name of the SKU capability. */
511
+ name?: string;
512
+ /** Value of the SKU capability. */
513
+ value?: string;
514
+ /** Reason of the SKU capability. */
515
+ reason?: string;
516
+ }
517
+ /** Extended Location. */
518
+ export interface ExtendedLocation {
519
+ /** Name of extended location. */
520
+ name?: string;
521
+ /**
522
+ * Type of extended location.
523
+ * NOTE: This property will not be serialized. It can only be populated by the server.
524
+ */
525
+ readonly type?: string;
526
+ }
527
+ /** Collection of App Service plans. */
528
+ export interface AppServicePlanCollection {
529
+ /** Collection of resources. */
530
+ value: AppServicePlan[];
531
+ /**
532
+ * Link to next page of resources.
533
+ * NOTE: This property will not be serialized. It can only be populated by the server.
534
+ */
535
+ readonly nextLink?: string;
536
+ }
537
+ /** A wrapper for an ARM resource id */
538
+ export interface ArmIdWrapper {
539
+ /** NOTE: This property will not be serialized. It can only be populated by the server. */
540
+ readonly id?: string;
541
+ }
542
+ /** Actions which to take by the auto-heal module when a rule is triggered. */
543
+ export interface AutoHealActions {
544
+ /** Predefined action to be taken. */
545
+ actionType?: AutoHealActionType;
546
+ /** Custom action to be taken. */
547
+ customAction?: AutoHealCustomAction;
548
+ /**
549
+ * Minimum time the process must execute
550
+ * before taking the action
551
+ */
552
+ minProcessExecutionTime?: string;
553
+ }
554
+ /**
555
+ * Custom action to be executed
556
+ * when an auto heal rule is triggered.
557
+ */
558
+ export interface AutoHealCustomAction {
559
+ /** Executable to be run. */
560
+ exe?: string;
561
+ /** Parameters for the executable. */
562
+ parameters?: string;
563
+ }
564
+ /** Rules that can be defined for auto-heal. */
565
+ export interface AutoHealRules {
566
+ /** Conditions that describe when to execute the auto-heal actions. */
567
+ triggers?: AutoHealTriggers;
568
+ /** Actions to be executed when a rule is triggered. */
569
+ actions?: AutoHealActions;
570
+ }
571
+ /** Triggers for auto-heal. */
572
+ export interface AutoHealTriggers {
573
+ /** A rule based on total requests. */
574
+ requests?: RequestsBasedTrigger;
575
+ /** A rule based on private bytes. */
576
+ privateBytesInKB?: number;
577
+ /** A rule based on status codes. */
578
+ statusCodes?: StatusCodesBasedTrigger[];
579
+ /** A rule based on request execution time. */
580
+ slowRequests?: SlowRequestsBasedTrigger;
581
+ /** A rule based on multiple Slow Requests Rule with path */
582
+ slowRequestsWithPath?: SlowRequestsBasedTrigger[];
583
+ /** A rule based on status codes ranges. */
584
+ statusCodesRange?: StatusCodesRangeBasedTrigger[];
585
+ }
586
+ /** Trigger based on total requests. */
587
+ export interface RequestsBasedTrigger {
588
+ /** Request Count. */
589
+ count?: number;
590
+ /** Time interval. */
591
+ timeInterval?: string;
592
+ }
593
+ /** Trigger based on status code. */
594
+ export interface StatusCodesBasedTrigger {
595
+ /** HTTP status code. */
596
+ status?: number;
597
+ /** Request Sub Status. */
598
+ subStatus?: number;
599
+ /** Win32 error code. */
600
+ win32Status?: number;
601
+ /** Request Count. */
602
+ count?: number;
603
+ /** Time interval. */
604
+ timeInterval?: string;
605
+ /** Request Path */
606
+ path?: string;
607
+ }
608
+ /** Trigger based on request execution time. */
609
+ export interface SlowRequestsBasedTrigger {
610
+ /** Time taken. */
611
+ timeTaken?: string;
612
+ /** Request Path. */
613
+ path?: string;
614
+ /** Request Count. */
615
+ count?: number;
616
+ /** Time interval. */
617
+ timeInterval?: string;
618
+ }
619
+ /** Trigger based on range of status codes. */
620
+ export interface StatusCodesRangeBasedTrigger {
621
+ /** HTTP status code. */
622
+ statusCodes?: string;
623
+ path?: string;
624
+ /** Request Count. */
625
+ count?: number;
626
+ /** Time interval. */
627
+ timeInterval?: string;
628
+ }
629
+ /** Azure Files or Blob Storage access information value for dictionary storage. */
630
+ export interface AzureStorageInfoValue {
631
+ /** Type of storage. */
632
+ type?: AzureStorageType;
633
+ /** Name of the storage account. */
634
+ accountName?: string;
635
+ /** Name of the file share (container name, for Blob storage). */
636
+ shareName?: string;
637
+ /** Access key for the storage account. */
638
+ accessKey?: string;
639
+ /** Path to mount the storage within the site's runtime environment. */
640
+ mountPath?: string;
641
+ /**
642
+ * State of the storage account.
643
+ * NOTE: This property will not be serialized. It can only be populated by the server.
644
+ */
645
+ readonly state?: AzureStorageState;
646
+ /** Mounting protocol to use for the storage account. */
647
+ protocol?: AzureStorageProtocol;
648
+ }
649
+ /** Collection of certificates. */
650
+ export interface CertificateCollection {
651
+ /** Collection of resources. */
652
+ value: Certificate[];
653
+ /**
654
+ * Link to next page of resources.
655
+ * NOTE: This property will not be serialized. It can only be populated by the server.
656
+ */
657
+ readonly nextLink?: string;
658
+ }
659
+ /** Describes valid TLS cipher suites. */
660
+ export interface CipherSuites {
661
+ /** List of TLS Cipher Suites that are supported by App Service. */
662
+ suites?: string[];
663
+ }
664
+ /** Information needed for cloning operation. */
665
+ export interface CloningInfo {
666
+ /**
667
+ * Correlation ID of cloning operation. This ID ties multiple cloning operations
668
+ * together to use the same snapshot.
669
+ */
670
+ correlationId?: string;
671
+ /** <code>true</code> to overwrite destination app; otherwise, <code>false</code>. */
672
+ overwrite?: boolean;
673
+ /** <code>true</code> to clone custom hostnames from source app; otherwise, <code>false</code>. */
674
+ cloneCustomHostNames?: boolean;
675
+ /** <code>true</code> to clone source control from source app; otherwise, <code>false</code>. */
676
+ cloneSourceControl?: boolean;
677
+ /**
678
+ * ARM resource ID of the source app. App resource ID is of the form
679
+ * /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and
680
+ * /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots.
681
+ */
682
+ sourceWebAppId: string;
683
+ /** Location of source app ex: West US or North Europe */
684
+ sourceWebAppLocation?: string;
685
+ /** App Service Environment. */
686
+ hostingEnvironment?: string;
687
+ /**
688
+ * Application setting overrides for cloned app. If specified, these settings override the settings cloned
689
+ * from source app. Otherwise, application settings from source app are retained.
690
+ */
691
+ appSettingsOverrides?: {
692
+ [propertyName: string]: string;
693
+ };
694
+ /** <code>true</code> to configure load balancing for source and destination app. */
695
+ configureLoadBalancing?: boolean;
696
+ /**
697
+ * ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form
698
+ * /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}.
699
+ */
700
+ trafficManagerProfileId?: string;
701
+ /** Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist. */
702
+ trafficManagerProfileName?: string;
703
+ }
704
+ /** Database connection string information. */
705
+ export interface ConnStringInfo {
706
+ /** Name of connection string. */
707
+ name?: string;
708
+ /** Connection string value. */
709
+ connectionString?: string;
710
+ /** Type of database. */
711
+ type?: ConnectionStringType;
712
+ }
713
+ /** Container App container definition. */
714
+ export interface Container {
715
+ /** Container image tag. */
716
+ image?: string;
717
+ /** Custom container name. */
718
+ name?: string;
719
+ /** Container start command. */
720
+ command?: string[];
721
+ /** Container start command arguments. */
722
+ args?: string[];
723
+ /** Container environment variables. */
724
+ env?: EnvironmentVar[];
725
+ /** Container resource requirements. */
726
+ resources?: ContainerResources;
727
+ }
728
+ /** Container App container environment variable. */
729
+ export interface EnvironmentVar {
730
+ /** Environment variable name. */
731
+ name?: string;
732
+ /** Non-secret environment variable value. */
733
+ value?: string;
734
+ /** Name of the Container App secret from which to pull the environment variable value. */
735
+ secretRef?: string;
736
+ }
737
+ /** Container App container resource requirements. */
738
+ export interface ContainerResources {
739
+ /** Required CPU in cores, e.g. 0.5 */
740
+ cpu?: number;
741
+ /** Required memory, e.g. "250Mb" */
742
+ memory?: string;
743
+ }
744
+ /** Cross-Origin Resource Sharing (CORS) settings for the app. */
745
+ export interface CorsSettings {
746
+ /**
747
+ * Gets or sets the list of origins that should be allowed to make cross-origin
748
+ * calls (for example: http://example.com:12345). Use "*" to allow all.
749
+ */
750
+ allowedOrigins?: string[];
751
+ /**
752
+ * Gets or sets whether CORS requests with credentials are allowed. See
753
+ * https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials
754
+ * for more details.
755
+ */
756
+ supportCredentials?: boolean;
757
+ }
758
+ /** Usage of the quota resource. */
759
+ export interface CsmUsageQuota {
760
+ /** Units of measurement for the quota resource. */
761
+ unit?: string;
762
+ /** Next reset time for the resource counter. */
763
+ nextResetTime?: Date;
764
+ /** The current value of the resource counter. */
765
+ currentValue?: number;
766
+ /** The resource limit. */
767
+ limit?: number;
768
+ /** Quota name. */
769
+ name?: LocalizableString;
770
+ }
771
+ /** Localizable string object containing the name and a localized value. */
772
+ export interface LocalizableString {
773
+ /** Non-localized name. */
774
+ value?: string;
775
+ /** Localized name. */
776
+ localizedValue?: string;
777
+ }
778
+ /** Collection of CSM usage quotas. */
779
+ export interface CsmUsageQuotaCollection {
780
+ /** Collection of resources. */
781
+ value: CsmUsageQuota[];
782
+ /**
783
+ * Link to next page of resources.
784
+ * NOTE: This property will not be serialized. It can only be populated by the server.
785
+ */
786
+ readonly nextLink?: string;
787
+ }
788
+ /** Container App container Custom scaling rule. */
789
+ export interface CustomScaleRule {
790
+ /**
791
+ * Type of the custom scale rule
792
+ * eg: azure-servicebus, redis etc.
793
+ */
794
+ type?: string;
795
+ /** Metadata properties to describe custom scale rule. */
796
+ metadata?: {
797
+ [propertyName: string]: string;
798
+ };
799
+ /** Authentication secrets for the custom scale rule. */
800
+ auth?: ScaleRuleAuth[];
801
+ }
802
+ /** Auth Secrets for Container App Scale Rule */
803
+ export interface ScaleRuleAuth {
804
+ /** Name of the Container App secret from which to pull the auth params. */
805
+ secretRef?: string;
806
+ /** Trigger Parameter that uses the secret */
807
+ triggerParameter?: string;
808
+ }
809
+ /** Container App Dapr configuration. */
810
+ export interface Dapr {
811
+ /** Boolean indicating if the Dapr side car is enabled */
812
+ enabled?: boolean;
813
+ /** Dapr application identifier */
814
+ appId?: string;
815
+ /** Port on which the Dapr side car */
816
+ appPort?: number;
817
+ /** Collection of Dapr components */
818
+ components?: DaprComponent[];
819
+ }
820
+ /** Dapr component configuration */
821
+ export interface DaprComponent {
822
+ /** Component name */
823
+ name?: string;
824
+ /** Component type */
825
+ type?: string;
826
+ /** Component version */
827
+ version?: string;
828
+ /** Component metadata */
829
+ metadata?: DaprMetadata[];
830
+ }
831
+ /** Container App Dapr component metadata. */
832
+ export interface DaprMetadata {
833
+ /** Metadata property name. */
834
+ name?: string;
835
+ /** Metadata property value. */
836
+ value?: string;
837
+ /** Name of the Container App secret from which to pull the metadata property value. */
838
+ secretRef?: string;
839
+ }
840
+ /** Additional configuration for a data providers */
841
+ export interface DataProviderMetadata {
842
+ providerName?: string;
843
+ /**
844
+ * Settings for the data provider
845
+ * NOTE: This property will not be serialized. It can only be populated by the server.
846
+ */
847
+ readonly propertyBag?: KeyValuePairStringObject[];
848
+ }
849
+ export interface KeyValuePairStringObject {
850
+ /** NOTE: This property will not be serialized. It can only be populated by the server. */
851
+ readonly key?: string;
852
+ /**
853
+ * Any object
854
+ * NOTE: This property will not be serialized. It can only be populated by the server.
855
+ */
856
+ readonly value?: Record<string, unknown>;
857
+ }
858
+ /** Column definition */
859
+ export interface DataTableResponseColumn {
860
+ /** Name of the column */
861
+ columnName?: string;
862
+ /** Data type which looks like 'String' or 'Int32'. */
863
+ dataType?: string;
864
+ /** Column Type */
865
+ columnType?: string;
866
+ }
867
+ /** Data Table which defines columns and raw row values */
868
+ export interface DataTableResponseObject {
869
+ /** Name of the table */
870
+ tableName?: string;
871
+ /** List of columns with data types */
872
+ columns?: DataTableResponseColumn[];
873
+ /** Raw row values */
874
+ rows?: string[][];
875
+ }
876
+ /** Definition of Detector */
877
+ export interface DetectorInfo {
878
+ /**
879
+ * Id of detector
880
+ * NOTE: This property will not be serialized. It can only be populated by the server.
881
+ */
882
+ readonly id?: string;
883
+ /**
884
+ * Name of detector
885
+ * NOTE: This property will not be serialized. It can only be populated by the server.
886
+ */
887
+ readonly name?: string;
888
+ /**
889
+ * Short description of the detector and its purpose.
890
+ * NOTE: This property will not be serialized. It can only be populated by the server.
891
+ */
892
+ readonly description?: string;
893
+ /**
894
+ * Author of the detector.
895
+ * NOTE: This property will not be serialized. It can only be populated by the server.
896
+ */
897
+ readonly author?: string;
898
+ /**
899
+ * Problem category. This serves for organizing group for detectors.
900
+ * NOTE: This property will not be serialized. It can only be populated by the server.
901
+ */
902
+ readonly category?: string;
903
+ /**
904
+ * List of Support Topics for which this detector is enabled.
905
+ * NOTE: This property will not be serialized. It can only be populated by the server.
906
+ */
907
+ readonly supportTopicList?: SupportTopic[];
908
+ /**
909
+ * Analysis Types for which this detector should apply to.
910
+ * NOTE: This property will not be serialized. It can only be populated by the server.
911
+ */
912
+ readonly analysisType?: string[];
913
+ /**
914
+ * Whether this detector is an Analysis Detector or not.
915
+ * NOTE: This property will not be serialized. It can only be populated by the server.
916
+ */
917
+ readonly type?: DetectorType;
918
+ /**
919
+ * Defines score of a detector to power ML based matching.
920
+ * NOTE: This property will not be serialized. It can only be populated by the server.
921
+ */
922
+ readonly score?: number;
923
+ }
924
+ /** Defines a unique Support Topic */
925
+ export interface SupportTopic {
926
+ /**
927
+ * Support Topic Id
928
+ * NOTE: This property will not be serialized. It can only be populated by the server.
929
+ */
930
+ readonly id?: string;
931
+ /**
932
+ * Unique resource Id
933
+ * NOTE: This property will not be serialized. It can only be populated by the server.
934
+ */
935
+ readonly pesId?: string;
936
+ }
937
+ /** Set of data with rendering instructions */
938
+ export interface DiagnosticData {
939
+ /** Data in table form */
940
+ table?: DataTableResponseObject;
941
+ /** Properties that describe how the table should be rendered */
942
+ renderingProperties?: Rendering;
943
+ }
944
+ /** Instructions for rendering the data */
945
+ export interface Rendering {
946
+ /** Rendering Type */
947
+ type?: RenderingType;
948
+ /** Title of data */
949
+ title?: string;
950
+ /** Description of the data that will help it be interpreted */
951
+ description?: string;
952
+ }
953
+ /** Identify the status of the most severe insight generated by the detector. */
954
+ export interface Status {
955
+ /** Descriptive message. */
956
+ message?: string;
957
+ /** Level of the most severe insight generated by the detector. */
958
+ statusId?: InsightStatus;
959
+ }
960
+ /** Suggested utterances where the detector can be applicable */
961
+ export interface QueryUtterancesResults {
962
+ /** Search Query. */
963
+ query?: string;
964
+ /** Array of utterance results for search query. */
965
+ results?: QueryUtterancesResult[];
966
+ }
967
+ /** Result for utterances query. */
968
+ export interface QueryUtterancesResult {
969
+ /** A sample utterance. */
970
+ sampleUtterance?: SampleUtterance;
971
+ /** Score of a sample utterance. */
972
+ score?: number;
973
+ }
974
+ /** Sample utterance. */
975
+ export interface SampleUtterance {
976
+ /** Text attribute of sample utterance. */
977
+ text?: string;
978
+ /** Links attribute of sample utterance. */
979
+ links?: string[];
980
+ /** Question id of sample utterance (for stackoverflow questions titles). */
981
+ qid?: string;
982
+ }
983
+ /** Collection of detector responses */
984
+ export interface DetectorResponseCollection {
985
+ /** Collection of resources. */
986
+ value: DetectorResponse[];
987
+ /**
988
+ * Link to next page of resources.
989
+ * NOTE: This property will not be serialized. It can only be populated by the server.
990
+ */
991
+ readonly nextLink?: string;
992
+ }
993
+ /** Body of the error response returned from the API. */
994
+ export interface ErrorEntity {
995
+ /** Type of error. */
996
+ extendedCode?: string;
997
+ /** Message template. */
998
+ messageTemplate?: string;
999
+ /** Parameters for the template. */
1000
+ parameters?: string[];
1001
+ /** Inner errors. */
1002
+ innerErrors?: ErrorEntity[];
1003
+ /** Error Details. */
1004
+ details?: ErrorEntity[];
1005
+ /** The error target. */
1006
+ target?: string;
1007
+ /** Basic error code. */
1008
+ code?: string;
1009
+ /** Any details of the error. */
1010
+ message?: string;
1011
+ }
1012
+ /** Routing rules in production experiments. */
1013
+ export interface Experiments {
1014
+ /** List of ramp-up rules. */
1015
+ rampUpRules?: RampUpRule[];
1016
+ }
1017
+ /** Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance. */
1018
+ export interface RampUpRule {
1019
+ /** Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. */
1020
+ actionHostName?: string;
1021
+ /** Percentage of the traffic which will be redirected to <code>ActionHostName</code>. */
1022
+ reroutePercentage?: number;
1023
+ /**
1024
+ * In auto ramp up scenario this is the step to add/remove from <code>ReroutePercentage</code> until it reaches \n<code>MinReroutePercentage</code> or
1025
+ * <code>MaxReroutePercentage</code>. Site metrics are checked every N minutes specified in <code>ChangeIntervalInMinutes</code>.\nCustom decision algorithm
1026
+ * can be provided in TiPCallback site extension which URL can be specified in <code>ChangeDecisionCallbackUrl</code>.
1027
+ */
1028
+ changeStep?: number;
1029
+ /** Specifies interval in minutes to reevaluate ReroutePercentage. */
1030
+ changeIntervalInMinutes?: number;
1031
+ /** Specifies lower boundary above which ReroutePercentage will stay. */
1032
+ minReroutePercentage?: number;
1033
+ /** Specifies upper boundary below which ReroutePercentage will stay. */
1034
+ maxReroutePercentage?: number;
1035
+ /** Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. */
1036
+ changeDecisionCallbackUrl?: string;
1037
+ /** Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. */
1038
+ name?: string;
1039
+ }
1040
+ /**
1041
+ * The IIS handler mappings used to define which handler processes HTTP requests with certain extension.
1042
+ * For example, it is used to configure php-cgi.exe process to handle all HTTP requests with *.php extension.
1043
+ */
1044
+ export interface HandlerMapping {
1045
+ /** Requests with this extension will be handled using the specified FastCGI application. */
1046
+ extension?: string;
1047
+ /** The absolute path to the FastCGI application. */
1048
+ scriptProcessor?: string;
1049
+ /** Command-line arguments to be passed to the script processor. */
1050
+ arguments?: string;
1051
+ }
1052
+ /** Collection of hostname bindings. */
1053
+ export interface HostNameBindingCollection {
1054
+ /** Collection of resources. */
1055
+ value: HostNameBinding[];
1056
+ /**
1057
+ * Link to next page of resources.
1058
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1059
+ */
1060
+ readonly nextLink?: string;
1061
+ }
1062
+ /** SSL-enabled hostname. */
1063
+ export interface HostNameSslState {
1064
+ /** Hostname. */
1065
+ name?: string;
1066
+ /** SSL type. */
1067
+ sslState?: SslState;
1068
+ /** Virtual IP address assigned to the hostname if IP based SSL is enabled. */
1069
+ virtualIP?: string;
1070
+ /** SSL certificate thumbprint. */
1071
+ thumbprint?: string;
1072
+ /** Set to <code>true</code> to update existing hostname. */
1073
+ toUpdate?: boolean;
1074
+ /** Indicates whether the hostname is a standard or repository hostname. */
1075
+ hostType?: HostType;
1076
+ }
1077
+ /** Container App container Custom scaling rule. */
1078
+ export interface HttpScaleRule {
1079
+ /** Metadata properties to describe http scale rule. */
1080
+ metadata?: {
1081
+ [propertyName: string]: string;
1082
+ };
1083
+ /** Authentication secrets for the custom scale rule. */
1084
+ auth?: ScaleRuleAuth[];
1085
+ }
1086
+ /** Collection of identifiers. */
1087
+ export interface IdentifierCollection {
1088
+ /** Collection of resources. */
1089
+ value: Identifier[];
1090
+ /**
1091
+ * Link to next page of resources.
1092
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1093
+ */
1094
+ readonly nextLink?: string;
1095
+ }
1096
+ /** IP security restriction on an app. */
1097
+ export interface IpSecurityRestriction {
1098
+ /**
1099
+ * IP address the security restriction is valid for.
1100
+ * It can be in form of pure ipv4 address (required SubnetMask property) or
1101
+ * CIDR notation such as ipv4/mask (leading bit match). For CIDR,
1102
+ * SubnetMask property must not be specified.
1103
+ */
1104
+ ipAddress?: string;
1105
+ /** Subnet mask for the range of IP addresses the restriction is valid for. */
1106
+ subnetMask?: string;
1107
+ /** Virtual network resource id */
1108
+ vnetSubnetResourceId?: string;
1109
+ /** (internal) Vnet traffic tag */
1110
+ vnetTrafficTag?: number;
1111
+ /** (internal) Subnet traffic tag */
1112
+ subnetTrafficTag?: number;
1113
+ /** Allow or Deny access for this IP range. */
1114
+ action?: string;
1115
+ /** Defines what this IP filter will be used for. This is to support IP filtering on proxies. */
1116
+ tag?: IpFilterTag;
1117
+ /** Priority of IP restriction rule. */
1118
+ priority?: number;
1119
+ /** IP restriction rule name. */
1120
+ name?: string;
1121
+ /** IP restriction rule description. */
1122
+ description?: string;
1123
+ /**
1124
+ * IP restriction rule headers.
1125
+ * X-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples).
1126
+ * The matching logic is ..
1127
+ * - If the property is null or empty (default), all hosts(or lack of) are allowed.
1128
+ * - A value is compared using ordinal-ignore-case (excluding port number).
1129
+ * - Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com
1130
+ * but not the root domain contoso.com or multi-level foo.bar.contoso.com
1131
+ * - Unicode host names are allowed but are converted to Punycode for matching.
1132
+ *
1133
+ * X-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples).
1134
+ * The matching logic is ..
1135
+ * - If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed.
1136
+ * - If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property.
1137
+ *
1138
+ * X-Azure-FDID and X-FD-HealthProbe.
1139
+ * The matching logic is exact match.
1140
+ */
1141
+ headers?: {
1142
+ [propertyName: string]: string[];
1143
+ };
1144
+ }
1145
+ /** Managed service identity. */
1146
+ export interface ManagedServiceIdentity {
1147
+ /** Type of managed service identity. */
1148
+ type?: ManagedServiceIdentityType;
1149
+ /**
1150
+ * Tenant of managed service identity.
1151
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1152
+ */
1153
+ readonly tenantId?: string;
1154
+ /**
1155
+ * Principal Id of managed service identity.
1156
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1157
+ */
1158
+ readonly principalId?: string;
1159
+ /** The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} */
1160
+ userAssignedIdentities?: {
1161
+ [propertyName: string]: UserAssignedIdentity;
1162
+ };
1163
+ }
1164
+ /** User Assigned identity. */
1165
+ export interface UserAssignedIdentity {
1166
+ /**
1167
+ * Principal Id of user assigned identity
1168
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1169
+ */
1170
+ readonly principalId?: string;
1171
+ /**
1172
+ * Client Id of user assigned identity
1173
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1174
+ */
1175
+ readonly clientId?: string;
1176
+ }
1177
+ /** An operation on a resource. */
1178
+ export interface Operation {
1179
+ /** Operation ID. */
1180
+ id?: string;
1181
+ /** Operation name. */
1182
+ name?: string;
1183
+ /** The current status of the operation. */
1184
+ status?: OperationStatus;
1185
+ /** Any errors associate with the operation. */
1186
+ errors?: ErrorEntity[];
1187
+ /** Time when operation has started. */
1188
+ createdTime?: Date;
1189
+ /** Time when operation has been updated. */
1190
+ modifiedTime?: Date;
1191
+ /** Time when operation will expire. */
1192
+ expirationTime?: Date;
1193
+ /** Applicable only for stamp operation ids. */
1194
+ geoMasterOperationId?: string;
1195
+ }
1196
+ export interface PrivateEndpointConnectionCollection {
1197
+ /** Collection of resources. */
1198
+ value: RemotePrivateEndpointConnectionARMResource[];
1199
+ /**
1200
+ * Link to next page of resources.
1201
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1202
+ */
1203
+ readonly nextLink?: string;
1204
+ }
1205
+ /** The state of a private link connection */
1206
+ export interface PrivateLinkConnectionState {
1207
+ /** Status of a private link connection */
1208
+ status?: string;
1209
+ /** Description of a private link connection */
1210
+ description?: string;
1211
+ /** ActionsRequired for a private link connection */
1212
+ actionsRequired?: string;
1213
+ }
1214
+ /** A private link resource */
1215
+ export interface PrivateLinkResource {
1216
+ id: string;
1217
+ /** Name of a private link resource */
1218
+ name: string;
1219
+ type: string;
1220
+ /** Properties of a private link resource */
1221
+ properties: PrivateLinkResourceProperties;
1222
+ }
1223
+ /** Properties of a private link resource */
1224
+ export interface PrivateLinkResourceProperties {
1225
+ /**
1226
+ * GroupId of a private link resource
1227
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1228
+ */
1229
+ readonly groupId?: string;
1230
+ /**
1231
+ * RequiredMembers of a private link resource
1232
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1233
+ */
1234
+ readonly requiredMembers?: string[];
1235
+ /**
1236
+ * RequiredZoneNames of a private link resource
1237
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1238
+ */
1239
+ readonly requiredZoneNames?: string[];
1240
+ }
1241
+ /** Wrapper for a collection of private link resources */
1242
+ export interface PrivateLinkResourcesWrapper {
1243
+ value: PrivateLinkResource[];
1244
+ }
1245
+ /** Container App container Azure Queue based scaling rule. */
1246
+ export interface QueueScaleRule {
1247
+ /** Queue name. */
1248
+ queueName?: string;
1249
+ /** Queue length. */
1250
+ queueLength?: number;
1251
+ /** Authentication secrets for the queue scale rule. */
1252
+ auth?: ScaleRuleAuth[];
1253
+ }
1254
+ /** Container App scaling configurations. */
1255
+ export interface Scale {
1256
+ /** Optional. Minimum number of container replicas. */
1257
+ minReplicas?: number;
1258
+ /** Optional. Maximum number of container replicas. Defaults to 10 if not set. */
1259
+ maxReplicas?: number;
1260
+ /** Scaling rules. */
1261
+ rules?: ScaleRule[];
1262
+ }
1263
+ /** Container App container scaling rule. */
1264
+ export interface ScaleRule {
1265
+ /** Scale Rule Name */
1266
+ name?: string;
1267
+ /** Azure Queue based scaling. */
1268
+ azureQueue?: QueueScaleRule;
1269
+ /** Custom scale rule. */
1270
+ custom?: CustomScaleRule;
1271
+ /** HTTP requests based scaling. */
1272
+ http?: HttpScaleRule;
1273
+ }
1274
+ export interface SiteDnsConfig {
1275
+ /** List of custom DNS servers to be used by an app for lookups. Maximum 5 dns servers can be set. */
1276
+ dnsServers?: string[];
1277
+ /** Alternate DNS server to be used by apps. This property replicates the WEBSITE_DNS_ALT_SERVER app setting. */
1278
+ dnsAltServer?: string;
1279
+ /** Timeout for a single dns lookup in seconds. Allowed range: 1-30. Default is 3. */
1280
+ dnsRetryAttemptTimeout?: number;
1281
+ /** Total number of retries for dns lookup. Allowed range: 1-5. Default is 3. */
1282
+ dnsRetryAttemptCount?: number;
1283
+ /** Custom time for DNS to be cached in seconds. Allowed range: 0-60. Default is 30 seconds. 0 means caching disabled. */
1284
+ dnsMaxCacheTimeout?: number;
1285
+ /**
1286
+ * Indicates that sites using Virtual network custom DNS servers are still sorting the list of DNS servers. Read-Only.
1287
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1288
+ */
1289
+ readonly dnsLegacySortOrder?: boolean;
1290
+ }
1291
+ /** Outbound traffic options over virtual network. */
1292
+ export interface OutboundVnetRouting {
1293
+ /** Enables all other routing options defined in OutboundVnetRouting if this setting is set to true. */
1294
+ allTraffic?: boolean;
1295
+ /** This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. Previously called VnetRouteAllEnabled. */
1296
+ applicationTraffic?: boolean;
1297
+ /** Enables accessing content over virtual network. Previously called VnetContentShareEnabled */
1298
+ contentShareTraffic?: boolean;
1299
+ /** Enables pulling image over Virtual Network. Previously called VnetImagePullEnabled. */
1300
+ imagePullTraffic?: boolean;
1301
+ /** Enables Backup and Restore operations over virtual network. Previously called VnetBackupRestoreEnabled */
1302
+ backupRestoreTraffic?: boolean;
1303
+ }
1304
+ /** Configuration of an App Service app. */
1305
+ export interface SiteConfig {
1306
+ /** Number of workers. */
1307
+ numberOfWorkers?: number;
1308
+ /** Default documents. */
1309
+ defaultDocuments?: string[];
1310
+ /** .NET Framework version. */
1311
+ netFrameworkVersion?: string;
1312
+ /** Version of PHP. */
1313
+ phpVersion?: string;
1314
+ /** Version of Python. */
1315
+ pythonVersion?: string;
1316
+ /** Version of Node.js. */
1317
+ nodeVersion?: string;
1318
+ /** Version of PowerShell. */
1319
+ powerShellVersion?: string;
1320
+ /** Linux App Framework and version */
1321
+ linuxFxVersion?: string;
1322
+ /** Xenon App Framework and version */
1323
+ windowsFxVersion?: string;
1324
+ /** <code>true</code> if request tracing is enabled; otherwise, <code>false</code>. */
1325
+ requestTracingEnabled?: boolean;
1326
+ /** Request tracing expiration time. */
1327
+ requestTracingExpirationTime?: Date;
1328
+ /** <code>true</code> if remote debugging is enabled; otherwise, <code>false</code>. */
1329
+ remoteDebuggingEnabled?: boolean;
1330
+ /** Remote debugging version. */
1331
+ remoteDebuggingVersion?: string;
1332
+ /** <code>true</code> if HTTP logging is enabled; otherwise, <code>false</code>. */
1333
+ httpLoggingEnabled?: boolean;
1334
+ /** Flag to use Managed Identity Creds for ACR pull */
1335
+ acrUseManagedIdentityCreds?: boolean;
1336
+ /** If using user managed identity, the user managed identity ClientId */
1337
+ acrUserManagedIdentityID?: string;
1338
+ /** HTTP logs directory size limit. */
1339
+ logsDirectorySizeLimit?: number;
1340
+ /** <code>true</code> if detailed error logging is enabled; otherwise, <code>false</code>. */
1341
+ detailedErrorLoggingEnabled?: boolean;
1342
+ /** Publishing user name. */
1343
+ publishingUsername?: string;
1344
+ /** Application settings. This property is not returned in response to normal create and read requests since it may contain sensitive information. */
1345
+ appSettings?: NameValuePair[];
1346
+ /** Application metadata. This property cannot be retrieved, since it may contain secrets. */
1347
+ metadata?: NameValuePair[];
1348
+ /** Connection strings. This property is not returned in response to normal create and read requests since it may contain sensitive information. */
1349
+ connectionStrings?: ConnStringInfo[];
1350
+ /**
1351
+ * Site MachineKey.
1352
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1353
+ */
1354
+ readonly machineKey?: SiteMachineKey;
1355
+ /** Handler mappings. */
1356
+ handlerMappings?: HandlerMapping[];
1357
+ /** Document root. */
1358
+ documentRoot?: string;
1359
+ /** SCM type. */
1360
+ scmType?: ScmType;
1361
+ /** <code>true</code> to use 32-bit worker process; otherwise, <code>false</code>. */
1362
+ use32BitWorkerProcess?: boolean;
1363
+ /** <code>true</code> if WebSocket is enabled; otherwise, <code>false</code>. */
1364
+ webSocketsEnabled?: boolean;
1365
+ /** <code>true</code> if Always On is enabled; otherwise, <code>false</code>. */
1366
+ alwaysOn?: boolean;
1367
+ /** Java version. */
1368
+ javaVersion?: string;
1369
+ /** Java container. */
1370
+ javaContainer?: string;
1371
+ /** Java container version. */
1372
+ javaContainerVersion?: string;
1373
+ /** App command line to launch. */
1374
+ appCommandLine?: string;
1375
+ /** Managed pipeline mode. */
1376
+ managedPipelineMode?: ManagedPipelineMode;
1377
+ /** Virtual applications. */
1378
+ virtualApplications?: VirtualApplication[];
1379
+ /** Site load balancing. */
1380
+ loadBalancing?: SiteLoadBalancing;
1381
+ /** This is work around for polymorphic types. */
1382
+ experiments?: Experiments;
1383
+ /** Site limits. */
1384
+ limits?: SiteLimits;
1385
+ /** <code>true</code> if Auto Heal is enabled; otherwise, <code>false</code>. */
1386
+ autoHealEnabled?: boolean;
1387
+ /** Auto Heal rules. */
1388
+ autoHealRules?: AutoHealRules;
1389
+ /** Tracing options. */
1390
+ tracingOptions?: string;
1391
+ /** Virtual Network name. */
1392
+ vnetName?: string;
1393
+ /** Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. */
1394
+ vnetRouteAllEnabled?: boolean;
1395
+ /** The number of private ports assigned to this app. These will be assigned dynamically on runtime. */
1396
+ vnetPrivatePortsCount?: number;
1397
+ /** Cross-Origin Resource Sharing (CORS) settings. */
1398
+ cors?: CorsSettings;
1399
+ /** Push endpoint settings. */
1400
+ push?: PushSettings;
1401
+ /** Information about the formal API definition for the app. */
1402
+ apiDefinition?: ApiDefinitionInfo;
1403
+ /** Azure API management settings linked to the app. */
1404
+ apiManagementConfig?: ApiManagementConfig;
1405
+ /** Auto-swap slot name. */
1406
+ autoSwapSlotName?: string;
1407
+ /** <code>true</code> to enable local MySQL; otherwise, <code>false</code>. */
1408
+ localMySqlEnabled?: boolean;
1409
+ /** Managed Service Identity Id */
1410
+ managedServiceIdentityId?: number;
1411
+ /** Explicit Managed Service Identity Id */
1412
+ xManagedServiceIdentityId?: number;
1413
+ /** Identity to use for Key Vault Reference authentication. */
1414
+ keyVaultReferenceIdentity?: string;
1415
+ /** IP security restrictions for main. */
1416
+ ipSecurityRestrictions?: IpSecurityRestriction[];
1417
+ /** Default action for main access restriction if no rules are matched. */
1418
+ ipSecurityRestrictionsDefaultAction?: DefaultAction;
1419
+ /** IP security restrictions for scm. */
1420
+ scmIpSecurityRestrictions?: IpSecurityRestriction[];
1421
+ /** Default action for scm access restriction if no rules are matched. */
1422
+ scmIpSecurityRestrictionsDefaultAction?: DefaultAction;
1423
+ /** IP security restrictions for scm to use main. */
1424
+ scmIpSecurityRestrictionsUseMain?: boolean;
1425
+ /** Http20Enabled: configures a web site to allow clients to connect over http2.0 */
1426
+ http20Enabled?: boolean;
1427
+ /** Http20ProxyFlag: Configures a website to allow http2.0 to pass be proxied all the way to the app. 0 = disabled, 1 = pass through all http2 traffic, 2 = pass through gRPC only. */
1428
+ http20ProxyFlag?: number;
1429
+ /** MinTlsVersion: configures the minimum version of TLS required for SSL requests */
1430
+ minTlsVersion?: SupportedTlsVersions;
1431
+ /** The minimum strength TLS cipher suite allowed for an application */
1432
+ minTlsCipherSuite?: TlsCipherSuites;
1433
+ /** ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site */
1434
+ scmMinTlsVersion?: SupportedTlsVersions;
1435
+ /** State of FTP / FTPS service */
1436
+ ftpsState?: FtpsState;
1437
+ /**
1438
+ * Number of preWarmed instances.
1439
+ * This setting only applies to the Consumption and Elastic Plans
1440
+ */
1441
+ preWarmedInstanceCount?: number;
1442
+ /**
1443
+ * Maximum number of workers that a site can scale out to.
1444
+ * This setting only applies to the Consumption and Elastic Premium Plans
1445
+ */
1446
+ functionAppScaleLimit?: number;
1447
+ /**
1448
+ * Maximum number of workers that a site can scale out to.
1449
+ * This setting only applies to apps in plans where ElasticScaleEnabled is <code>true</code>
1450
+ */
1451
+ elasticWebAppScaleLimit?: number;
1452
+ /** Health check path */
1453
+ healthCheckPath?: string;
1454
+ /**
1455
+ * Gets or sets a value indicating whether functions runtime scale monitoring is enabled. When enabled,
1456
+ * the ScaleController will not monitor event sources directly, but will instead call to the
1457
+ * runtime to get scale status.
1458
+ */
1459
+ functionsRuntimeScaleMonitoringEnabled?: boolean;
1460
+ /** Sets the time zone a site uses for generating timestamps. Compatible with Linux and Windows App Service. Setting the WEBSITE_TIME_ZONE app setting takes precedence over this config. For Linux, expects tz database values https://www.iana.org/time-zones (for a quick reference see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For Windows, expects one of the time zones listed under HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones */
1461
+ websiteTimeZone?: string;
1462
+ /**
1463
+ * Number of minimum instance count for a site
1464
+ * This setting only applies to the Elastic Plans
1465
+ */
1466
+ minimumElasticInstanceCount?: number;
1467
+ /** List of Azure Storage Accounts. */
1468
+ azureStorageAccounts?: {
1469
+ [propertyName: string]: AzureStorageInfoValue;
1470
+ };
1471
+ /** Property to allow or block all public traffic. */
1472
+ publicNetworkAccess?: string;
1473
+ }
1474
+ /** MachineKey of an app. */
1475
+ export interface SiteMachineKey {
1476
+ /** MachineKey validation. */
1477
+ validation?: string;
1478
+ /** Validation key. */
1479
+ validationKey?: string;
1480
+ /** Algorithm used for decryption. */
1481
+ decryption?: string;
1482
+ /** Decryption key. */
1483
+ decryptionKey?: string;
1484
+ }
1485
+ /** Virtual application in an app. */
1486
+ export interface VirtualApplication {
1487
+ /** Virtual path. */
1488
+ virtualPath?: string;
1489
+ /** Physical path. */
1490
+ physicalPath?: string;
1491
+ /** <code>true</code> if preloading is enabled; otherwise, <code>false</code>. */
1492
+ preloadEnabled?: boolean;
1493
+ /** Virtual directories for virtual application. */
1494
+ virtualDirectories?: VirtualDirectory[];
1495
+ }
1496
+ /** Directory for virtual application. */
1497
+ export interface VirtualDirectory {
1498
+ /** Path to virtual application. */
1499
+ virtualPath?: string;
1500
+ /** Physical path. */
1501
+ physicalPath?: string;
1502
+ }
1503
+ /** Metric limits set on an app. */
1504
+ export interface SiteLimits {
1505
+ /** Maximum allowed CPU usage percentage. */
1506
+ maxPercentageCpu?: number;
1507
+ /** Maximum allowed memory usage in MB. */
1508
+ maxMemoryInMb?: number;
1509
+ /** Maximum allowed disk size usage in MB. */
1510
+ maxDiskSizeInMb?: number;
1511
+ }
1512
+ /** Function app configuration. */
1513
+ export interface FunctionAppConfig {
1514
+ /** Function app deployment configuration. */
1515
+ deployment?: FunctionsDeployment;
1516
+ /** Function app runtime settings. */
1517
+ runtime?: FunctionsRuntime;
1518
+ /** Function app scale and concurrency settings. */
1519
+ scaleAndConcurrency?: FunctionsScaleAndConcurrency;
1520
+ }
1521
+ /** Configuration section for the function app deployment. */
1522
+ export interface FunctionsDeployment {
1523
+ /** Storage for deployed package used by the function app. */
1524
+ storage?: FunctionsDeploymentStorage;
1525
+ }
1526
+ /** Storage for deployed package used by the function app. */
1527
+ export interface FunctionsDeploymentStorage {
1528
+ /** Property to select Azure Storage type. Available options: blobContainer. */
1529
+ type?: FunctionsDeploymentStorageType;
1530
+ /** Property to set the URL for the selected Azure Storage type. Example: For blobContainer, the value could be https://<storageAccountName>.blob.core.windows.net/<containerName>. */
1531
+ value?: string;
1532
+ /** Authentication method to access the storage account for deployment. */
1533
+ authentication?: FunctionsDeploymentStorageAuthentication;
1534
+ }
1535
+ /** Authentication method to access the storage account for deployment. */
1536
+ export interface FunctionsDeploymentStorageAuthentication {
1537
+ /** Property to select authentication type to access the selected storage account. Available options: SystemAssignedIdentity, UserAssignedIdentity, StorageAccountConnectionString. */
1538
+ type?: AuthenticationType;
1539
+ /** Use this property for UserAssignedIdentity. Set the resource ID of the identity. Do not set a value for this property when using other authentication type. */
1540
+ userAssignedIdentityResourceId?: string;
1541
+ /** Use this property for StorageAccountConnectionString. Set the name of the app setting that has the storage account connection string. Do not set a value for this property when using other authentication type. */
1542
+ storageAccountConnectionStringName?: string;
1543
+ }
1544
+ /** Function app runtime name and version. */
1545
+ export interface FunctionsRuntime {
1546
+ /** Function app runtime name. Available options: dotnet-isolated, node, java, powershell, python, custom */
1547
+ name?: RuntimeName;
1548
+ /** Function app runtime version. Example: 8 (for dotnet-isolated) */
1549
+ version?: string;
1550
+ }
1551
+ /** Scale and concurrency settings for the function app. */
1552
+ export interface FunctionsScaleAndConcurrency {
1553
+ /** 'Always Ready' configuration for the function app. */
1554
+ alwaysReady?: FunctionsAlwaysReadyConfig[];
1555
+ /** The maximum number of instances for the function app. */
1556
+ maximumInstanceCount?: number;
1557
+ /** Set the amount of memory allocated to each instance of the function app in MB. CPU and network bandwidth are allocated proportionally. */
1558
+ instanceMemoryMB?: number;
1559
+ /** Scale and concurrency settings for the function app triggers. */
1560
+ triggers?: FunctionsScaleAndConcurrencyTriggers;
1561
+ }
1562
+ /** Sets the number of 'Always Ready' instances for a function group or a specific function. */
1563
+ export interface FunctionsAlwaysReadyConfig {
1564
+ /** Either a function group or a function name is required. For additional information see https://aka.ms/flexconsumption/alwaysready. */
1565
+ name?: string;
1566
+ /** Sets the number of 'Always Ready' instances for a given function group or a specific function. For additional information see https://aka.ms/flexconsumption/alwaysready. */
1567
+ instanceCount?: number;
1568
+ }
1569
+ /** Scale and concurrency settings for the function app triggers. */
1570
+ export interface FunctionsScaleAndConcurrencyTriggers {
1571
+ /** Scale and concurrency settings for the HTTP trigger. */
1572
+ http?: FunctionsScaleAndConcurrencyTriggersHttp;
1573
+ }
1574
+ /** Scale and concurrency settings for the HTTP trigger. */
1575
+ export interface FunctionsScaleAndConcurrencyTriggersHttp {
1576
+ /** The maximum number of concurrent HTTP trigger invocations per instance. */
1577
+ perInstanceConcurrency?: number;
1578
+ }
1579
+ /** App Dapr configuration. */
1580
+ export interface DaprConfig {
1581
+ /** Boolean indicating if the Dapr side car is enabled */
1582
+ enabled?: boolean;
1583
+ /** Dapr application identifier */
1584
+ appId?: string;
1585
+ /** Tells Dapr which port your application is listening on */
1586
+ appPort?: number;
1587
+ /** Dapr max size of http header read buffer in KB to handle when sending multi-KB headers. Default is 65KB. */
1588
+ httpReadBufferSize?: number;
1589
+ /** Increasing max size of request body http servers parameter in MB to handle uploading of big files. Default is 4 MB. */
1590
+ httpMaxRequestSize?: number;
1591
+ /** Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info. */
1592
+ logLevel?: DaprLogLevel;
1593
+ /** Enables API logging for the Dapr sidecar */
1594
+ enableApiLogging?: boolean;
1595
+ }
1596
+ /** Function app resource requirements. */
1597
+ export interface ResourceConfig {
1598
+ /** Required CPU in cores, e.g. 0.5 */
1599
+ cpu?: number;
1600
+ /** Required memory, e.g. "1Gi" */
1601
+ memory?: string;
1602
+ }
1603
+ /** The status of the last successful slot swap operation. */
1604
+ export interface SlotSwapStatus {
1605
+ /**
1606
+ * The time the last successful slot swap completed.
1607
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1608
+ */
1609
+ readonly timestampUtc?: Date;
1610
+ /**
1611
+ * The source slot of the last swap operation.
1612
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1613
+ */
1614
+ readonly sourceSlotName?: string;
1615
+ /**
1616
+ * The destination slot of the last swap operation.
1617
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1618
+ */
1619
+ readonly destinationSlotName?: string;
1620
+ }
1621
+ /**
1622
+ * Container App versioned application definition.
1623
+ * Defines the desired state of an immutable revision.
1624
+ * Any changes to this section Will result in a new revision being created
1625
+ */
1626
+ export interface Template {
1627
+ /** User friendly suffix that is appended to the revision name */
1628
+ revisionSuffix?: string;
1629
+ /** List of container definitions for the Container App. */
1630
+ containers?: Container[];
1631
+ /** Scaling properties for the Container App. */
1632
+ scale?: Scale;
1633
+ /** Dapr configuration for the Container App. */
1634
+ dapr?: Dapr;
1635
+ }
1636
+ /** Collection of App Service apps. */
1637
+ export interface WebAppCollection {
1638
+ /** Collection of resources. */
1639
+ value: Site[];
1640
+ /**
1641
+ * Link to next page of resources.
1642
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1643
+ */
1644
+ readonly nextLink?: string;
1645
+ }
1646
+ /** Information about a domain. */
1647
+ export interface Domain extends Resource {
1648
+ /** Administrative contact. */
1649
+ contactAdmin?: Contact;
1650
+ /** Billing contact. */
1651
+ contactBilling?: Contact;
1652
+ /** Registrant contact. */
1653
+ contactRegistrant?: Contact;
1654
+ /** Technical contact. */
1655
+ contactTech?: Contact;
1656
+ /**
1657
+ * Domain registration status.
1658
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1659
+ */
1660
+ readonly registrationStatus?: DomainStatus;
1661
+ /**
1662
+ * Domain provisioning state.
1663
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1664
+ */
1665
+ readonly provisioningState?: ProvisioningState;
1666
+ /**
1667
+ * Name servers.
1668
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1669
+ */
1670
+ readonly nameServers?: string[];
1671
+ /** <code>true</code> if domain privacy is enabled for this domain; otherwise, <code>false</code>. */
1672
+ privacy?: boolean;
1673
+ /**
1674
+ * Domain creation timestamp.
1675
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1676
+ */
1677
+ readonly createdTime?: Date;
1678
+ /**
1679
+ * Domain expiration timestamp.
1680
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1681
+ */
1682
+ readonly expirationTime?: Date;
1683
+ /**
1684
+ * Timestamp when the domain was renewed last time.
1685
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1686
+ */
1687
+ readonly lastRenewedTime?: Date;
1688
+ /** <code>true</code> if the domain should be automatically renewed; otherwise, <code>false</code>. */
1689
+ autoRenew?: boolean;
1690
+ /**
1691
+ * <code>true</code> if Azure can assign this domain to App Service apps; otherwise, <code>false</code>. This value will be <code>true</code> if domain registration status is active and
1692
+ * it is hosted on name servers Azure has programmatic access to.
1693
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1694
+ */
1695
+ readonly readyForDnsRecordManagement?: boolean;
1696
+ /**
1697
+ * All hostnames derived from the domain and assigned to Azure resources.
1698
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1699
+ */
1700
+ readonly managedHostNames?: HostName[];
1701
+ /** Legal agreement consent. */
1702
+ consent?: DomainPurchaseConsent;
1703
+ /**
1704
+ * Reasons why domain is not renewable.
1705
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1706
+ */
1707
+ readonly domainNotRenewableReasons?: ResourceNotRenewableReason[];
1708
+ /** Current DNS type */
1709
+ dnsType?: DnsType;
1710
+ /** Azure DNS Zone to use */
1711
+ dnsZoneId?: string;
1712
+ /** Target DNS type (would be used for migration) */
1713
+ targetDnsType?: DnsType;
1714
+ authCode?: string;
1715
+ }
1716
+ /** App Service plan. */
1717
+ export interface AppServicePlan extends Resource {
1718
+ /** Description of a SKU for a scalable resource. */
1719
+ sku?: SkuDescription;
1720
+ /** Extended Location. */
1721
+ extendedLocation?: ExtendedLocation;
1722
+ /** Target worker tier assigned to the App Service plan. */
1723
+ workerTierName?: string;
1724
+ /**
1725
+ * App Service plan status.
1726
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1727
+ */
1728
+ readonly status?: StatusOptions;
1729
+ /**
1730
+ * App Service plan subscription.
1731
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1732
+ */
1733
+ readonly subscription?: string;
1734
+ /** Specification for the App Service Environment to use for the App Service plan. */
1735
+ hostingEnvironmentProfile?: HostingEnvironmentProfile;
1736
+ /**
1737
+ * Maximum number of instances that can be assigned to this App Service plan.
1738
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1739
+ */
1740
+ readonly maximumNumberOfWorkers?: number;
1741
+ /**
1742
+ * The number of instances that are assigned to this App Service plan.
1743
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1744
+ */
1745
+ readonly numberOfWorkers?: number;
1746
+ /**
1747
+ * Geographical location for the App Service plan.
1748
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1749
+ */
1750
+ readonly geoRegion?: string;
1751
+ /**
1752
+ * If <code>true</code>, apps assigned to this App Service plan can be scaled independently.
1753
+ * If <code>false</code>, apps assigned to this App Service plan will scale to all instances of the plan.
1754
+ */
1755
+ perSiteScaling?: boolean;
1756
+ /** ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku */
1757
+ elasticScaleEnabled?: boolean;
1758
+ /** Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan */
1759
+ maximumElasticWorkerCount?: number;
1760
+ /**
1761
+ * Number of apps assigned to this App Service plan.
1762
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1763
+ */
1764
+ readonly numberOfSites?: number;
1765
+ /** If <code>true</code>, this App Service Plan owns spot instances. */
1766
+ isSpot?: boolean;
1767
+ /** The time when the server farm expires. Valid only if it is a spot server farm. */
1768
+ spotExpirationTime?: Date;
1769
+ /** The time when the server farm free offer expires. */
1770
+ freeOfferExpirationTime?: Date;
1771
+ /**
1772
+ * Resource group of the App Service plan.
1773
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1774
+ */
1775
+ readonly resourceGroup?: string;
1776
+ /** If Linux app service plan <code>true</code>, <code>false</code> otherwise. */
1777
+ reserved?: boolean;
1778
+ /** Obsolete: If Hyper-V container app service plan <code>true</code>, <code>false</code> otherwise. */
1779
+ isXenon?: boolean;
1780
+ /** If Hyper-V container app service plan <code>true</code>, <code>false</code> otherwise. */
1781
+ hyperV?: boolean;
1782
+ /** Scaling worker count. */
1783
+ targetWorkerCount?: number;
1784
+ /** Scaling worker size ID. */
1785
+ targetWorkerSizeId?: number;
1786
+ /**
1787
+ * Provisioning state of the App Service Plan.
1788
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1789
+ */
1790
+ readonly provisioningState?: ProvisioningState;
1791
+ /** Specification for the Kubernetes Environment to use for the App Service plan. */
1792
+ kubeEnvironmentProfile?: KubeEnvironmentProfile;
1793
+ /**
1794
+ * If <code>true</code>, this App Service Plan will perform availability zone balancing.
1795
+ * If <code>false</code>, this App Service Plan will not perform availability zone balancing.
1796
+ */
1797
+ zoneRedundant?: boolean;
1798
+ /**
1799
+ * If <code>true</code>, this App Service Plan will attempt to scale asynchronously if there are insufficient workers to scale synchronously.
1800
+ * If <code>false</code>, this App Service Plan will only attempt sync scaling.
1801
+ */
1802
+ asyncScalingEnabled?: boolean;
1803
+ }
1804
+ /** SSL certificate for an app. */
1805
+ export interface Certificate extends Resource {
1806
+ /** Certificate password. */
1807
+ password?: string;
1808
+ /**
1809
+ * Friendly name of the certificate.
1810
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1811
+ */
1812
+ readonly friendlyName?: string;
1813
+ /**
1814
+ * Subject name of the certificate.
1815
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1816
+ */
1817
+ readonly subjectName?: string;
1818
+ /** Host names the certificate applies to. */
1819
+ hostNames?: string[];
1820
+ /** Pfx blob. */
1821
+ pfxBlob?: Uint8Array;
1822
+ /**
1823
+ * App name.
1824
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1825
+ */
1826
+ readonly siteName?: string;
1827
+ /**
1828
+ * Self link.
1829
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1830
+ */
1831
+ readonly selfLink?: string;
1832
+ /**
1833
+ * Certificate issuer.
1834
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1835
+ */
1836
+ readonly issuer?: string;
1837
+ /**
1838
+ * Certificate issue Date.
1839
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1840
+ */
1841
+ readonly issueDate?: Date;
1842
+ /**
1843
+ * Certificate expiration date.
1844
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1845
+ */
1846
+ readonly expirationDate?: Date;
1847
+ /**
1848
+ * Certificate thumbprint.
1849
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1850
+ */
1851
+ readonly thumbprint?: string;
1852
+ /**
1853
+ * Is the certificate valid?.
1854
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1855
+ */
1856
+ readonly valid?: boolean;
1857
+ /**
1858
+ * Raw bytes of .cer file
1859
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1860
+ */
1861
+ readonly cerBlob?: Uint8Array;
1862
+ /**
1863
+ * Public key hash.
1864
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1865
+ */
1866
+ readonly publicKeyHash?: string;
1867
+ /**
1868
+ * Specification for the App Service Environment to use for the certificate.
1869
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1870
+ */
1871
+ readonly hostingEnvironmentProfile?: HostingEnvironmentProfile;
1872
+ /** Azure Key Vault Csm resource Id. */
1873
+ keyVaultId?: string;
1874
+ /** Azure Key Vault secret name. */
1875
+ keyVaultSecretName?: string;
1876
+ /**
1877
+ * Status of the Key Vault secret.
1878
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1879
+ */
1880
+ readonly keyVaultSecretStatus?: KeyVaultSecretStatus;
1881
+ /** Resource ID of the associated App Service plan. */
1882
+ serverFarmId?: string;
1883
+ /** CNAME of the certificate to be issued via free certificate */
1884
+ canonicalName?: string;
1885
+ /** Method of domain validation for free cert */
1886
+ domainValidationMethod?: string;
1887
+ }
1888
+ /** A web app, a mobile app backend, or an API app. */
1889
+ export interface Site extends Resource {
1890
+ /** Managed service identity. */
1891
+ identity?: ManagedServiceIdentity;
1892
+ /** Extended Location. */
1893
+ extendedLocation?: ExtendedLocation;
1894
+ /**
1895
+ * Current state of the app.
1896
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1897
+ */
1898
+ readonly state?: string;
1899
+ /**
1900
+ * Hostnames associated with the app.
1901
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1902
+ */
1903
+ readonly hostNames?: string[];
1904
+ /**
1905
+ * Name of the repository site.
1906
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1907
+ */
1908
+ readonly repositorySiteName?: string;
1909
+ /**
1910
+ * State indicating whether the app has exceeded its quota usage. Read-only.
1911
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1912
+ */
1913
+ readonly usageState?: UsageState;
1914
+ /** <code>true</code> if the app is enabled; otherwise, <code>false</code>. Setting this value to false disables the app (takes the app offline). */
1915
+ enabled?: boolean;
1916
+ /**
1917
+ * Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,
1918
+ * the app is not served on those hostnames.
1919
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1920
+ */
1921
+ readonly enabledHostNames?: string[];
1922
+ /**
1923
+ * Management information availability state for the app.
1924
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1925
+ */
1926
+ readonly availabilityState?: SiteAvailabilityState;
1927
+ /** Hostname SSL states are used to manage the SSL bindings for app's hostnames. */
1928
+ hostNameSslStates?: HostNameSslState[];
1929
+ /** Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". */
1930
+ serverFarmId?: string;
1931
+ /** <code>true</code> if reserved; otherwise, <code>false</code>. */
1932
+ reserved?: boolean;
1933
+ /** Obsolete: Hyper-V sandbox. */
1934
+ isXenon?: boolean;
1935
+ /** Hyper-V sandbox. */
1936
+ hyperV?: boolean;
1937
+ /**
1938
+ * Last time the app was modified, in UTC. Read-only.
1939
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1940
+ */
1941
+ readonly lastModifiedTimeUtc?: Date;
1942
+ /** Property to configure various DNS related settings for a site. */
1943
+ dnsConfiguration?: SiteDnsConfig;
1944
+ /** Property to configure various outbound traffic routing options over virtual network for a site */
1945
+ outboundVnetRouting?: OutboundVnetRouting;
1946
+ /** Configuration of an App Service app. This property is not returned in response to normal create and read requests since it may contain sensitive information. */
1947
+ siteConfig?: SiteConfig;
1948
+ /** Configuration specific of the Azure Function app. */
1949
+ functionAppConfig?: FunctionAppConfig;
1950
+ /** Dapr configuration of the app. */
1951
+ daprConfig?: DaprConfig;
1952
+ /** Workload profile name for function app to execute on. */
1953
+ workloadProfileName?: string;
1954
+ /** Function app resource requirements. */
1955
+ resourceConfig?: ResourceConfig;
1956
+ /**
1957
+ * Azure Traffic Manager hostnames associated with the app. Read-only.
1958
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1959
+ */
1960
+ readonly trafficManagerHostNames?: string[];
1961
+ /** <code>true</code> to stop SCM (KUDU) site when the app is stopped; otherwise, <code>false</code>. The default is <code>false</code>. */
1962
+ scmSiteAlsoStopped?: boolean;
1963
+ /**
1964
+ * Specifies which deployment slot this app will swap into. Read-only.
1965
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1966
+ */
1967
+ readonly targetSwapSlot?: string;
1968
+ /** App Service Environment to use for the app. */
1969
+ hostingEnvironmentProfile?: HostingEnvironmentProfile;
1970
+ /** <code>true</code> to enable client affinity; <code>false</code> to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is <code>true</code>. */
1971
+ clientAffinityEnabled?: boolean;
1972
+ /** <code>true</code> to enable client affinity partitioning using CHIPS cookies, this will add the <code>partitioned</code> property to the affinity cookies; <code>false</code> to stop sending partitioned affinity cookies. Default is <code>false</code>. */
1973
+ clientAffinityPartitioningEnabled?: boolean;
1974
+ /** <code>true</code> to override client affinity cookie domain with X-Forwarded-Host request header. <code>false</code> to use default domain. Default is <code>false</code>. */
1975
+ clientAffinityProxyEnabled?: boolean;
1976
+ /** <code>true</code> to enable client certificate authentication (TLS mutual authentication); otherwise, <code>false</code>. Default is <code>false</code>. */
1977
+ clientCertEnabled?: boolean;
1978
+ /**
1979
+ * This composes with ClientCertEnabled setting.
1980
+ * - ClientCertEnabled: false means ClientCert is ignored.
1981
+ * - ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required.
1982
+ * - ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted.
1983
+ */
1984
+ clientCertMode?: ClientCertMode;
1985
+ /** client certificate authentication comma-separated exclusion paths */
1986
+ clientCertExclusionPaths?: string;
1987
+ /** Specifies the IP mode of the app. */
1988
+ ipMode?: IPMode;
1989
+ /** Whether to use end to end encryption between the FrontEnd and the Worker */
1990
+ endToEndEncryptionEnabled?: boolean;
1991
+ /** Whether to enable ssh access. */
1992
+ sshEnabled?: boolean;
1993
+ /**
1994
+ * <code>true</code> to disable the public hostnames of the app; otherwise, <code>false</code>.
1995
+ * If <code>true</code>, the app is only accessible via API management process.
1996
+ */
1997
+ hostNamesDisabled?: boolean;
1998
+ /** Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification. */
1999
+ customDomainVerificationId?: string;
2000
+ /**
2001
+ * List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only.
2002
+ * NOTE: This property will not be serialized. It can only be populated by the server.
2003
+ */
2004
+ readonly outboundIpAddresses?: string;
2005
+ /**
2006
+ * List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only.
2007
+ * NOTE: This property will not be serialized. It can only be populated by the server.
2008
+ */
2009
+ readonly possibleOutboundIpAddresses?: string;
2010
+ /** Size of the function container. */
2011
+ containerSize?: number;
2012
+ /** Maximum allowed daily memory-time quota (applicable on dynamic apps only). */
2013
+ dailyMemoryTimeQuota?: number;
2014
+ /**
2015
+ * App suspended till in case memory-time quota is exceeded.
2016
+ * NOTE: This property will not be serialized. It can only be populated by the server.
2017
+ */
2018
+ readonly suspendedTill?: Date;
2019
+ /**
2020
+ * Maximum number of workers.
2021
+ * This only applies to Functions container.
2022
+ * NOTE: This property will not be serialized. It can only be populated by the server.
2023
+ */
2024
+ readonly maxNumberOfWorkers?: number;
2025
+ /** If specified during app creation, the app is cloned from a source app. */
2026
+ cloningInfo?: CloningInfo;
2027
+ /**
2028
+ * Name of the resource group the app belongs to. Read-only.
2029
+ * NOTE: This property will not be serialized. It can only be populated by the server.
2030
+ */
2031
+ readonly resourceGroup?: string;
2032
+ /**
2033
+ * <code>true</code> if the app is a default container; otherwise, <code>false</code>.
2034
+ * NOTE: This property will not be serialized. It can only be populated by the server.
2035
+ */
2036
+ readonly isDefaultContainer?: boolean;
2037
+ /**
2038
+ * Default hostname of the app. Read-only.
2039
+ * NOTE: This property will not be serialized. It can only be populated by the server.
2040
+ */
2041
+ readonly defaultHostName?: string;
2042
+ /**
2043
+ * Status of the last deployment slot swap operation.
2044
+ * NOTE: This property will not be serialized. It can only be populated by the server.
2045
+ */
2046
+ readonly slotSwapStatus?: SlotSwapStatus;
2047
+ /**
2048
+ * HttpsOnly: configures a web site to accept only https requests. Issues redirect for
2049
+ * http requests
2050
+ */
2051
+ httpsOnly?: boolean;
2052
+ /** Site redundancy mode */
2053
+ redundancyMode?: RedundancyMode;
2054
+ /**
2055
+ * Specifies an operation id if this site has a pending operation.
2056
+ * NOTE: This property will not be serialized. It can only be populated by the server.
2057
+ */
2058
+ readonly inProgressOperationId?: string;
2059
+ /** Property to allow or block all public traffic. Allowed Values: 'Enabled', 'Disabled' or an empty string. */
2060
+ publicNetworkAccess?: string;
2061
+ /** Checks if Customer provided storage account is required */
2062
+ storageAccountRequired?: boolean;
2063
+ /** Identity to use for Key Vault Reference authentication. */
2064
+ keyVaultReferenceIdentity?: string;
2065
+ /** Specifies the scope of uniqueness for the default hostname during resource creation */
2066
+ autoGeneratedDomainNameLabelScope?: AutoGeneratedDomainNameLabelScope;
2067
+ /**
2068
+ * Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration.
2069
+ * This must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}
2070
+ */
2071
+ virtualNetworkSubnetId?: string;
2072
+ /** Azure Resource Manager ID of the customer's selected Managed Environment on which to host this app. This must be of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.App/managedEnvironments/{managedEnvironmentName} */
2073
+ managedEnvironmentId?: string;
2074
+ /**
2075
+ * Current SKU of application based on associated App Service Plan. Some valid SKU values are Free, Shared, Basic, Dynamic, FlexConsumption, Standard, Premium, PremiumV2, PremiumV3, Isolated, IsolatedV2
2076
+ * NOTE: This property will not be serialized. It can only be populated by the server.
2077
+ */
2078
+ readonly sku?: string;
2079
+ }
2080
+ /** ARM resource for a domain. */
2081
+ export interface DomainPatchResource extends ProxyOnlyResource {
2082
+ /** Administrative contact. */
2083
+ contactAdmin?: Contact;
2084
+ /** Billing contact. */
2085
+ contactBilling?: Contact;
2086
+ /** Registrant contact. */
2087
+ contactRegistrant?: Contact;
2088
+ /** Technical contact. */
2089
+ contactTech?: Contact;
2090
+ /**
2091
+ * Domain registration status.
2092
+ * NOTE: This property will not be serialized. It can only be populated by the server.
2093
+ */
2094
+ readonly registrationStatus?: DomainStatus;
2095
+ /**
2096
+ * Domain provisioning state.
2097
+ * NOTE: This property will not be serialized. It can only be populated by the server.
2098
+ */
2099
+ readonly provisioningState?: ProvisioningState;
2100
+ /**
2101
+ * Name servers.
2102
+ * NOTE: This property will not be serialized. It can only be populated by the server.
2103
+ */
2104
+ readonly nameServers?: string[];
2105
+ /** <code>true</code> if domain privacy is enabled for this domain; otherwise, <code>false</code>. */
2106
+ privacy?: boolean;
2107
+ /**
2108
+ * Domain creation timestamp.
2109
+ * NOTE: This property will not be serialized. It can only be populated by the server.
2110
+ */
2111
+ readonly createdTime?: Date;
2112
+ /**
2113
+ * Domain expiration timestamp.
2114
+ * NOTE: This property will not be serialized. It can only be populated by the server.
2115
+ */
2116
+ readonly expirationTime?: Date;
2117
+ /**
2118
+ * Timestamp when the domain was renewed last time.
2119
+ * NOTE: This property will not be serialized. It can only be populated by the server.
2120
+ */
2121
+ readonly lastRenewedTime?: Date;
2122
+ /** <code>true</code> if the domain should be automatically renewed; otherwise, <code>false</code>. */
2123
+ autoRenew?: boolean;
2124
+ /**
2125
+ * <code>true</code> if Azure can assign this domain to App Service apps; otherwise, <code>false</code>. This value will be <code>true</code> if domain registration status is active and
2126
+ * it is hosted on name servers Azure has programmatic access to.
2127
+ * NOTE: This property will not be serialized. It can only be populated by the server.
2128
+ */
2129
+ readonly readyForDnsRecordManagement?: boolean;
2130
+ /**
2131
+ * All hostnames derived from the domain and assigned to Azure resources.
2132
+ * NOTE: This property will not be serialized. It can only be populated by the server.
2133
+ */
2134
+ readonly managedHostNames?: HostName[];
2135
+ /** Legal agreement consent. */
2136
+ consent?: DomainPurchaseConsent;
2137
+ /**
2138
+ * Reasons why domain is not renewable.
2139
+ * NOTE: This property will not be serialized. It can only be populated by the server.
2140
+ */
2141
+ readonly domainNotRenewableReasons?: ResourceNotRenewableReason[];
2142
+ /** Current DNS type */
2143
+ dnsType?: DnsType;
2144
+ /** Azure DNS Zone to use */
2145
+ dnsZoneId?: string;
2146
+ /** Target DNS type (would be used for migration) */
2147
+ targetDnsType?: DnsType;
2148
+ authCode?: string;
2149
+ }
2150
+ /** Domain ownership Identifier. */
2151
+ export interface DomainOwnershipIdentifier extends ProxyOnlyResource {
2152
+ /** Ownership Id. */
2153
+ ownershipId?: string;
2154
+ }
2155
+ /** A top level domain object. */
2156
+ export interface TopLevelDomain extends ProxyOnlyResource {
2157
+ /** If <code>true</code>, then the top level domain supports domain privacy; otherwise, <code>false</code>. */
2158
+ privacy?: boolean;
2159
+ }
2160
+ /** Full view of the custom domain suffix configuration for ASEv3. */
2161
+ export interface CustomDnsSuffixConfiguration extends ProxyOnlyResource {
2162
+ /** NOTE: This property will not be serialized. It can only be populated by the server. */
2163
+ readonly provisioningState?: CustomDnsSuffixProvisioningState;
2164
+ /** NOTE: This property will not be serialized. It can only be populated by the server. */
2165
+ readonly provisioningDetails?: string;
2166
+ /** The default custom domain suffix to use for all sites deployed on the ASE. */
2167
+ dnsSuffix?: string;
2168
+ /** The URL referencing the Azure Key Vault certificate secret that should be used as the default SSL/TLS certificate for sites with the custom domain suffix. */
2169
+ certificateUrl?: string;
2170
+ /** The user-assigned identity to use for resolving the key vault certificate reference. If not specified, the system-assigned ASE identity will be used if available. */
2171
+ keyVaultReferenceIdentity?: string;
2172
+ }
2173
+ /** Full view of networking configuration for an ASE. */
2174
+ export interface AseV3NetworkingConfiguration extends ProxyOnlyResource {
2175
+ /** NOTE: This property will not be serialized. It can only be populated by the server. */
2176
+ readonly windowsOutboundIpAddresses?: string[];
2177
+ /** NOTE: This property will not be serialized. It can only be populated by the server. */
2178
+ readonly linuxOutboundIpAddresses?: string[];
2179
+ /** NOTE: This property will not be serialized. It can only be populated by the server. */
2180
+ readonly externalInboundIpAddresses?: string[];
2181
+ /** NOTE: This property will not be serialized. It can only be populated by the server. */
2182
+ readonly internalInboundIpAddresses?: string[];
2183
+ /** Property to enable and disable new private endpoint connection creation on ASE */
2184
+ allowNewPrivateEndpointConnections?: boolean;
2185
+ /** Property to enable and disable FTP on ASEV3 */
2186
+ ftpEnabled?: boolean;
2187
+ /** Property to enable and disable Remote Debug on ASEV3 */
2188
+ remoteDebugEnabled?: boolean;
2189
+ /** Customer provided Inbound IP Address. Only able to be set on Ase create. */
2190
+ inboundIpAddressOverride?: string;
2191
+ }
2192
+ /** ARM resource for a certificate. */
2193
+ export interface CertificatePatchResource extends ProxyOnlyResource {
2194
+ /** Certificate password. */
2195
+ password?: string;
2196
+ /**
2197
+ * Friendly name of the certificate.
2198
+ * NOTE: This property will not be serialized. It can only be populated by the server.
2199
+ */
2200
+ readonly friendlyName?: string;
2201
+ /**
2202
+ * Subject name of the certificate.
2203
+ * NOTE: This property will not be serialized. It can only be populated by the server.
2204
+ */
2205
+ readonly subjectName?: string;
2206
+ /** Host names the certificate applies to. */
2207
+ hostNames?: string[];
2208
+ /** Pfx blob. */
2209
+ pfxBlob?: Uint8Array;
2210
+ /**
2211
+ * App name.
2212
+ * NOTE: This property will not be serialized. It can only be populated by the server.
2213
+ */
2214
+ readonly siteName?: string;
2215
+ /**
2216
+ * Self link.
2217
+ * NOTE: This property will not be serialized. It can only be populated by the server.
2218
+ */
2219
+ readonly selfLink?: string;
2220
+ /**
2221
+ * Certificate issuer.
2222
+ * NOTE: This property will not be serialized. It can only be populated by the server.
2223
+ */
2224
+ readonly issuer?: string;
2225
+ /**
2226
+ * Certificate issue Date.
2227
+ * NOTE: This property will not be serialized. It can only be populated by the server.
2228
+ */
2229
+ readonly issueDate?: Date;
2230
+ /**
2231
+ * Certificate expiration date.
2232
+ * NOTE: This property will not be serialized. It can only be populated by the server.
2233
+ */
2234
+ readonly expirationDate?: Date;
2235
+ /**
2236
+ * Certificate thumbprint.
2237
+ * NOTE: This property will not be serialized. It can only be populated by the server.
2238
+ */
2239
+ readonly thumbprint?: string;
2240
+ /**
2241
+ * Is the certificate valid?.
2242
+ * NOTE: This property will not be serialized. It can only be populated by the server.
2243
+ */
2244
+ readonly valid?: boolean;
2245
+ /**
2246
+ * Raw bytes of .cer file
2247
+ * NOTE: This property will not be serialized. It can only be populated by the server.
2248
+ */
2249
+ readonly cerBlob?: Uint8Array;
2250
+ /**
2251
+ * Public key hash.
2252
+ * NOTE: This property will not be serialized. It can only be populated by the server.
2253
+ */
2254
+ readonly publicKeyHash?: string;
2255
+ /**
2256
+ * Specification for the App Service Environment to use for the certificate.
2257
+ * NOTE: This property will not be serialized. It can only be populated by the server.
2258
+ */
2259
+ readonly hostingEnvironmentProfile?: HostingEnvironmentProfile;
2260
+ /** Key Vault Csm resource Id. */
2261
+ keyVaultId?: string;
2262
+ /** Key Vault secret name. */
2263
+ keyVaultSecretName?: string;
2264
+ /**
2265
+ * Status of the Key Vault secret.
2266
+ * NOTE: This property will not be serialized. It can only be populated by the server.
2267
+ */
2268
+ readonly keyVaultSecretStatus?: KeyVaultSecretStatus;
2269
+ /** Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". */
2270
+ serverFarmId?: string;
2271
+ /** CNAME of the certificate to be issued via free certificate */
2272
+ canonicalName?: string;
2273
+ /** Method of domain validation for free cert */
2274
+ domainValidationMethod?: string;
2275
+ }
2276
+ /** A deleted app. */
2277
+ export interface DeletedSite extends ProxyOnlyResource {
2278
+ /**
2279
+ * Numeric id for the deleted site
2280
+ * NOTE: This property will not be serialized. It can only be populated by the server.
2281
+ */
2282
+ readonly deletedSiteId?: number;
2283
+ /**
2284
+ * Time in UTC when the app was deleted.
2285
+ * NOTE: This property will not be serialized. It can only be populated by the server.
2286
+ */
2287
+ readonly deletedTimestamp?: string;
2288
+ /**
2289
+ * Subscription containing the deleted site
2290
+ * NOTE: This property will not be serialized. It can only be populated by the server.
2291
+ */
2292
+ readonly subscription?: string;
2293
+ /**
2294
+ * ResourceGroup that contained the deleted site
2295
+ * NOTE: This property will not be serialized. It can only be populated by the server.
2296
+ */
2297
+ readonly resourceGroup?: string;
2298
+ /**
2299
+ * Name of the deleted site
2300
+ * NOTE: This property will not be serialized. It can only be populated by the server.
2301
+ */
2302
+ readonly deletedSiteName?: string;
2303
+ /**
2304
+ * Slot of the deleted site
2305
+ * NOTE: This property will not be serialized. It can only be populated by the server.
2306
+ */
2307
+ readonly slot?: string;
2308
+ /**
2309
+ * Kind of site that was deleted
2310
+ * NOTE: This property will not be serialized. It can only be populated by the server.
2311
+ */
2312
+ readonly kindPropertiesKind?: string;
2313
+ /**
2314
+ * Geo Region of the deleted site
2315
+ * NOTE: This property will not be serialized. It can only be populated by the server.
2316
+ */
2317
+ readonly geoRegionName?: string;
2318
+ }
2319
+ /** Class representing Response from Detector */
2320
+ export interface DetectorResponse extends ProxyOnlyResource {
2321
+ /** metadata for the detector */
2322
+ metadata?: DetectorInfo;
2323
+ /** Data Set */
2324
+ dataset?: DiagnosticData[];
2325
+ /** Indicates status of the most severe insight. */
2326
+ status?: Status;
2327
+ /** Additional configuration for different data providers to be used by the UI */
2328
+ dataProvidersMetadata?: DataProviderMetadata[];
2329
+ /** Suggested utterances where the detector can be applicable. */
2330
+ suggestedUtterances?: QueryUtterancesResults;
2331
+ }
2332
+ /** A hostname binding object. */
2333
+ export interface HostNameBinding extends ProxyOnlyResource {
2334
+ /** App Service app name. */
2335
+ siteName?: string;
2336
+ /** Fully qualified ARM domain resource URI. */
2337
+ domainId?: string;
2338
+ /** Azure resource name. */
2339
+ azureResourceName?: string;
2340
+ /** Azure resource type. */
2341
+ azureResourceType?: AzureResourceType;
2342
+ /** Custom DNS record type. */
2343
+ customHostNameDnsRecordType?: CustomHostNameDnsRecordType;
2344
+ /** Hostname type. */
2345
+ hostNameType?: HostNameType;
2346
+ /** SSL type */
2347
+ sslState?: SslState;
2348
+ /** SSL certificate thumbprint */
2349
+ thumbprint?: string;
2350
+ /**
2351
+ * Virtual IP address assigned to the hostname if IP based SSL is enabled.
2352
+ * NOTE: This property will not be serialized. It can only be populated by the server.
2353
+ */
2354
+ readonly virtualIP?: string;
2355
+ }
2356
+ /** Hybrid Connection contract. This is used to configure a Hybrid Connection. */
2357
+ export interface HybridConnection extends ProxyOnlyResource {
2358
+ /** The name of the Service Bus namespace. */
2359
+ serviceBusNamespace?: string;
2360
+ /** The name of the Service Bus relay. */
2361
+ relayName?: string;
2362
+ /** The ARM URI to the Service Bus relay. */
2363
+ relayArmUri?: string;
2364
+ /** The hostname of the endpoint. */
2365
+ hostname?: string;
2366
+ /** The port of the endpoint. */
2367
+ port?: number;
2368
+ /** The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus. */
2369
+ sendKeyName?: string;
2370
+ /**
2371
+ * The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned
2372
+ * normally, use the POST /listKeys API instead.
2373
+ */
2374
+ sendKeyValue?: string;
2375
+ /** The suffix for the service bus endpoint. By default this is .servicebus.windows.net */
2376
+ serviceBusSuffix?: string;
2377
+ }
2378
+ /** A domain specific resource identifier. */
2379
+ export interface Identifier extends ProxyOnlyResource {
2380
+ /** String representation of the identity. */
2381
+ value?: string;
2382
+ }
2383
+ /** Remote Private Endpoint Connection ARM resource. */
2384
+ export interface RemotePrivateEndpointConnectionARMResource extends ProxyOnlyResource {
2385
+ /** NOTE: This property will not be serialized. It can only be populated by the server. */
2386
+ readonly provisioningState?: string;
2387
+ /** PrivateEndpoint of a remote private endpoint connection */
2388
+ privateEndpoint?: ArmIdWrapper;
2389
+ /** The state of a private link connection */
2390
+ privateLinkServiceConnectionState?: PrivateLinkConnectionState;
2391
+ /** Private IPAddresses mapped to the remote private endpoint */
2392
+ ipAddresses?: string[];
2393
+ }
2394
+ /** Private Endpoint Connection Approval ARM resource. */
2395
+ export interface PrivateLinkConnectionApprovalRequestResource extends ProxyOnlyResource {
2396
+ /** The state of a private link connection */
2397
+ privateLinkServiceConnectionState?: PrivateLinkConnectionState;
2398
+ }
2399
+ /** Push settings for the App. */
2400
+ export interface PushSettings extends ProxyOnlyResource {
2401
+ /** Gets or sets a flag indicating whether the Push endpoint is enabled. */
2402
+ isPushEnabled?: boolean;
2403
+ /** Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. */
2404
+ tagWhitelistJson?: string;
2405
+ /**
2406
+ * Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.
2407
+ * Tags can consist of alphanumeric characters and the following:
2408
+ * '_', '@', '#', '.', ':', '-'.
2409
+ * Validation should be performed at the PushRequestHandler.
2410
+ */
2411
+ tagsRequiringAuth?: string;
2412
+ /** Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. */
2413
+ dynamicTagsJson?: string;
2414
+ }
2415
+ /** A snapshot of an app. */
2416
+ export interface Snapshot extends ProxyOnlyResource {
2417
+ /**
2418
+ * The time the snapshot was taken.
2419
+ * NOTE: This property will not be serialized. It can only be populated by the server.
2420
+ */
2421
+ readonly time?: string;
2422
+ }
2423
+ /** String dictionary resource. */
2424
+ export interface StringDictionary extends ProxyOnlyResource {
2425
+ /** Settings. */
2426
+ properties?: {
2427
+ [propertyName: string]: string;
2428
+ };
2429
+ }
2430
+ /** User credentials used for publishing activity. */
2431
+ export interface User extends ProxyOnlyResource {
2432
+ /** Username used for publishing. */
2433
+ publishingUserName?: string;
2434
+ /**
2435
+ * Password used for publishing.
2436
+ * This value contains a credential. Consider obscuring before showing to users
2437
+ */
2438
+ publishingPassword?: string;
2439
+ /**
2440
+ * Password hash used for publishing.
2441
+ * This value contains a credential. Consider obscuring before showing to users
2442
+ */
2443
+ publishingPasswordHash?: string;
2444
+ /**
2445
+ * Password hash salt used for publishing.
2446
+ * This value contains a credential. Consider obscuring before showing to users
2447
+ */
2448
+ publishingPasswordHashSalt?: string;
2449
+ /** Url of SCM site. */
2450
+ scmUri?: string;
2451
+ }
2452
+ /** The Virtual Network gateway contract. This is used to give the Virtual Network gateway access to the VPN package. */
2453
+ export interface VnetGateway extends ProxyOnlyResource {
2454
+ /** The Virtual Network name. */
2455
+ vnetName?: string;
2456
+ /** The URI where the VPN package can be downloaded. */
2457
+ vpnPackageUri?: string;
2458
+ }
2459
+ /** Virtual Network route contract used to pass routing information for a Virtual Network. */
2460
+ export interface VnetRoute extends ProxyOnlyResource {
2461
+ /** The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. */
2462
+ startAddress?: string;
2463
+ /** The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. */
2464
+ endAddress?: string;
2465
+ /**
2466
+ * The type of route this is:
2467
+ * DEFAULT - By default, every app has routes to the local address ranges specified by RFC1918
2468
+ * INHERITED - Routes inherited from the real Virtual Network routes
2469
+ * STATIC - Static route set on the app only
2470
+ *
2471
+ * These values will be used for syncing an app's routes with those from a Virtual Network.
2472
+ */
2473
+ routeType?: RouteType;
2474
+ }
2475
+ /** Virtual Network information ARM resource. */
2476
+ export interface VnetInfoResource extends ProxyOnlyResource {
2477
+ /** The Virtual Network's resource ID. */
2478
+ vnetResourceId?: string;
2479
+ /**
2480
+ * The client certificate thumbprint.
2481
+ * NOTE: This property will not be serialized. It can only be populated by the server.
2482
+ */
2483
+ readonly certThumbprint?: string;
2484
+ /**
2485
+ * A certificate file (.cer) blob containing the public key of the private key used to authenticate a
2486
+ * Point-To-Site VPN connection.
2487
+ */
2488
+ certBlob?: string;
2489
+ /**
2490
+ * The routes that this Virtual Network connection uses.
2491
+ * NOTE: This property will not be serialized. It can only be populated by the server.
2492
+ */
2493
+ readonly routes?: VnetRoute[];
2494
+ /**
2495
+ * <code>true</code> if a resync is required; otherwise, <code>false</code>.
2496
+ * NOTE: This property will not be serialized. It can only be populated by the server.
2497
+ */
2498
+ readonly resyncRequired?: boolean;
2499
+ /** DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses. */
2500
+ dnsServers?: string;
2501
+ /** Flag that is used to denote if this is VNET injection */
2502
+ isSwift?: boolean;
2503
+ }
2504
+ /** Known values of {@link ResourceNotRenewableReason} that the service accepts. */
2505
+ export declare enum KnownResourceNotRenewableReason {
2506
+ /** RegistrationStatusNotSupportedForRenewal */
2507
+ RegistrationStatusNotSupportedForRenewal = "RegistrationStatusNotSupportedForRenewal",
2508
+ /** ExpirationNotInRenewalTimeRange */
2509
+ ExpirationNotInRenewalTimeRange = "ExpirationNotInRenewalTimeRange",
2510
+ /** SubscriptionNotActive */
2511
+ SubscriptionNotActive = "SubscriptionNotActive"
2512
+ }
2513
+ /**
2514
+ * Defines values for ResourceNotRenewableReason. \
2515
+ * {@link KnownResourceNotRenewableReason} can be used interchangeably with ResourceNotRenewableReason,
2516
+ * this enum contains the known values that the service supports.
2517
+ * ### Known values supported by the service
2518
+ * **RegistrationStatusNotSupportedForRenewal** \
2519
+ * **ExpirationNotInRenewalTimeRange** \
2520
+ * **SubscriptionNotActive**
2521
+ */
2522
+ export type ResourceNotRenewableReason = string;
2523
+ /** Known values of {@link LoadBalancingMode} that the service accepts. */
2524
+ export declare enum KnownLoadBalancingMode {
2525
+ /** None */
2526
+ None = "None",
2527
+ /** Web */
2528
+ Web = "Web",
2529
+ /** Publishing */
2530
+ Publishing = "Publishing",
2531
+ /** WebPublishing */
2532
+ WebPublishing = "Web, Publishing"
2533
+ }
2534
+ /**
2535
+ * Defines values for LoadBalancingMode. \
2536
+ * {@link KnownLoadBalancingMode} can be used interchangeably with LoadBalancingMode,
2537
+ * this enum contains the known values that the service supports.
2538
+ * ### Known values supported by the service
2539
+ * **None** \
2540
+ * **Web** \
2541
+ * **Publishing** \
2542
+ * **Web, Publishing**
2543
+ */
2544
+ export type LoadBalancingMode = string;
2545
+ /** Known values of {@link UpgradePreference} that the service accepts. */
2546
+ export declare enum KnownUpgradePreference {
2547
+ /** No preference on when this App Service Environment will be upgraded */
2548
+ None = "None",
2549
+ /** This App Service Environment will be upgraded before others in the same region that have Upgrade Preference 'Late' */
2550
+ Early = "Early",
2551
+ /** This App Service Environment will be upgraded after others in the same region that have Upgrade Preference 'Early' */
2552
+ Late = "Late",
2553
+ /** ASEv3 only. Once an upgrade is available, this App Service Environment will wait 10 days for the upgrade to be manually initiated. After 10 days the upgrade will begin automatically */
2554
+ Manual = "Manual"
2555
+ }
2556
+ /**
2557
+ * Defines values for UpgradePreference. \
2558
+ * {@link KnownUpgradePreference} can be used interchangeably with UpgradePreference,
2559
+ * this enum contains the known values that the service supports.
2560
+ * ### Known values supported by the service
2561
+ * **None**: No preference on when this App Service Environment will be upgraded \
2562
+ * **Early**: This App Service Environment will be upgraded before others in the same region that have Upgrade Preference 'Late' \
2563
+ * **Late**: This App Service Environment will be upgraded after others in the same region that have Upgrade Preference 'Early' \
2564
+ * **Manual**: ASEv3 only. Once an upgrade is available, this App Service Environment will wait 10 days for the upgrade to be manually initiated. After 10 days the upgrade will begin automatically
2565
+ */
2566
+ export type UpgradePreference = string;
2567
+ /** Known values of {@link UpgradeAvailability} that the service accepts. */
2568
+ export declare enum KnownUpgradeAvailability {
2569
+ /** No upgrade is currently available for this App Service Environment */
2570
+ None = "None",
2571
+ /** An upgrade is ready to be manually initiated on this App Service Environment */
2572
+ Ready = "Ready"
2573
+ }
2574
+ /**
2575
+ * Defines values for UpgradeAvailability. \
2576
+ * {@link KnownUpgradeAvailability} can be used interchangeably with UpgradeAvailability,
2577
+ * this enum contains the known values that the service supports.
2578
+ * ### Known values supported by the service
2579
+ * **None**: No upgrade is currently available for this App Service Environment \
2580
+ * **Ready**: An upgrade is ready to be manually initiated on this App Service Environment
2581
+ */
2582
+ export type UpgradeAvailability = string;
2583
+ /** Known values of {@link AzureStorageProtocol} that the service accepts. */
2584
+ export declare enum KnownAzureStorageProtocol {
2585
+ /** Smb */
2586
+ Smb = "Smb",
2587
+ /** Http */
2588
+ Http = "Http",
2589
+ /** Nfs */
2590
+ Nfs = "Nfs"
2591
+ }
2592
+ /**
2593
+ * Defines values for AzureStorageProtocol. \
2594
+ * {@link KnownAzureStorageProtocol} can be used interchangeably with AzureStorageProtocol,
2595
+ * this enum contains the known values that the service supports.
2596
+ * ### Known values supported by the service
2597
+ * **Smb** \
2598
+ * **Http** \
2599
+ * **Nfs**
2600
+ */
2601
+ export type AzureStorageProtocol = string;
2602
+ /** Known values of {@link IpFilterTag} that the service accepts. */
2603
+ export declare enum KnownIpFilterTag {
2604
+ /** Default */
2605
+ Default = "Default",
2606
+ /** XffProxy */
2607
+ XffProxy = "XffProxy",
2608
+ /** ServiceTag */
2609
+ ServiceTag = "ServiceTag"
2610
+ }
2611
+ /**
2612
+ * Defines values for IpFilterTag. \
2613
+ * {@link KnownIpFilterTag} can be used interchangeably with IpFilterTag,
2614
+ * this enum contains the known values that the service supports.
2615
+ * ### Known values supported by the service
2616
+ * **Default** \
2617
+ * **XffProxy** \
2618
+ * **ServiceTag**
2619
+ */
2620
+ export type IpFilterTag = string;
2621
+ /** Known values of {@link ScmType} that the service accepts. */
2622
+ export declare enum KnownScmType {
2623
+ /** None */
2624
+ None = "None",
2625
+ /** Dropbox */
2626
+ Dropbox = "Dropbox",
2627
+ /** Tfs */
2628
+ Tfs = "Tfs",
2629
+ /** LocalGit */
2630
+ LocalGit = "LocalGit",
2631
+ /** GitHub */
2632
+ GitHub = "GitHub",
2633
+ /** CodePlexGit */
2634
+ CodePlexGit = "CodePlexGit",
2635
+ /** CodePlexHg */
2636
+ CodePlexHg = "CodePlexHg",
2637
+ /** BitbucketGit */
2638
+ BitbucketGit = "BitbucketGit",
2639
+ /** BitbucketHg */
2640
+ BitbucketHg = "BitbucketHg",
2641
+ /** ExternalGit */
2642
+ ExternalGit = "ExternalGit",
2643
+ /** ExternalHg */
2644
+ ExternalHg = "ExternalHg",
2645
+ /** OneDrive */
2646
+ OneDrive = "OneDrive",
2647
+ /** VSO */
2648
+ VSO = "VSO",
2649
+ /** Vstsrm */
2650
+ Vstsrm = "VSTSRM"
2651
+ }
2652
+ /**
2653
+ * Defines values for ScmType. \
2654
+ * {@link KnownScmType} can be used interchangeably with ScmType,
2655
+ * this enum contains the known values that the service supports.
2656
+ * ### Known values supported by the service
2657
+ * **None** \
2658
+ * **Dropbox** \
2659
+ * **Tfs** \
2660
+ * **LocalGit** \
2661
+ * **GitHub** \
2662
+ * **CodePlexGit** \
2663
+ * **CodePlexHg** \
2664
+ * **BitbucketGit** \
2665
+ * **BitbucketHg** \
2666
+ * **ExternalGit** \
2667
+ * **ExternalHg** \
2668
+ * **OneDrive** \
2669
+ * **VSO** \
2670
+ * **VSTSRM**
2671
+ */
2672
+ export type ScmType = string;
2673
+ /** Known values of {@link DefaultAction} that the service accepts. */
2674
+ export declare enum KnownDefaultAction {
2675
+ /** Allow */
2676
+ Allow = "Allow",
2677
+ /** Deny */
2678
+ Deny = "Deny"
2679
+ }
2680
+ /**
2681
+ * Defines values for DefaultAction. \
2682
+ * {@link KnownDefaultAction} can be used interchangeably with DefaultAction,
2683
+ * this enum contains the known values that the service supports.
2684
+ * ### Known values supported by the service
2685
+ * **Allow** \
2686
+ * **Deny**
2687
+ */
2688
+ export type DefaultAction = string;
2689
+ /** Known values of {@link SupportedTlsVersions} that the service accepts. */
2690
+ export declare enum KnownSupportedTlsVersions {
2691
+ /** One0 */
2692
+ One0 = "1.0",
2693
+ /** One1 */
2694
+ One1 = "1.1",
2695
+ /** One2 */
2696
+ One2 = "1.2",
2697
+ /** One3 */
2698
+ One3 = "1.3"
2699
+ }
2700
+ /**
2701
+ * Defines values for SupportedTlsVersions. \
2702
+ * {@link KnownSupportedTlsVersions} can be used interchangeably with SupportedTlsVersions,
2703
+ * this enum contains the known values that the service supports.
2704
+ * ### Known values supported by the service
2705
+ * **1.0** \
2706
+ * **1.1** \
2707
+ * **1.2** \
2708
+ * **1.3**
2709
+ */
2710
+ export type SupportedTlsVersions = string;
2711
+ /** Known values of {@link TlsCipherSuites} that the service accepts. */
2712
+ export declare enum KnownTlsCipherSuites {
2713
+ /** TLSAES256GCMSHA384 */
2714
+ TLSAES256GCMSHA384 = "TLS_AES_256_GCM_SHA384",
2715
+ /** TLSAES128GCMSHA256 */
2716
+ TLSAES128GCMSHA256 = "TLS_AES_128_GCM_SHA256",
2717
+ /** TLSEcdheEcdsaWithAES256GCMSHA384 */
2718
+ TLSEcdheEcdsaWithAES256GCMSHA384 = "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384",
2719
+ /** TLSEcdheEcdsaWithAES128CBCSHA256 */
2720
+ TLSEcdheEcdsaWithAES128CBCSHA256 = "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256",
2721
+ /** TLSEcdheEcdsaWithAES128GCMSHA256 */
2722
+ TLSEcdheEcdsaWithAES128GCMSHA256 = "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256",
2723
+ /** TLSEcdheRSAWithAES256GCMSHA384 */
2724
+ TLSEcdheRSAWithAES256GCMSHA384 = "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384",
2725
+ /** TLSEcdheRSAWithAES128GCMSHA256 */
2726
+ TLSEcdheRSAWithAES128GCMSHA256 = "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256",
2727
+ /** TLSEcdheRSAWithAES256CBCSHA384 */
2728
+ TLSEcdheRSAWithAES256CBCSHA384 = "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384",
2729
+ /** TLSEcdheRSAWithAES128CBCSHA256 */
2730
+ TLSEcdheRSAWithAES128CBCSHA256 = "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256",
2731
+ /** TLSEcdheRSAWithAES256CBCSHA */
2732
+ TLSEcdheRSAWithAES256CBCSHA = "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA",
2733
+ /** TLSEcdheRSAWithAES128CBCSHA */
2734
+ TLSEcdheRSAWithAES128CBCSHA = "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA",
2735
+ /** TLSRSAWithAES256GCMSHA384 */
2736
+ TLSRSAWithAES256GCMSHA384 = "TLS_RSA_WITH_AES_256_GCM_SHA384",
2737
+ /** TLSRSAWithAES128GCMSHA256 */
2738
+ TLSRSAWithAES128GCMSHA256 = "TLS_RSA_WITH_AES_128_GCM_SHA256",
2739
+ /** TLSRSAWithAES256CBCSHA256 */
2740
+ TLSRSAWithAES256CBCSHA256 = "TLS_RSA_WITH_AES_256_CBC_SHA256",
2741
+ /** TLSRSAWithAES128CBCSHA256 */
2742
+ TLSRSAWithAES128CBCSHA256 = "TLS_RSA_WITH_AES_128_CBC_SHA256",
2743
+ /** TLSRSAWithAES256CBCSHA */
2744
+ TLSRSAWithAES256CBCSHA = "TLS_RSA_WITH_AES_256_CBC_SHA",
2745
+ /** TLSRSAWithAES128CBCSHA */
2746
+ TLSRSAWithAES128CBCSHA = "TLS_RSA_WITH_AES_128_CBC_SHA"
2747
+ }
2748
+ /**
2749
+ * Defines values for TlsCipherSuites. \
2750
+ * {@link KnownTlsCipherSuites} can be used interchangeably with TlsCipherSuites,
2751
+ * this enum contains the known values that the service supports.
2752
+ * ### Known values supported by the service
2753
+ * **TLS_AES_256_GCM_SHA384** \
2754
+ * **TLS_AES_128_GCM_SHA256** \
2755
+ * **TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384** \
2756
+ * **TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256** \
2757
+ * **TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256** \
2758
+ * **TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384** \
2759
+ * **TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256** \
2760
+ * **TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384** \
2761
+ * **TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256** \
2762
+ * **TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA** \
2763
+ * **TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA** \
2764
+ * **TLS_RSA_WITH_AES_256_GCM_SHA384** \
2765
+ * **TLS_RSA_WITH_AES_128_GCM_SHA256** \
2766
+ * **TLS_RSA_WITH_AES_256_CBC_SHA256** \
2767
+ * **TLS_RSA_WITH_AES_128_CBC_SHA256** \
2768
+ * **TLS_RSA_WITH_AES_256_CBC_SHA** \
2769
+ * **TLS_RSA_WITH_AES_128_CBC_SHA**
2770
+ */
2771
+ export type TlsCipherSuites = string;
2772
+ /** Known values of {@link FtpsState} that the service accepts. */
2773
+ export declare enum KnownFtpsState {
2774
+ /** AllAllowed */
2775
+ AllAllowed = "AllAllowed",
2776
+ /** FtpsOnly */
2777
+ FtpsOnly = "FtpsOnly",
2778
+ /** Disabled */
2779
+ Disabled = "Disabled"
2780
+ }
2781
+ /**
2782
+ * Defines values for FtpsState. \
2783
+ * {@link KnownFtpsState} can be used interchangeably with FtpsState,
2784
+ * this enum contains the known values that the service supports.
2785
+ * ### Known values supported by the service
2786
+ * **AllAllowed** \
2787
+ * **FtpsOnly** \
2788
+ * **Disabled**
2789
+ */
2790
+ export type FtpsState = string;
2791
+ /** Known values of {@link FunctionsDeploymentStorageType} that the service accepts. */
2792
+ export declare enum KnownFunctionsDeploymentStorageType {
2793
+ /** BlobContainer */
2794
+ BlobContainer = "blobContainer"
2795
+ }
2796
+ /**
2797
+ * Defines values for FunctionsDeploymentStorageType. \
2798
+ * {@link KnownFunctionsDeploymentStorageType} can be used interchangeably with FunctionsDeploymentStorageType,
2799
+ * this enum contains the known values that the service supports.
2800
+ * ### Known values supported by the service
2801
+ * **blobContainer**
2802
+ */
2803
+ export type FunctionsDeploymentStorageType = string;
2804
+ /** Known values of {@link AuthenticationType} that the service accepts. */
2805
+ export declare enum KnownAuthenticationType {
2806
+ /** SystemAssignedIdentity */
2807
+ SystemAssignedIdentity = "SystemAssignedIdentity",
2808
+ /** UserAssignedIdentity */
2809
+ UserAssignedIdentity = "UserAssignedIdentity",
2810
+ /** StorageAccountConnectionString */
2811
+ StorageAccountConnectionString = "StorageAccountConnectionString"
2812
+ }
2813
+ /**
2814
+ * Defines values for AuthenticationType. \
2815
+ * {@link KnownAuthenticationType} can be used interchangeably with AuthenticationType,
2816
+ * this enum contains the known values that the service supports.
2817
+ * ### Known values supported by the service
2818
+ * **SystemAssignedIdentity** \
2819
+ * **UserAssignedIdentity** \
2820
+ * **StorageAccountConnectionString**
2821
+ */
2822
+ export type AuthenticationType = string;
2823
+ /** Known values of {@link RuntimeName} that the service accepts. */
2824
+ export declare enum KnownRuntimeName {
2825
+ /** DotnetIsolated */
2826
+ DotnetIsolated = "dotnet-isolated",
2827
+ /** Node */
2828
+ Node = "node",
2829
+ /** Java */
2830
+ Java = "java",
2831
+ /** Powershell */
2832
+ Powershell = "powershell",
2833
+ /** Python */
2834
+ Python = "python",
2835
+ /** Custom */
2836
+ Custom = "custom"
2837
+ }
2838
+ /**
2839
+ * Defines values for RuntimeName. \
2840
+ * {@link KnownRuntimeName} can be used interchangeably with RuntimeName,
2841
+ * this enum contains the known values that the service supports.
2842
+ * ### Known values supported by the service
2843
+ * **dotnet-isolated** \
2844
+ * **node** \
2845
+ * **java** \
2846
+ * **powershell** \
2847
+ * **python** \
2848
+ * **custom**
2849
+ */
2850
+ export type RuntimeName = string;
2851
+ /** Known values of {@link DaprLogLevel} that the service accepts. */
2852
+ export declare enum KnownDaprLogLevel {
2853
+ /** Info */
2854
+ Info = "info",
2855
+ /** Debug */
2856
+ Debug = "debug",
2857
+ /** Warn */
2858
+ Warn = "warn",
2859
+ /** Error */
2860
+ Error = "error"
2861
+ }
2862
+ /**
2863
+ * Defines values for DaprLogLevel. \
2864
+ * {@link KnownDaprLogLevel} can be used interchangeably with DaprLogLevel,
2865
+ * this enum contains the known values that the service supports.
2866
+ * ### Known values supported by the service
2867
+ * **info** \
2868
+ * **debug** \
2869
+ * **warn** \
2870
+ * **error**
2871
+ */
2872
+ export type DaprLogLevel = string;
2873
+ /** Known values of {@link RouteType} that the service accepts. */
2874
+ export declare enum KnownRouteType {
2875
+ /** Default */
2876
+ Default = "DEFAULT",
2877
+ /** Inherited */
2878
+ Inherited = "INHERITED",
2879
+ /** Static */
2880
+ Static = "STATIC"
2881
+ }
2882
+ /**
2883
+ * Defines values for RouteType. \
2884
+ * {@link KnownRouteType} can be used interchangeably with RouteType,
2885
+ * this enum contains the known values that the service supports.
2886
+ * ### Known values supported by the service
2887
+ * **DEFAULT** \
2888
+ * **INHERITED** \
2889
+ * **STATIC**
2890
+ */
2891
+ export type RouteType = string;
2892
+ /** Defines values for DomainType. */
2893
+ export type DomainType = "Regular" | "SoftDeleted";
2894
+ /** Defines values for DomainStatus. */
2895
+ export type DomainStatus = "Active" | "Awaiting" | "Cancelled" | "Confiscated" | "Disabled" | "Excluded" | "Expired" | "Failed" | "Held" | "Locked" | "Parked" | "Pending" | "Reserved" | "Reverted" | "Suspended" | "Transferred" | "Unknown" | "Unlocked" | "Unparked" | "Updated" | "JsonConverterFailed";
2896
+ /** Defines values for ProvisioningState. */
2897
+ export type ProvisioningState = "Succeeded" | "Failed" | "Canceled" | "InProgress" | "Deleting";
2898
+ /** Defines values for AzureResourceType. */
2899
+ export type AzureResourceType = "Website" | "TrafficManager";
2900
+ /** Defines values for CustomHostNameDnsRecordType. */
2901
+ export type CustomHostNameDnsRecordType = "CName" | "A";
2902
+ /** Defines values for HostNameType. */
2903
+ export type HostNameType = "Verified" | "Managed";
2904
+ /** Defines values for DnsType. */
2905
+ export type DnsType = "AzureDns" | "DefaultDomainRegistrarDns";
2906
+ /** Defines values for HostingEnvironmentStatus. */
2907
+ export type HostingEnvironmentStatus = "Preparing" | "Ready" | "Scaling" | "Deleting";
2908
+ /** Defines values for CustomDnsSuffixProvisioningState. */
2909
+ export type CustomDnsSuffixProvisioningState = "Succeeded" | "Failed" | "Degraded" | "InProgress";
2910
+ /** Defines values for StatusOptions. */
2911
+ export type StatusOptions = "Ready" | "Pending" | "Creating";
2912
+ /** Defines values for AutoHealActionType. */
2913
+ export type AutoHealActionType = "Recycle" | "LogEvent" | "CustomAction";
2914
+ /** Defines values for AzureStorageType. */
2915
+ export type AzureStorageType = "AzureFiles" | "AzureBlob";
2916
+ /** Defines values for AzureStorageState. */
2917
+ export type AzureStorageState = "Ok" | "InvalidCredentials" | "InvalidShare" | "NotValidated";
2918
+ /** Defines values for KeyVaultSecretStatus. */
2919
+ export type KeyVaultSecretStatus = "Initialized" | "WaitingOnCertificateOrder" | "Succeeded" | "CertificateOrderFailed" | "OperationNotPermittedOnKeyVault" | "AzureServiceUnauthorizedToAccessKeyVault" | "KeyVaultDoesNotExist" | "KeyVaultSecretDoesNotExist" | "UnknownError" | "ExternalPrivateKey" | "Unknown";
2920
+ /** Defines values for ConnectionStringType. */
2921
+ export type ConnectionStringType = "MySql" | "SQLServer" | "SQLAzure" | "Custom" | "NotificationHub" | "ServiceBus" | "EventHub" | "ApiHub" | "DocDb" | "RedisCache" | "PostgreSQL";
2922
+ /** Defines values for DetectorType. */
2923
+ export type DetectorType = "Detector" | "Analysis" | "CategoryOverview";
2924
+ /** Defines values for RenderingType. */
2925
+ export type RenderingType = "NoGraph" | "Table" | "TimeSeries" | "TimeSeriesPerInstance" | "PieChart" | "DataSummary" | "Email" | "Insights" | "DynamicInsight" | "Markdown" | "Detector" | "DropDown" | "Card" | "Solution" | "Guage" | "Form" | "ChangeSets" | "ChangeAnalysisOnboarding" | "ChangesView" | "AppInsight" | "DependencyGraph" | "DownTime" | "SummaryCard" | "SearchComponent" | "AppInsightEnablement";
2926
+ /** Defines values for InsightStatus. */
2927
+ export type InsightStatus = "Critical" | "Warning" | "Info" | "Success" | "None";
2928
+ /** Defines values for SslState. */
2929
+ export type SslState = "Disabled" | "SniEnabled" | "IpBasedEnabled";
2930
+ /** Defines values for HostType. */
2931
+ export type HostType = "Standard" | "Repository";
2932
+ /** Defines values for ManagedServiceIdentityType. */
2933
+ export type ManagedServiceIdentityType = "SystemAssigned" | "UserAssigned" | "SystemAssigned, UserAssigned" | "None";
2934
+ /** Defines values for OperationStatus. */
2935
+ export type OperationStatus = "InProgress" | "Failed" | "Succeeded" | "TimedOut" | "Created";
2936
+ /** Defines values for UsageState. */
2937
+ export type UsageState = "Normal" | "Exceeded";
2938
+ /** Defines values for SiteAvailabilityState. */
2939
+ export type SiteAvailabilityState = "Normal" | "Limited" | "DisasterRecoveryMode";
2940
+ /** Defines values for ManagedPipelineMode. */
2941
+ export type ManagedPipelineMode = "Integrated" | "Classic";
2942
+ /** Defines values for SiteLoadBalancing. */
2943
+ export type SiteLoadBalancing = "WeightedRoundRobin" | "LeastRequests" | "LeastResponseTime" | "WeightedTotalTraffic" | "RequestHash" | "PerSiteRoundRobin" | "LeastRequestsWithTieBreaker";
2944
+ /** Defines values for ClientCertMode. */
2945
+ export type ClientCertMode = "Required" | "Optional" | "OptionalInteractiveUser";
2946
+ /** Defines values for IPMode. */
2947
+ export type IPMode = "IPv4" | "IPv6" | "IPv4AndIPv6";
2948
+ /** Defines values for RedundancyMode. */
2949
+ export type RedundancyMode = "None" | "Manual" | "Failover" | "ActiveActive" | "GeoRedundant";
2950
+ /** Defines values for AutoGeneratedDomainNameLabelScope. */
2951
+ export type AutoGeneratedDomainNameLabelScope = "TenantReuse" | "SubscriptionReuse" | "ResourceGroupReuse" | "NoReuse";
2952
+ /** Optional parameters. */
2953
+ export interface DomainRegistrationProviderListOperationsOptionalParams extends coreClient.OperationOptions {
2954
+ }
2955
+ /** Contains response data for the listOperations operation. */
2956
+ export type DomainRegistrationProviderListOperationsResponse = CsmOperationCollection;
2957
+ /** Optional parameters. */
2958
+ export interface DomainRegistrationProviderListOperationsNextOptionalParams extends coreClient.OperationOptions {
2959
+ }
2960
+ /** Contains response data for the listOperationsNext operation. */
2961
+ export type DomainRegistrationProviderListOperationsNextResponse = CsmOperationCollection;
2962
+ /** Optional parameters. */
2963
+ export interface DomainsCheckAvailabilityOptionalParams extends coreClient.OperationOptions {
2964
+ }
2965
+ /** Contains response data for the checkAvailability operation. */
2966
+ export type DomainsCheckAvailabilityResponse = DomainAvailabilityCheckResult;
2967
+ /** Optional parameters. */
2968
+ export interface DomainsListOptionalParams extends coreClient.OperationOptions {
2969
+ }
2970
+ /** Contains response data for the list operation. */
2971
+ export type DomainsListResponse = DomainCollection;
2972
+ /** Optional parameters. */
2973
+ export interface DomainsGetControlCenterSsoRequestOptionalParams extends coreClient.OperationOptions {
2974
+ }
2975
+ /** Contains response data for the getControlCenterSsoRequest operation. */
2976
+ export type DomainsGetControlCenterSsoRequestResponse = DomainControlCenterSsoRequest;
2977
+ /** Optional parameters. */
2978
+ export interface DomainsListRecommendationsOptionalParams extends coreClient.OperationOptions {
2979
+ }
2980
+ /** Contains response data for the listRecommendations operation. */
2981
+ export type DomainsListRecommendationsResponse = NameIdentifierCollection;
2982
+ /** Optional parameters. */
2983
+ export interface DomainsListByResourceGroupOptionalParams extends coreClient.OperationOptions {
2984
+ }
2985
+ /** Contains response data for the listByResourceGroup operation. */
2986
+ export type DomainsListByResourceGroupResponse = DomainCollection;
2987
+ /** Optional parameters. */
2988
+ export interface DomainsGetOptionalParams extends coreClient.OperationOptions {
2989
+ }
2990
+ /** Contains response data for the get operation. */
2991
+ export type DomainsGetResponse = Domain;
2992
+ /** Optional parameters. */
2993
+ export interface DomainsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
2994
+ /** Delay to wait until next poll, in milliseconds. */
2995
+ updateIntervalInMs?: number;
2996
+ /** A serialized poller which can be used to resume an existing paused Long-Running-Operation. */
2997
+ resumeFrom?: string;
2998
+ }
2999
+ /** Contains response data for the createOrUpdate operation. */
3000
+ export type DomainsCreateOrUpdateResponse = Domain;
3001
+ /** Optional parameters. */
3002
+ export interface DomainsDeleteOptionalParams extends coreClient.OperationOptions {
3003
+ /** Specify <code>true</code> to delete the domain immediately. The default is <code>false</code> which deletes the domain after 24 hours. */
3004
+ forceHardDeleteDomain?: boolean;
3005
+ }
3006
+ /** Optional parameters. */
3007
+ export interface DomainsUpdateOptionalParams extends coreClient.OperationOptions {
3008
+ }
3009
+ /** Contains response data for the update operation. */
3010
+ export type DomainsUpdateResponse = Domain;
3011
+ /** Optional parameters. */
3012
+ export interface DomainsListOwnershipIdentifiersOptionalParams extends coreClient.OperationOptions {
3013
+ }
3014
+ /** Contains response data for the listOwnershipIdentifiers operation. */
3015
+ export type DomainsListOwnershipIdentifiersResponse = DomainOwnershipIdentifierCollection;
3016
+ /** Optional parameters. */
3017
+ export interface DomainsGetOwnershipIdentifierOptionalParams extends coreClient.OperationOptions {
3018
+ }
3019
+ /** Contains response data for the getOwnershipIdentifier operation. */
3020
+ export type DomainsGetOwnershipIdentifierResponse = DomainOwnershipIdentifier;
3021
+ /** Optional parameters. */
3022
+ export interface DomainsCreateOrUpdateOwnershipIdentifierOptionalParams extends coreClient.OperationOptions {
3023
+ }
3024
+ /** Contains response data for the createOrUpdateOwnershipIdentifier operation. */
3025
+ export type DomainsCreateOrUpdateOwnershipIdentifierResponse = DomainOwnershipIdentifier;
3026
+ /** Optional parameters. */
3027
+ export interface DomainsDeleteOwnershipIdentifierOptionalParams extends coreClient.OperationOptions {
3028
+ }
3029
+ /** Optional parameters. */
3030
+ export interface DomainsUpdateOwnershipIdentifierOptionalParams extends coreClient.OperationOptions {
3031
+ }
3032
+ /** Contains response data for the updateOwnershipIdentifier operation. */
3033
+ export type DomainsUpdateOwnershipIdentifierResponse = DomainOwnershipIdentifier;
3034
+ /** Optional parameters. */
3035
+ export interface DomainsRenewOptionalParams extends coreClient.OperationOptions {
3036
+ }
3037
+ /** Optional parameters. */
3038
+ export interface DomainsTransferOutOptionalParams extends coreClient.OperationOptions {
3039
+ }
3040
+ /** Contains response data for the transferOut operation. */
3041
+ export type DomainsTransferOutResponse = Domain;
3042
+ /** Optional parameters. */
3043
+ export interface DomainsListNextOptionalParams extends coreClient.OperationOptions {
3044
+ }
3045
+ /** Contains response data for the listNext operation. */
3046
+ export type DomainsListNextResponse = DomainCollection;
3047
+ /** Optional parameters. */
3048
+ export interface DomainsListRecommendationsNextOptionalParams extends coreClient.OperationOptions {
3049
+ }
3050
+ /** Contains response data for the listRecommendationsNext operation. */
3051
+ export type DomainsListRecommendationsNextResponse = NameIdentifierCollection;
3052
+ /** Optional parameters. */
3053
+ export interface DomainsListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
3054
+ }
3055
+ /** Contains response data for the listByResourceGroupNext operation. */
3056
+ export type DomainsListByResourceGroupNextResponse = DomainCollection;
3057
+ /** Optional parameters. */
3058
+ export interface DomainsListOwnershipIdentifiersNextOptionalParams extends coreClient.OperationOptions {
3059
+ }
3060
+ /** Contains response data for the listOwnershipIdentifiersNext operation. */
3061
+ export type DomainsListOwnershipIdentifiersNextResponse = DomainOwnershipIdentifierCollection;
3062
+ /** Optional parameters. */
3063
+ export interface TopLevelDomainsListOptionalParams extends coreClient.OperationOptions {
3064
+ }
3065
+ /** Contains response data for the list operation. */
3066
+ export type TopLevelDomainsListResponse = TopLevelDomainCollection;
3067
+ /** Optional parameters. */
3068
+ export interface TopLevelDomainsGetOptionalParams extends coreClient.OperationOptions {
3069
+ }
3070
+ /** Contains response data for the get operation. */
3071
+ export type TopLevelDomainsGetResponse = TopLevelDomain;
3072
+ /** Optional parameters. */
3073
+ export interface TopLevelDomainsListAgreementsOptionalParams extends coreClient.OperationOptions {
3074
+ }
3075
+ /** Contains response data for the listAgreements operation. */
3076
+ export type TopLevelDomainsListAgreementsResponse = TldLegalAgreementCollection;
3077
+ /** Optional parameters. */
3078
+ export interface TopLevelDomainsListNextOptionalParams extends coreClient.OperationOptions {
3079
+ }
3080
+ /** Contains response data for the listNext operation. */
3081
+ export type TopLevelDomainsListNextResponse = TopLevelDomainCollection;
3082
+ /** Optional parameters. */
3083
+ export interface TopLevelDomainsListAgreementsNextOptionalParams extends coreClient.OperationOptions {
3084
+ }
3085
+ /** Contains response data for the listAgreementsNext operation. */
3086
+ export type TopLevelDomainsListAgreementsNextResponse = TldLegalAgreementCollection;
3087
+ /** Optional parameters. */
3088
+ export interface DomainRegistrationManagementClientOptionalParams extends coreClient.ServiceClientOptions {
3089
+ /** server parameter */
3090
+ $host?: string;
3091
+ /** Api Version */
3092
+ apiVersion?: string;
3093
+ /** Overrides client endpoint. */
3094
+ endpoint?: string;
3095
+ }
3096
+ //# sourceMappingURL=index.d.ts.map