@azure/arm-resourcehealth 3.2.1-alpha.20230511.1 → 4.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (190) hide show
  1. package/CHANGELOG.md +111 -8
  2. package/dist/index.js +2621 -386
  3. package/dist/index.js.map +1 -1
  4. package/dist/index.min.js +1 -1
  5. package/dist/index.min.js.map +1 -1
  6. package/dist-esm/samples-dev/availabilityStatusesGetByResourceSample.js +1 -1
  7. package/dist-esm/samples-dev/availabilityStatusesListByResourceGroupSample.js +3 -3
  8. package/dist-esm/samples-dev/availabilityStatusesListBySubscriptionIdSample.js +3 -3
  9. package/dist-esm/samples-dev/availabilityStatusesListSample.js +3 -3
  10. package/dist-esm/samples-dev/childAvailabilityStatusesGetByResourceSample.js +4 -4
  11. package/dist-esm/samples-dev/childAvailabilityStatusesGetByResourceSample.js.map +1 -1
  12. package/dist-esm/samples-dev/childAvailabilityStatusesListSample.js +4 -4
  13. package/dist-esm/samples-dev/childAvailabilityStatusesListSample.js.map +1 -1
  14. package/dist-esm/samples-dev/childResourcesListSample.js +3 -3
  15. package/dist-esm/samples-dev/childResourcesListSample.js.map +1 -1
  16. package/dist-esm/samples-dev/emergingIssuesGetSample.js +3 -2
  17. package/dist-esm/samples-dev/emergingIssuesGetSample.js.map +1 -1
  18. package/dist-esm/samples-dev/emergingIssuesListSample.js +1 -1
  19. package/dist-esm/samples-dev/eventFetchDetailsBySubscriptionIdAndTrackingIdSample.d.ts +2 -0
  20. package/dist-esm/samples-dev/eventFetchDetailsBySubscriptionIdAndTrackingIdSample.d.ts.map +1 -0
  21. package/dist-esm/samples-dev/eventFetchDetailsBySubscriptionIdAndTrackingIdSample.js +37 -0
  22. package/dist-esm/samples-dev/eventFetchDetailsBySubscriptionIdAndTrackingIdSample.js.map +1 -0
  23. package/dist-esm/samples-dev/eventFetchDetailsByTenantIdAndTrackingIdSample.d.ts +2 -0
  24. package/dist-esm/samples-dev/eventFetchDetailsByTenantIdAndTrackingIdSample.d.ts.map +1 -0
  25. package/dist-esm/samples-dev/eventFetchDetailsByTenantIdAndTrackingIdSample.js +38 -0
  26. package/dist-esm/samples-dev/eventFetchDetailsByTenantIdAndTrackingIdSample.js.map +1 -0
  27. package/dist-esm/samples-dev/eventGetBySubscriptionIdAndTrackingIdSample.d.ts +2 -0
  28. package/dist-esm/samples-dev/eventGetBySubscriptionIdAndTrackingIdSample.d.ts.map +1 -0
  29. package/dist-esm/samples-dev/eventGetBySubscriptionIdAndTrackingIdSample.js +43 -0
  30. package/dist-esm/samples-dev/eventGetBySubscriptionIdAndTrackingIdSample.js.map +1 -0
  31. package/dist-esm/samples-dev/eventGetByTenantIdAndTrackingIdSample.d.ts +2 -0
  32. package/dist-esm/samples-dev/eventGetByTenantIdAndTrackingIdSample.d.ts.map +1 -0
  33. package/dist-esm/samples-dev/eventGetByTenantIdAndTrackingIdSample.js +44 -0
  34. package/dist-esm/samples-dev/eventGetByTenantIdAndTrackingIdSample.js.map +1 -0
  35. package/dist-esm/samples-dev/eventsListBySingleResourceSample.d.ts +2 -0
  36. package/dist-esm/samples-dev/eventsListBySingleResourceSample.d.ts.map +1 -0
  37. package/dist-esm/samples-dev/eventsListBySingleResourceSample.js +59 -0
  38. package/dist-esm/samples-dev/eventsListBySingleResourceSample.js.map +1 -0
  39. package/dist-esm/samples-dev/eventsListBySubscriptionIdSample.d.ts +2 -0
  40. package/dist-esm/samples-dev/eventsListBySubscriptionIdSample.d.ts.map +1 -0
  41. package/dist-esm/samples-dev/eventsListBySubscriptionIdSample.js +63 -0
  42. package/dist-esm/samples-dev/eventsListBySubscriptionIdSample.js.map +1 -0
  43. package/dist-esm/samples-dev/eventsListByTenantIdSample.d.ts +2 -0
  44. package/dist-esm/samples-dev/eventsListByTenantIdSample.d.ts.map +1 -0
  45. package/dist-esm/samples-dev/eventsListByTenantIdSample.js +64 -0
  46. package/dist-esm/samples-dev/eventsListByTenantIdSample.js.map +1 -0
  47. package/dist-esm/samples-dev/impactedResourcesGetByTenantIdSample.d.ts +2 -0
  48. package/dist-esm/samples-dev/impactedResourcesGetByTenantIdSample.d.ts.map +1 -0
  49. package/dist-esm/samples-dev/impactedResourcesGetByTenantIdSample.js +39 -0
  50. package/dist-esm/samples-dev/impactedResourcesGetByTenantIdSample.js.map +1 -0
  51. package/dist-esm/samples-dev/impactedResourcesGetSample.d.ts +2 -0
  52. package/dist-esm/samples-dev/impactedResourcesGetSample.d.ts.map +1 -0
  53. package/dist-esm/samples-dev/impactedResourcesGetSample.js +38 -0
  54. package/dist-esm/samples-dev/impactedResourcesGetSample.js.map +1 -0
  55. package/dist-esm/samples-dev/impactedResourcesListBySubscriptionIdAndEventIdSample.d.ts +2 -0
  56. package/dist-esm/samples-dev/impactedResourcesListBySubscriptionIdAndEventIdSample.d.ts.map +1 -0
  57. package/dist-esm/samples-dev/impactedResourcesListBySubscriptionIdAndEventIdSample.js +62 -0
  58. package/dist-esm/samples-dev/impactedResourcesListBySubscriptionIdAndEventIdSample.js.map +1 -0
  59. package/dist-esm/samples-dev/impactedResourcesListByTenantIdAndEventIdSample.d.ts +2 -0
  60. package/dist-esm/samples-dev/impactedResourcesListByTenantIdAndEventIdSample.d.ts.map +1 -0
  61. package/dist-esm/samples-dev/impactedResourcesListByTenantIdAndEventIdSample.js +63 -0
  62. package/dist-esm/samples-dev/impactedResourcesListByTenantIdAndEventIdSample.js.map +1 -0
  63. package/dist-esm/samples-dev/metadataGetEntitySample.d.ts +2 -0
  64. package/dist-esm/samples-dev/metadataGetEntitySample.d.ts.map +1 -0
  65. package/dist-esm/samples-dev/metadataGetEntitySample.js +38 -0
  66. package/dist-esm/samples-dev/metadataGetEntitySample.js.map +1 -0
  67. package/dist-esm/samples-dev/metadataListSample.d.ts +2 -0
  68. package/dist-esm/samples-dev/metadataListSample.d.ts.map +1 -0
  69. package/dist-esm/samples-dev/metadataListSample.js +58 -0
  70. package/dist-esm/samples-dev/metadataListSample.js.map +1 -0
  71. package/dist-esm/samples-dev/operationsListSample.d.ts +2 -0
  72. package/dist-esm/samples-dev/operationsListSample.d.ts.map +1 -0
  73. package/dist-esm/samples-dev/operationsListSample.js +37 -0
  74. package/dist-esm/samples-dev/operationsListSample.js.map +1 -0
  75. package/dist-esm/samples-dev/securityAdvisoryImpactedResourcesListBySubscriptionIdAndEventIdSample.d.ts +2 -0
  76. package/dist-esm/samples-dev/securityAdvisoryImpactedResourcesListBySubscriptionIdAndEventIdSample.d.ts.map +1 -0
  77. package/dist-esm/samples-dev/securityAdvisoryImpactedResourcesListBySubscriptionIdAndEventIdSample.js +58 -0
  78. package/dist-esm/samples-dev/securityAdvisoryImpactedResourcesListBySubscriptionIdAndEventIdSample.js.map +1 -0
  79. package/dist-esm/samples-dev/securityAdvisoryImpactedResourcesListByTenantIdAndEventIdSample.d.ts +2 -0
  80. package/dist-esm/samples-dev/securityAdvisoryImpactedResourcesListByTenantIdAndEventIdSample.d.ts.map +1 -0
  81. package/dist-esm/samples-dev/securityAdvisoryImpactedResourcesListByTenantIdAndEventIdSample.js +59 -0
  82. package/dist-esm/samples-dev/securityAdvisoryImpactedResourcesListByTenantIdAndEventIdSample.js.map +1 -0
  83. package/dist-esm/src/microsoftResourceHealth.d.ts +8 -4
  84. package/dist-esm/src/microsoftResourceHealth.d.ts.map +1 -1
  85. package/dist-esm/src/microsoftResourceHealth.js +10 -6
  86. package/dist-esm/src/microsoftResourceHealth.js.map +1 -1
  87. package/dist-esm/src/models/index.d.ts +657 -34
  88. package/dist-esm/src/models/index.d.ts.map +1 -1
  89. package/dist-esm/src/models/index.js +114 -0
  90. package/dist-esm/src/models/index.js.map +1 -1
  91. package/dist-esm/src/models/mappers.d.ts +24 -3
  92. package/dist-esm/src/models/mappers.d.ts.map +1 -1
  93. package/dist-esm/src/models/mappers.js +883 -100
  94. package/dist-esm/src/models/mappers.js.map +1 -1
  95. package/dist-esm/src/models/parameters.d.ts +4 -0
  96. package/dist-esm/src/models/parameters.d.ts.map +1 -1
  97. package/dist-esm/src/models/parameters.js +51 -3
  98. package/dist-esm/src/models/parameters.js.map +1 -1
  99. package/dist-esm/src/operations/availabilityStatuses.d.ts +9 -15
  100. package/dist-esm/src/operations/availabilityStatuses.d.ts.map +1 -1
  101. package/dist-esm/src/operations/availabilityStatuses.js +9 -15
  102. package/dist-esm/src/operations/availabilityStatuses.js.map +1 -1
  103. package/dist-esm/src/operations/emergingIssues.d.ts +6 -5
  104. package/dist-esm/src/operations/emergingIssues.d.ts.map +1 -1
  105. package/dist-esm/src/operations/emergingIssues.js +15 -14
  106. package/dist-esm/src/operations/emergingIssues.js.map +1 -1
  107. package/dist-esm/src/operations/eventOperations.d.ts +39 -0
  108. package/dist-esm/src/operations/eventOperations.d.ts.map +1 -0
  109. package/dist-esm/src/operations/eventOperations.js +137 -0
  110. package/dist-esm/src/operations/eventOperations.js.map +1 -0
  111. package/dist-esm/src/operations/eventsOperations.d.ts +83 -0
  112. package/dist-esm/src/operations/eventsOperations.d.ts.map +1 -0
  113. package/dist-esm/src/operations/eventsOperations.js +393 -0
  114. package/dist-esm/src/operations/eventsOperations.js.map +1 -0
  115. package/dist-esm/src/operations/impactedResources.d.ts +72 -0
  116. package/dist-esm/src/operations/impactedResources.d.ts.map +1 -0
  117. package/dist-esm/src/operations/impactedResources.js +330 -0
  118. package/dist-esm/src/operations/impactedResources.js.map +1 -0
  119. package/dist-esm/src/operations/index.d.ts +6 -1
  120. package/dist-esm/src/operations/index.d.ts.map +1 -1
  121. package/dist-esm/src/operations/index.js +6 -1
  122. package/dist-esm/src/operations/index.js.map +1 -1
  123. package/dist-esm/src/operations/metadata.d.ts +38 -0
  124. package/dist-esm/src/operations/metadata.d.ts.map +1 -0
  125. package/dist-esm/src/operations/metadata.js +162 -0
  126. package/dist-esm/src/operations/metadata.js.map +1 -0
  127. package/dist-esm/src/operations/securityAdvisoryImpactedResources.d.ts +58 -0
  128. package/dist-esm/src/operations/securityAdvisoryImpactedResources.d.ts.map +1 -0
  129. package/dist-esm/src/operations/securityAdvisoryImpactedResources.js +271 -0
  130. package/dist-esm/src/operations/securityAdvisoryImpactedResources.js.map +1 -0
  131. package/dist-esm/src/operationsInterfaces/availabilityStatuses.d.ts +4 -7
  132. package/dist-esm/src/operationsInterfaces/availabilityStatuses.d.ts.map +1 -1
  133. package/dist-esm/src/operationsInterfaces/emergingIssues.d.ts +3 -2
  134. package/dist-esm/src/operationsInterfaces/emergingIssues.d.ts.map +1 -1
  135. package/dist-esm/src/operationsInterfaces/eventOperations.d.ts +31 -0
  136. package/dist-esm/src/operationsInterfaces/eventOperations.d.ts.map +1 -0
  137. package/dist-esm/src/operationsInterfaces/eventOperations.js +9 -0
  138. package/dist-esm/src/operationsInterfaces/eventOperations.js.map +1 -0
  139. package/dist-esm/src/operationsInterfaces/eventsOperations.d.ts +26 -0
  140. package/dist-esm/src/operationsInterfaces/eventsOperations.d.ts.map +1 -0
  141. package/dist-esm/src/operationsInterfaces/eventsOperations.js +9 -0
  142. package/dist-esm/src/operationsInterfaces/eventsOperations.js.map +1 -0
  143. package/dist-esm/src/operationsInterfaces/impactedResources.d.ts +32 -0
  144. package/dist-esm/src/operationsInterfaces/impactedResources.d.ts.map +1 -0
  145. package/dist-esm/src/operationsInterfaces/impactedResources.js +9 -0
  146. package/dist-esm/src/operationsInterfaces/impactedResources.js.map +1 -0
  147. package/dist-esm/src/operationsInterfaces/index.d.ts +6 -1
  148. package/dist-esm/src/operationsInterfaces/index.d.ts.map +1 -1
  149. package/dist-esm/src/operationsInterfaces/index.js +6 -1
  150. package/dist-esm/src/operationsInterfaces/index.js.map +1 -1
  151. package/dist-esm/src/operationsInterfaces/metadata.d.ts +17 -0
  152. package/dist-esm/src/operationsInterfaces/metadata.d.ts.map +1 -0
  153. package/dist-esm/src/operationsInterfaces/metadata.js +9 -0
  154. package/dist-esm/src/operationsInterfaces/metadata.js.map +1 -0
  155. package/dist-esm/src/operationsInterfaces/securityAdvisoryImpactedResources.d.ts +18 -0
  156. package/dist-esm/src/operationsInterfaces/securityAdvisoryImpactedResources.d.ts.map +1 -0
  157. package/dist-esm/src/operationsInterfaces/securityAdvisoryImpactedResources.js +9 -0
  158. package/dist-esm/src/operationsInterfaces/securityAdvisoryImpactedResources.js.map +1 -0
  159. package/dist-esm/test/resourcehealth_operations_test.spec.d.ts +4 -0
  160. package/dist-esm/test/resourcehealth_operations_test.spec.d.ts.map +1 -0
  161. package/dist-esm/test/resourcehealth_operations_test.spec.js +56 -0
  162. package/dist-esm/test/resourcehealth_operations_test.spec.js.map +1 -0
  163. package/package.json +6 -6
  164. package/review/arm-resourcehealth.api.md +516 -8
  165. package/src/microsoftResourceHealth.ts +29 -8
  166. package/src/models/index.ts +757 -35
  167. package/src/models/mappers.ts +956 -101
  168. package/src/models/parameters.ts +55 -3
  169. package/src/operations/availabilityStatuses.ts +9 -15
  170. package/src/operations/emergingIssues.ts +24 -18
  171. package/src/operations/eventOperations.ts +184 -0
  172. package/src/operations/eventsOperations.ts +434 -0
  173. package/src/operations/impactedResources.ts +414 -0
  174. package/src/operations/index.ts +6 -1
  175. package/src/operations/metadata.ts +182 -0
  176. package/src/operations/securityAdvisoryImpactedResources.ts +342 -0
  177. package/src/operationsInterfaces/availabilityStatuses.ts +4 -7
  178. package/src/operationsInterfaces/emergingIssues.ts +3 -0
  179. package/src/operationsInterfaces/eventOperations.ts +60 -0
  180. package/src/operationsInterfaces/eventsOperations.ts +47 -0
  181. package/src/operationsInterfaces/impactedResources.ts +63 -0
  182. package/src/operationsInterfaces/index.ts +6 -1
  183. package/src/operationsInterfaces/metadata.ts +36 -0
  184. package/src/operationsInterfaces/securityAdvisoryImpactedResources.ts +37 -0
  185. package/types/arm-resourcehealth.d.ts +853 -23
  186. package/types/tsdoc-metadata.json +1 -1
  187. package/dist-esm/test/sampleTest.d.ts +0 -2
  188. package/dist-esm/test/sampleTest.d.ts.map +0 -1
  189. package/dist-esm/test/sampleTest.js +0 -38
  190. package/dist-esm/test/sampleTest.js.map +0 -1
@@ -2,8 +2,17 @@ import * as coreAuth from '@azure/core-auth';
2
2
  import * as coreClient from '@azure/core-client';
3
3
  import { PagedAsyncIterableIterator } from '@azure/core-paging';
4
4
 
5
- /** Defines values for AvailabilityStateValues. */
6
- export declare type AvailabilityStateValues = "Available" | "Unavailable" | "Unknown";
5
+ /**
6
+ * Defines values for AvailabilityStateValues. \
7
+ * {@link KnownAvailabilityStateValues} can be used interchangeably with AvailabilityStateValues,
8
+ * this enum contains the known values that the service supports.
9
+ * ### Known values supported by the service
10
+ * **Available** \
11
+ * **Unavailable** \
12
+ * **Degraded** \
13
+ * **Unknown**
14
+ */
15
+ export declare type AvailabilityStateValues = string;
7
16
 
8
17
  /** availabilityStatus of a resource. */
9
18
  export declare interface AvailabilityStatus {
@@ -22,21 +31,18 @@ export declare interface AvailabilityStatus {
22
31
  /** Interface representing a AvailabilityStatuses. */
23
32
  export declare interface AvailabilityStatuses {
24
33
  /**
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.
34
+ * Lists the current availability status for all the resources in the subscription.
27
35
  * @param options The options parameters.
28
36
  */
29
37
  listBySubscriptionId(options?: AvailabilityStatusesListBySubscriptionIdOptionalParams): PagedAsyncIterableIterator<AvailabilityStatus>;
30
38
  /**
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.
39
+ * Lists the current availability status for all the resources in the resource group.
40
+ * @param resourceGroupName The name of the resource group. The name is case insensitive.
34
41
  * @param options The options parameters.
35
42
  */
36
43
  listByResourceGroup(resourceGroupName: string, options?: AvailabilityStatusesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<AvailabilityStatus>;
37
44
  /**
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
45
+ * Lists all historical availability transitions and impacting events for a single resource.
40
46
  * @param resourceUri The fully qualified ID of the resource, including the resource name and resource
41
47
  * type. Currently the API support not nested and one nesting level resource types :
42
48
  * /subscriptions/{subscriptionId}/resourceGroups/{resource-group-name}/providers/{resource-provider-name}/{resource-type}/{resource-name}
@@ -134,12 +140,20 @@ export declare interface AvailabilityStatusListResult {
134
140
  export declare interface AvailabilityStatusProperties {
135
141
  /** Availability status of the resource. When it is null, this availabilityStatus object represents an availability impacting event */
136
142
  availabilityState?: AvailabilityStateValues;
143
+ /** Title description of the availability status. */
144
+ title?: string;
137
145
  /** Summary description of the availability status. */
138
146
  summary?: string;
139
147
  /** Details of the availability status. */
140
148
  detailedStatus?: string;
141
149
  /** 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. */
142
150
  reasonType?: string;
151
+ /** When an event is created, it can either be triggered by a customer or the platform of the resource and this field will illustrate that. This field is connected to the category field in this object. */
152
+ context?: string;
153
+ /** When a context field is set to Platform, this field will reflect if the event was planned or unplanned. If the context field does not have a value of Platform, then this field will be ignored. */
154
+ category?: string;
155
+ /** The Article Id */
156
+ articleId?: string;
143
157
  /** When the resource's availabilityState is Unavailable, it provides the Timestamp for when the health impacting event was received. */
144
158
  rootCauseAttributionTime?: Date;
145
159
  /** In case of an availability impacting event, it describes when the health impacting event was originated. Examples are Lifecycle, Downtime, Fault Analysis etc. */
@@ -159,7 +173,7 @@ export declare interface AvailabilityStatusProperties {
159
173
  /** Timestamp for when the health was last checked. */
160
174
  reportedTime?: Date;
161
175
  /** An annotation describing a change in the availabilityState to Available from Unavailable with a reasonType of type Unplanned */
162
- recentlyResolvedState?: AvailabilityStatusPropertiesRecentlyResolvedState;
176
+ recentlyResolved?: AvailabilityStatusPropertiesRecentlyResolved;
163
177
  /** Lists actions the user can take based on the current availabilityState of the resource. */
164
178
  recommendedActions?: RecommendedAction[];
165
179
  /** Lists the service impacting events that may be affecting the health of the resource. */
@@ -167,13 +181,13 @@ export declare interface AvailabilityStatusProperties {
167
181
  }
168
182
 
169
183
  /** An annotation describing a change in the availabilityState to Available from Unavailable with a reasonType of type Unplanned */
170
- export declare interface AvailabilityStatusPropertiesRecentlyResolvedState {
184
+ export declare interface AvailabilityStatusPropertiesRecentlyResolved {
171
185
  /** Timestamp for when the availabilityState changed to Unavailable */
172
- unavailableOccurredTime?: Date;
186
+ unavailableOccuredTime?: Date;
173
187
  /** Timestamp when the availabilityState changes to Available. */
174
188
  resolvedTime?: Date;
175
189
  /** Brief description of cause of the resource becoming unavailable. */
176
- unavailabilitySummary?: string;
190
+ unavailableSummary?: string;
177
191
  }
178
192
 
179
193
  /** Interface representing a ChildAvailabilityStatuses. */
@@ -257,6 +271,18 @@ export declare interface ChildResourcesListOptionalParams extends coreClient.Ope
257
271
  /** Contains response data for the list operation. */
258
272
  export declare type ChildResourcesListResponse = AvailabilityStatusListResult;
259
273
 
274
+ /**
275
+ * Defines values for CreatedByType. \
276
+ * {@link KnownCreatedByType} can be used interchangeably with CreatedByType,
277
+ * this enum contains the known values that the service supports.
278
+ * ### Known values supported by the service
279
+ * **User** \
280
+ * **Application** \
281
+ * **ManagedIdentity** \
282
+ * **Key**
283
+ */
284
+ export declare type CreatedByType = string;
285
+
260
286
  /** Object of the emerging issue impact on services and regions. */
261
287
  export declare interface EmergingIssueImpact {
262
288
  /** The impacted service id. */
@@ -284,9 +310,10 @@ export declare interface EmergingIssues {
284
310
  list(options?: EmergingIssuesListOptionalParams): PagedAsyncIterableIterator<EmergingIssuesGetResult>;
285
311
  /**
286
312
  * Gets Azure services' emerging issues.
313
+ * @param issueName The name of the emerging issue.
287
314
  * @param options The options parameters.
288
315
  */
289
- get(options?: EmergingIssuesGetOptionalParams): Promise<EmergingIssuesGetResponse>;
316
+ get(issueName: IssueNameParameter, options?: EmergingIssuesGetOptionalParams): Promise<EmergingIssuesGetResponse>;
290
317
  }
291
318
 
292
319
  /** Optional parameters. */
@@ -297,7 +324,7 @@ export declare interface EmergingIssuesGetOptionalParams extends coreClient.Oper
297
324
  export declare type EmergingIssuesGetResponse = EmergingIssuesGetResult;
298
325
 
299
326
  /** The Get EmergingIssues operation response. */
300
- export declare interface EmergingIssuesGetResult extends Resource {
327
+ export declare interface EmergingIssuesGetResult extends ProxyResource {
301
328
  /** Timestamp for when last time refreshed for ongoing emerging issue. */
302
329
  refreshTimestamp?: Date;
303
330
  /** The list of emerging issues of banner type. */
@@ -339,6 +366,336 @@ export declare interface ErrorResponse {
339
366
  readonly details?: string;
340
367
  }
341
368
 
369
+ /** Service health event */
370
+ declare interface Event_2 extends ProxyResource {
371
+ /** Type of event. */
372
+ eventType?: EventTypeValues;
373
+ /** Source of event. */
374
+ eventSource?: EventSourceValues;
375
+ /** Current status of event. */
376
+ status?: EventStatusValues;
377
+ /** Title text of event. */
378
+ title?: string;
379
+ /** Summary text of event. */
380
+ summary?: string;
381
+ /** Header text of event. */
382
+ header?: string;
383
+ /** Level of insight. */
384
+ level?: LevelValues;
385
+ /** Level of event. */
386
+ eventLevel?: EventLevelValues;
387
+ /** The id of the Incident */
388
+ externalIncidentId?: string;
389
+ /** The reason for the Incident */
390
+ reason?: string;
391
+ /** Article of event. */
392
+ article?: EventPropertiesArticle;
393
+ /** Useful links of event. */
394
+ links?: Link[];
395
+ /** It provides the Timestamp for when the health impacting event started. */
396
+ impactStartTime?: Date;
397
+ /** It provides the Timestamp for when the health impacting event resolved. */
398
+ impactMitigationTime?: Date;
399
+ /** List services impacted by the service health event. */
400
+ impact?: Impact[];
401
+ /** Recommended actions of event. */
402
+ recommendedActions?: EventPropertiesRecommendedActions;
403
+ /** Frequently asked questions for the service health event. */
404
+ faqs?: Faq[];
405
+ /** It provides information if the event is High incident rate event or not. */
406
+ isHIR?: boolean;
407
+ /** Tells if we want to enable or disable Microsoft Support for this event. */
408
+ enableMicrosoftSupport?: boolean;
409
+ /** Contains the communication message for the event, that could include summary, root cause and other details. */
410
+ description?: string;
411
+ /** Is true if the event is platform initiated. */
412
+ platformInitiated?: boolean;
413
+ /** Tells if we want to enable or disable Microsoft Support for this event. */
414
+ enableChatWithUs?: boolean;
415
+ /** Priority level of the event. Has value from 0 to 23. 0 is the highest priority. Service issue events have higher priority followed by planned maintenance and health advisory. Critical events have higher priority followed by error, warning and informational. Furthermore, active events have higher priority than resolved. */
416
+ priority?: number;
417
+ /** It provides the Timestamp for when the health impacting event was last updated. */
418
+ lastUpdateTime?: Date;
419
+ /** Stage for HIR Document */
420
+ hirStage?: string;
421
+ /** Additional information */
422
+ additionalInformation?: EventPropertiesAdditionalInformation;
423
+ /** duration in seconds */
424
+ duration?: number;
425
+ /** The type of the impact */
426
+ impactType?: string;
427
+ }
428
+ export { Event_2 as Event }
429
+
430
+ /** Optional parameters. */
431
+ export declare interface EventFetchDetailsBySubscriptionIdAndTrackingIdOptionalParams extends coreClient.OperationOptions {
432
+ }
433
+
434
+ /** Contains response data for the fetchDetailsBySubscriptionIdAndTrackingId operation. */
435
+ export declare type EventFetchDetailsBySubscriptionIdAndTrackingIdResponse = Event_2;
436
+
437
+ /** Optional parameters. */
438
+ export declare interface EventFetchDetailsByTenantIdAndTrackingIdOptionalParams extends coreClient.OperationOptions {
439
+ }
440
+
441
+ /** Contains response data for the fetchDetailsByTenantIdAndTrackingId operation. */
442
+ export declare type EventFetchDetailsByTenantIdAndTrackingIdResponse = Event_2;
443
+
444
+ /** Optional parameters. */
445
+ export declare interface EventGetBySubscriptionIdAndTrackingIdOptionalParams extends coreClient.OperationOptions {
446
+ /** The filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN */
447
+ filter?: string;
448
+ /** Specifies from when to return events, based on the lastUpdateTime property. For example, queryStartTime = 7/24/2020 OR queryStartTime=7%2F24%2F2020 */
449
+ queryStartTime?: string;
450
+ }
451
+
452
+ /** Contains response data for the getBySubscriptionIdAndTrackingId operation. */
453
+ export declare type EventGetBySubscriptionIdAndTrackingIdResponse = Event_2;
454
+
455
+ /** Optional parameters. */
456
+ export declare interface EventGetByTenantIdAndTrackingIdOptionalParams extends coreClient.OperationOptions {
457
+ /** The filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN */
458
+ filter?: string;
459
+ /** Specifies from when to return events, based on the lastUpdateTime property. For example, queryStartTime = 7/24/2020 OR queryStartTime=7%2F24%2F2020 */
460
+ queryStartTime?: string;
461
+ }
462
+
463
+ /** Contains response data for the getByTenantIdAndTrackingId operation. */
464
+ export declare type EventGetByTenantIdAndTrackingIdResponse = Event_2;
465
+
466
+ /** Impacted resource for an event. */
467
+ export declare interface EventImpactedResource extends ProxyResource {
468
+ /**
469
+ * Resource type within Microsoft cloud.
470
+ * NOTE: This property will not be serialized. It can only be populated by the server.
471
+ */
472
+ readonly targetResourceType?: string;
473
+ /**
474
+ * Identity for resource within Microsoft cloud.
475
+ * NOTE: This property will not be serialized. It can only be populated by the server.
476
+ */
477
+ readonly targetResourceId?: string;
478
+ /**
479
+ * Impacted resource region name.
480
+ * NOTE: This property will not be serialized. It can only be populated by the server.
481
+ */
482
+ readonly targetRegion?: string;
483
+ /** Additional information. */
484
+ info?: KeyValueItem[];
485
+ }
486
+
487
+ /** The List of eventImpactedResources operation response. */
488
+ export declare interface EventImpactedResourceListResult {
489
+ /** The list of eventImpactedResources. */
490
+ value: EventImpactedResource[];
491
+ /** The URI to fetch the next page of events. Call ListNext() with this URI to fetch the next page of impacted resource. */
492
+ nextLink?: string;
493
+ }
494
+
495
+ /**
496
+ * Defines values for EventLevelValues. \
497
+ * {@link KnownEventLevelValues} can be used interchangeably with EventLevelValues,
498
+ * this enum contains the known values that the service supports.
499
+ * ### Known values supported by the service
500
+ * **Critical** \
501
+ * **Error** \
502
+ * **Warning** \
503
+ * **Informational**
504
+ */
505
+ export declare type EventLevelValues = string;
506
+
507
+ /** Interface representing a EventOperations. */
508
+ export declare interface EventOperations {
509
+ /**
510
+ * Service health event in the subscription by event tracking id
511
+ * @param eventTrackingId Event Id which uniquely identifies ServiceHealth event.
512
+ * @param options The options parameters.
513
+ */
514
+ getBySubscriptionIdAndTrackingId(eventTrackingId: string, options?: EventGetBySubscriptionIdAndTrackingIdOptionalParams): Promise<EventGetBySubscriptionIdAndTrackingIdResponse>;
515
+ /**
516
+ * Service health event details in the subscription by event tracking id. This can be used to fetch
517
+ * sensitive properties for Security Advisory events
518
+ * @param eventTrackingId Event Id which uniquely identifies ServiceHealth event.
519
+ * @param options The options parameters.
520
+ */
521
+ fetchDetailsBySubscriptionIdAndTrackingId(eventTrackingId: string, options?: EventFetchDetailsBySubscriptionIdAndTrackingIdOptionalParams): Promise<EventFetchDetailsBySubscriptionIdAndTrackingIdResponse>;
522
+ /**
523
+ * Service health event in the tenant by event tracking id
524
+ * @param eventTrackingId Event Id which uniquely identifies ServiceHealth event.
525
+ * @param options The options parameters.
526
+ */
527
+ getByTenantIdAndTrackingId(eventTrackingId: string, options?: EventGetByTenantIdAndTrackingIdOptionalParams): Promise<EventGetByTenantIdAndTrackingIdResponse>;
528
+ /**
529
+ * Service health event details in the tenant by event tracking id. This can be used to fetch sensitive
530
+ * properties for Security Advisory events
531
+ * @param eventTrackingId Event Id which uniquely identifies ServiceHealth event.
532
+ * @param options The options parameters.
533
+ */
534
+ fetchDetailsByTenantIdAndTrackingId(eventTrackingId: string, options?: EventFetchDetailsByTenantIdAndTrackingIdOptionalParams): Promise<EventFetchDetailsByTenantIdAndTrackingIdResponse>;
535
+ }
536
+
537
+ /** Additional information */
538
+ export declare interface EventPropertiesAdditionalInformation {
539
+ /** Additional information Message */
540
+ message?: string;
541
+ }
542
+
543
+ /** Article of event. */
544
+ export declare interface EventPropertiesArticle {
545
+ /** Article content of event. */
546
+ articleContent?: string;
547
+ /** Article Id */
548
+ articleId?: string;
549
+ /** It provides a map of parameter name and value */
550
+ parameters?: Record<string, unknown>;
551
+ }
552
+
553
+ /** Recommended actions of event. */
554
+ export declare interface EventPropertiesRecommendedActions {
555
+ /** Recommended action title for the service health event. */
556
+ message?: string;
557
+ /** Recommended actions for the service health event. */
558
+ actions?: EventPropertiesRecommendedActionsItem[];
559
+ /** Recommended action locale for the service health event. */
560
+ localeCode?: string;
561
+ }
562
+
563
+ /** Recommended action for the service health event. */
564
+ export declare interface EventPropertiesRecommendedActionsItem {
565
+ /** Recommended action group Id for the service health event. */
566
+ groupId?: number;
567
+ /** Recommended action text */
568
+ actionText?: string;
569
+ }
570
+
571
+ /** The List events operation response. */
572
+ export declare interface Events {
573
+ /** The list of event. */
574
+ value: Event_2[];
575
+ /** The URI to fetch the next page of events. Call ListNext() with this URI to fetch the next page of events. */
576
+ nextLink?: string;
577
+ }
578
+
579
+ /** Optional parameters. */
580
+ export declare interface EventsListBySingleResourceNextOptionalParams extends coreClient.OperationOptions {
581
+ }
582
+
583
+ /** Contains response data for the listBySingleResourceNext operation. */
584
+ export declare type EventsListBySingleResourceNextResponse = Events;
585
+
586
+ /** Optional parameters. */
587
+ export declare interface EventsListBySingleResourceOptionalParams extends coreClient.OperationOptions {
588
+ /** The filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN */
589
+ filter?: string;
590
+ }
591
+
592
+ /** Contains response data for the listBySingleResource operation. */
593
+ export declare type EventsListBySingleResourceResponse = Events;
594
+
595
+ /** Optional parameters. */
596
+ export declare interface EventsListBySubscriptionIdNextOptionalParams extends coreClient.OperationOptions {
597
+ }
598
+
599
+ /** Contains response data for the listBySubscriptionIdNext operation. */
600
+ export declare type EventsListBySubscriptionIdNextResponse = Events;
601
+
602
+ /** Optional parameters. */
603
+ export declare interface EventsListBySubscriptionIdOptionalParams extends coreClient.OperationOptions {
604
+ /** The filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN */
605
+ filter?: string;
606
+ /** Specifies from when to return events, based on the lastUpdateTime property. For example, queryStartTime = 7/24/2020 OR queryStartTime=7%2F24%2F2020 */
607
+ queryStartTime?: string;
608
+ }
609
+
610
+ /** Contains response data for the listBySubscriptionId operation. */
611
+ export declare type EventsListBySubscriptionIdResponse = Events;
612
+
613
+ /** Optional parameters. */
614
+ export declare interface EventsListByTenantIdNextOptionalParams extends coreClient.OperationOptions {
615
+ }
616
+
617
+ /** Contains response data for the listByTenantIdNext operation. */
618
+ export declare type EventsListByTenantIdNextResponse = Events;
619
+
620
+ /** Optional parameters. */
621
+ export declare interface EventsListByTenantIdOptionalParams extends coreClient.OperationOptions {
622
+ /** The filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN */
623
+ filter?: string;
624
+ /** Specifies from when to return events, based on the lastUpdateTime property. For example, queryStartTime = 7/24/2020 OR queryStartTime=7%2F24%2F2020 */
625
+ queryStartTime?: string;
626
+ }
627
+
628
+ /** Contains response data for the listByTenantId operation. */
629
+ export declare type EventsListByTenantIdResponse = Events;
630
+
631
+ /** Interface representing a EventsOperations. */
632
+ export declare interface EventsOperations {
633
+ /**
634
+ * Lists service health events in the subscription.
635
+ * @param options The options parameters.
636
+ */
637
+ listBySubscriptionId(options?: EventsListBySubscriptionIdOptionalParams): PagedAsyncIterableIterator<Event_2>;
638
+ /**
639
+ * Lists current service health events in the tenant.
640
+ * @param options The options parameters.
641
+ */
642
+ listByTenantId(options?: EventsListByTenantIdOptionalParams): PagedAsyncIterableIterator<Event_2>;
643
+ /**
644
+ * Lists current service health events for given resource.
645
+ * @param resourceUri The fully qualified ID of the resource, including the resource name and resource
646
+ * type. Currently the API support not nested and one nesting level resource types :
647
+ * /subscriptions/{subscriptionId}/resourceGroups/{resource-group-name}/providers/{resource-provider-name}/{resource-type}/{resource-name}
648
+ * and
649
+ * /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resource-provider-name}/{parentResourceType}/{parentResourceName}/{resourceType}/{resourceName}
650
+ * @param options The options parameters.
651
+ */
652
+ listBySingleResource(resourceUri: string, options?: EventsListBySingleResourceOptionalParams): PagedAsyncIterableIterator<Event_2>;
653
+ }
654
+
655
+ /**
656
+ * Defines values for EventSourceValues. \
657
+ * {@link KnownEventSourceValues} can be used interchangeably with EventSourceValues,
658
+ * this enum contains the known values that the service supports.
659
+ * ### Known values supported by the service
660
+ * **ResourceHealth** \
661
+ * **ServiceHealth**
662
+ */
663
+ export declare type EventSourceValues = string;
664
+
665
+ /**
666
+ * Defines values for EventStatusValues. \
667
+ * {@link KnownEventStatusValues} can be used interchangeably with EventStatusValues,
668
+ * this enum contains the known values that the service supports.
669
+ * ### Known values supported by the service
670
+ * **Active** \
671
+ * **Resolved**
672
+ */
673
+ export declare type EventStatusValues = string;
674
+
675
+ /**
676
+ * Defines values for EventTypeValues. \
677
+ * {@link KnownEventTypeValues} can be used interchangeably with EventTypeValues,
678
+ * this enum contains the known values that the service supports.
679
+ * ### Known values supported by the service
680
+ * **ServiceIssue** \
681
+ * **PlannedMaintenance** \
682
+ * **HealthAdvisory** \
683
+ * **RCA** \
684
+ * **EmergingIssues** \
685
+ * **SecurityAdvisory**
686
+ */
687
+ export declare type EventTypeValues = string;
688
+
689
+ /** Frequently asked question for the service health event */
690
+ export declare interface Faq {
691
+ /** FAQ question for the service health event. */
692
+ question?: string;
693
+ /** FAQ answer for the service health event. */
694
+ answer?: string;
695
+ /** FAQ locale for the service health event. */
696
+ localeCode?: string;
697
+ }
698
+
342
699
  /**
343
700
  * Given the last `.value` produced by the `byPage` iterator,
344
701
  * returns a continuation token that can be used to begin paging from
@@ -348,6 +705,14 @@ export declare interface ErrorResponse {
348
705
  */
349
706
  export declare function getContinuationToken(page: unknown): string | undefined;
350
707
 
708
+ /** Azure service impacted by the service health event. */
709
+ export declare interface Impact {
710
+ /** Impacted service name. */
711
+ impactedService?: string;
712
+ /** List regions impacted by the service health event. */
713
+ impactedRegions?: ImpactedServiceRegion[];
714
+ }
715
+
351
716
  /** Object of impacted region. */
352
717
  export declare interface ImpactedRegion {
353
718
  /** The impacted region id. */
@@ -356,6 +721,249 @@ export declare interface ImpactedRegion {
356
721
  name?: string;
357
722
  }
358
723
 
724
+ /** Interface representing a ImpactedResources. */
725
+ export declare interface ImpactedResources {
726
+ /**
727
+ * Lists impacted resources in the subscription by an event.
728
+ * @param eventTrackingId Event Id which uniquely identifies ServiceHealth event.
729
+ * @param options The options parameters.
730
+ */
731
+ listBySubscriptionIdAndEventId(eventTrackingId: string, options?: ImpactedResourcesListBySubscriptionIdAndEventIdOptionalParams): PagedAsyncIterableIterator<EventImpactedResource>;
732
+ /**
733
+ * Lists impacted resources in the tenant by an event.
734
+ * @param eventTrackingId Event Id which uniquely identifies ServiceHealth event.
735
+ * @param options The options parameters.
736
+ */
737
+ listByTenantIdAndEventId(eventTrackingId: string, options?: ImpactedResourcesListByTenantIdAndEventIdOptionalParams): PagedAsyncIterableIterator<EventImpactedResource>;
738
+ /**
739
+ * Gets the specific impacted resource in the subscription by an event.
740
+ * @param eventTrackingId Event Id which uniquely identifies ServiceHealth event.
741
+ * @param impactedResourceName Name of the Impacted Resource.
742
+ * @param options The options parameters.
743
+ */
744
+ get(eventTrackingId: string, impactedResourceName: string, options?: ImpactedResourcesGetOptionalParams): Promise<ImpactedResourcesGetResponse>;
745
+ /**
746
+ * Gets the specific impacted resource in the tenant by an event.
747
+ * @param eventTrackingId Event Id which uniquely identifies ServiceHealth event.
748
+ * @param impactedResourceName Name of the Impacted Resource.
749
+ * @param options The options parameters.
750
+ */
751
+ getByTenantId(eventTrackingId: string, impactedResourceName: string, options?: ImpactedResourcesGetByTenantIdOptionalParams): Promise<ImpactedResourcesGetByTenantIdResponse>;
752
+ }
753
+
754
+ /** Optional parameters. */
755
+ export declare interface ImpactedResourcesGetByTenantIdOptionalParams extends coreClient.OperationOptions {
756
+ }
757
+
758
+ /** Contains response data for the getByTenantId operation. */
759
+ export declare type ImpactedResourcesGetByTenantIdResponse = EventImpactedResource;
760
+
761
+ /** Optional parameters. */
762
+ export declare interface ImpactedResourcesGetOptionalParams extends coreClient.OperationOptions {
763
+ }
764
+
765
+ /** Contains response data for the get operation. */
766
+ export declare type ImpactedResourcesGetResponse = EventImpactedResource;
767
+
768
+ /** Optional parameters. */
769
+ export declare interface ImpactedResourcesListBySubscriptionIdAndEventIdNextOptionalParams extends coreClient.OperationOptions {
770
+ }
771
+
772
+ /** Contains response data for the listBySubscriptionIdAndEventIdNext operation. */
773
+ export declare type ImpactedResourcesListBySubscriptionIdAndEventIdNextResponse = EventImpactedResourceListResult;
774
+
775
+ /** Optional parameters. */
776
+ export declare interface ImpactedResourcesListBySubscriptionIdAndEventIdOptionalParams extends coreClient.OperationOptions {
777
+ /** The filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN */
778
+ filter?: string;
779
+ }
780
+
781
+ /** Contains response data for the listBySubscriptionIdAndEventId operation. */
782
+ export declare type ImpactedResourcesListBySubscriptionIdAndEventIdResponse = EventImpactedResourceListResult;
783
+
784
+ /** Optional parameters. */
785
+ export declare interface ImpactedResourcesListByTenantIdAndEventIdNextOptionalParams extends coreClient.OperationOptions {
786
+ }
787
+
788
+ /** Contains response data for the listByTenantIdAndEventIdNext operation. */
789
+ export declare type ImpactedResourcesListByTenantIdAndEventIdNextResponse = EventImpactedResourceListResult;
790
+
791
+ /** Optional parameters. */
792
+ export declare interface ImpactedResourcesListByTenantIdAndEventIdOptionalParams extends coreClient.OperationOptions {
793
+ /** The filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN */
794
+ filter?: string;
795
+ }
796
+
797
+ /** Contains response data for the listByTenantIdAndEventId operation. */
798
+ export declare type ImpactedResourcesListByTenantIdAndEventIdResponse = EventImpactedResourceListResult;
799
+
800
+ /** impactedResource with health status */
801
+ export declare interface ImpactedResourceStatus extends ProxyResource {
802
+ /** Impacted resource status of the resource. */
803
+ availabilityState?: AvailabilityStateValues;
804
+ /** Title description of the impacted resource status. */
805
+ title?: string;
806
+ /** Summary description of the impacted resource status. */
807
+ summary?: string;
808
+ /** When the resource's availabilityState is Unavailable, it describes where the health impacting event was originated. */
809
+ reasonType?: ReasonTypeValues;
810
+ /** Timestamp for when last change in health status occurred. */
811
+ occurredTime?: Date;
812
+ }
813
+
814
+ /** Azure region impacted by the service health event. */
815
+ export declare interface ImpactedServiceRegion {
816
+ /** Impacted region name. */
817
+ impactedRegion?: string;
818
+ /** Current status of event in the region. */
819
+ status?: EventStatusValues;
820
+ /** List subscription impacted by the service health event. */
821
+ impactedSubscriptions?: string[];
822
+ /** List tenant impacted by the service health event. */
823
+ impactedTenants?: string[];
824
+ /** It provides the Timestamp for when the last update for the service health event. */
825
+ lastUpdateTime?: Date;
826
+ /** List of updates for given service health event. */
827
+ updates?: Update[];
828
+ }
829
+
830
+ /**
831
+ * Defines values for IssueNameParameter. \
832
+ * {@link KnownIssueNameParameter} can be used interchangeably with IssueNameParameter,
833
+ * this enum contains the known values that the service supports.
834
+ * ### Known values supported by the service
835
+ * **default**
836
+ */
837
+ export declare type IssueNameParameter = string;
838
+
839
+ /** Key value tuple. */
840
+ export declare interface KeyValueItem {
841
+ /**
842
+ * Key of tuple.
843
+ * NOTE: This property will not be serialized. It can only be populated by the server.
844
+ */
845
+ readonly key?: string;
846
+ /**
847
+ * Value of tuple.
848
+ * NOTE: This property will not be serialized. It can only be populated by the server.
849
+ */
850
+ readonly value?: string;
851
+ }
852
+
853
+ /** Known values of {@link AvailabilityStateValues} that the service accepts. */
854
+ export declare enum KnownAvailabilityStateValues {
855
+ /** Available */
856
+ Available = "Available",
857
+ /** Unavailable */
858
+ Unavailable = "Unavailable",
859
+ /** Degraded */
860
+ Degraded = "Degraded",
861
+ /** Unknown */
862
+ Unknown = "Unknown"
863
+ }
864
+
865
+ /** Known values of {@link CreatedByType} that the service accepts. */
866
+ export declare enum KnownCreatedByType {
867
+ /** User */
868
+ User = "User",
869
+ /** Application */
870
+ Application = "Application",
871
+ /** ManagedIdentity */
872
+ ManagedIdentity = "ManagedIdentity",
873
+ /** Key */
874
+ Key = "Key"
875
+ }
876
+
877
+ /** Known values of {@link EventLevelValues} that the service accepts. */
878
+ export declare enum KnownEventLevelValues {
879
+ /** Critical */
880
+ Critical = "Critical",
881
+ /** Error */
882
+ Error = "Error",
883
+ /** Warning */
884
+ Warning = "Warning",
885
+ /** Informational */
886
+ Informational = "Informational"
887
+ }
888
+
889
+ /** Known values of {@link EventSourceValues} that the service accepts. */
890
+ export declare enum KnownEventSourceValues {
891
+ /** ResourceHealth */
892
+ ResourceHealth = "ResourceHealth",
893
+ /** ServiceHealth */
894
+ ServiceHealth = "ServiceHealth"
895
+ }
896
+
897
+ /** Known values of {@link EventStatusValues} that the service accepts. */
898
+ export declare enum KnownEventStatusValues {
899
+ /** Active */
900
+ Active = "Active",
901
+ /** Resolved */
902
+ Resolved = "Resolved"
903
+ }
904
+
905
+ /** Known values of {@link EventTypeValues} that the service accepts. */
906
+ export declare enum KnownEventTypeValues {
907
+ /** ServiceIssue */
908
+ ServiceIssue = "ServiceIssue",
909
+ /** PlannedMaintenance */
910
+ PlannedMaintenance = "PlannedMaintenance",
911
+ /** HealthAdvisory */
912
+ HealthAdvisory = "HealthAdvisory",
913
+ /** RCA */
914
+ RCA = "RCA",
915
+ /** EmergingIssues */
916
+ EmergingIssues = "EmergingIssues",
917
+ /** SecurityAdvisory */
918
+ SecurityAdvisory = "SecurityAdvisory"
919
+ }
920
+
921
+ /** Known values of {@link IssueNameParameter} that the service accepts. */
922
+ export declare enum KnownIssueNameParameter {
923
+ /** Default */
924
+ Default = "default"
925
+ }
926
+
927
+ /** Known values of {@link LevelValues} that the service accepts. */
928
+ export declare enum KnownLevelValues {
929
+ /** Critical */
930
+ Critical = "Critical",
931
+ /** Warning */
932
+ Warning = "Warning"
933
+ }
934
+
935
+ /** Known values of {@link LinkTypeValues} that the service accepts. */
936
+ export declare enum KnownLinkTypeValues {
937
+ /** Button */
938
+ Button = "Button",
939
+ /** Hyperlink */
940
+ Hyperlink = "Hyperlink"
941
+ }
942
+
943
+ /** Known values of {@link ReasonChronicityTypes} that the service accepts. */
944
+ export declare enum KnownReasonChronicityTypes {
945
+ /** Transient */
946
+ Transient = "Transient",
947
+ /** Persistent */
948
+ Persistent = "Persistent"
949
+ }
950
+
951
+ /** Known values of {@link ReasonTypeValues} that the service accepts. */
952
+ export declare enum KnownReasonTypeValues {
953
+ /** Unplanned */
954
+ Unplanned = "Unplanned",
955
+ /** Planned */
956
+ Planned = "Planned",
957
+ /** UserInitiated */
958
+ UserInitiated = "UserInitiated"
959
+ }
960
+
961
+ /** Known values of {@link Scenario} that the service accepts. */
962
+ export declare enum KnownScenario {
963
+ /** Alerts */
964
+ Alerts = "Alerts"
965
+ }
966
+
359
967
  /** Known values of {@link SeverityValues} that the service accepts. */
360
968
  export declare enum KnownSeverityValues {
361
969
  /** Information */
@@ -376,6 +984,114 @@ export declare enum KnownStageValues {
376
984
  Archived = "Archived"
377
985
  }
378
986
 
987
+ /**
988
+ * Defines values for LevelValues. \
989
+ * {@link KnownLevelValues} can be used interchangeably with LevelValues,
990
+ * this enum contains the known values that the service supports.
991
+ * ### Known values supported by the service
992
+ * **Critical** \
993
+ * **Warning**
994
+ */
995
+ export declare type LevelValues = string;
996
+
997
+ /** Useful links for service health event. */
998
+ export declare interface Link {
999
+ /** Type of link. */
1000
+ type?: LinkTypeValues;
1001
+ /** Display text of link. */
1002
+ displayText?: LinkDisplayText;
1003
+ /** It provides the name of portal extension to produce link for given service health event. */
1004
+ extensionName?: string;
1005
+ /** It provides the name of portal extension blade to produce link for given service health event. */
1006
+ bladeName?: string;
1007
+ /** It provides a map of parameter name and value for portal extension blade to produce lik for given service health event. */
1008
+ parameters?: Record<string, unknown>;
1009
+ }
1010
+
1011
+ /** Display text of link. */
1012
+ export declare interface LinkDisplayText {
1013
+ /** Display text of link. */
1014
+ value?: string;
1015
+ /** Localized display text of link. */
1016
+ localizedValue?: string;
1017
+ }
1018
+
1019
+ /**
1020
+ * Defines values for LinkTypeValues. \
1021
+ * {@link KnownLinkTypeValues} can be used interchangeably with LinkTypeValues,
1022
+ * this enum contains the known values that the service supports.
1023
+ * ### Known values supported by the service
1024
+ * **Button** \
1025
+ * **Hyperlink**
1026
+ */
1027
+ export declare type LinkTypeValues = string;
1028
+
1029
+ /** Interface representing a Metadata. */
1030
+ export declare interface Metadata {
1031
+ /**
1032
+ * Gets the list of metadata entities.
1033
+ * @param options The options parameters.
1034
+ */
1035
+ list(options?: MetadataListOptionalParams): PagedAsyncIterableIterator<MetadataEntity>;
1036
+ /**
1037
+ * Gets the list of metadata entities.
1038
+ * @param name Name of metadata entity.
1039
+ * @param options The options parameters.
1040
+ */
1041
+ getEntity(name: string, options?: MetadataGetEntityOptionalParams): Promise<MetadataGetEntityResponse>;
1042
+ }
1043
+
1044
+ /** The metadata entity contract. */
1045
+ export declare interface MetadataEntity extends ProxyResource {
1046
+ /** The display name. */
1047
+ displayName?: string;
1048
+ /** The list of keys on which this entity depends on. */
1049
+ dependsOn?: string[];
1050
+ /** The list of scenarios applicable to this metadata entity. */
1051
+ applicableScenarios?: Scenario[];
1052
+ /** The list of supported values. */
1053
+ supportedValues?: MetadataSupportedValueDetail[];
1054
+ }
1055
+
1056
+ /** The list of metadata entities */
1057
+ export declare interface MetadataEntityListResult {
1058
+ /** The list of metadata entities. */
1059
+ value?: MetadataEntity[];
1060
+ /** The link used to get the next page of metadata. */
1061
+ nextLink?: string;
1062
+ }
1063
+
1064
+ /** Optional parameters. */
1065
+ export declare interface MetadataGetEntityOptionalParams extends coreClient.OperationOptions {
1066
+ }
1067
+
1068
+ /** Contains response data for the getEntity operation. */
1069
+ export declare type MetadataGetEntityResponse = MetadataEntity;
1070
+
1071
+ /** Optional parameters. */
1072
+ export declare interface MetadataListNextOptionalParams extends coreClient.OperationOptions {
1073
+ }
1074
+
1075
+ /** Contains response data for the listNext operation. */
1076
+ export declare type MetadataListNextResponse = MetadataEntityListResult;
1077
+
1078
+ /** Optional parameters. */
1079
+ export declare interface MetadataListOptionalParams extends coreClient.OperationOptions {
1080
+ }
1081
+
1082
+ /** Contains response data for the list operation. */
1083
+ export declare type MetadataListResponse = MetadataEntityListResult;
1084
+
1085
+ /** The metadata supported value detail. */
1086
+ export declare interface MetadataSupportedValueDetail {
1087
+ /** The id. */
1088
+ id?: string;
1089
+ /** The display name. */
1090
+ displayName?: string;
1091
+ /** The list of associated resource types. */
1092
+ resourceTypes?: string[];
1093
+ }
1094
+
379
1095
  export declare class MicrosoftResourceHealth extends coreClient.ServiceClient {
380
1096
  $host: string;
381
1097
  apiVersion: string;
@@ -383,17 +1099,21 @@ export declare class MicrosoftResourceHealth extends coreClient.ServiceClient {
383
1099
  /**
384
1100
  * Initializes a new instance of the MicrosoftResourceHealth class.
385
1101
  * @param credentials Subscription credentials which uniquely identify client subscription.
386
- * @param subscriptionId Subscription credentials which uniquely identify Microsoft Azure subscription.
387
- * The subscription ID forms part of the URI for every service call.
1102
+ * @param subscriptionId The ID of the target subscription.
388
1103
  * @param options The parameter options
389
1104
  */
390
1105
  constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: MicrosoftResourceHealthOptionalParams);
391
1106
  /** A function that adds a policy that sets the api-version (or equivalent) to reflect the library version. */
392
1107
  private addCustomApiVersionPolicy;
393
1108
  availabilityStatuses: AvailabilityStatuses;
1109
+ operations: Operations;
1110
+ metadata: Metadata;
1111
+ impactedResources: ImpactedResources;
1112
+ securityAdvisoryImpactedResources: SecurityAdvisoryImpactedResources;
1113
+ eventsOperations: EventsOperations;
1114
+ eventOperations: EventOperations;
394
1115
  childAvailabilityStatuses: ChildAvailabilityStatuses;
395
1116
  childResources: ChildResources;
396
- operations: Operations;
397
1117
  emergingIssues: EmergingIssues;
398
1118
  }
399
1119
 
@@ -407,7 +1127,7 @@ export declare interface MicrosoftResourceHealthOptionalParams extends coreClien
407
1127
  endpoint?: string;
408
1128
  }
409
1129
 
410
- /** Operation available in the resourcehealth resource provider. */
1130
+ /** Operation available in the Microsoft.ResourceHealth resource provider. */
411
1131
  export declare interface Operation {
412
1132
  /** Name of the operation. */
413
1133
  name?: string;
@@ -429,7 +1149,7 @@ export declare interface OperationDisplay {
429
1149
 
430
1150
  /** Lists the operations response. */
431
1151
  export declare interface OperationListResult {
432
- /** List of operations available in the resourcehealth resource provider. */
1152
+ /** List of operations available in the Microsoft.ResourceHealth resource provider. */
433
1153
  value: Operation[];
434
1154
  }
435
1155
 
@@ -449,8 +1169,30 @@ export declare interface OperationsListOptionalParams extends coreClient.Operati
449
1169
  /** Contains response data for the list operation. */
450
1170
  export declare type OperationsListResponse = OperationListResult;
451
1171
 
452
- /** Defines values for ReasonChronicityTypes. */
453
- export declare type ReasonChronicityTypes = "Transient" | "Persistent";
1172
+ /** The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location */
1173
+ export declare interface ProxyResource extends Resource {
1174
+ }
1175
+
1176
+ /**
1177
+ * Defines values for ReasonChronicityTypes. \
1178
+ * {@link KnownReasonChronicityTypes} can be used interchangeably with ReasonChronicityTypes,
1179
+ * this enum contains the known values that the service supports.
1180
+ * ### Known values supported by the service
1181
+ * **Transient** \
1182
+ * **Persistent**
1183
+ */
1184
+ export declare type ReasonChronicityTypes = string;
1185
+
1186
+ /**
1187
+ * Defines values for ReasonTypeValues. \
1188
+ * {@link KnownReasonTypeValues} can be used interchangeably with ReasonTypeValues,
1189
+ * this enum contains the known values that the service supports.
1190
+ * ### Known values supported by the service
1191
+ * **Unplanned** \
1192
+ * **Planned** \
1193
+ * **UserInitiated**
1194
+ */
1195
+ export declare type ReasonTypeValues = string;
454
1196
 
455
1197
  /** Lists actions the user can take based on the current availabilityState of the resource. */
456
1198
  export declare interface RecommendedAction {
@@ -458,7 +1200,9 @@ export declare interface RecommendedAction {
458
1200
  action?: string;
459
1201
  /** Link to the action */
460
1202
  actionUrl?: string;
461
- /** Substring of action, it describes which text should host the action url. */
1203
+ /** the comment for the Action */
1204
+ actionUrlComment?: string;
1205
+ /** Substring of action, it describes which text should host the action URL. */
462
1206
  actionUrlText?: string;
463
1207
  }
464
1208
 
@@ -479,8 +1223,70 @@ export declare interface Resource {
479
1223
  * NOTE: This property will not be serialized. It can only be populated by the server.
480
1224
  */
481
1225
  readonly type?: string;
1226
+ /**
1227
+ * Azure Resource Manager metadata containing createdBy and modifiedBy information.
1228
+ * NOTE: This property will not be serialized. It can only be populated by the server.
1229
+ */
1230
+ readonly systemData?: SystemData;
1231
+ }
1232
+
1233
+ /**
1234
+ * Defines values for Scenario. \
1235
+ * {@link KnownScenario} can be used interchangeably with Scenario,
1236
+ * this enum contains the known values that the service supports.
1237
+ * ### Known values supported by the service
1238
+ * **Alerts**
1239
+ */
1240
+ export declare type Scenario = string;
1241
+
1242
+ /** Interface representing a SecurityAdvisoryImpactedResources. */
1243
+ export declare interface SecurityAdvisoryImpactedResources {
1244
+ /**
1245
+ * Lists impacted resources in the subscription by an event (Security Advisory).
1246
+ * @param eventTrackingId Event Id which uniquely identifies ServiceHealth event.
1247
+ * @param options The options parameters.
1248
+ */
1249
+ listBySubscriptionIdAndEventId(eventTrackingId: string, options?: SecurityAdvisoryImpactedResourcesListBySubscriptionIdAndEventIdOptionalParams): PagedAsyncIterableIterator<EventImpactedResource>;
1250
+ /**
1251
+ * Lists impacted resources in the tenant by an event (Security Advisory).
1252
+ * @param eventTrackingId Event Id which uniquely identifies ServiceHealth event.
1253
+ * @param options The options parameters.
1254
+ */
1255
+ listByTenantIdAndEventId(eventTrackingId: string, options?: SecurityAdvisoryImpactedResourcesListByTenantIdAndEventIdOptionalParams): PagedAsyncIterableIterator<EventImpactedResource>;
1256
+ }
1257
+
1258
+ /** Optional parameters. */
1259
+ export declare interface SecurityAdvisoryImpactedResourcesListBySubscriptionIdAndEventIdNextOptionalParams extends coreClient.OperationOptions {
1260
+ }
1261
+
1262
+ /** Contains response data for the listBySubscriptionIdAndEventIdNext operation. */
1263
+ export declare type SecurityAdvisoryImpactedResourcesListBySubscriptionIdAndEventIdNextResponse = EventImpactedResourceListResult;
1264
+
1265
+ /** Optional parameters. */
1266
+ export declare interface SecurityAdvisoryImpactedResourcesListBySubscriptionIdAndEventIdOptionalParams extends coreClient.OperationOptions {
1267
+ /** The filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN */
1268
+ filter?: string;
482
1269
  }
483
1270
 
1271
+ /** Contains response data for the listBySubscriptionIdAndEventId operation. */
1272
+ export declare type SecurityAdvisoryImpactedResourcesListBySubscriptionIdAndEventIdResponse = EventImpactedResourceListResult;
1273
+
1274
+ /** Optional parameters. */
1275
+ export declare interface SecurityAdvisoryImpactedResourcesListByTenantIdAndEventIdNextOptionalParams extends coreClient.OperationOptions {
1276
+ }
1277
+
1278
+ /** Contains response data for the listByTenantIdAndEventIdNext operation. */
1279
+ export declare type SecurityAdvisoryImpactedResourcesListByTenantIdAndEventIdNextResponse = EventImpactedResourceListResult;
1280
+
1281
+ /** Optional parameters. */
1282
+ export declare interface SecurityAdvisoryImpactedResourcesListByTenantIdAndEventIdOptionalParams extends coreClient.OperationOptions {
1283
+ /** The filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN */
1284
+ filter?: string;
1285
+ }
1286
+
1287
+ /** Contains response data for the listByTenantIdAndEventId operation. */
1288
+ export declare type SecurityAdvisoryImpactedResourcesListByTenantIdAndEventIdResponse = EventImpactedResourceListResult;
1289
+
484
1290
  /** Lists the service impacting events that may be affecting the health of the resource. */
485
1291
  export declare interface ServiceImpactingEvent {
486
1292
  /** Timestamp for when the event started. */
@@ -571,4 +1377,28 @@ export declare interface StatusBanner {
571
1377
  lastModifiedTime?: Date;
572
1378
  }
573
1379
 
1380
+ /** Metadata pertaining to creation and last modification of the resource. */
1381
+ export declare interface SystemData {
1382
+ /** The identity that created the resource. */
1383
+ createdBy?: string;
1384
+ /** The type of identity that created the resource. */
1385
+ createdByType?: CreatedByType;
1386
+ /** The timestamp of resource creation (UTC). */
1387
+ createdAt?: Date;
1388
+ /** The identity that last modified the resource. */
1389
+ lastModifiedBy?: string;
1390
+ /** The type of identity that last modified the resource. */
1391
+ lastModifiedByType?: CreatedByType;
1392
+ /** The timestamp of resource last modification (UTC) */
1393
+ lastModifiedAt?: Date;
1394
+ }
1395
+
1396
+ /** Update for service health event. */
1397
+ export declare interface Update {
1398
+ /** Summary text for the given update for the service health event. */
1399
+ summary?: string;
1400
+ /** It provides the Timestamp for the given update for the service health event. */
1401
+ updateDateTime?: Date;
1402
+ }
1403
+
574
1404
  export { }