@azure/arm-servicefabricmesh 2.2.1 → 3.0.0-beta.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 (267) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/LICENSE +21 -0
  3. package/README.md +69 -80
  4. package/dist/index.js +5478 -0
  5. package/dist/index.js.map +1 -0
  6. package/dist/index.min.js +1 -0
  7. package/dist/index.min.js.map +1 -0
  8. package/dist-esm/src/index.d.ts +5 -0
  9. package/dist-esm/src/index.d.ts.map +1 -0
  10. package/dist-esm/src/index.js +12 -0
  11. package/dist-esm/src/index.js.map +1 -0
  12. package/dist-esm/src/models/index.d.ts +1366 -0
  13. package/dist-esm/src/models/index.d.ts.map +1 -0
  14. package/dist-esm/src/models/index.js +121 -0
  15. package/dist-esm/src/models/index.js.map +1 -0
  16. package/dist-esm/src/models/mappers.d.ts +105 -0
  17. package/dist-esm/src/models/mappers.d.ts.map +1 -0
  18. package/{esm → dist-esm/src}/models/mappers.js +1264 -1320
  19. package/dist-esm/src/models/mappers.js.map +1 -0
  20. package/dist-esm/src/models/parameters.d.ts +25 -0
  21. package/dist-esm/src/models/parameters.d.ts.map +1 -0
  22. package/{esm → dist-esm/src}/models/parameters.js +104 -62
  23. package/dist-esm/src/models/parameters.js.map +1 -0
  24. package/dist-esm/src/operations/application.d.ts +82 -0
  25. package/dist-esm/src/operations/application.d.ts.map +1 -0
  26. package/dist-esm/src/operations/application.js +340 -0
  27. package/dist-esm/src/operations/application.js.map +1 -0
  28. package/dist-esm/src/operations/codePackage.d.ts +23 -0
  29. package/dist-esm/src/operations/codePackage.d.ts.map +1 -0
  30. package/dist-esm/src/operations/codePackage.js +66 -0
  31. package/dist-esm/src/operations/codePackage.js.map +1 -0
  32. package/dist-esm/src/operations/gateway.d.ts +83 -0
  33. package/dist-esm/src/operations/gateway.d.ts.map +1 -0
  34. package/dist-esm/src/operations/gateway.js +341 -0
  35. package/dist-esm/src/operations/gateway.js.map +1 -0
  36. package/{esm → dist-esm/src}/operations/index.d.ts +0 -0
  37. package/dist-esm/src/operations/index.d.ts.map +1 -0
  38. package/{esm → dist-esm/src}/operations/index.js +3 -5
  39. package/dist-esm/src/operations/index.js.map +1 -0
  40. package/dist-esm/src/operations/network.d.ts +82 -0
  41. package/dist-esm/src/operations/network.d.ts.map +1 -0
  42. package/dist-esm/src/operations/network.js +340 -0
  43. package/dist-esm/src/operations/network.js.map +1 -0
  44. package/dist-esm/src/operations/operations.d.ts +32 -0
  45. package/dist-esm/src/operations/operations.d.ts.map +1 -0
  46. package/dist-esm/src/operations/operations.js +120 -0
  47. package/dist-esm/src/operations/operations.js.map +1 -0
  48. package/dist-esm/src/operations/secret.d.ts +81 -0
  49. package/dist-esm/src/operations/secret.d.ts.map +1 -0
  50. package/dist-esm/src/operations/secret.js +339 -0
  51. package/dist-esm/src/operations/secret.js.map +1 -0
  52. package/dist-esm/src/operations/secretValueOperations.d.ts +81 -0
  53. package/dist-esm/src/operations/secretValueOperations.d.ts.map +1 -0
  54. package/dist-esm/src/operations/secretValueOperations.js +303 -0
  55. package/dist-esm/src/operations/secretValueOperations.js.map +1 -0
  56. package/dist-esm/src/operations/service.d.ts +49 -0
  57. package/dist-esm/src/operations/service.d.ts.map +1 -0
  58. package/dist-esm/src/operations/service.js +177 -0
  59. package/dist-esm/src/operations/service.js.map +1 -0
  60. package/dist-esm/src/operations/serviceReplica.d.ts +53 -0
  61. package/dist-esm/src/operations/serviceReplica.d.ts.map +1 -0
  62. package/dist-esm/src/operations/serviceReplica.js +196 -0
  63. package/dist-esm/src/operations/serviceReplica.js.map +1 -0
  64. package/dist-esm/src/operations/volume.d.ts +81 -0
  65. package/dist-esm/src/operations/volume.d.ts.map +1 -0
  66. package/dist-esm/src/operations/volume.js +339 -0
  67. package/dist-esm/src/operations/volume.js.map +1 -0
  68. package/dist-esm/src/operationsInterfaces/application.d.ts +44 -0
  69. package/dist-esm/src/operationsInterfaces/application.d.ts.map +1 -0
  70. package/dist-esm/src/operationsInterfaces/application.js +9 -0
  71. package/dist-esm/src/operationsInterfaces/application.js.map +1 -0
  72. package/dist-esm/src/operationsInterfaces/codePackage.d.ts +15 -0
  73. package/dist-esm/src/operationsInterfaces/codePackage.d.ts.map +1 -0
  74. package/dist-esm/src/operationsInterfaces/codePackage.js +9 -0
  75. package/dist-esm/src/operationsInterfaces/codePackage.js.map +1 -0
  76. package/dist-esm/src/operationsInterfaces/gateway.d.ts +45 -0
  77. package/dist-esm/src/operationsInterfaces/gateway.d.ts.map +1 -0
  78. package/dist-esm/src/operationsInterfaces/gateway.js +9 -0
  79. package/dist-esm/src/operationsInterfaces/gateway.js.map +1 -0
  80. package/dist-esm/src/operationsInterfaces/index.d.ts +11 -0
  81. package/dist-esm/src/operationsInterfaces/index.d.ts.map +1 -0
  82. package/dist-esm/src/operationsInterfaces/index.js +18 -0
  83. package/dist-esm/src/operationsInterfaces/index.js.map +1 -0
  84. package/dist-esm/src/operationsInterfaces/network.d.ts +44 -0
  85. package/dist-esm/src/operationsInterfaces/network.d.ts.map +1 -0
  86. package/dist-esm/src/operationsInterfaces/network.js +9 -0
  87. package/dist-esm/src/operationsInterfaces/network.js.map +1 -0
  88. package/dist-esm/src/operationsInterfaces/operations.d.ts +11 -0
  89. package/dist-esm/src/operationsInterfaces/operations.d.ts.map +1 -0
  90. package/dist-esm/src/operationsInterfaces/operations.js +9 -0
  91. package/dist-esm/src/operationsInterfaces/operations.js.map +1 -0
  92. package/dist-esm/src/operationsInterfaces/secret.d.ts +43 -0
  93. package/dist-esm/src/operationsInterfaces/secret.d.ts.map +1 -0
  94. package/dist-esm/src/operationsInterfaces/secret.js +9 -0
  95. package/dist-esm/src/operationsInterfaces/secret.js.map +1 -0
  96. package/dist-esm/src/operationsInterfaces/secretValueOperations.d.ts +55 -0
  97. package/dist-esm/src/operationsInterfaces/secretValueOperations.d.ts.map +1 -0
  98. package/dist-esm/src/operationsInterfaces/secretValueOperations.js +9 -0
  99. package/dist-esm/src/operationsInterfaces/secretValueOperations.js.map +1 -0
  100. package/dist-esm/src/operationsInterfaces/service.d.ts +23 -0
  101. package/dist-esm/src/operationsInterfaces/service.d.ts.map +1 -0
  102. package/dist-esm/src/operationsInterfaces/service.js +9 -0
  103. package/dist-esm/src/operationsInterfaces/service.js.map +1 -0
  104. package/dist-esm/src/operationsInterfaces/serviceReplica.d.ts +25 -0
  105. package/dist-esm/src/operationsInterfaces/serviceReplica.d.ts.map +1 -0
  106. package/dist-esm/src/operationsInterfaces/serviceReplica.js +9 -0
  107. package/dist-esm/src/operationsInterfaces/serviceReplica.js.map +1 -0
  108. package/dist-esm/src/operationsInterfaces/volume.d.ts +43 -0
  109. package/dist-esm/src/operationsInterfaces/volume.d.ts.map +1 -0
  110. package/dist-esm/src/operationsInterfaces/volume.js +9 -0
  111. package/dist-esm/src/operationsInterfaces/volume.js.map +1 -0
  112. package/dist-esm/src/serviceFabricMeshManagementClient.d.ts +27 -0
  113. package/dist-esm/src/serviceFabricMeshManagementClient.d.ts.map +1 -0
  114. package/dist-esm/src/serviceFabricMeshManagementClient.js +60 -0
  115. package/dist-esm/src/serviceFabricMeshManagementClient.js.map +1 -0
  116. package/dist-esm/test/sampleTest.d.ts +2 -0
  117. package/dist-esm/test/sampleTest.d.ts.map +1 -0
  118. package/dist-esm/test/sampleTest.js +40 -0
  119. package/dist-esm/test/sampleTest.js.map +1 -0
  120. package/package.json +85 -26
  121. package/review/arm-servicefabricmesh.api.md +1210 -0
  122. package/rollup.config.js +184 -27
  123. package/src/index.ts +12 -0
  124. package/src/models/index.ts +1281 -2775
  125. package/src/models/mappers.ts +1315 -1344
  126. package/src/models/parameters.ts +138 -63
  127. package/src/operations/application.ts +260 -269
  128. package/src/operations/codePackage.ts +44 -60
  129. package/src/operations/gateway.ts +263 -272
  130. package/src/operations/index.ts +3 -5
  131. package/src/operations/network.ts +262 -271
  132. package/src/operations/operations.ts +87 -75
  133. package/src/operations/secret.ts +261 -271
  134. package/src/operations/secretValueOperations.ts +239 -259
  135. package/src/operations/service.ts +161 -124
  136. package/src/operations/serviceReplica.ts +177 -120
  137. package/src/operations/volume.ts +261 -271
  138. package/src/operationsInterfaces/application.ts +80 -0
  139. package/src/operationsInterfaces/codePackage.ts +33 -0
  140. package/src/operationsInterfaces/gateway.ts +81 -0
  141. package/src/operationsInterfaces/index.ts +18 -0
  142. package/src/operationsInterfaces/network.ts +80 -0
  143. package/src/operationsInterfaces/operations.ts +22 -0
  144. package/src/operationsInterfaces/secret.ts +79 -0
  145. package/src/operationsInterfaces/secretValueOperations.ts +99 -0
  146. package/src/operationsInterfaces/service.ts +46 -0
  147. package/src/operationsInterfaces/serviceReplica.ts +50 -0
  148. package/src/operationsInterfaces/volume.ts +79 -0
  149. package/src/serviceFabricMeshManagementClient.ts +102 -53
  150. package/tsconfig.json +20 -7
  151. package/types/arm-servicefabricmesh.d.ts +1940 -0
  152. package/types/tsdoc-metadata.json +11 -0
  153. package/dist/arm-servicefabricmesh.js +0 -5363
  154. package/dist/arm-servicefabricmesh.js.map +0 -1
  155. package/dist/arm-servicefabricmesh.min.js +0 -1
  156. package/dist/arm-servicefabricmesh.min.js.map +0 -1
  157. package/esm/models/applicationMappers.d.ts +0 -2
  158. package/esm/models/applicationMappers.d.ts.map +0 -1
  159. package/esm/models/applicationMappers.js +0 -11
  160. package/esm/models/applicationMappers.js.map +0 -1
  161. package/esm/models/codePackageMappers.d.ts +0 -2
  162. package/esm/models/codePackageMappers.d.ts.map +0 -1
  163. package/esm/models/codePackageMappers.js +0 -11
  164. package/esm/models/codePackageMappers.js.map +0 -1
  165. package/esm/models/gatewayMappers.d.ts +0 -2
  166. package/esm/models/gatewayMappers.d.ts.map +0 -1
  167. package/esm/models/gatewayMappers.js +0 -11
  168. package/esm/models/gatewayMappers.js.map +0 -1
  169. package/esm/models/index.d.ts +0 -2938
  170. package/esm/models/index.d.ts.map +0 -1
  171. package/esm/models/index.js +0 -10
  172. package/esm/models/index.js.map +0 -1
  173. package/esm/models/mappers.d.ts +0 -102
  174. package/esm/models/mappers.d.ts.map +0 -1
  175. package/esm/models/mappers.js.map +0 -1
  176. package/esm/models/networkMappers.d.ts +0 -2
  177. package/esm/models/networkMappers.d.ts.map +0 -1
  178. package/esm/models/networkMappers.js +0 -11
  179. package/esm/models/networkMappers.js.map +0 -1
  180. package/esm/models/operationsMappers.d.ts +0 -2
  181. package/esm/models/operationsMappers.d.ts.map +0 -1
  182. package/esm/models/operationsMappers.js +0 -11
  183. package/esm/models/operationsMappers.js.map +0 -1
  184. package/esm/models/parameters.d.ts +0 -17
  185. package/esm/models/parameters.d.ts.map +0 -1
  186. package/esm/models/parameters.js.map +0 -1
  187. package/esm/models/secretMappers.d.ts +0 -2
  188. package/esm/models/secretMappers.d.ts.map +0 -1
  189. package/esm/models/secretMappers.js +0 -11
  190. package/esm/models/secretMappers.js.map +0 -1
  191. package/esm/models/secretValueOperationsMappers.d.ts +0 -2
  192. package/esm/models/secretValueOperationsMappers.d.ts.map +0 -1
  193. package/esm/models/secretValueOperationsMappers.js +0 -11
  194. package/esm/models/secretValueOperationsMappers.js.map +0 -1
  195. package/esm/models/serviceMappers.d.ts +0 -2
  196. package/esm/models/serviceMappers.d.ts.map +0 -1
  197. package/esm/models/serviceMappers.js +0 -11
  198. package/esm/models/serviceMappers.js.map +0 -1
  199. package/esm/models/serviceReplicaMappers.d.ts +0 -2
  200. package/esm/models/serviceReplicaMappers.d.ts.map +0 -1
  201. package/esm/models/serviceReplicaMappers.js +0 -11
  202. package/esm/models/serviceReplicaMappers.js.map +0 -1
  203. package/esm/models/volumeMappers.d.ts +0 -2
  204. package/esm/models/volumeMappers.d.ts.map +0 -1
  205. package/esm/models/volumeMappers.js +0 -11
  206. package/esm/models/volumeMappers.js.map +0 -1
  207. package/esm/operations/application.d.ts +0 -162
  208. package/esm/operations/application.d.ts.map +0 -1
  209. package/esm/operations/application.js +0 -238
  210. package/esm/operations/application.js.map +0 -1
  211. package/esm/operations/codePackage.d.ts +0 -44
  212. package/esm/operations/codePackage.d.ts.map +0 -1
  213. package/esm/operations/codePackage.js +0 -65
  214. package/esm/operations/codePackage.js.map +0 -1
  215. package/esm/operations/gateway.d.ts +0 -163
  216. package/esm/operations/gateway.d.ts.map +0 -1
  217. package/esm/operations/gateway.js +0 -238
  218. package/esm/operations/gateway.js.map +0 -1
  219. package/esm/operations/index.d.ts.map +0 -1
  220. package/esm/operations/index.js.map +0 -1
  221. package/esm/operations/network.d.ts +0 -162
  222. package/esm/operations/network.d.ts.map +0 -1
  223. package/esm/operations/network.js +0 -238
  224. package/esm/operations/network.js.map +0 -1
  225. package/esm/operations/operations.d.ts +0 -48
  226. package/esm/operations/operations.d.ts.map +0 -1
  227. package/esm/operations/operations.js +0 -77
  228. package/esm/operations/operations.js.map +0 -1
  229. package/esm/operations/secret.d.ts +0 -162
  230. package/esm/operations/secret.d.ts.map +0 -1
  231. package/esm/operations/secret.js +0 -238
  232. package/esm/operations/secret.js.map +0 -1
  233. package/esm/operations/secretValueOperations.d.ts +0 -175
  234. package/esm/operations/secretValueOperations.d.ts.map +0 -1
  235. package/esm/operations/secretValueOperations.js +0 -226
  236. package/esm/operations/secretValueOperations.js.map +0 -1
  237. package/esm/operations/service.d.ts +0 -82
  238. package/esm/operations/service.d.ts.map +0 -1
  239. package/esm/operations/service.js +0 -117
  240. package/esm/operations/service.js.map +0 -1
  241. package/esm/operations/serviceReplica.d.ts +0 -88
  242. package/esm/operations/serviceReplica.d.ts.map +0 -1
  243. package/esm/operations/serviceReplica.js +0 -121
  244. package/esm/operations/serviceReplica.js.map +0 -1
  245. package/esm/operations/volume.d.ts +0 -162
  246. package/esm/operations/volume.d.ts.map +0 -1
  247. package/esm/operations/volume.js +0 -238
  248. package/esm/operations/volume.js.map +0 -1
  249. package/esm/serviceFabricMeshManagementClient.d.ts +0 -33
  250. package/esm/serviceFabricMeshManagementClient.d.ts.map +0 -1
  251. package/esm/serviceFabricMeshManagementClient.js +0 -47
  252. package/esm/serviceFabricMeshManagementClient.js.map +0 -1
  253. package/esm/serviceFabricMeshManagementClientContext.d.ts +0 -22
  254. package/esm/serviceFabricMeshManagementClientContext.d.ts.map +0 -1
  255. package/esm/serviceFabricMeshManagementClientContext.js +0 -61
  256. package/esm/serviceFabricMeshManagementClientContext.js.map +0 -1
  257. package/src/models/applicationMappers.ts +0 -76
  258. package/src/models/codePackageMappers.ts +0 -18
  259. package/src/models/gatewayMappers.ts +0 -76
  260. package/src/models/networkMappers.ts +0 -76
  261. package/src/models/operationsMappers.ts +0 -20
  262. package/src/models/secretMappers.ts +0 -76
  263. package/src/models/secretValueOperationsMappers.ts +0 -77
  264. package/src/models/serviceMappers.ts +0 -76
  265. package/src/models/serviceReplicaMappers.ts +0 -40
  266. package/src/models/volumeMappers.ts +0 -76
  267. package/src/serviceFabricMeshManagementClientContext.ts +0 -68
@@ -0,0 +1,1940 @@
1
+ import * as coreAuth from '@azure/core-auth';
2
+ import * as coreClient from '@azure/core-client';
3
+ import { PagedAsyncIterableIterator } from '@azure/core-paging';
4
+
5
+ /** Describes the horizontal auto scaling mechanism that adds or removes replicas (containers or container groups). */
6
+ export declare type AddRemoveReplicaScalingMechanism = AutoScalingMechanism & {
7
+ /** Polymorphic discriminator, which specifies the different types this object can be */
8
+ kind: "AddRemoveReplica";
9
+ /** Minimum number of containers (scale down won't be performed below this number). */
10
+ minCount: number;
11
+ /** Maximum number of containers (scale up won't be performed above this number). */
12
+ maxCount: number;
13
+ /** Each time auto scaling is performed, this number of containers will be added or removed. */
14
+ scaleIncrement: number;
15
+ };
16
+
17
+ /** Interface representing a Application. */
18
+ export declare interface Application {
19
+ /**
20
+ * Gets the information about all application resources in a given resource group. The information
21
+ * include the description and other properties of the Application.
22
+ * @param resourceGroupName Azure resource group name
23
+ * @param options The options parameters.
24
+ */
25
+ listByResourceGroup(resourceGroupName: string, options?: ApplicationListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ApplicationResourceDescription>;
26
+ /**
27
+ * Gets the information about all application resources in a given resource group. The information
28
+ * include the description and other properties of the application.
29
+ * @param options The options parameters.
30
+ */
31
+ listBySubscription(options?: ApplicationListBySubscriptionOptionalParams): PagedAsyncIterableIterator<ApplicationResourceDescription>;
32
+ /**
33
+ * Creates an application resource with the specified name, description and properties. If an
34
+ * application resource with the same name exists, then it is updated with the specified description
35
+ * and properties.
36
+ * @param resourceGroupName Azure resource group name
37
+ * @param applicationResourceName The identity of the application.
38
+ * @param applicationResourceDescription Description for creating a Application resource.
39
+ * @param options The options parameters.
40
+ */
41
+ create(resourceGroupName: string, applicationResourceName: string, applicationResourceDescription: ApplicationResourceDescription, options?: ApplicationCreateOptionalParams): Promise<ApplicationCreateResponse>;
42
+ /**
43
+ * Gets the information about the application resource with the given name. The information include the
44
+ * description and other properties of the application.
45
+ * @param resourceGroupName Azure resource group name
46
+ * @param applicationResourceName The identity of the application.
47
+ * @param options The options parameters.
48
+ */
49
+ get(resourceGroupName: string, applicationResourceName: string, options?: ApplicationGetOptionalParams): Promise<ApplicationGetResponse>;
50
+ /**
51
+ * Deletes the application resource identified by the name.
52
+ * @param resourceGroupName Azure resource group name
53
+ * @param applicationResourceName The identity of the application.
54
+ * @param options The options parameters.
55
+ */
56
+ delete(resourceGroupName: string, applicationResourceName: string, options?: ApplicationDeleteOptionalParams): Promise<void>;
57
+ }
58
+
59
+ /** Optional parameters. */
60
+ export declare interface ApplicationCreateOptionalParams extends coreClient.OperationOptions {
61
+ }
62
+
63
+ /** Contains response data for the create operation. */
64
+ export declare type ApplicationCreateResponse = ApplicationResourceDescription;
65
+
66
+ /** Optional parameters. */
67
+ export declare interface ApplicationDeleteOptionalParams extends coreClient.OperationOptions {
68
+ }
69
+
70
+ /** Optional parameters. */
71
+ export declare interface ApplicationGetOptionalParams extends coreClient.OperationOptions {
72
+ }
73
+
74
+ /** Contains response data for the get operation. */
75
+ export declare type ApplicationGetResponse = ApplicationResourceDescription;
76
+
77
+ /** Optional parameters. */
78
+ export declare interface ApplicationListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
79
+ }
80
+
81
+ /** Contains response data for the listByResourceGroupNext operation. */
82
+ export declare type ApplicationListByResourceGroupNextResponse = ApplicationResourceDescriptionList;
83
+
84
+ /** Optional parameters. */
85
+ export declare interface ApplicationListByResourceGroupOptionalParams extends coreClient.OperationOptions {
86
+ }
87
+
88
+ /** Contains response data for the listByResourceGroup operation. */
89
+ export declare type ApplicationListByResourceGroupResponse = ApplicationResourceDescriptionList;
90
+
91
+ /** Optional parameters. */
92
+ export declare interface ApplicationListBySubscriptionNextOptionalParams extends coreClient.OperationOptions {
93
+ }
94
+
95
+ /** Contains response data for the listBySubscriptionNext operation. */
96
+ export declare type ApplicationListBySubscriptionNextResponse = ApplicationResourceDescriptionList;
97
+
98
+ /** Optional parameters. */
99
+ export declare interface ApplicationListBySubscriptionOptionalParams extends coreClient.OperationOptions {
100
+ }
101
+
102
+ /** Contains response data for the listBySubscription operation. */
103
+ export declare type ApplicationListBySubscriptionResponse = ApplicationResourceDescriptionList;
104
+
105
+ /** Describes properties of a application resource. */
106
+ export declare interface ApplicationProperties {
107
+ /** User readable description of the application. */
108
+ description?: string;
109
+ /** Describes the services in the application. This property is used to create or modify services of the application. On get only the name of the service is returned. The service description can be obtained by querying for the service resource. */
110
+ services?: ServiceResourceDescription[];
111
+ /** Describes the diagnostics definition and usage for an application resource. */
112
+ diagnostics?: DiagnosticsDescription;
113
+ /** Internal - used by Visual Studio to setup the debugging session on the local development environment. */
114
+ debugParams?: string;
115
+ /**
116
+ * Names of the services in the application.
117
+ * NOTE: This property will not be serialized. It can only be populated by the server.
118
+ */
119
+ readonly serviceNames?: string[];
120
+ /**
121
+ * Status of the application.
122
+ * NOTE: This property will not be serialized. It can only be populated by the server.
123
+ */
124
+ readonly status?: ResourceStatus;
125
+ /**
126
+ * Gives additional information about the current status of the application.
127
+ * NOTE: This property will not be serialized. It can only be populated by the server.
128
+ */
129
+ readonly statusDetails?: string;
130
+ /**
131
+ * Describes the health state of an application resource.
132
+ * NOTE: This property will not be serialized. It can only be populated by the server.
133
+ */
134
+ readonly healthState?: HealthState;
135
+ /**
136
+ * When the application's health state is not 'Ok', this additional details from service fabric Health Manager for the user to know why the application is marked unhealthy.
137
+ * NOTE: This property will not be serialized. It can only be populated by the server.
138
+ */
139
+ readonly unhealthyEvaluation?: string;
140
+ }
141
+
142
+ /** This type describes an application resource. */
143
+ export declare type ApplicationResourceDescription = TrackedResource & {
144
+ /**
145
+ * State of the resource.
146
+ * NOTE: This property will not be serialized. It can only be populated by the server.
147
+ */
148
+ readonly provisioningState?: string;
149
+ /** User readable description of the application. */
150
+ description?: string;
151
+ /** Describes the services in the application. This property is used to create or modify services of the application. On get only the name of the service is returned. The service description can be obtained by querying for the service resource. */
152
+ services?: ServiceResourceDescription[];
153
+ /** Describes the diagnostics definition and usage for an application resource. */
154
+ diagnostics?: DiagnosticsDescription;
155
+ /** Internal - used by Visual Studio to setup the debugging session on the local development environment. */
156
+ debugParams?: string;
157
+ /**
158
+ * Names of the services in the application.
159
+ * NOTE: This property will not be serialized. It can only be populated by the server.
160
+ */
161
+ readonly serviceNames?: string[];
162
+ /**
163
+ * Status of the application.
164
+ * NOTE: This property will not be serialized. It can only be populated by the server.
165
+ */
166
+ readonly status?: ResourceStatus;
167
+ /**
168
+ * Gives additional information about the current status of the application.
169
+ * NOTE: This property will not be serialized. It can only be populated by the server.
170
+ */
171
+ readonly statusDetails?: string;
172
+ /**
173
+ * Describes the health state of an application resource.
174
+ * NOTE: This property will not be serialized. It can only be populated by the server.
175
+ */
176
+ readonly healthState?: HealthState;
177
+ /**
178
+ * When the application's health state is not 'Ok', this additional details from service fabric Health Manager for the user to know why the application is marked unhealthy.
179
+ * NOTE: This property will not be serialized. It can only be populated by the server.
180
+ */
181
+ readonly unhealthyEvaluation?: string;
182
+ };
183
+
184
+ /** A pageable list of application resources. */
185
+ export declare interface ApplicationResourceDescriptionList {
186
+ /** One page of the list. */
187
+ value?: ApplicationResourceDescription[];
188
+ /** URI to fetch the next page of the list. */
189
+ nextLink?: string;
190
+ }
191
+
192
+ /** This type describes properties of an application resource. */
193
+ export declare type ApplicationResourceProperties = ProvisionedResourceProperties & ApplicationProperties & {};
194
+
195
+ /** Describes a volume whose lifetime is scoped to the application's lifetime. */
196
+ export declare type ApplicationScopedVolume = VolumeReference & {
197
+ /** Describes parameters for creating application-scoped volumes. */
198
+ creationParameters: ApplicationScopedVolumeCreationParametersUnion;
199
+ };
200
+
201
+ /** Describes parameters for creating application-scoped volumes. */
202
+ export declare interface ApplicationScopedVolumeCreationParameters {
203
+ /** Polymorphic discriminator, which specifies the different types this object can be */
204
+ kind: "ServiceFabricVolumeDisk";
205
+ /** User readable description of the volume. */
206
+ description?: string;
207
+ }
208
+
209
+ /** Describes parameters for creating application-scoped volumes provided by Service Fabric Volume Disks */
210
+ export declare type ApplicationScopedVolumeCreationParametersServiceFabricVolumeDisk = ApplicationScopedVolumeCreationParameters & {
211
+ /** Polymorphic discriminator, which specifies the different types this object can be */
212
+ kind: "ServiceFabricVolumeDisk";
213
+ /** Volume size */
214
+ sizeDisk: SizeTypes;
215
+ };
216
+
217
+ export declare type ApplicationScopedVolumeCreationParametersUnion = ApplicationScopedVolumeCreationParameters | ApplicationScopedVolumeCreationParametersServiceFabricVolumeDisk;
218
+
219
+ /**
220
+ * Defines values for ApplicationScopedVolumeKind. \
221
+ * {@link KnownApplicationScopedVolumeKind} can be used interchangeably with ApplicationScopedVolumeKind,
222
+ * this enum contains the known values that the service supports.
223
+ * ### Known values supported by the service
224
+ * **ServiceFabricVolumeDisk**: Provides Service Fabric High Availability Volume Disk
225
+ */
226
+ export declare type ApplicationScopedVolumeKind = string;
227
+
228
+ /** Describes the mechanism for performing auto scaling operation. Derived classes will describe the actual mechanism. */
229
+ export declare interface AutoScalingMechanism {
230
+ /** Polymorphic discriminator, which specifies the different types this object can be */
231
+ kind: "AddRemoveReplica";
232
+ }
233
+
234
+ /**
235
+ * Defines values for AutoScalingMechanismKind. \
236
+ * {@link KnownAutoScalingMechanismKind} can be used interchangeably with AutoScalingMechanismKind,
237
+ * this enum contains the known values that the service supports.
238
+ * ### Known values supported by the service
239
+ * **AddRemoveReplica**: Indicates that scaling should be performed by adding or removing replicas.
240
+ */
241
+ export declare type AutoScalingMechanismKind = string;
242
+
243
+ export declare type AutoScalingMechanismUnion = AutoScalingMechanism | AddRemoveReplicaScalingMechanism;
244
+
245
+ /** Describes the metric that is used for triggering auto scaling operation. Derived classes will describe resources or metrics. */
246
+ export declare interface AutoScalingMetric {
247
+ /** Polymorphic discriminator, which specifies the different types this object can be */
248
+ kind: "Resource";
249
+ }
250
+
251
+ /**
252
+ * Defines values for AutoScalingMetricKind. \
253
+ * {@link KnownAutoScalingMetricKind} can be used interchangeably with AutoScalingMetricKind,
254
+ * this enum contains the known values that the service supports.
255
+ * ### Known values supported by the service
256
+ * **Resource**: Indicates that the metric is one of resources, like cpu or memory.
257
+ */
258
+ export declare type AutoScalingMetricKind = string;
259
+
260
+ export declare type AutoScalingMetricUnion = AutoScalingMetric | AutoScalingResourceMetric;
261
+
262
+ /** Describes the auto scaling policy */
263
+ export declare interface AutoScalingPolicy {
264
+ /** The name of the auto scaling policy. */
265
+ name: string;
266
+ /** Determines when auto scaling operation will be invoked. */
267
+ trigger: AutoScalingTriggerUnion;
268
+ /** The mechanism that is used to scale when auto scaling operation is invoked. */
269
+ mechanism: AutoScalingMechanismUnion;
270
+ }
271
+
272
+ /** Describes the resource that is used for triggering auto scaling. */
273
+ export declare type AutoScalingResourceMetric = AutoScalingMetric & {
274
+ /** Polymorphic discriminator, which specifies the different types this object can be */
275
+ kind: "Resource";
276
+ /** Name of the resource. */
277
+ name: AutoScalingResourceMetricName;
278
+ };
279
+
280
+ /**
281
+ * Defines values for AutoScalingResourceMetricName. \
282
+ * {@link KnownAutoScalingResourceMetricName} can be used interchangeably with AutoScalingResourceMetricName,
283
+ * this enum contains the known values that the service supports.
284
+ * ### Known values supported by the service
285
+ * **cpu**: Indicates that the resource is CPU cores. \
286
+ * **memoryInGB**: Indicates that the resource is memory in GB.
287
+ */
288
+ export declare type AutoScalingResourceMetricName = string;
289
+
290
+ /** Describes the trigger for performing auto scaling operation. */
291
+ export declare interface AutoScalingTrigger {
292
+ /** Polymorphic discriminator, which specifies the different types this object can be */
293
+ kind: "AverageLoad";
294
+ }
295
+
296
+ /**
297
+ * Defines values for AutoScalingTriggerKind. \
298
+ * {@link KnownAutoScalingTriggerKind} can be used interchangeably with AutoScalingTriggerKind,
299
+ * this enum contains the known values that the service supports.
300
+ * ### Known values supported by the service
301
+ * **AverageLoad**: Indicates that scaling should be performed based on average load of all replicas in the service.
302
+ */
303
+ export declare type AutoScalingTriggerKind = string;
304
+
305
+ export declare type AutoScalingTriggerUnion = AutoScalingTrigger | AverageLoadScalingTrigger;
306
+
307
+ /** An operation available at the listed Azure resource provider. */
308
+ export declare interface AvailableOperationDisplay {
309
+ /** Name of the operation provider. */
310
+ provider?: string;
311
+ /** Name of the resource on which the operation is available. */
312
+ resource?: string;
313
+ /** Name of the available operation. */
314
+ operation?: string;
315
+ /** Description of the available operation. */
316
+ description?: string;
317
+ }
318
+
319
+ /** Describes the average load trigger used for auto scaling. */
320
+ export declare type AverageLoadScalingTrigger = AutoScalingTrigger & {
321
+ /** Polymorphic discriminator, which specifies the different types this object can be */
322
+ kind: "AverageLoad";
323
+ /** Description of the metric that is used for scaling. */
324
+ metric: AutoScalingMetricUnion;
325
+ /** Lower load threshold (if average load is below this threshold, service will scale down). */
326
+ lowerLoadThreshold: number;
327
+ /** Upper load threshold (if average load is above this threshold, service will scale up). */
328
+ upperLoadThreshold: number;
329
+ /** Scale interval that indicates how often will this trigger be checked. */
330
+ scaleIntervalInSeconds: number;
331
+ };
332
+
333
+ /** Diagnostics settings for Geneva. */
334
+ export declare type AzureInternalMonitoringPipelineSinkDescription = DiagnosticsSinkProperties & {
335
+ /** Polymorphic discriminator, which specifies the different types this object can be */
336
+ kind: "AzureInternalMonitoringPipeline";
337
+ /** Azure Internal monitoring pipeline account. */
338
+ accountName?: string;
339
+ /** Azure Internal monitoring pipeline account namespace. */
340
+ namespace?: string;
341
+ /** Azure Internal monitoring agent configuration. */
342
+ maConfigUrl?: string;
343
+ /** Azure Internal monitoring agent fluentd configuration. */
344
+ fluentdConfigUrl?: any;
345
+ /** Azure Internal monitoring pipeline autokey associated with the certificate. */
346
+ autoKeyConfigUrl?: string;
347
+ };
348
+
349
+ /** Interface representing a CodePackage. */
350
+ export declare interface CodePackage {
351
+ /**
352
+ * Gets the logs for the container of the specified code package of the service replica.
353
+ * @param resourceGroupName Azure resource group name
354
+ * @param applicationResourceName The identity of the application.
355
+ * @param serviceResourceName The identity of the service.
356
+ * @param replicaName Service Fabric replica name.
357
+ * @param codePackageName The name of code package of the service.
358
+ * @param options The options parameters.
359
+ */
360
+ getContainerLogs(resourceGroupName: string, applicationResourceName: string, serviceResourceName: string, replicaName: string, codePackageName: string, options?: CodePackageGetContainerLogsOptionalParams): Promise<CodePackageGetContainerLogsResponse>;
361
+ }
362
+
363
+ /** Optional parameters. */
364
+ export declare interface CodePackageGetContainerLogsOptionalParams extends coreClient.OperationOptions {
365
+ /** Number of lines to show from the end of the logs. Default is 100. */
366
+ tail?: number;
367
+ }
368
+
369
+ /** Contains response data for the getContainerLogs operation. */
370
+ export declare type CodePackageGetContainerLogsResponse = ContainerLogs;
371
+
372
+ /** Describes a container and its runtime properties. */
373
+ export declare interface ContainerCodePackageProperties {
374
+ /** The name of the code package. */
375
+ name: string;
376
+ /** The Container image to use. */
377
+ image: string;
378
+ /** Image registry credential. */
379
+ imageRegistryCredential?: ImageRegistryCredential;
380
+ /** Override for the default entry point in the container. */
381
+ entrypoint?: string;
382
+ /** Command array to execute within the container in exec form. */
383
+ commands?: string[];
384
+ /** The environment variables to set in this container */
385
+ environmentVariables?: EnvironmentVariable[];
386
+ /** The settings to set in this container. The setting file path can be fetched from environment variable "Fabric_SettingPath". The path for Windows container is "C:\\secrets". The path for Linux container is "/var/secrets". */
387
+ settings?: Setting[];
388
+ /** The labels to set in this container. */
389
+ labels?: ContainerLabel[];
390
+ /** The endpoints exposed by this container. */
391
+ endpoints?: EndpointProperties[];
392
+ /** The resources required by this container. */
393
+ resources: ResourceRequirements;
394
+ /** Volumes to be attached to the container. The lifetime of these volumes is independent of the application's lifetime. */
395
+ volumeRefs?: VolumeReference[];
396
+ /** Volumes to be attached to the container. The lifetime of these volumes is scoped to the application's lifetime. */
397
+ volumes?: ApplicationScopedVolume[];
398
+ /** Reference to sinks in DiagnosticsDescription. */
399
+ diagnostics?: DiagnosticsRef;
400
+ /** A list of ReliableCollection resources used by this particular code package. Please refer to ReliableCollectionsRef for more details. */
401
+ reliableCollectionsRefs?: ReliableCollectionsRef[];
402
+ /**
403
+ * Runtime information of a container instance.
404
+ * NOTE: This property will not be serialized. It can only be populated by the server.
405
+ */
406
+ readonly instanceView?: ContainerInstanceView;
407
+ }
408
+
409
+ /** A container event. */
410
+ export declare interface ContainerEvent {
411
+ /** The name of the container event. */
412
+ name?: string;
413
+ /** The count of the event. */
414
+ count?: number;
415
+ /** Date/time of the first event. */
416
+ firstTimestamp?: string;
417
+ /** Date/time of the last event. */
418
+ lastTimestamp?: string;
419
+ /** The event message */
420
+ message?: string;
421
+ /** The event type. */
422
+ type?: string;
423
+ }
424
+
425
+ /** Runtime information of a container instance. */
426
+ export declare interface ContainerInstanceView {
427
+ /** The number of times the container has been restarted. */
428
+ restartCount?: number;
429
+ /** Current container instance state. */
430
+ currentState?: ContainerState;
431
+ /** Previous container instance state. */
432
+ previousState?: ContainerState;
433
+ /** The events of this container instance. */
434
+ events?: ContainerEvent[];
435
+ }
436
+
437
+ /** Describes a container label. */
438
+ export declare interface ContainerLabel {
439
+ /** The name of the container label. */
440
+ name: string;
441
+ /** The value of the container label. */
442
+ value: string;
443
+ }
444
+
445
+ /** Container logs. */
446
+ export declare interface ContainerLogs {
447
+ /** Container logs. */
448
+ content?: string;
449
+ }
450
+
451
+ /** The container state. */
452
+ export declare interface ContainerState {
453
+ /** The state of this container */
454
+ state?: string;
455
+ /** Date/time when the container state started. */
456
+ startTime?: Date;
457
+ /** The container exit code. */
458
+ exitCode?: string;
459
+ /** Date/time when the container state finished. */
460
+ finishTime?: Date;
461
+ /** Human-readable status of this state. */
462
+ detailStatus?: string;
463
+ }
464
+
465
+ /** Describes the diagnostics options available */
466
+ export declare interface DiagnosticsDescription {
467
+ /** List of supported sinks that can be referenced. */
468
+ sinks?: DiagnosticsSinkPropertiesUnion[];
469
+ /** Status of whether or not sinks are enabled. */
470
+ enabled?: boolean;
471
+ /** The sinks to be used if diagnostics is enabled. Sink choices can be overridden at the service and code package level. */
472
+ defaultSinkRefs?: string[];
473
+ }
474
+
475
+ /** Reference to sinks in DiagnosticsDescription. */
476
+ export declare interface DiagnosticsRef {
477
+ /** Status of whether or not sinks are enabled. */
478
+ enabled?: boolean;
479
+ /** List of sinks to be used if enabled. References the list of sinks in DiagnosticsDescription. */
480
+ sinkRefs?: string[];
481
+ }
482
+
483
+ /**
484
+ * Defines values for DiagnosticsSinkKind. \
485
+ * {@link KnownDiagnosticsSinkKind} can be used interchangeably with DiagnosticsSinkKind,
486
+ * this enum contains the known values that the service supports.
487
+ * ### Known values supported by the service
488
+ * **Invalid**: Indicates an invalid sink kind. All Service Fabric enumerations have the invalid type. \
489
+ * **AzureInternalMonitoringPipeline**: Diagnostics settings for Geneva.
490
+ */
491
+ export declare type DiagnosticsSinkKind = string;
492
+
493
+ /** Properties of a DiagnosticsSink. */
494
+ export declare interface DiagnosticsSinkProperties {
495
+ /** Polymorphic discriminator, which specifies the different types this object can be */
496
+ kind: "AzureInternalMonitoringPipeline";
497
+ /** Name of the sink. This value is referenced by DiagnosticsReferenceDescription */
498
+ name?: string;
499
+ /** A description of the sink. */
500
+ description?: string;
501
+ }
502
+
503
+ export declare type DiagnosticsSinkPropertiesUnion = DiagnosticsSinkProperties | AzureInternalMonitoringPipelineSinkDescription;
504
+
505
+ /** Describes a container endpoint. */
506
+ export declare interface EndpointProperties {
507
+ /** The name of the endpoint. */
508
+ name: string;
509
+ /** Port used by the container. */
510
+ port?: number;
511
+ }
512
+
513
+ /** Describes a reference to a service endpoint. */
514
+ export declare interface EndpointRef {
515
+ /** Name of the endpoint. */
516
+ name?: string;
517
+ }
518
+
519
+ /** Describes an environment variable for the container. */
520
+ export declare interface EnvironmentVariable {
521
+ /** The name of the environment variable. */
522
+ name?: string;
523
+ /** The value of the environment variable. */
524
+ value?: string;
525
+ }
526
+
527
+ /** Error model details information */
528
+ export declare interface ErrorDetailsModel {
529
+ code: string;
530
+ /** Error message. */
531
+ message: string;
532
+ }
533
+
534
+ /** Error model information */
535
+ export declare interface ErrorErrorModel {
536
+ code: string;
537
+ /** Error message. */
538
+ message?: string;
539
+ innerError?: string;
540
+ /** List of error message details. */
541
+ details?: ErrorDetailsModel[];
542
+ }
543
+
544
+ /** The error details. */
545
+ export declare interface ErrorModel {
546
+ /** Error model information */
547
+ error: ErrorErrorModel;
548
+ }
549
+
550
+ /** Interface representing a Gateway. */
551
+ export declare interface Gateway {
552
+ /**
553
+ * Gets the information about all gateway resources in a given resource group. The information include
554
+ * the description and other properties of the Gateway.
555
+ * @param resourceGroupName Azure resource group name
556
+ * @param options The options parameters.
557
+ */
558
+ listByResourceGroup(resourceGroupName: string, options?: GatewayListByResourceGroupOptionalParams): PagedAsyncIterableIterator<GatewayResourceDescription>;
559
+ /**
560
+ * Gets the information about all gateway resources in a given resource group. The information include
561
+ * the description and other properties of the gateway.
562
+ * @param options The options parameters.
563
+ */
564
+ listBySubscription(options?: GatewayListBySubscriptionOptionalParams): PagedAsyncIterableIterator<GatewayResourceDescription>;
565
+ /**
566
+ * Creates a gateway resource with the specified name, description and properties. If a gateway
567
+ * resource with the same name exists, then it is updated with the specified description and
568
+ * properties. Use gateway resources to create a gateway for public connectivity for services within
569
+ * your application.
570
+ * @param resourceGroupName Azure resource group name
571
+ * @param gatewayResourceName The identity of the gateway.
572
+ * @param gatewayResourceDescription Description for creating a Gateway resource.
573
+ * @param options The options parameters.
574
+ */
575
+ create(resourceGroupName: string, gatewayResourceName: string, gatewayResourceDescription: GatewayResourceDescription, options?: GatewayCreateOptionalParams): Promise<GatewayCreateResponse>;
576
+ /**
577
+ * Gets the information about the gateway resource with the given name. The information include the
578
+ * description and other properties of the gateway.
579
+ * @param resourceGroupName Azure resource group name
580
+ * @param gatewayResourceName The identity of the gateway.
581
+ * @param options The options parameters.
582
+ */
583
+ get(resourceGroupName: string, gatewayResourceName: string, options?: GatewayGetOptionalParams): Promise<GatewayGetResponse>;
584
+ /**
585
+ * Deletes the gateway resource identified by the name.
586
+ * @param resourceGroupName Azure resource group name
587
+ * @param gatewayResourceName The identity of the gateway.
588
+ * @param options The options parameters.
589
+ */
590
+ delete(resourceGroupName: string, gatewayResourceName: string, options?: GatewayDeleteOptionalParams): Promise<void>;
591
+ }
592
+
593
+ /** Optional parameters. */
594
+ export declare interface GatewayCreateOptionalParams extends coreClient.OperationOptions {
595
+ }
596
+
597
+ /** Contains response data for the create operation. */
598
+ export declare type GatewayCreateResponse = GatewayResourceDescription;
599
+
600
+ /** Optional parameters. */
601
+ export declare interface GatewayDeleteOptionalParams extends coreClient.OperationOptions {
602
+ }
603
+
604
+ /** Describes destination endpoint for routing traffic. */
605
+ export declare interface GatewayDestination {
606
+ /** Name of the service fabric Mesh application. */
607
+ applicationName: string;
608
+ /** service that contains the endpoint. */
609
+ serviceName: string;
610
+ /** name of the endpoint in the service. */
611
+ endpointName: string;
612
+ }
613
+
614
+ /** Optional parameters. */
615
+ export declare interface GatewayGetOptionalParams extends coreClient.OperationOptions {
616
+ }
617
+
618
+ /** Contains response data for the get operation. */
619
+ export declare type GatewayGetResponse = GatewayResourceDescription;
620
+
621
+ /** Optional parameters. */
622
+ export declare interface GatewayListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
623
+ }
624
+
625
+ /** Contains response data for the listByResourceGroupNext operation. */
626
+ export declare type GatewayListByResourceGroupNextResponse = GatewayResourceDescriptionList;
627
+
628
+ /** Optional parameters. */
629
+ export declare interface GatewayListByResourceGroupOptionalParams extends coreClient.OperationOptions {
630
+ }
631
+
632
+ /** Contains response data for the listByResourceGroup operation. */
633
+ export declare type GatewayListByResourceGroupResponse = GatewayResourceDescriptionList;
634
+
635
+ /** Optional parameters. */
636
+ export declare interface GatewayListBySubscriptionNextOptionalParams extends coreClient.OperationOptions {
637
+ }
638
+
639
+ /** Contains response data for the listBySubscriptionNext operation. */
640
+ export declare type GatewayListBySubscriptionNextResponse = GatewayResourceDescriptionList;
641
+
642
+ /** Optional parameters. */
643
+ export declare interface GatewayListBySubscriptionOptionalParams extends coreClient.OperationOptions {
644
+ }
645
+
646
+ /** Contains response data for the listBySubscription operation. */
647
+ export declare type GatewayListBySubscriptionResponse = GatewayResourceDescriptionList;
648
+
649
+ /** Describes properties of a gateway resource. */
650
+ export declare interface GatewayProperties {
651
+ /** User readable description of the gateway. */
652
+ description?: string;
653
+ /** Network the gateway should listen on for requests. */
654
+ sourceNetwork: NetworkRef;
655
+ /** Network that the Application is using. */
656
+ destinationNetwork: NetworkRef;
657
+ /** Configuration for tcp connectivity for this gateway. */
658
+ tcp?: TcpConfig[];
659
+ /** Configuration for http connectivity for this gateway. */
660
+ http?: HttpConfig[];
661
+ /**
662
+ * Status of the resource.
663
+ * NOTE: This property will not be serialized. It can only be populated by the server.
664
+ */
665
+ readonly status?: ResourceStatus;
666
+ /**
667
+ * Gives additional information about the current status of the gateway.
668
+ * NOTE: This property will not be serialized. It can only be populated by the server.
669
+ */
670
+ readonly statusDetails?: string;
671
+ /**
672
+ * IP address of the gateway. This is populated in the response and is ignored for incoming requests.
673
+ * NOTE: This property will not be serialized. It can only be populated by the server.
674
+ */
675
+ readonly ipAddress?: string;
676
+ }
677
+
678
+ /** This type describes a gateway resource. */
679
+ export declare type GatewayResourceDescription = TrackedResource & {
680
+ /**
681
+ * State of the resource.
682
+ * NOTE: This property will not be serialized. It can only be populated by the server.
683
+ */
684
+ readonly provisioningState?: string;
685
+ /** User readable description of the gateway. */
686
+ description?: string;
687
+ /** Network the gateway should listen on for requests. */
688
+ sourceNetwork: NetworkRef;
689
+ /** Network that the Application is using. */
690
+ destinationNetwork: NetworkRef;
691
+ /** Configuration for tcp connectivity for this gateway. */
692
+ tcp?: TcpConfig[];
693
+ /** Configuration for http connectivity for this gateway. */
694
+ http?: HttpConfig[];
695
+ /**
696
+ * Status of the resource.
697
+ * NOTE: This property will not be serialized. It can only be populated by the server.
698
+ */
699
+ readonly status?: ResourceStatus;
700
+ /**
701
+ * Gives additional information about the current status of the gateway.
702
+ * NOTE: This property will not be serialized. It can only be populated by the server.
703
+ */
704
+ readonly statusDetails?: string;
705
+ /**
706
+ * IP address of the gateway. This is populated in the response and is ignored for incoming requests.
707
+ * NOTE: This property will not be serialized. It can only be populated by the server.
708
+ */
709
+ readonly ipAddress?: string;
710
+ };
711
+
712
+ /** A pageable list of gateway resources. */
713
+ export declare interface GatewayResourceDescriptionList {
714
+ /** One page of the list. */
715
+ value?: GatewayResourceDescription[];
716
+ /** URI to fetch the next page of the list. */
717
+ nextLink?: string;
718
+ }
719
+
720
+ /** This type describes properties of a gateway resource. */
721
+ export declare type GatewayResourceProperties = ProvisionedResourceProperties & GatewayProperties & {};
722
+
723
+ /**
724
+ * Defines values for HeaderMatchType. \
725
+ * {@link KnownHeaderMatchType} can be used interchangeably with HeaderMatchType,
726
+ * this enum contains the known values that the service supports.
727
+ * ### Known values supported by the service
728
+ * **exact**
729
+ */
730
+ export declare type HeaderMatchType = string;
731
+
732
+ /**
733
+ * Defines values for HealthState. \
734
+ * {@link KnownHealthState} can be used interchangeably with HealthState,
735
+ * this enum contains the known values that the service supports.
736
+ * ### Known values supported by the service
737
+ * **Invalid**: Indicates an invalid health state. All Service Fabric enumerations have the invalid type. The value is zero. \
738
+ * **Ok**: Indicates the health state is okay. The value is 1. \
739
+ * **Warning**: Indicates the health state is at a warning level. The value is 2. \
740
+ * **Error**: Indicates the health state is at an error level. Error health state should be investigated, as they can impact the correct functionality of the cluster. The value is 3. \
741
+ * **Unknown**: Indicates an unknown health status. The value is 65535.
742
+ */
743
+ export declare type HealthState = string;
744
+
745
+ /** Describes the http configuration for external connectivity for this network. */
746
+ export declare interface HttpConfig {
747
+ /** http gateway config name. */
748
+ name: string;
749
+ /** Specifies the port at which the service endpoint below needs to be exposed. */
750
+ port: number;
751
+ /** description for routing. */
752
+ hosts: HttpHostConfig[];
753
+ }
754
+
755
+ /** Describes the hostname properties for http routing. */
756
+ export declare interface HttpHostConfig {
757
+ /** http hostname config name. */
758
+ name: string;
759
+ /** Route information to use for routing. Routes are processed in the order they are specified. Specify routes that are more specific before routes that can handle general cases. */
760
+ routes: HttpRouteConfig[];
761
+ }
762
+
763
+ /** Describes the hostname properties for http routing. */
764
+ export declare interface HttpRouteConfig {
765
+ /** http route name. */
766
+ name: string;
767
+ /** Describes a rule for http route matching. */
768
+ match: HttpRouteMatchRule;
769
+ /** Describes destination endpoint for routing traffic. */
770
+ destination: GatewayDestination;
771
+ }
772
+
773
+ /** Describes header information for http route matching. */
774
+ export declare interface HttpRouteMatchHeader {
775
+ /** Name of header to match in request. */
776
+ name: string;
777
+ /** Value of header to match in request. */
778
+ value?: string;
779
+ /** how to match header value */
780
+ type?: HeaderMatchType;
781
+ }
782
+
783
+ /** Path to match for routing. */
784
+ export declare interface HttpRouteMatchPath {
785
+ /** Uri path to match for request. */
786
+ value: string;
787
+ /** replacement string for matched part of the Uri. */
788
+ rewrite?: string;
789
+ /** how to match value in the Uri */
790
+ type: PathMatchType;
791
+ }
792
+
793
+ /** Describes a rule for http route matching. */
794
+ export declare interface HttpRouteMatchRule {
795
+ /** Path to match for routing. */
796
+ path: HttpRouteMatchPath;
797
+ /** headers and their values to match in request. */
798
+ headers?: HttpRouteMatchHeader[];
799
+ }
800
+
801
+ /** Image registry credential. */
802
+ export declare interface ImageRegistryCredential {
803
+ /** Docker image registry server, without protocol such as `http` and `https`. */
804
+ server: string;
805
+ /** The username for the private registry. */
806
+ username: string;
807
+ /** The password for the private registry. The password is required for create or update operations, however it is not returned in the get or list operations. */
808
+ password?: string;
809
+ }
810
+
811
+ /** Describes the properties of a secret resource whose value is provided explicitly as plaintext. The secret resource may have multiple values, each being uniquely versioned. The secret value of each version is stored encrypted, and delivered as plaintext into the context of applications referencing it. */
812
+ export declare type InlinedValueSecretResourceProperties = SecretResourceProperties & {};
813
+
814
+ /** Known values of {@link ApplicationScopedVolumeKind} that the service accepts. */
815
+ export declare enum KnownApplicationScopedVolumeKind {
816
+ /** Provides Service Fabric High Availability Volume Disk */
817
+ ServiceFabricVolumeDisk = "ServiceFabricVolumeDisk"
818
+ }
819
+
820
+ /** Known values of {@link AutoScalingMechanismKind} that the service accepts. */
821
+ export declare enum KnownAutoScalingMechanismKind {
822
+ /** Indicates that scaling should be performed by adding or removing replicas. */
823
+ AddRemoveReplica = "AddRemoveReplica"
824
+ }
825
+
826
+ /** Known values of {@link AutoScalingMetricKind} that the service accepts. */
827
+ export declare enum KnownAutoScalingMetricKind {
828
+ /** Indicates that the metric is one of resources, like cpu or memory. */
829
+ Resource = "Resource"
830
+ }
831
+
832
+ /** Known values of {@link AutoScalingResourceMetricName} that the service accepts. */
833
+ export declare enum KnownAutoScalingResourceMetricName {
834
+ /** Indicates that the resource is CPU cores. */
835
+ Cpu = "cpu",
836
+ /** Indicates that the resource is memory in GB. */
837
+ MemoryInGB = "memoryInGB"
838
+ }
839
+
840
+ /** Known values of {@link AutoScalingTriggerKind} that the service accepts. */
841
+ export declare enum KnownAutoScalingTriggerKind {
842
+ /** Indicates that scaling should be performed based on average load of all replicas in the service. */
843
+ AverageLoad = "AverageLoad"
844
+ }
845
+
846
+ /** Known values of {@link DiagnosticsSinkKind} that the service accepts. */
847
+ export declare enum KnownDiagnosticsSinkKind {
848
+ /** Indicates an invalid sink kind. All Service Fabric enumerations have the invalid type. */
849
+ Invalid = "Invalid",
850
+ /** Diagnostics settings for Geneva. */
851
+ AzureInternalMonitoringPipeline = "AzureInternalMonitoringPipeline"
852
+ }
853
+
854
+ /** Known values of {@link HeaderMatchType} that the service accepts. */
855
+ export declare enum KnownHeaderMatchType {
856
+ Exact = "exact"
857
+ }
858
+
859
+ /** Known values of {@link HealthState} that the service accepts. */
860
+ export declare enum KnownHealthState {
861
+ /** Indicates an invalid health state. All Service Fabric enumerations have the invalid type. The value is zero. */
862
+ Invalid = "Invalid",
863
+ /** Indicates the health state is okay. The value is 1. */
864
+ Ok = "Ok",
865
+ /** Indicates the health state is at a warning level. The value is 2. */
866
+ Warning = "Warning",
867
+ /** Indicates the health state is at an error level. Error health state should be investigated, as they can impact the correct functionality of the cluster. The value is 3. */
868
+ Error = "Error",
869
+ /** Indicates an unknown health status. The value is 65535. */
870
+ Unknown = "Unknown"
871
+ }
872
+
873
+ /** Known values of {@link NetworkKind} that the service accepts. */
874
+ export declare enum KnownNetworkKind {
875
+ /** Indicates a container network local to a single Service Fabric cluster. The value is 1. */
876
+ Local = "Local"
877
+ }
878
+
879
+ /** Known values of {@link OperatingSystemType} that the service accepts. */
880
+ export declare enum KnownOperatingSystemType {
881
+ /** The required operating system is Linux. */
882
+ Linux = "Linux",
883
+ /** The required operating system is Windows. */
884
+ Windows = "Windows"
885
+ }
886
+
887
+ /** Known values of {@link PathMatchType} that the service accepts. */
888
+ export declare enum KnownPathMatchType {
889
+ Prefix = "prefix"
890
+ }
891
+
892
+ /** Known values of {@link ResourceStatus} that the service accepts. */
893
+ export declare enum KnownResourceStatus {
894
+ /** Indicates the resource status is unknown. The value is zero. */
895
+ Unknown = "Unknown",
896
+ /** Indicates the resource is ready. The value is 1. */
897
+ Ready = "Ready",
898
+ /** Indicates the resource is upgrading. The value is 2. */
899
+ Upgrading = "Upgrading",
900
+ /** Indicates the resource is being created. The value is 3. */
901
+ Creating = "Creating",
902
+ /** Indicates the resource is being deleted. The value is 4. */
903
+ Deleting = "Deleting",
904
+ /** Indicates the resource is not functional due to persistent failures. See statusDetails property for more details. The value is 5. */
905
+ Failed = "Failed"
906
+ }
907
+
908
+ /** Known values of {@link SecretKind} that the service accepts. */
909
+ export declare enum KnownSecretKind {
910
+ /** A simple secret resource whose plaintext value is provided by the user. */
911
+ InlinedValue = "inlinedValue"
912
+ }
913
+
914
+ /** Known values of {@link SizeTypes} that the service accepts. */
915
+ export declare enum KnownSizeTypes {
916
+ Small = "Small",
917
+ Medium = "Medium",
918
+ Large = "Large"
919
+ }
920
+
921
+ /** Known values of {@link VolumeProvider} that the service accepts. */
922
+ export declare enum KnownVolumeProvider {
923
+ /** Provides volumes that are backed by Azure Files. */
924
+ SFAzureFile = "SFAzureFile"
925
+ }
926
+
927
+ /** Information about a Service Fabric container network local to a single Service Fabric cluster. */
928
+ export declare type LocalNetworkResourceProperties = NetworkResourceProperties & {
929
+ /** Address space for the local container network. */
930
+ networkAddressPrefix?: string;
931
+ };
932
+
933
+ /** The resource model definition for Azure Resource Manager proxy resource. It will have everything other than required location and tags. This proxy resource is explicitly created or updated by including it in the parent resource. */
934
+ export declare interface ManagedProxyResource {
935
+ /**
936
+ * Fully qualified identifier for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
937
+ * NOTE: This property will not be serialized. It can only be populated by the server.
938
+ */
939
+ readonly id?: string;
940
+ /** The name of the resource */
941
+ name?: string;
942
+ /**
943
+ * The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
944
+ * NOTE: This property will not be serialized. It can only be populated by the server.
945
+ */
946
+ readonly type?: string;
947
+ }
948
+
949
+ /** Interface representing a Network. */
950
+ export declare interface Network {
951
+ /**
952
+ * Gets the information about all network resources in a given resource group. The information include
953
+ * the description and other properties of the Network.
954
+ * @param resourceGroupName Azure resource group name
955
+ * @param options The options parameters.
956
+ */
957
+ listByResourceGroup(resourceGroupName: string, options?: NetworkListByResourceGroupOptionalParams): PagedAsyncIterableIterator<NetworkResourceDescription>;
958
+ /**
959
+ * Gets the information about all network resources in a given resource group. The information include
960
+ * the description and other properties of the network.
961
+ * @param options The options parameters.
962
+ */
963
+ listBySubscription(options?: NetworkListBySubscriptionOptionalParams): PagedAsyncIterableIterator<NetworkResourceDescription>;
964
+ /**
965
+ * Creates a network resource with the specified name, description and properties. If a network
966
+ * resource with the same name exists, then it is updated with the specified description and
967
+ * properties.
968
+ * @param resourceGroupName Azure resource group name
969
+ * @param networkResourceName The identity of the network.
970
+ * @param networkResourceDescription Description for creating a Network resource.
971
+ * @param options The options parameters.
972
+ */
973
+ create(resourceGroupName: string, networkResourceName: string, networkResourceDescription: NetworkResourceDescription, options?: NetworkCreateOptionalParams): Promise<NetworkCreateResponse>;
974
+ /**
975
+ * Gets the information about the network resource with the given name. The information include the
976
+ * description and other properties of the network.
977
+ * @param resourceGroupName Azure resource group name
978
+ * @param networkResourceName The identity of the network.
979
+ * @param options The options parameters.
980
+ */
981
+ get(resourceGroupName: string, networkResourceName: string, options?: NetworkGetOptionalParams): Promise<NetworkGetResponse>;
982
+ /**
983
+ * Deletes the network resource identified by the name.
984
+ * @param resourceGroupName Azure resource group name
985
+ * @param networkResourceName The identity of the network.
986
+ * @param options The options parameters.
987
+ */
988
+ delete(resourceGroupName: string, networkResourceName: string, options?: NetworkDeleteOptionalParams): Promise<void>;
989
+ }
990
+
991
+ /** Optional parameters. */
992
+ export declare interface NetworkCreateOptionalParams extends coreClient.OperationOptions {
993
+ }
994
+
995
+ /** Contains response data for the create operation. */
996
+ export declare type NetworkCreateResponse = NetworkResourceDescription;
997
+
998
+ /** Optional parameters. */
999
+ export declare interface NetworkDeleteOptionalParams extends coreClient.OperationOptions {
1000
+ }
1001
+
1002
+ /** Optional parameters. */
1003
+ export declare interface NetworkGetOptionalParams extends coreClient.OperationOptions {
1004
+ }
1005
+
1006
+ /** Contains response data for the get operation. */
1007
+ export declare type NetworkGetResponse = NetworkResourceDescription;
1008
+
1009
+ /**
1010
+ * Defines values for NetworkKind. \
1011
+ * {@link KnownNetworkKind} can be used interchangeably with NetworkKind,
1012
+ * this enum contains the known values that the service supports.
1013
+ * ### Known values supported by the service
1014
+ * **Local**: Indicates a container network local to a single Service Fabric cluster. The value is 1.
1015
+ */
1016
+ export declare type NetworkKind = string;
1017
+
1018
+ /** Optional parameters. */
1019
+ export declare interface NetworkListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
1020
+ }
1021
+
1022
+ /** Contains response data for the listByResourceGroupNext operation. */
1023
+ export declare type NetworkListByResourceGroupNextResponse = NetworkResourceDescriptionList;
1024
+
1025
+ /** Optional parameters. */
1026
+ export declare interface NetworkListByResourceGroupOptionalParams extends coreClient.OperationOptions {
1027
+ }
1028
+
1029
+ /** Contains response data for the listByResourceGroup operation. */
1030
+ export declare type NetworkListByResourceGroupResponse = NetworkResourceDescriptionList;
1031
+
1032
+ /** Optional parameters. */
1033
+ export declare interface NetworkListBySubscriptionNextOptionalParams extends coreClient.OperationOptions {
1034
+ }
1035
+
1036
+ /** Contains response data for the listBySubscriptionNext operation. */
1037
+ export declare type NetworkListBySubscriptionNextResponse = NetworkResourceDescriptionList;
1038
+
1039
+ /** Optional parameters. */
1040
+ export declare interface NetworkListBySubscriptionOptionalParams extends coreClient.OperationOptions {
1041
+ }
1042
+
1043
+ /** Contains response data for the listBySubscription operation. */
1044
+ export declare type NetworkListBySubscriptionResponse = NetworkResourceDescriptionList;
1045
+
1046
+ /** Describes a network reference in a service. */
1047
+ export declare interface NetworkRef {
1048
+ /** Name of the network */
1049
+ name?: string;
1050
+ /** A list of endpoints that are exposed on this network. */
1051
+ endpointRefs?: EndpointRef[];
1052
+ }
1053
+
1054
+ /** This type describes a network resource. */
1055
+ export declare type NetworkResourceDescription = TrackedResource & {
1056
+ /** Describes properties of a network resource. */
1057
+ properties: NetworkResourcePropertiesUnion;
1058
+ };
1059
+
1060
+ /** A pageable list of network resources. */
1061
+ export declare interface NetworkResourceDescriptionList {
1062
+ /** One page of the list. */
1063
+ value?: NetworkResourceDescription[];
1064
+ /** URI to fetch the next page of the list. */
1065
+ nextLink?: string;
1066
+ }
1067
+
1068
+ /** Describes properties of a network resource. */
1069
+ export declare type NetworkResourceProperties = NetworkResourcePropertiesBase & {
1070
+ /** User readable description of the network. */
1071
+ description?: string;
1072
+ /**
1073
+ * Status of the network.
1074
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1075
+ */
1076
+ readonly status?: ResourceStatus;
1077
+ /**
1078
+ * Gives additional information about the current status of the network.
1079
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1080
+ */
1081
+ readonly statusDetails?: string;
1082
+ };
1083
+
1084
+ /** This type describes the properties of a network resource, including its kind. */
1085
+ export declare type NetworkResourcePropertiesBase = ProvisionedResourceProperties & {
1086
+ /** The type of a Service Fabric container network. */
1087
+ kind: NetworkKind;
1088
+ };
1089
+
1090
+ export declare type NetworkResourcePropertiesBaseUnion = NetworkResourcePropertiesBase | NetworkResourcePropertiesUnion;
1091
+
1092
+ export declare type NetworkResourcePropertiesUnion = NetworkResourceProperties | LocalNetworkResourceProperties;
1093
+
1094
+ /**
1095
+ * Defines values for OperatingSystemType. \
1096
+ * {@link KnownOperatingSystemType} can be used interchangeably with OperatingSystemType,
1097
+ * this enum contains the known values that the service supports.
1098
+ * ### Known values supported by the service
1099
+ * **Linux**: The required operating system is Linux. \
1100
+ * **Windows**: The required operating system is Windows.
1101
+ */
1102
+ export declare type OperatingSystemType = string;
1103
+
1104
+ /** Describes the result of the request to list Service Fabric operations. */
1105
+ export declare interface OperationListResult {
1106
+ /** List of Service Fabric operations supported by the Microsoft.ServiceFabric resource provider. */
1107
+ value?: OperationResult[];
1108
+ /**
1109
+ * URL to get the next set of operation list results if there are any.
1110
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1111
+ */
1112
+ readonly nextLink?: string;
1113
+ }
1114
+
1115
+ /** List of operations available at the listed Azure resource provider. */
1116
+ export declare interface OperationResult {
1117
+ /** The name of the operation. */
1118
+ name?: string;
1119
+ /** The object that represents the operation. */
1120
+ display?: AvailableOperationDisplay;
1121
+ /** Origin result */
1122
+ origin?: string;
1123
+ /** The URL to use for getting the next set of results. */
1124
+ nextLink?: string;
1125
+ }
1126
+
1127
+ /** Interface representing a Operations. */
1128
+ export declare interface Operations {
1129
+ /**
1130
+ * Lists all the available operations provided by Service Fabric SeaBreeze resource provider.
1131
+ * @param options The options parameters.
1132
+ */
1133
+ list(options?: OperationsListOptionalParams): PagedAsyncIterableIterator<OperationResult>;
1134
+ }
1135
+
1136
+ /** Optional parameters. */
1137
+ export declare interface OperationsListNextOptionalParams extends coreClient.OperationOptions {
1138
+ }
1139
+
1140
+ /** Contains response data for the listNext operation. */
1141
+ export declare type OperationsListNextResponse = OperationListResult;
1142
+
1143
+ /** Optional parameters. */
1144
+ export declare interface OperationsListOptionalParams extends coreClient.OperationOptions {
1145
+ }
1146
+
1147
+ /** Contains response data for the list operation. */
1148
+ export declare type OperationsListResponse = OperationListResult;
1149
+
1150
+ /**
1151
+ * Defines values for PathMatchType. \
1152
+ * {@link KnownPathMatchType} can be used interchangeably with PathMatchType,
1153
+ * this enum contains the known values that the service supports.
1154
+ * ### Known values supported by the service
1155
+ * **prefix**
1156
+ */
1157
+ export declare type PathMatchType = string;
1158
+
1159
+ /** Describes common properties of a provisioned resource. */
1160
+ export declare interface ProvisionedResourceProperties {
1161
+ /**
1162
+ * State of the resource.
1163
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1164
+ */
1165
+ readonly provisioningState?: string;
1166
+ }
1167
+
1168
+ /** The resource model definition for Azure Resource Manager proxy resource. It will have everything other than required location and tags. */
1169
+ export declare type ProxyResource = Resource & {};
1170
+
1171
+ /** Specifying this parameter adds support for reliable collections */
1172
+ export declare interface ReliableCollectionsRef {
1173
+ /** Name of ReliableCollection resource. Right now it's not used and you can use any string. */
1174
+ name: string;
1175
+ /** False (the default) if ReliableCollections state is persisted to disk as usual. True if you do not want to persist state, in which case replication is still enabled and you can use ReliableCollections as distributed cache. */
1176
+ doNotPersistState?: boolean;
1177
+ }
1178
+
1179
+ /** The resource model definition for Azure Resource Manager resource. */
1180
+ export declare interface Resource {
1181
+ /**
1182
+ * Fully qualified identifier for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
1183
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1184
+ */
1185
+ readonly id?: string;
1186
+ /**
1187
+ * The name of the resource
1188
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1189
+ */
1190
+ readonly name?: string;
1191
+ /**
1192
+ * The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
1193
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1194
+ */
1195
+ readonly type?: string;
1196
+ }
1197
+
1198
+ /** This type describes the resource limits for a given container. It describes the most amount of resources a container is allowed to use before being restarted. */
1199
+ export declare interface ResourceLimits {
1200
+ /** The memory limit in GB. */
1201
+ memoryInGB?: number;
1202
+ /** CPU limits in cores. At present, only full cores are supported. */
1203
+ cpu?: number;
1204
+ }
1205
+
1206
+ /** This type describes the requested resources for a given container. It describes the least amount of resources required for the container. A container can consume more than requested resources up to the specified limits before being restarted. Currently, the requested resources are treated as limits. */
1207
+ export declare interface ResourceRequests {
1208
+ /** The memory request in GB for this container. */
1209
+ memoryInGB: number;
1210
+ /** Requested number of CPU cores. At present, only full cores are supported. */
1211
+ cpu: number;
1212
+ }
1213
+
1214
+ /** This type describes the resource requirements for a container or a service. */
1215
+ export declare interface ResourceRequirements {
1216
+ /** Describes the requested resources for a given container. */
1217
+ requests: ResourceRequests;
1218
+ /** Describes the maximum limits on the resources for a given container. */
1219
+ limits?: ResourceLimits;
1220
+ }
1221
+
1222
+ /**
1223
+ * Defines values for ResourceStatus. \
1224
+ * {@link KnownResourceStatus} can be used interchangeably with ResourceStatus,
1225
+ * this enum contains the known values that the service supports.
1226
+ * ### Known values supported by the service
1227
+ * **Unknown**: Indicates the resource status is unknown. The value is zero. \
1228
+ * **Ready**: Indicates the resource is ready. The value is 1. \
1229
+ * **Upgrading**: Indicates the resource is upgrading. The value is 2. \
1230
+ * **Creating**: Indicates the resource is being created. The value is 3. \
1231
+ * **Deleting**: Indicates the resource is being deleted. The value is 4. \
1232
+ * **Failed**: Indicates the resource is not functional due to persistent failures. See statusDetails property for more details. The value is 5.
1233
+ */
1234
+ export declare type ResourceStatus = string;
1235
+
1236
+ /** Interface representing a Secret. */
1237
+ export declare interface Secret {
1238
+ /**
1239
+ * Gets the information about all secret resources in a given resource group. The information include
1240
+ * the description and other properties of the Secret.
1241
+ * @param resourceGroupName Azure resource group name
1242
+ * @param options The options parameters.
1243
+ */
1244
+ listByResourceGroup(resourceGroupName: string, options?: SecretListByResourceGroupOptionalParams): PagedAsyncIterableIterator<SecretResourceDescription>;
1245
+ /**
1246
+ * Gets the information about all secret resources in a given resource group. The information include
1247
+ * the description and other properties of the secret.
1248
+ * @param options The options parameters.
1249
+ */
1250
+ listBySubscription(options?: SecretListBySubscriptionOptionalParams): PagedAsyncIterableIterator<SecretResourceDescription>;
1251
+ /**
1252
+ * Creates a secret resource with the specified name, description and properties. If a secret resource
1253
+ * with the same name exists, then it is updated with the specified description and properties.
1254
+ * @param resourceGroupName Azure resource group name
1255
+ * @param secretResourceName The name of the secret resource.
1256
+ * @param secretResourceDescription Description for creating a secret resource.
1257
+ * @param options The options parameters.
1258
+ */
1259
+ create(resourceGroupName: string, secretResourceName: string, secretResourceDescription: SecretResourceDescription, options?: SecretCreateOptionalParams): Promise<SecretCreateResponse>;
1260
+ /**
1261
+ * Gets the information about the secret resource with the given name. The information include the
1262
+ * description and other properties of the secret.
1263
+ * @param resourceGroupName Azure resource group name
1264
+ * @param secretResourceName The name of the secret resource.
1265
+ * @param options The options parameters.
1266
+ */
1267
+ get(resourceGroupName: string, secretResourceName: string, options?: SecretGetOptionalParams): Promise<SecretGetResponse>;
1268
+ /**
1269
+ * Deletes the secret resource identified by the name.
1270
+ * @param resourceGroupName Azure resource group name
1271
+ * @param secretResourceName The name of the secret resource.
1272
+ * @param options The options parameters.
1273
+ */
1274
+ delete(resourceGroupName: string, secretResourceName: string, options?: SecretDeleteOptionalParams): Promise<void>;
1275
+ }
1276
+
1277
+ /** Optional parameters. */
1278
+ export declare interface SecretCreateOptionalParams extends coreClient.OperationOptions {
1279
+ }
1280
+
1281
+ /** Contains response data for the create operation. */
1282
+ export declare type SecretCreateResponse = SecretResourceDescription;
1283
+
1284
+ /** Optional parameters. */
1285
+ export declare interface SecretDeleteOptionalParams extends coreClient.OperationOptions {
1286
+ }
1287
+
1288
+ /** Optional parameters. */
1289
+ export declare interface SecretGetOptionalParams extends coreClient.OperationOptions {
1290
+ }
1291
+
1292
+ /** Contains response data for the get operation. */
1293
+ export declare type SecretGetResponse = SecretResourceDescription;
1294
+
1295
+ /**
1296
+ * Defines values for SecretKind. \
1297
+ * {@link KnownSecretKind} can be used interchangeably with SecretKind,
1298
+ * this enum contains the known values that the service supports.
1299
+ * ### Known values supported by the service
1300
+ * **inlinedValue**: A simple secret resource whose plaintext value is provided by the user.
1301
+ */
1302
+ export declare type SecretKind = string;
1303
+
1304
+ /** Optional parameters. */
1305
+ export declare interface SecretListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
1306
+ }
1307
+
1308
+ /** Contains response data for the listByResourceGroupNext operation. */
1309
+ export declare type SecretListByResourceGroupNextResponse = SecretResourceDescriptionList;
1310
+
1311
+ /** Optional parameters. */
1312
+ export declare interface SecretListByResourceGroupOptionalParams extends coreClient.OperationOptions {
1313
+ }
1314
+
1315
+ /** Contains response data for the listByResourceGroup operation. */
1316
+ export declare type SecretListByResourceGroupResponse = SecretResourceDescriptionList;
1317
+
1318
+ /** Optional parameters. */
1319
+ export declare interface SecretListBySubscriptionNextOptionalParams extends coreClient.OperationOptions {
1320
+ }
1321
+
1322
+ /** Contains response data for the listBySubscriptionNext operation. */
1323
+ export declare type SecretListBySubscriptionNextResponse = SecretResourceDescriptionList;
1324
+
1325
+ /** Optional parameters. */
1326
+ export declare interface SecretListBySubscriptionOptionalParams extends coreClient.OperationOptions {
1327
+ }
1328
+
1329
+ /** Contains response data for the listBySubscription operation. */
1330
+ export declare type SecretListBySubscriptionResponse = SecretResourceDescriptionList;
1331
+
1332
+ /** This type describes a secret resource. */
1333
+ export declare type SecretResourceDescription = TrackedResource & {
1334
+ /** Describes the properties of a secret resource. */
1335
+ properties: SecretResourcePropertiesUnion;
1336
+ };
1337
+
1338
+ /** A pageable list of secret resources. */
1339
+ export declare interface SecretResourceDescriptionList {
1340
+ /** One page of the list. */
1341
+ value?: SecretResourceDescription[];
1342
+ /** URI to fetch the next page of the list. */
1343
+ nextLink?: string;
1344
+ }
1345
+
1346
+ /** Describes the properties of a secret resource. */
1347
+ export declare type SecretResourceProperties = SecretResourcePropertiesBase & {
1348
+ /** User readable description of the secret. */
1349
+ description?: string;
1350
+ /**
1351
+ * Status of the resource.
1352
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1353
+ */
1354
+ readonly status?: ResourceStatus;
1355
+ /**
1356
+ * Gives additional information about the current status of the secret.
1357
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1358
+ */
1359
+ readonly statusDetails?: string;
1360
+ /** The type of the content stored in the secret value. The value of this property is opaque to Service Fabric. Once set, the value of this property cannot be changed. */
1361
+ contentType?: string;
1362
+ };
1363
+
1364
+ /** This type describes the properties of a secret resource, including its kind. */
1365
+ export declare type SecretResourcePropertiesBase = ProvisionedResourceProperties & {
1366
+ /** Describes the kind of secret. */
1367
+ kind: SecretKind;
1368
+ };
1369
+
1370
+ export declare type SecretResourcePropertiesBaseUnion = SecretResourcePropertiesBase | SecretResourcePropertiesUnion;
1371
+
1372
+ export declare type SecretResourcePropertiesUnion = SecretResourceProperties | InlinedValueSecretResourceProperties;
1373
+
1374
+ /** This type represents the unencrypted value of the secret. */
1375
+ export declare interface SecretValue {
1376
+ /** The actual value of the secret. */
1377
+ value?: string;
1378
+ }
1379
+
1380
+ /** Optional parameters. */
1381
+ export declare interface SecretValueCreateOptionalParams extends coreClient.OperationOptions {
1382
+ }
1383
+
1384
+ /** Contains response data for the create operation. */
1385
+ export declare type SecretValueCreateResponse = SecretValueResourceDescription;
1386
+
1387
+ /** Optional parameters. */
1388
+ export declare interface SecretValueDeleteOptionalParams extends coreClient.OperationOptions {
1389
+ }
1390
+
1391
+ /** Optional parameters. */
1392
+ export declare interface SecretValueGetOptionalParams extends coreClient.OperationOptions {
1393
+ }
1394
+
1395
+ /** Contains response data for the get operation. */
1396
+ export declare type SecretValueGetResponse = SecretValueResourceDescription;
1397
+
1398
+ /** Optional parameters. */
1399
+ export declare interface SecretValueListNextOptionalParams extends coreClient.OperationOptions {
1400
+ }
1401
+
1402
+ /** Contains response data for the listNext operation. */
1403
+ export declare type SecretValueListNextResponse = SecretValueResourceDescriptionList;
1404
+
1405
+ /** Optional parameters. */
1406
+ export declare interface SecretValueListOptionalParams extends coreClient.OperationOptions {
1407
+ }
1408
+
1409
+ /** Contains response data for the list operation. */
1410
+ export declare type SecretValueListResponse = SecretValueResourceDescriptionList;
1411
+
1412
+ /** Optional parameters. */
1413
+ export declare interface SecretValueListValueOptionalParams extends coreClient.OperationOptions {
1414
+ }
1415
+
1416
+ /** Contains response data for the listValue operation. */
1417
+ export declare type SecretValueListValueResponse = SecretValue;
1418
+
1419
+ /** Interface representing a SecretValueOperations. */
1420
+ export declare interface SecretValueOperations {
1421
+ /**
1422
+ * Gets information about all secret value resources of the specified secret resource. The information
1423
+ * includes the names of the secret value resources, but not the actual values.
1424
+ * @param resourceGroupName Azure resource group name
1425
+ * @param secretResourceName The name of the secret resource.
1426
+ * @param options The options parameters.
1427
+ */
1428
+ list(resourceGroupName: string, secretResourceName: string, options?: SecretValueListOptionalParams): PagedAsyncIterableIterator<SecretValueResourceDescription>;
1429
+ /**
1430
+ * Creates a new value of the specified secret resource. The name of the value is typically the version
1431
+ * identifier. Once created the value cannot be changed.
1432
+ * @param resourceGroupName Azure resource group name
1433
+ * @param secretResourceName The name of the secret resource.
1434
+ * @param secretValueResourceName The name of the secret resource value which is typically the version
1435
+ * identifier for the value.
1436
+ * @param secretValueResourceDescription Description for creating a value of a secret resource.
1437
+ * @param options The options parameters.
1438
+ */
1439
+ create(resourceGroupName: string, secretResourceName: string, secretValueResourceName: string, secretValueResourceDescription: SecretValueResourceDescription, options?: SecretValueCreateOptionalParams): Promise<SecretValueCreateResponse>;
1440
+ /**
1441
+ * Get the information about the specified named secret value resources. The information does not
1442
+ * include the actual value of the secret.
1443
+ * @param resourceGroupName Azure resource group name
1444
+ * @param secretResourceName The name of the secret resource.
1445
+ * @param secretValueResourceName The name of the secret resource value which is typically the version
1446
+ * identifier for the value.
1447
+ * @param options The options parameters.
1448
+ */
1449
+ get(resourceGroupName: string, secretResourceName: string, secretValueResourceName: string, options?: SecretValueGetOptionalParams): Promise<SecretValueGetResponse>;
1450
+ /**
1451
+ * Deletes the secret value resource identified by the name. The name of the resource is typically the
1452
+ * version associated with that value. Deletion will fail if the specified value is in use.
1453
+ * @param resourceGroupName Azure resource group name
1454
+ * @param secretResourceName The name of the secret resource.
1455
+ * @param secretValueResourceName The name of the secret resource value which is typically the version
1456
+ * identifier for the value.
1457
+ * @param options The options parameters.
1458
+ */
1459
+ delete(resourceGroupName: string, secretResourceName: string, secretValueResourceName: string, options?: SecretValueDeleteOptionalParams): Promise<void>;
1460
+ /**
1461
+ * Lists the decrypted value of the specified named value of the secret resource. This is a privileged
1462
+ * operation.
1463
+ * @param resourceGroupName Azure resource group name
1464
+ * @param secretResourceName The name of the secret resource.
1465
+ * @param secretValueResourceName The name of the secret resource value which is typically the version
1466
+ * identifier for the value.
1467
+ * @param options The options parameters.
1468
+ */
1469
+ listValue(resourceGroupName: string, secretResourceName: string, secretValueResourceName: string, options?: SecretValueListValueOptionalParams): Promise<SecretValueListValueResponse>;
1470
+ }
1471
+
1472
+ /** This type describes properties of secret value resource. */
1473
+ export declare interface SecretValueProperties {
1474
+ /** The actual value of the secret. */
1475
+ value?: string;
1476
+ }
1477
+
1478
+ /** This type describes a value of a secret resource. The name of this resource is the version identifier corresponding to this secret value. */
1479
+ export declare type SecretValueResourceDescription = TrackedResource & {
1480
+ /**
1481
+ * State of the resource.
1482
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1483
+ */
1484
+ readonly provisioningState?: string;
1485
+ /** The actual value of the secret. */
1486
+ value?: string;
1487
+ };
1488
+
1489
+ /** A pageable list of values of a secret resource. The information does not include only the name of the value and not the actual unencrypted value. */
1490
+ export declare interface SecretValueResourceDescriptionList {
1491
+ /** One page of the list. */
1492
+ value?: SecretValueResourceDescription[];
1493
+ /** URI to fetch the next page of the list. */
1494
+ nextLink?: string;
1495
+ }
1496
+
1497
+ /** This type describes properties of a secret value resource. */
1498
+ export declare type SecretValueResourceProperties = ProvisionedResourceProperties & SecretValueProperties & {};
1499
+
1500
+ /** Interface representing a Service. */
1501
+ export declare interface Service {
1502
+ /**
1503
+ * Gets the information about all services of an application resource. The information include the
1504
+ * description and other properties of the Service.
1505
+ * @param resourceGroupName Azure resource group name
1506
+ * @param applicationResourceName The identity of the application.
1507
+ * @param options The options parameters.
1508
+ */
1509
+ list(resourceGroupName: string, applicationResourceName: string, options?: ServiceListOptionalParams): PagedAsyncIterableIterator<ServiceResourceDescription>;
1510
+ /**
1511
+ * Gets the information about the service resource with the given name. The information include the
1512
+ * description and other properties of the service.
1513
+ * @param resourceGroupName Azure resource group name
1514
+ * @param applicationResourceName The identity of the application.
1515
+ * @param serviceResourceName The identity of the service.
1516
+ * @param options The options parameters.
1517
+ */
1518
+ get(resourceGroupName: string, applicationResourceName: string, serviceResourceName: string, options?: ServiceGetOptionalParams): Promise<ServiceGetResponse>;
1519
+ }
1520
+
1521
+ export declare class ServiceFabricMeshManagementClient extends coreClient.ServiceClient {
1522
+ $host: string;
1523
+ apiVersion: string;
1524
+ subscriptionId: string;
1525
+ /**
1526
+ * Initializes a new instance of the ServiceFabricMeshManagementClient class.
1527
+ * @param credentials Subscription credentials which uniquely identify client subscription.
1528
+ * @param subscriptionId The customer subscription identifier
1529
+ * @param options The parameter options
1530
+ */
1531
+ constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: ServiceFabricMeshManagementClientOptionalParams);
1532
+ operations: Operations;
1533
+ secret: Secret;
1534
+ secretValueOperations: SecretValueOperations;
1535
+ volume: Volume;
1536
+ network: Network;
1537
+ gateway: Gateway;
1538
+ application: Application;
1539
+ service: Service;
1540
+ serviceReplica: ServiceReplica;
1541
+ codePackage: CodePackage;
1542
+ }
1543
+
1544
+ /** Optional parameters. */
1545
+ export declare interface ServiceFabricMeshManagementClientOptionalParams extends coreClient.ServiceClientOptions {
1546
+ /** server parameter */
1547
+ $host?: string;
1548
+ /** Api Version */
1549
+ apiVersion?: string;
1550
+ /** Overrides client endpoint. */
1551
+ endpoint?: string;
1552
+ }
1553
+
1554
+ /** Optional parameters. */
1555
+ export declare interface ServiceGetOptionalParams extends coreClient.OperationOptions {
1556
+ }
1557
+
1558
+ /** Contains response data for the get operation. */
1559
+ export declare type ServiceGetResponse = ServiceResourceDescription;
1560
+
1561
+ /** Optional parameters. */
1562
+ export declare interface ServiceListNextOptionalParams extends coreClient.OperationOptions {
1563
+ }
1564
+
1565
+ /** Contains response data for the listNext operation. */
1566
+ export declare type ServiceListNextResponse = ServiceResourceDescriptionList;
1567
+
1568
+ /** Optional parameters. */
1569
+ export declare interface ServiceListOptionalParams extends coreClient.OperationOptions {
1570
+ }
1571
+
1572
+ /** Contains response data for the list operation. */
1573
+ export declare type ServiceListResponse = ServiceResourceDescriptionList;
1574
+
1575
+ /** Describes properties of a service resource. */
1576
+ export declare interface ServiceProperties {
1577
+ /** User readable description of the service. */
1578
+ description?: string;
1579
+ /** The number of replicas of the service to create. Defaults to 1 if not specified. */
1580
+ replicaCount?: number;
1581
+ /** Auto scaling policies */
1582
+ autoScalingPolicies?: AutoScalingPolicy[];
1583
+ /**
1584
+ * Status of the service.
1585
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1586
+ */
1587
+ readonly status?: ResourceStatus;
1588
+ /**
1589
+ * Gives additional information about the current status of the service.
1590
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1591
+ */
1592
+ readonly statusDetails?: string;
1593
+ /**
1594
+ * Describes the health state of an application resource.
1595
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1596
+ */
1597
+ readonly healthState?: HealthState;
1598
+ /**
1599
+ * When the service's health state is not 'Ok', this additional details from service fabric Health Manager for the user to know why the service is marked unhealthy.
1600
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1601
+ */
1602
+ readonly unhealthyEvaluation?: string;
1603
+ }
1604
+
1605
+ /** Interface representing a ServiceReplica. */
1606
+ export declare interface ServiceReplica {
1607
+ /**
1608
+ * Gets the information about all replicas of a given service of an application. The information
1609
+ * includes the runtime properties of the replica instance.
1610
+ * @param resourceGroupName Azure resource group name
1611
+ * @param applicationResourceName The identity of the application.
1612
+ * @param serviceResourceName The identity of the service.
1613
+ * @param options The options parameters.
1614
+ */
1615
+ list(resourceGroupName: string, applicationResourceName: string, serviceResourceName: string, options?: ServiceReplicaListOptionalParams): PagedAsyncIterableIterator<ServiceReplicaDescription>;
1616
+ /**
1617
+ * Gets the information about the service replica with the given name. The information include the
1618
+ * description and other properties of the service replica.
1619
+ * @param resourceGroupName Azure resource group name
1620
+ * @param applicationResourceName The identity of the application.
1621
+ * @param serviceResourceName The identity of the service.
1622
+ * @param replicaName Service Fabric replica name.
1623
+ * @param options The options parameters.
1624
+ */
1625
+ get(resourceGroupName: string, applicationResourceName: string, serviceResourceName: string, replicaName: string, options?: ServiceReplicaGetOptionalParams): Promise<ServiceReplicaGetResponse>;
1626
+ }
1627
+
1628
+ /** Describes a replica of a service resource. */
1629
+ export declare type ServiceReplicaDescription = ServiceReplicaProperties & {
1630
+ /** Name of the replica. */
1631
+ replicaName: string;
1632
+ };
1633
+
1634
+ /** A pageable list of service replicas. */
1635
+ export declare interface ServiceReplicaDescriptionList {
1636
+ /** One page of the list. */
1637
+ value?: ServiceReplicaDescription[];
1638
+ /** URI to fetch the next page of the list. */
1639
+ nextLink?: string;
1640
+ }
1641
+
1642
+ /** Optional parameters. */
1643
+ export declare interface ServiceReplicaGetOptionalParams extends coreClient.OperationOptions {
1644
+ }
1645
+
1646
+ /** Contains response data for the get operation. */
1647
+ export declare type ServiceReplicaGetResponse = ServiceReplicaDescription;
1648
+
1649
+ /** Optional parameters. */
1650
+ export declare interface ServiceReplicaListNextOptionalParams extends coreClient.OperationOptions {
1651
+ }
1652
+
1653
+ /** Contains response data for the listNext operation. */
1654
+ export declare type ServiceReplicaListNextResponse = ServiceReplicaDescriptionList;
1655
+
1656
+ /** Optional parameters. */
1657
+ export declare interface ServiceReplicaListOptionalParams extends coreClient.OperationOptions {
1658
+ }
1659
+
1660
+ /** Contains response data for the list operation. */
1661
+ export declare type ServiceReplicaListResponse = ServiceReplicaDescriptionList;
1662
+
1663
+ /** Describes the properties of a service replica. */
1664
+ export declare interface ServiceReplicaProperties {
1665
+ /** The operation system required by the code in service. */
1666
+ osType: OperatingSystemType;
1667
+ /** Describes the set of code packages that forms the service. A code package describes the container and the properties for running it. All the code packages are started together on the same host and share the same context (network, process etc.). */
1668
+ codePackages: ContainerCodePackageProperties[];
1669
+ /** The names of the private networks that this service needs to be part of. */
1670
+ networkRefs?: NetworkRef[];
1671
+ /** Reference to sinks in DiagnosticsDescription. */
1672
+ diagnostics?: DiagnosticsRef;
1673
+ }
1674
+
1675
+ /** This type describes a service resource. */
1676
+ export declare type ServiceResourceDescription = ManagedProxyResource & {
1677
+ /**
1678
+ * State of the resource.
1679
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1680
+ */
1681
+ readonly provisioningState?: string;
1682
+ /** The operation system required by the code in service. */
1683
+ osType: OperatingSystemType;
1684
+ /** Describes the set of code packages that forms the service. A code package describes the container and the properties for running it. All the code packages are started together on the same host and share the same context (network, process etc.). */
1685
+ codePackages: ContainerCodePackageProperties[];
1686
+ /** The names of the private networks that this service needs to be part of. */
1687
+ networkRefs?: NetworkRef[];
1688
+ /** Reference to sinks in DiagnosticsDescription. */
1689
+ diagnostics?: DiagnosticsRef;
1690
+ /** User readable description of the service. */
1691
+ description?: string;
1692
+ /** The number of replicas of the service to create. Defaults to 1 if not specified. */
1693
+ replicaCount?: number;
1694
+ /** Auto scaling policies */
1695
+ autoScalingPolicies?: AutoScalingPolicy[];
1696
+ /**
1697
+ * Status of the service.
1698
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1699
+ */
1700
+ readonly status?: ResourceStatus;
1701
+ /**
1702
+ * Gives additional information about the current status of the service.
1703
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1704
+ */
1705
+ readonly statusDetails?: string;
1706
+ /**
1707
+ * Describes the health state of an application resource.
1708
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1709
+ */
1710
+ readonly healthState?: HealthState;
1711
+ /**
1712
+ * When the service's health state is not 'Ok', this additional details from service fabric Health Manager for the user to know why the service is marked unhealthy.
1713
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1714
+ */
1715
+ readonly unhealthyEvaluation?: string;
1716
+ };
1717
+
1718
+ /** A pageable list of service resources. */
1719
+ export declare interface ServiceResourceDescriptionList {
1720
+ /** One page of the list. */
1721
+ value?: ServiceResourceDescription[];
1722
+ /** URI to fetch the next page of the list. */
1723
+ nextLink?: string;
1724
+ }
1725
+
1726
+ /** This type describes properties of a service resource. */
1727
+ export declare type ServiceResourceProperties = ProvisionedResourceProperties & ServiceReplicaProperties & ServiceProperties & {};
1728
+
1729
+ /** Describes a setting for the container. The setting file path can be fetched from environment variable "Fabric_SettingPath". The path for Windows container is "C:\\secrets". The path for Linux container is "/var/secrets". */
1730
+ export declare interface Setting {
1731
+ /** The name of the setting. */
1732
+ name?: string;
1733
+ /** The value of the setting. */
1734
+ value?: string;
1735
+ }
1736
+
1737
+ /**
1738
+ * Defines values for SizeTypes. \
1739
+ * {@link KnownSizeTypes} can be used interchangeably with SizeTypes,
1740
+ * this enum contains the known values that the service supports.
1741
+ * ### Known values supported by the service
1742
+ * **Small** \
1743
+ * **Medium** \
1744
+ * **Large**
1745
+ */
1746
+ export declare type SizeTypes = string;
1747
+
1748
+ /** Describes the tcp configuration for external connectivity for this network. */
1749
+ export declare interface TcpConfig {
1750
+ /** tcp gateway config name. */
1751
+ name: string;
1752
+ /** Specifies the port at which the service endpoint below needs to be exposed. */
1753
+ port: number;
1754
+ /** Describes destination endpoint for routing traffic. */
1755
+ destination: GatewayDestination;
1756
+ }
1757
+
1758
+ /** The resource model definition for Azure Resource Manager tracked top-level resource. */
1759
+ export declare type TrackedResource = Resource & {
1760
+ /** Resource tags. */
1761
+ tags?: {
1762
+ [propertyName: string]: string;
1763
+ };
1764
+ /** The geo-location where the resource lives */
1765
+ location: string;
1766
+ };
1767
+
1768
+ /** Interface representing a Volume. */
1769
+ export declare interface Volume {
1770
+ /**
1771
+ * Gets the information about all volume resources in a given resource group. The information include
1772
+ * the description and other properties of the Volume.
1773
+ * @param resourceGroupName Azure resource group name
1774
+ * @param options The options parameters.
1775
+ */
1776
+ listByResourceGroup(resourceGroupName: string, options?: VolumeListByResourceGroupOptionalParams): PagedAsyncIterableIterator<VolumeResourceDescription>;
1777
+ /**
1778
+ * Gets the information about all volume resources in a given resource group. The information include
1779
+ * the description and other properties of the volume.
1780
+ * @param options The options parameters.
1781
+ */
1782
+ listBySubscription(options?: VolumeListBySubscriptionOptionalParams): PagedAsyncIterableIterator<VolumeResourceDescription>;
1783
+ /**
1784
+ * Creates a volume resource with the specified name, description and properties. If a volume resource
1785
+ * with the same name exists, then it is updated with the specified description and properties.
1786
+ * @param resourceGroupName Azure resource group name
1787
+ * @param volumeResourceName The identity of the volume.
1788
+ * @param volumeResourceDescription Description for creating a Volume resource.
1789
+ * @param options The options parameters.
1790
+ */
1791
+ create(resourceGroupName: string, volumeResourceName: string, volumeResourceDescription: VolumeResourceDescription, options?: VolumeCreateOptionalParams): Promise<VolumeCreateResponse>;
1792
+ /**
1793
+ * Gets the information about the volume resource with the given name. The information include the
1794
+ * description and other properties of the volume.
1795
+ * @param resourceGroupName Azure resource group name
1796
+ * @param volumeResourceName The identity of the volume.
1797
+ * @param options The options parameters.
1798
+ */
1799
+ get(resourceGroupName: string, volumeResourceName: string, options?: VolumeGetOptionalParams): Promise<VolumeGetResponse>;
1800
+ /**
1801
+ * Deletes the volume resource identified by the name.
1802
+ * @param resourceGroupName Azure resource group name
1803
+ * @param volumeResourceName The identity of the volume.
1804
+ * @param options The options parameters.
1805
+ */
1806
+ delete(resourceGroupName: string, volumeResourceName: string, options?: VolumeDeleteOptionalParams): Promise<void>;
1807
+ }
1808
+
1809
+ /** Optional parameters. */
1810
+ export declare interface VolumeCreateOptionalParams extends coreClient.OperationOptions {
1811
+ }
1812
+
1813
+ /** Contains response data for the create operation. */
1814
+ export declare type VolumeCreateResponse = VolumeResourceDescription;
1815
+
1816
+ /** Optional parameters. */
1817
+ export declare interface VolumeDeleteOptionalParams extends coreClient.OperationOptions {
1818
+ }
1819
+
1820
+ /** Optional parameters. */
1821
+ export declare interface VolumeGetOptionalParams extends coreClient.OperationOptions {
1822
+ }
1823
+
1824
+ /** Contains response data for the get operation. */
1825
+ export declare type VolumeGetResponse = VolumeResourceDescription;
1826
+
1827
+ /** Optional parameters. */
1828
+ export declare interface VolumeListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
1829
+ }
1830
+
1831
+ /** Contains response data for the listByResourceGroupNext operation. */
1832
+ export declare type VolumeListByResourceGroupNextResponse = VolumeResourceDescriptionList;
1833
+
1834
+ /** Optional parameters. */
1835
+ export declare interface VolumeListByResourceGroupOptionalParams extends coreClient.OperationOptions {
1836
+ }
1837
+
1838
+ /** Contains response data for the listByResourceGroup operation. */
1839
+ export declare type VolumeListByResourceGroupResponse = VolumeResourceDescriptionList;
1840
+
1841
+ /** Optional parameters. */
1842
+ export declare interface VolumeListBySubscriptionNextOptionalParams extends coreClient.OperationOptions {
1843
+ }
1844
+
1845
+ /** Contains response data for the listBySubscriptionNext operation. */
1846
+ export declare type VolumeListBySubscriptionNextResponse = VolumeResourceDescriptionList;
1847
+
1848
+ /** Optional parameters. */
1849
+ export declare interface VolumeListBySubscriptionOptionalParams extends coreClient.OperationOptions {
1850
+ }
1851
+
1852
+ /** Contains response data for the listBySubscription operation. */
1853
+ export declare type VolumeListBySubscriptionResponse = VolumeResourceDescriptionList;
1854
+
1855
+ /** Describes properties of a volume resource. */
1856
+ export declare interface VolumeProperties {
1857
+ /** User readable description of the volume. */
1858
+ description?: string;
1859
+ /**
1860
+ * Status of the volume.
1861
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1862
+ */
1863
+ readonly status?: ResourceStatus;
1864
+ /**
1865
+ * Gives additional information about the current status of the volume.
1866
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1867
+ */
1868
+ readonly statusDetails?: string;
1869
+ /** Provider of the volume. */
1870
+ provider: VolumeProvider;
1871
+ /** This type describes a volume provided by an Azure Files file share. */
1872
+ azureFileParameters?: VolumeProviderParametersAzureFile;
1873
+ }
1874
+
1875
+ /**
1876
+ * Defines values for VolumeProvider. \
1877
+ * {@link KnownVolumeProvider} can be used interchangeably with VolumeProvider,
1878
+ * this enum contains the known values that the service supports.
1879
+ * ### Known values supported by the service
1880
+ * **SFAzureFile**: Provides volumes that are backed by Azure Files.
1881
+ */
1882
+ export declare type VolumeProvider = string;
1883
+
1884
+ /** This type describes a volume provided by an Azure Files file share. */
1885
+ export declare interface VolumeProviderParametersAzureFile {
1886
+ /** Name of the Azure storage account for the File Share. */
1887
+ accountName: string;
1888
+ /** Access key of the Azure storage account for the File Share. */
1889
+ accountKey?: string;
1890
+ /** Name of the Azure Files file share that provides storage for the volume. */
1891
+ shareName: string;
1892
+ }
1893
+
1894
+ /** Describes a reference to a volume resource. */
1895
+ export declare interface VolumeReference {
1896
+ /** Name of the volume being referenced. */
1897
+ name: string;
1898
+ /** The flag indicating whether the volume is read only. Default is 'false'. */
1899
+ readOnly?: boolean;
1900
+ /** The path within the container at which the volume should be mounted. Only valid path characters are allowed. */
1901
+ destinationPath: string;
1902
+ }
1903
+
1904
+ /** This type describes a volume resource. */
1905
+ export declare type VolumeResourceDescription = TrackedResource & {
1906
+ /**
1907
+ * State of the resource.
1908
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1909
+ */
1910
+ readonly provisioningState?: string;
1911
+ /** User readable description of the volume. */
1912
+ description?: string;
1913
+ /**
1914
+ * Status of the volume.
1915
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1916
+ */
1917
+ readonly status?: ResourceStatus;
1918
+ /**
1919
+ * Gives additional information about the current status of the volume.
1920
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1921
+ */
1922
+ readonly statusDetails?: string;
1923
+ /** Provider of the volume. */
1924
+ provider: VolumeProvider;
1925
+ /** This type describes a volume provided by an Azure Files file share. */
1926
+ azureFileParameters?: VolumeProviderParametersAzureFile;
1927
+ };
1928
+
1929
+ /** A pageable list of volume resources. */
1930
+ export declare interface VolumeResourceDescriptionList {
1931
+ /** One page of the list. */
1932
+ value?: VolumeResourceDescription[];
1933
+ /** URI to fetch the next page of the list. */
1934
+ nextLink?: string;
1935
+ }
1936
+
1937
+ /** This type describes properties of a volume resource. */
1938
+ export declare type VolumeResourceProperties = ProvisionedResourceProperties & VolumeProperties & {};
1939
+
1940
+ export { }