@azure/arm-resourcehealth 2.0.0 → 3.0.0-beta.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (173) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/{LICENSE.txt → LICENSE} +1 -1
  3. package/README.md +70 -82
  4. package/dist/index.js +1811 -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 +6 -0
  9. package/dist-esm/src/index.d.ts.map +1 -0
  10. package/dist-esm/src/index.js +13 -0
  11. package/dist-esm/src/index.js.map +1 -0
  12. package/dist-esm/src/microsoftResourceHealth.d.ts +20 -0
  13. package/dist-esm/src/microsoftResourceHealth.d.ts.map +1 -0
  14. package/dist-esm/src/microsoftResourceHealth.js +27 -0
  15. package/dist-esm/src/microsoftResourceHealth.js.map +1 -0
  16. package/dist-esm/src/microsoftResourceHealthContext.d.ts +17 -0
  17. package/dist-esm/src/microsoftResourceHealthContext.d.ts.map +1 -0
  18. package/dist-esm/src/microsoftResourceHealthContext.js +50 -0
  19. package/dist-esm/src/microsoftResourceHealthContext.js.map +1 -0
  20. package/dist-esm/src/models/index.d.ts +402 -0
  21. package/dist-esm/src/models/index.d.ts.map +1 -0
  22. package/dist-esm/src/models/index.js +22 -0
  23. package/dist-esm/src/models/index.js.map +1 -0
  24. package/dist-esm/src/models/mappers.d.ts +21 -0
  25. package/dist-esm/src/models/mappers.d.ts.map +1 -0
  26. package/{esm → dist-esm/src}/models/mappers.js +233 -309
  27. package/dist-esm/src/models/mappers.js.map +1 -0
  28. package/dist-esm/src/models/parameters.d.ts +12 -0
  29. package/dist-esm/src/models/parameters.d.ts.map +1 -0
  30. package/{esm → dist-esm/src}/models/parameters.js +44 -39
  31. package/dist-esm/src/models/parameters.js.map +1 -0
  32. package/dist-esm/src/operations/availabilityStatuses.d.ts +102 -0
  33. package/dist-esm/src/operations/availabilityStatuses.d.ts.map +1 -0
  34. package/dist-esm/src/operations/availabilityStatuses.js +407 -0
  35. package/dist-esm/src/operations/availabilityStatuses.js.map +1 -0
  36. package/dist-esm/src/operations/childAvailabilityStatuses.d.ts +51 -0
  37. package/dist-esm/src/operations/childAvailabilityStatuses.d.ts.map +1 -0
  38. package/dist-esm/src/operations/childAvailabilityStatuses.js +173 -0
  39. package/dist-esm/src/operations/childAvailabilityStatuses.js.map +1 -0
  40. package/dist-esm/src/operations/childResources.d.ts +43 -0
  41. package/dist-esm/src/operations/childResources.d.ts.map +1 -0
  42. package/dist-esm/src/operations/childResources.js +143 -0
  43. package/dist-esm/src/operations/childResources.js.map +1 -0
  44. package/dist-esm/src/operations/emergingIssues.d.ts +37 -0
  45. package/dist-esm/src/operations/emergingIssues.d.ts.map +1 -0
  46. package/dist-esm/src/operations/emergingIssues.js +143 -0
  47. package/dist-esm/src/operations/emergingIssues.js.map +1 -0
  48. package/{esm → dist-esm/src}/operations/index.d.ts +0 -0
  49. package/dist-esm/src/operations/index.d.ts.map +1 -0
  50. package/{esm → dist-esm/src}/operations/index.js +1 -2
  51. package/dist-esm/src/operations/index.js.map +1 -0
  52. package/dist-esm/src/operations/operations.d.ts +18 -0
  53. package/dist-esm/src/operations/operations.d.ts.map +1 -0
  54. package/dist-esm/src/operations/operations.js +46 -0
  55. package/dist-esm/src/operations/operations.js.map +1 -0
  56. package/dist-esm/src/operationsInterfaces/availabilityStatuses.d.ts +40 -0
  57. package/dist-esm/src/operationsInterfaces/availabilityStatuses.d.ts.map +1 -0
  58. package/{src/models/operationsMappers.ts → dist-esm/src/operationsInterfaces/availabilityStatuses.js} +2 -7
  59. package/dist-esm/src/operationsInterfaces/availabilityStatuses.js.map +1 -0
  60. package/dist-esm/src/operationsInterfaces/childAvailabilityStatuses.d.ts +23 -0
  61. package/dist-esm/src/operationsInterfaces/childAvailabilityStatuses.d.ts.map +1 -0
  62. package/{esm/models/operationsMappers.js → dist-esm/src/operationsInterfaces/childAvailabilityStatuses.js} +2 -2
  63. package/dist-esm/src/operationsInterfaces/childAvailabilityStatuses.js.map +1 -0
  64. package/dist-esm/src/operationsInterfaces/childResources.d.ts +15 -0
  65. package/dist-esm/src/operationsInterfaces/childResources.d.ts.map +1 -0
  66. package/dist-esm/src/operationsInterfaces/childResources.js +9 -0
  67. package/dist-esm/src/operationsInterfaces/childResources.js.map +1 -0
  68. package/dist-esm/src/operationsInterfaces/emergingIssues.d.ts +16 -0
  69. package/dist-esm/src/operationsInterfaces/emergingIssues.d.ts.map +1 -0
  70. package/dist-esm/src/operationsInterfaces/emergingIssues.js +9 -0
  71. package/dist-esm/src/operationsInterfaces/emergingIssues.js.map +1 -0
  72. package/dist-esm/src/operationsInterfaces/index.d.ts +6 -0
  73. package/dist-esm/src/operationsInterfaces/index.d.ts.map +1 -0
  74. package/dist-esm/src/operationsInterfaces/index.js +13 -0
  75. package/dist-esm/src/operationsInterfaces/index.js.map +1 -0
  76. package/dist-esm/src/operationsInterfaces/operations.d.ts +10 -0
  77. package/dist-esm/src/operationsInterfaces/operations.d.ts.map +1 -0
  78. package/{esm/models/index.js → dist-esm/src/operationsInterfaces/operations.js} +2 -1
  79. package/dist-esm/src/operationsInterfaces/operations.js.map +1 -0
  80. package/dist-esm/test/sampleTest.d.ts +2 -0
  81. package/dist-esm/test/sampleTest.d.ts.map +1 -0
  82. package/dist-esm/test/sampleTest.js +40 -0
  83. package/dist-esm/test/sampleTest.js.map +1 -0
  84. package/package.json +63 -32
  85. package/review/arm-resourcehealth.api.md +396 -0
  86. package/rollup.config.js +181 -30
  87. package/src/index.ts +13 -0
  88. package/src/microsoftResourceHealth.ts +38 -41
  89. package/src/microsoftResourceHealthContext.ts +47 -44
  90. package/src/models/index.ts +322 -878
  91. package/src/models/mappers.ts +232 -320
  92. package/src/models/parameters.ts +58 -40
  93. package/src/operations/availabilityStatuses.ts +325 -276
  94. package/src/operations/childAvailabilityStatuses.ts +137 -130
  95. package/src/operations/childResources.ts +109 -85
  96. package/src/operations/emergingIssues.ts +96 -103
  97. package/src/operations/index.ts +1 -2
  98. package/src/operations/operations.ts +24 -38
  99. package/src/operationsInterfaces/availabilityStatuses.ts +67 -0
  100. package/src/operationsInterfaces/childAvailabilityStatuses.ts +43 -0
  101. package/src/operationsInterfaces/childResources.ts +30 -0
  102. package/src/operationsInterfaces/emergingIssues.ts +34 -0
  103. package/src/operationsInterfaces/index.ts +13 -0
  104. package/src/operationsInterfaces/operations.ts +21 -0
  105. package/tsconfig.json +3 -3
  106. package/types/arm-resourcehealth.d.ts +588 -0
  107. package/types/tsdoc-metadata.json +11 -0
  108. package/dist/arm-resourcehealth.js +0 -1743
  109. package/dist/arm-resourcehealth.js.map +0 -1
  110. package/dist/arm-resourcehealth.min.js +0 -1
  111. package/dist/arm-resourcehealth.min.js.map +0 -1
  112. package/esm/microsoftResourceHealth.d.ts +0 -29
  113. package/esm/microsoftResourceHealth.d.ts.map +0 -1
  114. package/esm/microsoftResourceHealth.js +0 -42
  115. package/esm/microsoftResourceHealth.js.map +0 -1
  116. package/esm/microsoftResourceHealthContext.d.ts +0 -23
  117. package/esm/microsoftResourceHealthContext.d.ts.map +0 -1
  118. package/esm/microsoftResourceHealthContext.js +0 -61
  119. package/esm/microsoftResourceHealthContext.js.map +0 -1
  120. package/esm/models/availabilityStatusesMappers.d.ts +0 -2
  121. package/esm/models/availabilityStatusesMappers.d.ts.map +0 -1
  122. package/esm/models/availabilityStatusesMappers.js +0 -9
  123. package/esm/models/availabilityStatusesMappers.js.map +0 -1
  124. package/esm/models/childAvailabilityStatusesMappers.d.ts +0 -2
  125. package/esm/models/childAvailabilityStatusesMappers.d.ts.map +0 -1
  126. package/esm/models/childAvailabilityStatusesMappers.js +0 -9
  127. package/esm/models/childAvailabilityStatusesMappers.js.map +0 -1
  128. package/esm/models/childResourcesMappers.d.ts +0 -2
  129. package/esm/models/childResourcesMappers.d.ts.map +0 -1
  130. package/esm/models/childResourcesMappers.js +0 -9
  131. package/esm/models/childResourcesMappers.js.map +0 -1
  132. package/esm/models/emergingIssuesMappers.d.ts +0 -2
  133. package/esm/models/emergingIssuesMappers.d.ts.map +0 -1
  134. package/esm/models/emergingIssuesMappers.js +0 -9
  135. package/esm/models/emergingIssuesMappers.js.map +0 -1
  136. package/esm/models/index.d.ts +0 -957
  137. package/esm/models/index.d.ts.map +0 -1
  138. package/esm/models/index.js.map +0 -1
  139. package/esm/models/mappers.d.ts +0 -26
  140. package/esm/models/mappers.d.ts.map +0 -1
  141. package/esm/models/mappers.js.map +0 -1
  142. package/esm/models/operationsMappers.d.ts +0 -2
  143. package/esm/models/operationsMappers.d.ts.map +0 -1
  144. package/esm/models/operationsMappers.js.map +0 -1
  145. package/esm/models/parameters.d.ts +0 -11
  146. package/esm/models/parameters.d.ts.map +0 -1
  147. package/esm/models/parameters.js.map +0 -1
  148. package/esm/operations/availabilityStatuses.d.ts +0 -166
  149. package/esm/operations/availabilityStatuses.d.ts.map +0 -1
  150. package/esm/operations/availabilityStatuses.js +0 -239
  151. package/esm/operations/availabilityStatuses.js.map +0 -1
  152. package/esm/operations/childAvailabilityStatuses.d.ts +0 -81
  153. package/esm/operations/childAvailabilityStatuses.d.ts.map +0 -1
  154. package/esm/operations/childAvailabilityStatuses.js +0 -117
  155. package/esm/operations/childAvailabilityStatuses.js.map +0 -1
  156. package/esm/operations/childResources.d.ts +0 -57
  157. package/esm/operations/childResources.d.ts.map +0 -1
  158. package/esm/operations/childResources.js +0 -87
  159. package/esm/operations/childResources.js.map +0 -1
  160. package/esm/operations/emergingIssues.d.ts +0 -61
  161. package/esm/operations/emergingIssues.d.ts.map +0 -1
  162. package/esm/operations/emergingIssues.js +0 -106
  163. package/esm/operations/emergingIssues.js.map +0 -1
  164. package/esm/operations/index.d.ts.map +0 -1
  165. package/esm/operations/index.js.map +0 -1
  166. package/esm/operations/operations.d.ts +0 -28
  167. package/esm/operations/operations.d.ts.map +0 -1
  168. package/esm/operations/operations.js +0 -50
  169. package/esm/operations/operations.js.map +0 -1
  170. package/src/models/availabilityStatusesMappers.ts +0 -19
  171. package/src/models/childAvailabilityStatusesMappers.ts +0 -19
  172. package/src/models/childResourcesMappers.ts +0 -19
  173. package/src/models/emergingIssuesMappers.ts +0 -22
@@ -0,0 +1,588 @@
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
+ /** Defines values for AvailabilityStateValues. */
6
+ export declare type AvailabilityStateValues = "Available" | "Unavailable" | "Unknown";
7
+
8
+ /** availabilityStatus of a resource. */
9
+ export declare interface AvailabilityStatus {
10
+ /** Azure Resource Manager Identity for the availabilityStatuses resource. */
11
+ id?: string;
12
+ /** current. */
13
+ name?: string;
14
+ /** Microsoft.ResourceHealth/AvailabilityStatuses. */
15
+ type?: string;
16
+ /** Azure Resource Manager geo location of the resource. */
17
+ location?: string;
18
+ /** Properties of availability state. */
19
+ properties?: AvailabilityStatusProperties;
20
+ }
21
+
22
+ /** Interface representing a AvailabilityStatuses. */
23
+ export declare interface AvailabilityStatuses {
24
+ /**
25
+ * Lists the current availability status for all the resources in the subscription. Use the nextLink
26
+ * property in the response to get the next page of availability statuses.
27
+ * @param options The options parameters.
28
+ */
29
+ listBySubscriptionId(options?: AvailabilityStatusesListBySubscriptionIdOptionalParams): PagedAsyncIterableIterator<AvailabilityStatus>;
30
+ /**
31
+ * Lists the current availability status for all the resources in the resource group. Use the nextLink
32
+ * property in the response to get the next page of availability statuses.
33
+ * @param resourceGroupName The name of the resource group.
34
+ * @param options The options parameters.
35
+ */
36
+ listByResourceGroup(resourceGroupName: string, options?: AvailabilityStatusesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<AvailabilityStatus>;
37
+ /**
38
+ * Lists all historical availability transitions and impacting events for a single resource. Use the
39
+ * nextLink property in the response to get the next page of availability status
40
+ * @param resourceUri The fully qualified ID of the resource, including the resource name and resource
41
+ * type. Currently the API support not nested and one nesting level resource types :
42
+ * /subscriptions/{subscriptionId}/resourceGroups/{resource-group-name}/providers/{resource-provider-name}/{resource-type}/{resource-name}
43
+ * and
44
+ * /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resource-provider-name}/{parentResourceType}/{parentResourceName}/{resourceType}/{resourceName}
45
+ * @param options The options parameters.
46
+ */
47
+ list(resourceUri: string, options?: AvailabilityStatusesListOptionalParams): PagedAsyncIterableIterator<AvailabilityStatus>;
48
+ /**
49
+ * Gets current availability status for a single resource
50
+ * @param resourceUri The fully qualified ID of the resource, including the resource name and resource
51
+ * type. Currently the API support not nested and one nesting level resource types :
52
+ * /subscriptions/{subscriptionId}/resourceGroups/{resource-group-name}/providers/{resource-provider-name}/{resource-type}/{resource-name}
53
+ * and
54
+ * /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resource-provider-name}/{parentResourceType}/{parentResourceName}/{resourceType}/{resourceName}
55
+ * @param options The options parameters.
56
+ */
57
+ getByResource(resourceUri: string, options?: AvailabilityStatusesGetByResourceOptionalParams): Promise<AvailabilityStatusesGetByResourceResponse>;
58
+ }
59
+
60
+ /** Optional parameters. */
61
+ export declare interface AvailabilityStatusesGetByResourceOptionalParams extends coreClient.OperationOptions {
62
+ /** The filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN */
63
+ filter?: string;
64
+ /** Setting $expand=recommendedactions in url query expands the recommendedactions in the response. */
65
+ expand?: string;
66
+ }
67
+
68
+ /** Contains response data for the getByResource operation. */
69
+ export declare type AvailabilityStatusesGetByResourceResponse = AvailabilityStatus;
70
+
71
+ /** Optional parameters. */
72
+ export declare interface AvailabilityStatusesListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
73
+ /** The filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN */
74
+ filter?: string;
75
+ /** Setting $expand=recommendedactions in url query expands the recommendedactions in the response. */
76
+ expand?: string;
77
+ }
78
+
79
+ /** Contains response data for the listByResourceGroupNext operation. */
80
+ export declare type AvailabilityStatusesListByResourceGroupNextResponse = AvailabilityStatusListResult;
81
+
82
+ /** Optional parameters. */
83
+ export declare interface AvailabilityStatusesListByResourceGroupOptionalParams extends coreClient.OperationOptions {
84
+ /** The filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN */
85
+ filter?: string;
86
+ /** Setting $expand=recommendedactions in url query expands the recommendedactions in the response. */
87
+ expand?: string;
88
+ }
89
+
90
+ /** Contains response data for the listByResourceGroup operation. */
91
+ export declare type AvailabilityStatusesListByResourceGroupResponse = AvailabilityStatusListResult;
92
+
93
+ /** Optional parameters. */
94
+ export declare interface AvailabilityStatusesListBySubscriptionIdNextOptionalParams extends coreClient.OperationOptions {
95
+ /** The filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN */
96
+ filter?: string;
97
+ /** Setting $expand=recommendedactions in url query expands the recommendedactions in the response. */
98
+ expand?: string;
99
+ }
100
+
101
+ /** Contains response data for the listBySubscriptionIdNext operation. */
102
+ export declare type AvailabilityStatusesListBySubscriptionIdNextResponse = AvailabilityStatusListResult;
103
+
104
+ /** Optional parameters. */
105
+ export declare interface AvailabilityStatusesListBySubscriptionIdOptionalParams extends coreClient.OperationOptions {
106
+ /** The filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN */
107
+ filter?: string;
108
+ /** Setting $expand=recommendedactions in url query expands the recommendedactions in the response. */
109
+ expand?: string;
110
+ }
111
+
112
+ /** Contains response data for the listBySubscriptionId operation. */
113
+ export declare type AvailabilityStatusesListBySubscriptionIdResponse = AvailabilityStatusListResult;
114
+
115
+ /** Optional parameters. */
116
+ export declare interface AvailabilityStatusesListNextOptionalParams extends coreClient.OperationOptions {
117
+ /** The filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN */
118
+ filter?: string;
119
+ /** Setting $expand=recommendedactions in url query expands the recommendedactions in the response. */
120
+ expand?: string;
121
+ }
122
+
123
+ /** Contains response data for the listNext operation. */
124
+ export declare type AvailabilityStatusesListNextResponse = AvailabilityStatusListResult;
125
+
126
+ /** Optional parameters. */
127
+ export declare interface AvailabilityStatusesListOptionalParams extends coreClient.OperationOptions {
128
+ /** The filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN */
129
+ filter?: string;
130
+ /** Setting $expand=recommendedactions in url query expands the recommendedactions in the response. */
131
+ expand?: string;
132
+ }
133
+
134
+ /** Contains response data for the list operation. */
135
+ export declare type AvailabilityStatusesListResponse = AvailabilityStatusListResult;
136
+
137
+ /** The List availabilityStatus operation response. */
138
+ export declare interface AvailabilityStatusListResult {
139
+ /** The list of availabilityStatuses. */
140
+ value: AvailabilityStatus[];
141
+ /** The URI to fetch the next page of availabilityStatuses. Call ListNext() with this URI to fetch the next page of availabilityStatuses. */
142
+ nextLink?: string;
143
+ }
144
+
145
+ /** Properties of availability state. */
146
+ export declare interface AvailabilityStatusProperties {
147
+ /** Availability status of the resource. When it is null, this availabilityStatus object represents an availability impacting event */
148
+ availabilityState?: AvailabilityStateValues;
149
+ /** Summary description of the availability status. */
150
+ summary?: string;
151
+ /** Details of the availability status. */
152
+ detailedStatus?: string;
153
+ /** When the resource's availabilityState is Unavailable, it describes where the health impacting event was originated. Examples are planned, unplanned, user initiated or an outage etc. */
154
+ reasonType?: string;
155
+ /** When the resource's availabilityState is Unavailable, it provides the Timestamp for when the health impacting event was received. */
156
+ rootCauseAttributionTime?: Date;
157
+ /** In case of an availability impacting event, it describes when the health impacting event was originated. Examples are Lifecycle, Downtime, Fault Analysis etc. */
158
+ healthEventType?: string;
159
+ /** In case of an availability impacting event, it describes where the health impacting event was originated. Examples are PlatformInitiated, UserInitiated etc. */
160
+ healthEventCause?: string;
161
+ /** In case of an availability impacting event, it describes the category of a PlatformInitiated health impacting event. Examples are Planned, Unplanned etc. */
162
+ healthEventCategory?: string;
163
+ /** It is a unique Id that identifies the event */
164
+ healthEventId?: string;
165
+ /** When the resource's availabilityState is Unavailable and the reasonType is not User Initiated, it provides the date and time for when the issue is expected to be resolved. */
166
+ resolutionETA?: Date;
167
+ /** Timestamp for when last change in health status occurred. */
168
+ occuredTime?: Date;
169
+ /** Chronicity of the availability transition. */
170
+ reasonChronicity?: ReasonChronicityTypes;
171
+ /** Timestamp for when the health was last checked. */
172
+ reportedTime?: Date;
173
+ /** An annotation describing a change in the availabilityState to Available from Unavailable with a reasonType of type Unplanned */
174
+ recentlyResolvedState?: AvailabilityStatusPropertiesRecentlyResolvedState;
175
+ /** Lists actions the user can take based on the current availabilityState of the resource. */
176
+ recommendedActions?: RecommendedAction[];
177
+ /** Lists the service impacting events that may be affecting the health of the resource. */
178
+ serviceImpactingEvents?: ServiceImpactingEvent[];
179
+ }
180
+
181
+ /** An annotation describing a change in the availabilityState to Available from Unavailable with a reasonType of type Unplanned */
182
+ export declare interface AvailabilityStatusPropertiesRecentlyResolvedState {
183
+ /** Timestamp for when the availabilityState changed to Unavailable */
184
+ unavailableOccurredTime?: Date;
185
+ /** Timestamp when the availabilityState changes to Available. */
186
+ resolvedTime?: Date;
187
+ /** Brief description of cause of the resource becoming unavailable. */
188
+ unavailabilitySummary?: string;
189
+ }
190
+
191
+ /** Interface representing a ChildAvailabilityStatuses. */
192
+ export declare interface ChildAvailabilityStatuses {
193
+ /**
194
+ * Lists the historical availability statuses for a single child resource. Use the nextLink property in
195
+ * the response to get the next page of availability status
196
+ * @param resourceUri The fully qualified ID of the resource, including the resource name and resource
197
+ * type. Currently the API only support one nesting level resource types :
198
+ * /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resource-provider-name}/{parentResourceType}/{parentResourceName}/{resourceType}/{resourceName}
199
+ * @param options The options parameters.
200
+ */
201
+ list(resourceUri: string, options?: ChildAvailabilityStatusesListOptionalParams): PagedAsyncIterableIterator<AvailabilityStatus>;
202
+ /**
203
+ * Gets current availability status for a single resource
204
+ * @param resourceUri The fully qualified ID of the resource, including the resource name and resource
205
+ * type. Currently the API only support one nesting level resource types :
206
+ * /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resource-provider-name}/{parentResourceType}/{parentResourceName}/{resourceType}/{resourceName}
207
+ * @param options The options parameters.
208
+ */
209
+ getByResource(resourceUri: string, options?: ChildAvailabilityStatusesGetByResourceOptionalParams): Promise<ChildAvailabilityStatusesGetByResourceResponse>;
210
+ }
211
+
212
+ /** Optional parameters. */
213
+ export declare interface ChildAvailabilityStatusesGetByResourceOptionalParams extends coreClient.OperationOptions {
214
+ /** The filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN */
215
+ filter?: string;
216
+ /** Setting $expand=recommendedactions in url query expands the recommendedactions in the response. */
217
+ expand?: string;
218
+ }
219
+
220
+ /** Contains response data for the getByResource operation. */
221
+ export declare type ChildAvailabilityStatusesGetByResourceResponse = AvailabilityStatus;
222
+
223
+ /** Optional parameters. */
224
+ export declare interface ChildAvailabilityStatusesListNextOptionalParams extends coreClient.OperationOptions {
225
+ /** The filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN */
226
+ filter?: string;
227
+ /** Setting $expand=recommendedactions in url query expands the recommendedactions in the response. */
228
+ expand?: string;
229
+ }
230
+
231
+ /** Contains response data for the listNext operation. */
232
+ export declare type ChildAvailabilityStatusesListNextResponse = AvailabilityStatusListResult;
233
+
234
+ /** Optional parameters. */
235
+ export declare interface ChildAvailabilityStatusesListOptionalParams extends coreClient.OperationOptions {
236
+ /** The filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN */
237
+ filter?: string;
238
+ /** Setting $expand=recommendedactions in url query expands the recommendedactions in the response. */
239
+ expand?: string;
240
+ }
241
+
242
+ /** Contains response data for the list operation. */
243
+ export declare type ChildAvailabilityStatusesListResponse = AvailabilityStatusListResult;
244
+
245
+ /** Interface representing a ChildResources. */
246
+ export declare interface ChildResources {
247
+ /**
248
+ * Lists the all the children and its current health status for a parent resource. Use the nextLink
249
+ * property in the response to get the next page of children current health
250
+ * @param resourceUri The fully qualified ID of the resource, including the resource name and resource
251
+ * type. Currently the API only support not nested parent resource type:
252
+ * /subscriptions/{subscriptionId}/resourceGroups/{resource-group-name}/providers/{resource-provider-name}/{resource-type}/{resource-name}
253
+ * @param options The options parameters.
254
+ */
255
+ list(resourceUri: string, options?: ChildResourcesListOptionalParams): PagedAsyncIterableIterator<AvailabilityStatus>;
256
+ }
257
+
258
+ /** Optional parameters. */
259
+ export declare interface ChildResourcesListNextOptionalParams extends coreClient.OperationOptions {
260
+ /** The filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN */
261
+ filter?: string;
262
+ /** Setting $expand=recommendedactions in url query expands the recommendedactions in the response. */
263
+ expand?: string;
264
+ }
265
+
266
+ /** Contains response data for the listNext operation. */
267
+ export declare type ChildResourcesListNextResponse = AvailabilityStatusListResult;
268
+
269
+ /** Optional parameters. */
270
+ export declare interface ChildResourcesListOptionalParams extends coreClient.OperationOptions {
271
+ /** The filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN */
272
+ filter?: string;
273
+ /** Setting $expand=recommendedactions in url query expands the recommendedactions in the response. */
274
+ expand?: string;
275
+ }
276
+
277
+ /** Contains response data for the list operation. */
278
+ export declare type ChildResourcesListResponse = AvailabilityStatusListResult;
279
+
280
+ /** Object of the emerging issue impact on services and regions. */
281
+ export declare interface EmergingIssueImpact {
282
+ /** The impacted service id. */
283
+ id?: string;
284
+ /** The impacted service name. */
285
+ name?: string;
286
+ /** The list of impacted regions for corresponding emerging issues. */
287
+ regions?: ImpactedRegion[];
288
+ }
289
+
290
+ /** The list of emerging issues. */
291
+ export declare interface EmergingIssueListResult {
292
+ /** The list of emerging issues. */
293
+ value?: EmergingIssuesGetResult[];
294
+ /** The link used to get the next page of emerging issues. */
295
+ nextLink?: string;
296
+ }
297
+
298
+ /** Interface representing a EmergingIssues. */
299
+ export declare interface EmergingIssues {
300
+ /**
301
+ * Lists Azure services' emerging issues.
302
+ * @param options The options parameters.
303
+ */
304
+ list(options?: EmergingIssuesListOptionalParams): PagedAsyncIterableIterator<EmergingIssuesGetResult>;
305
+ /**
306
+ * Gets Azure services' emerging issues.
307
+ * @param options The options parameters.
308
+ */
309
+ get(options?: EmergingIssuesGetOptionalParams): Promise<EmergingIssuesGetResponse>;
310
+ }
311
+
312
+ /** Optional parameters. */
313
+ export declare interface EmergingIssuesGetOptionalParams extends coreClient.OperationOptions {
314
+ }
315
+
316
+ /** Contains response data for the get operation. */
317
+ export declare type EmergingIssuesGetResponse = EmergingIssuesGetResult;
318
+
319
+ /** The Get EmergingIssues operation response. */
320
+ export declare type EmergingIssuesGetResult = Resource & {
321
+ /** Timestamp for when last time refreshed for ongoing emerging issue. */
322
+ refreshTimestamp?: Date;
323
+ /** The list of emerging issues of banner type. */
324
+ statusBanners?: StatusBanner[];
325
+ /** The list of emerging issues of active event type. */
326
+ statusActiveEvents?: StatusActiveEvent[];
327
+ };
328
+
329
+ /** Optional parameters. */
330
+ export declare interface EmergingIssuesListNextOptionalParams extends coreClient.OperationOptions {
331
+ }
332
+
333
+ /** Contains response data for the listNext operation. */
334
+ export declare type EmergingIssuesListNextResponse = EmergingIssueListResult;
335
+
336
+ /** Optional parameters. */
337
+ export declare interface EmergingIssuesListOptionalParams extends coreClient.OperationOptions {
338
+ }
339
+
340
+ /** Contains response data for the list operation. */
341
+ export declare type EmergingIssuesListResponse = EmergingIssueListResult;
342
+
343
+ /** Error details. */
344
+ export declare interface ErrorResponse {
345
+ /**
346
+ * The error code.
347
+ * NOTE: This property will not be serialized. It can only be populated by the server.
348
+ */
349
+ readonly code?: string;
350
+ /**
351
+ * The error message.
352
+ * NOTE: This property will not be serialized. It can only be populated by the server.
353
+ */
354
+ readonly message?: string;
355
+ /**
356
+ * The error details.
357
+ * NOTE: This property will not be serialized. It can only be populated by the server.
358
+ */
359
+ readonly details?: string;
360
+ }
361
+
362
+ /** Object of impacted region. */
363
+ export declare interface ImpactedRegion {
364
+ /** The impacted region id. */
365
+ id?: string;
366
+ /** The impacted region name. */
367
+ name?: string;
368
+ }
369
+
370
+ /** Known values of {@link SeverityValues} that the service accepts. */
371
+ export declare enum KnownSeverityValues {
372
+ Information = "Information",
373
+ Warning = "Warning",
374
+ Error = "Error"
375
+ }
376
+
377
+ /** Known values of {@link StageValues} that the service accepts. */
378
+ export declare enum KnownStageValues {
379
+ Active = "Active",
380
+ Resolve = "Resolve",
381
+ Archived = "Archived"
382
+ }
383
+
384
+ export declare class MicrosoftResourceHealth extends MicrosoftResourceHealthContext {
385
+ /**
386
+ * Initializes a new instance of the MicrosoftResourceHealth class.
387
+ * @param credentials Subscription credentials which uniquely identify client subscription.
388
+ * @param subscriptionId Subscription credentials which uniquely identify Microsoft Azure subscription.
389
+ * The subscription ID forms part of the URI for every service call.
390
+ * @param options The parameter options
391
+ */
392
+ constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: MicrosoftResourceHealthOptionalParams);
393
+ availabilityStatuses: AvailabilityStatuses;
394
+ childAvailabilityStatuses: ChildAvailabilityStatuses;
395
+ childResources: ChildResources;
396
+ operations: Operations;
397
+ emergingIssues: EmergingIssues;
398
+ }
399
+
400
+ export declare class MicrosoftResourceHealthContext extends coreClient.ServiceClient {
401
+ $host: string;
402
+ apiVersion: string;
403
+ subscriptionId: string;
404
+ /**
405
+ * Initializes a new instance of the MicrosoftResourceHealthContext class.
406
+ * @param credentials Subscription credentials which uniquely identify client subscription.
407
+ * @param subscriptionId Subscription credentials which uniquely identify Microsoft Azure subscription.
408
+ * The subscription ID forms part of the URI for every service call.
409
+ * @param options The parameter options
410
+ */
411
+ constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: MicrosoftResourceHealthOptionalParams);
412
+ }
413
+
414
+ /** Optional parameters. */
415
+ export declare interface MicrosoftResourceHealthOptionalParams extends coreClient.ServiceClientOptions {
416
+ /** server parameter */
417
+ $host?: string;
418
+ /** Api Version */
419
+ apiVersion?: string;
420
+ /** Overrides client endpoint. */
421
+ endpoint?: string;
422
+ }
423
+
424
+ /** Operation available in the resourcehealth resource provider. */
425
+ export declare interface Operation {
426
+ /** Name of the operation. */
427
+ name?: string;
428
+ /** Properties of the operation. */
429
+ display?: OperationDisplay;
430
+ }
431
+
432
+ /** Properties of the operation. */
433
+ export declare interface OperationDisplay {
434
+ /** Provider name. */
435
+ provider?: string;
436
+ /** Resource name. */
437
+ resource?: string;
438
+ /** Operation name. */
439
+ operation?: string;
440
+ /** Description of the operation. */
441
+ description?: string;
442
+ }
443
+
444
+ /** Lists the operations response. */
445
+ export declare interface OperationListResult {
446
+ /** List of operations available in the resourcehealth resource provider. */
447
+ value: Operation[];
448
+ }
449
+
450
+ /** Interface representing a Operations. */
451
+ export declare interface Operations {
452
+ /**
453
+ * Lists available operations for the resourcehealth resource provider
454
+ * @param options The options parameters.
455
+ */
456
+ list(options?: OperationsListOptionalParams): Promise<OperationsListResponse>;
457
+ }
458
+
459
+ /** Optional parameters. */
460
+ export declare interface OperationsListOptionalParams extends coreClient.OperationOptions {
461
+ }
462
+
463
+ /** Contains response data for the list operation. */
464
+ export declare type OperationsListResponse = OperationListResult;
465
+
466
+ /** Defines values for ReasonChronicityTypes. */
467
+ export declare type ReasonChronicityTypes = "Transient" | "Persistent";
468
+
469
+ /** Lists actions the user can take based on the current availabilityState of the resource. */
470
+ export declare interface RecommendedAction {
471
+ /** Recommended action. */
472
+ action?: string;
473
+ /** Link to the action */
474
+ actionUrl?: string;
475
+ /** Substring of action, it describes which text should host the action url. */
476
+ actionUrlText?: string;
477
+ }
478
+
479
+ /** Common fields that are returned in the response for all Azure Resource Manager resources */
480
+ export declare interface Resource {
481
+ /**
482
+ * Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
483
+ * NOTE: This property will not be serialized. It can only be populated by the server.
484
+ */
485
+ readonly id?: string;
486
+ /**
487
+ * The name of the resource
488
+ * NOTE: This property will not be serialized. It can only be populated by the server.
489
+ */
490
+ readonly name?: string;
491
+ /**
492
+ * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
493
+ * NOTE: This property will not be serialized. It can only be populated by the server.
494
+ */
495
+ readonly type?: string;
496
+ }
497
+
498
+ /** Lists the service impacting events that may be affecting the health of the resource. */
499
+ export declare interface ServiceImpactingEvent {
500
+ /** Timestamp for when the event started. */
501
+ eventStartTime?: Date;
502
+ /** Timestamp for when event was submitted/detected. */
503
+ eventStatusLastModifiedTime?: Date;
504
+ /** Correlation id for the event */
505
+ correlationId?: string;
506
+ /** Status of the service impacting event. */
507
+ status?: ServiceImpactingEventStatus;
508
+ /** Properties of the service impacting event. */
509
+ incidentProperties?: ServiceImpactingEventIncidentProperties;
510
+ }
511
+
512
+ /** Properties of the service impacting event. */
513
+ export declare interface ServiceImpactingEventIncidentProperties {
514
+ /** Title of the incident. */
515
+ title?: string;
516
+ /** Service impacted by the event. */
517
+ service?: string;
518
+ /** Region impacted by the event. */
519
+ region?: string;
520
+ /** Type of Event. */
521
+ incidentType?: string;
522
+ }
523
+
524
+ /** Status of the service impacting event. */
525
+ export declare interface ServiceImpactingEventStatus {
526
+ /** Current status of the event */
527
+ value?: string;
528
+ }
529
+
530
+ /**
531
+ * Defines values for SeverityValues. \
532
+ * {@link KnownSeverityValues} can be used interchangeably with SeverityValues,
533
+ * this enum contains the known values that the service supports.
534
+ * ### Known values supported by the service
535
+ * **Information** \
536
+ * **Warning** \
537
+ * **Error**
538
+ */
539
+ export declare type SeverityValues = string;
540
+
541
+ /**
542
+ * Defines values for StageValues. \
543
+ * {@link KnownStageValues} can be used interchangeably with StageValues,
544
+ * this enum contains the known values that the service supports.
545
+ * ### Known values supported by the service
546
+ * **Active** \
547
+ * **Resolve** \
548
+ * **Archived**
549
+ */
550
+ export declare type StageValues = string;
551
+
552
+ /** Active event type of emerging issue. */
553
+ export declare interface StatusActiveEvent {
554
+ /** The active event title. */
555
+ title?: string;
556
+ /** The details of active event. */
557
+ description?: string;
558
+ /** The tracking id of this active event. */
559
+ trackingId?: string;
560
+ /** The impact start time on this active event. */
561
+ startTime?: Date;
562
+ /** The cloud type of this active event. */
563
+ cloud?: string;
564
+ /** The severity level of this active event. */
565
+ severity?: SeverityValues;
566
+ /** The stage of this active event. */
567
+ stage?: StageValues;
568
+ /** The boolean value of this active event if published or not. */
569
+ published?: boolean;
570
+ /** The last time modified on this banner. */
571
+ lastModifiedTime?: Date;
572
+ /** The list of emerging issues impacts. */
573
+ impacts?: EmergingIssueImpact[];
574
+ }
575
+
576
+ /** Banner type of emerging issue. */
577
+ export declare interface StatusBanner {
578
+ /** The banner title. */
579
+ title?: string;
580
+ /** The details of banner. */
581
+ message?: string;
582
+ /** The cloud type of this banner. */
583
+ cloud?: string;
584
+ /** The last time modified on this banner. */
585
+ lastModifiedTime?: Date;
586
+ }
587
+
588
+ export { }
@@ -0,0 +1,11 @@
1
+ // This file is read by tools that parse documentation comments conforming to the TSDoc standard.
2
+ // It should be published with your NPM package. It should not be tracked by Git.
3
+ {
4
+ "tsdocVersion": "0.12",
5
+ "toolPackages": [
6
+ {
7
+ "packageName": "@microsoft/api-extractor",
8
+ "packageVersion": "7.18.19"
9
+ }
10
+ ]
11
+ }