@azure/arm-resourcehealth 3.2.1-alpha.20230522.1 → 4.0.1-alpha.20230524.2

package/review/arm-resourcehealth.api.md

@@ -9,7 +9,7 @@ import * as coreClient from '@azure/core-client';
 import { PagedAsyncIterableIterator } from '@azure/core-paging';
 
 // @public
-export type AvailabilityStateValues = "Available" | "Unavailable" | "Unknown";
+export type AvailabilityStateValues = string;
 
 // @public
 export interface AvailabilityStatus {
@@ -93,7 +93,10 @@ export interface AvailabilityStatusListResult {
 
 // @public
 export interface AvailabilityStatusProperties {
+    articleId?: string;
     availabilityState?: AvailabilityStateValues;
+    category?: string;
+    context?: string;
     detailedStatus?: string;
     healthEventCategory?: string;
     healthEventCause?: string;
@@ -102,20 +105,21 @@ export interface AvailabilityStatusProperties {
     occuredTime?: Date;
     reasonChronicity?: ReasonChronicityTypes;
     reasonType?: string;
-    recentlyResolvedState?: AvailabilityStatusPropertiesRecentlyResolvedState;
+    recentlyResolved?: AvailabilityStatusPropertiesRecentlyResolved;
     recommendedActions?: RecommendedAction[];
     reportedTime?: Date;
     resolutionETA?: Date;
     rootCauseAttributionTime?: Date;
     serviceImpactingEvents?: ServiceImpactingEvent[];
     summary?: string;
+    title?: string;
 }
 
 // @public
-export interface AvailabilityStatusPropertiesRecentlyResolvedState {
+export interface AvailabilityStatusPropertiesRecentlyResolved {
     resolvedTime?: Date;
-    unavailabilitySummary?: string;
-    unavailableOccurredTime?: Date;
+    unavailableOccuredTime?: Date;
+    unavailableSummary?: string;
 }
 
 // @public
@@ -170,6 +174,9 @@ export interface ChildResourcesListOptionalParams extends coreClient.OperationOp
 // @public
 export type ChildResourcesListResponse = AvailabilityStatusListResult;
 
+// @public
+export type CreatedByType = string;
+
 // @public
 export interface EmergingIssueImpact {
     id?: string;
@@ -185,7 +192,7 @@ export interface EmergingIssueListResult {
 
 // @public
 export interface EmergingIssues {
-    get(options?: EmergingIssuesGetOptionalParams): Promise<EmergingIssuesGetResponse>;
+    get(issueName: IssueNameParameter, options?: EmergingIssuesGetOptionalParams): Promise<EmergingIssuesGetResponse>;
     list(options?: EmergingIssuesListOptionalParams): PagedAsyncIterableIterator<EmergingIssuesGetResult>;
 }
 
@@ -197,7 +204,7 @@ export interface EmergingIssuesGetOptionalParams extends coreClient.OperationOpt
 export type EmergingIssuesGetResponse = EmergingIssuesGetResult;
 
 // @public
-export interface EmergingIssuesGetResult extends Resource {
+export interface EmergingIssuesGetResult extends ProxyResource {
     refreshTimestamp?: Date;
     statusActiveEvents?: StatusActiveEvent[];
     statusBanners?: StatusBanner[];
@@ -224,15 +231,373 @@ export interface ErrorResponse {
     readonly message?: string;
 }
 
+// @public
+interface Event_2 extends ProxyResource {
+    additionalInformation?: EventPropertiesAdditionalInformation;
+    article?: EventPropertiesArticle;
+    description?: string;
+    duration?: number;
+    enableChatWithUs?: boolean;
+    enableMicrosoftSupport?: boolean;
+    eventLevel?: EventLevelValues;
+    eventSource?: EventSourceValues;
+    eventType?: EventTypeValues;
+    externalIncidentId?: string;
+    faqs?: Faq[];
+    header?: string;
+    hirStage?: string;
+    impact?: Impact[];
+    impactMitigationTime?: Date;
+    impactStartTime?: Date;
+    impactType?: string;
+    isHIR?: boolean;
+    lastUpdateTime?: Date;
+    level?: LevelValues;
+    links?: Link[];
+    platformInitiated?: boolean;
+    priority?: number;
+    reason?: string;
+    recommendedActions?: EventPropertiesRecommendedActions;
+    status?: EventStatusValues;
+    summary?: string;
+    title?: string;
+}
+export { Event_2 as Event }
+
+// @public
+export interface EventFetchDetailsBySubscriptionIdAndTrackingIdOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type EventFetchDetailsBySubscriptionIdAndTrackingIdResponse = Event_2;
+
+// @public
+export interface EventFetchDetailsByTenantIdAndTrackingIdOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type EventFetchDetailsByTenantIdAndTrackingIdResponse = Event_2;
+
+// @public
+export interface EventGetBySubscriptionIdAndTrackingIdOptionalParams extends coreClient.OperationOptions {
+    filter?: string;
+    queryStartTime?: string;
+}
+
+// @public
+export type EventGetBySubscriptionIdAndTrackingIdResponse = Event_2;
+
+// @public
+export interface EventGetByTenantIdAndTrackingIdOptionalParams extends coreClient.OperationOptions {
+    filter?: string;
+    queryStartTime?: string;
+}
+
+// @public
+export type EventGetByTenantIdAndTrackingIdResponse = Event_2;
+
+// @public
+export interface EventImpactedResource extends ProxyResource {
+    info?: KeyValueItem[];
+    readonly targetRegion?: string;
+    readonly targetResourceId?: string;
+    readonly targetResourceType?: string;
+}
+
+// @public
+export interface EventImpactedResourceListResult {
+    nextLink?: string;
+    value: EventImpactedResource[];
+}
+
+// @public
+export type EventLevelValues = string;
+
+// @public
+export interface EventOperations {
+    fetchDetailsBySubscriptionIdAndTrackingId(eventTrackingId: string, options?: EventFetchDetailsBySubscriptionIdAndTrackingIdOptionalParams): Promise<EventFetchDetailsBySubscriptionIdAndTrackingIdResponse>;
+    fetchDetailsByTenantIdAndTrackingId(eventTrackingId: string, options?: EventFetchDetailsByTenantIdAndTrackingIdOptionalParams): Promise<EventFetchDetailsByTenantIdAndTrackingIdResponse>;
+    getBySubscriptionIdAndTrackingId(eventTrackingId: string, options?: EventGetBySubscriptionIdAndTrackingIdOptionalParams): Promise<EventGetBySubscriptionIdAndTrackingIdResponse>;
+    getByTenantIdAndTrackingId(eventTrackingId: string, options?: EventGetByTenantIdAndTrackingIdOptionalParams): Promise<EventGetByTenantIdAndTrackingIdResponse>;
+}
+
+// @public
+export interface EventPropertiesAdditionalInformation {
+    message?: string;
+}
+
+// @public
+export interface EventPropertiesArticle {
+    articleContent?: string;
+    articleId?: string;
+    parameters?: Record<string, unknown>;
+}
+
+// @public
+export interface EventPropertiesRecommendedActions {
+    actions?: EventPropertiesRecommendedActionsItem[];
+    localeCode?: string;
+    message?: string;
+}
+
+// @public
+export interface EventPropertiesRecommendedActionsItem {
+    actionText?: string;
+    groupId?: number;
+}
+
+// @public
+export interface Events {
+    nextLink?: string;
+    value: Event_2[];
+}
+
+// @public
+export interface EventsListBySingleResourceNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type EventsListBySingleResourceNextResponse = Events;
+
+// @public
+export interface EventsListBySingleResourceOptionalParams extends coreClient.OperationOptions {
+    filter?: string;
+}
+
+// @public
+export type EventsListBySingleResourceResponse = Events;
+
+// @public
+export interface EventsListBySubscriptionIdNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type EventsListBySubscriptionIdNextResponse = Events;
+
+// @public
+export interface EventsListBySubscriptionIdOptionalParams extends coreClient.OperationOptions {
+    filter?: string;
+    queryStartTime?: string;
+}
+
+// @public
+export type EventsListBySubscriptionIdResponse = Events;
+
+// @public
+export interface EventsListByTenantIdNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type EventsListByTenantIdNextResponse = Events;
+
+// @public
+export interface EventsListByTenantIdOptionalParams extends coreClient.OperationOptions {
+    filter?: string;
+    queryStartTime?: string;
+}
+
+// @public
+export type EventsListByTenantIdResponse = Events;
+
+// @public
+export interface EventsOperations {
+    listBySingleResource(resourceUri: string, options?: EventsListBySingleResourceOptionalParams): PagedAsyncIterableIterator<Event_2>;
+    listBySubscriptionId(options?: EventsListBySubscriptionIdOptionalParams): PagedAsyncIterableIterator<Event_2>;
+    listByTenantId(options?: EventsListByTenantIdOptionalParams): PagedAsyncIterableIterator<Event_2>;
+}
+
+// @public
+export type EventSourceValues = string;
+
+// @public
+export type EventStatusValues = string;
+
+// @public
+export type EventTypeValues = string;
+
+// @public
+export interface Faq {
+    answer?: string;
+    localeCode?: string;
+    question?: string;
+}
+
 // @public
 export function getContinuationToken(page: unknown): string | undefined;
 
+// @public
+export interface Impact {
+    impactedRegions?: ImpactedServiceRegion[];
+    impactedService?: string;
+}
+
 // @public
 export interface ImpactedRegion {
     id?: string;
     name?: string;
 }
 
+// @public
+export interface ImpactedResources {
+    get(eventTrackingId: string, impactedResourceName: string, options?: ImpactedResourcesGetOptionalParams): Promise<ImpactedResourcesGetResponse>;
+    getByTenantId(eventTrackingId: string, impactedResourceName: string, options?: ImpactedResourcesGetByTenantIdOptionalParams): Promise<ImpactedResourcesGetByTenantIdResponse>;
+    listBySubscriptionIdAndEventId(eventTrackingId: string, options?: ImpactedResourcesListBySubscriptionIdAndEventIdOptionalParams): PagedAsyncIterableIterator<EventImpactedResource>;
+    listByTenantIdAndEventId(eventTrackingId: string, options?: ImpactedResourcesListByTenantIdAndEventIdOptionalParams): PagedAsyncIterableIterator<EventImpactedResource>;
+}
+
+// @public
+export interface ImpactedResourcesGetByTenantIdOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ImpactedResourcesGetByTenantIdResponse = EventImpactedResource;
+
+// @public
+export interface ImpactedResourcesGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ImpactedResourcesGetResponse = EventImpactedResource;
+
+// @public
+export interface ImpactedResourcesListBySubscriptionIdAndEventIdNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ImpactedResourcesListBySubscriptionIdAndEventIdNextResponse = EventImpactedResourceListResult;
+
+// @public
+export interface ImpactedResourcesListBySubscriptionIdAndEventIdOptionalParams extends coreClient.OperationOptions {
+    filter?: string;
+}
+
+// @public
+export type ImpactedResourcesListBySubscriptionIdAndEventIdResponse = EventImpactedResourceListResult;
+
+// @public
+export interface ImpactedResourcesListByTenantIdAndEventIdNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ImpactedResourcesListByTenantIdAndEventIdNextResponse = EventImpactedResourceListResult;
+
+// @public
+export interface ImpactedResourcesListByTenantIdAndEventIdOptionalParams extends coreClient.OperationOptions {
+    filter?: string;
+}
+
+// @public
+export type ImpactedResourcesListByTenantIdAndEventIdResponse = EventImpactedResourceListResult;
+
+// @public
+export interface ImpactedResourceStatus extends ProxyResource {
+    availabilityState?: AvailabilityStateValues;
+    occurredTime?: Date;
+    reasonType?: ReasonTypeValues;
+    summary?: string;
+    title?: string;
+}
+
+// @public
+export interface ImpactedServiceRegion {
+    impactedRegion?: string;
+    impactedSubscriptions?: string[];
+    impactedTenants?: string[];
+    lastUpdateTime?: Date;
+    status?: EventStatusValues;
+    updates?: Update[];
+}
+
+// @public
+export type IssueNameParameter = string;
+
+// @public
+export interface KeyValueItem {
+    readonly key?: string;
+    readonly value?: string;
+}
+
+// @public
+export enum KnownAvailabilityStateValues {
+    Available = "Available",
+    Degraded = "Degraded",
+    Unavailable = "Unavailable",
+    Unknown = "Unknown"
+}
+
+// @public
+export enum KnownCreatedByType {
+    Application = "Application",
+    Key = "Key",
+    ManagedIdentity = "ManagedIdentity",
+    User = "User"
+}
+
+// @public
+export enum KnownEventLevelValues {
+    Critical = "Critical",
+    Error = "Error",
+    Informational = "Informational",
+    Warning = "Warning"
+}
+
+// @public
+export enum KnownEventSourceValues {
+    ResourceHealth = "ResourceHealth",
+    ServiceHealth = "ServiceHealth"
+}
+
+// @public
+export enum KnownEventStatusValues {
+    Active = "Active",
+    Resolved = "Resolved"
+}
+
+// @public
+export enum KnownEventTypeValues {
+    EmergingIssues = "EmergingIssues",
+    HealthAdvisory = "HealthAdvisory",
+    PlannedMaintenance = "PlannedMaintenance",
+    RCA = "RCA",
+    SecurityAdvisory = "SecurityAdvisory",
+    ServiceIssue = "ServiceIssue"
+}
+
+// @public
+export enum KnownIssueNameParameter {
+    Default = "default"
+}
+
+// @public
+export enum KnownLevelValues {
+    Critical = "Critical",
+    Warning = "Warning"
+}
+
+// @public
+export enum KnownLinkTypeValues {
+    Button = "Button",
+    Hyperlink = "Hyperlink"
+}
+
+// @public
+export enum KnownReasonChronicityTypes {
+    Persistent = "Persistent",
+    Transient = "Transient"
+}
+
+// @public
+export enum KnownReasonTypeValues {
+    Planned = "Planned",
+    Unplanned = "Unplanned",
+    UserInitiated = "UserInitiated"
+}
+
+// @public
+export enum KnownScenario {
+    Alerts = "Alerts"
+}
+
 // @public
 export enum KnownSeverityValues {
     Error = "Error",
@@ -247,6 +612,75 @@ export enum KnownStageValues {
     Resolve = "Resolve"
 }
 
+// @public
+export type LevelValues = string;
+
+// @public
+export interface Link {
+    bladeName?: string;
+    displayText?: LinkDisplayText;
+    extensionName?: string;
+    parameters?: Record<string, unknown>;
+    type?: LinkTypeValues;
+}
+
+// @public
+export interface LinkDisplayText {
+    localizedValue?: string;
+    value?: string;
+}
+
+// @public
+export type LinkTypeValues = string;
+
+// @public
+export interface Metadata {
+    getEntity(name: string, options?: MetadataGetEntityOptionalParams): Promise<MetadataGetEntityResponse>;
+    list(options?: MetadataListOptionalParams): PagedAsyncIterableIterator<MetadataEntity>;
+}
+
+// @public
+export interface MetadataEntity extends ProxyResource {
+    applicableScenarios?: Scenario[];
+    dependsOn?: string[];
+    displayName?: string;
+    supportedValues?: MetadataSupportedValueDetail[];
+}
+
+// @public
+export interface MetadataEntityListResult {
+    nextLink?: string;
+    value?: MetadataEntity[];
+}
+
+// @public
+export interface MetadataGetEntityOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type MetadataGetEntityResponse = MetadataEntity;
+
+// @public
+export interface MetadataListNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type MetadataListNextResponse = MetadataEntityListResult;
+
+// @public
+export interface MetadataListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type MetadataListResponse = MetadataEntityListResult;
+
+// @public
+export interface MetadataSupportedValueDetail {
+    displayName?: string;
+    id?: string;
+    resourceTypes?: string[];
+}
+
 // @public (undocumented)
 export class MicrosoftResourceHealth extends coreClient.ServiceClient {
     // (undocumented)
@@ -263,8 +697,18 @@ export class MicrosoftResourceHealth extends coreClient.ServiceClient {
     // (undocumented)
     emergingIssues: EmergingIssues;
     // (undocumented)
+    eventOperations: EventOperations;
+    // (undocumented)
+    eventsOperations: EventsOperations;
+    // (undocumented)
+    impactedResources: ImpactedResources;
+    // (undocumented)
+    metadata: Metadata;
+    // (undocumented)
     operations: Operations;
     // (undocumented)
+    securityAdvisoryImpactedResources: SecurityAdvisoryImpactedResources;
+    // (undocumented)
     subscriptionId: string;
 }
 
@@ -307,12 +751,20 @@ export interface OperationsListOptionalParams extends coreClient.OperationOption
 export type OperationsListResponse = OperationListResult;
 
 // @public
-export type ReasonChronicityTypes = "Transient" | "Persistent";
+export interface ProxyResource extends Resource {
+}
+
+// @public
+export type ReasonChronicityTypes = string;
+
+// @public
+export type ReasonTypeValues = string;
 
 // @public
 export interface RecommendedAction {
     action?: string;
     actionUrl?: string;
+    actionUrlComment?: string;
     actionUrlText?: string;
 }
 
@@ -320,9 +772,49 @@ export interface RecommendedAction {
 export interface Resource {
     readonly id?: string;
     readonly name?: string;
+    readonly systemData?: SystemData;
     readonly type?: string;
 }
 
+// @public
+export type Scenario = string;
+
+// @public
+export interface SecurityAdvisoryImpactedResources {
+    listBySubscriptionIdAndEventId(eventTrackingId: string, options?: SecurityAdvisoryImpactedResourcesListBySubscriptionIdAndEventIdOptionalParams): PagedAsyncIterableIterator<EventImpactedResource>;
+    listByTenantIdAndEventId(eventTrackingId: string, options?: SecurityAdvisoryImpactedResourcesListByTenantIdAndEventIdOptionalParams): PagedAsyncIterableIterator<EventImpactedResource>;
+}
+
+// @public
+export interface SecurityAdvisoryImpactedResourcesListBySubscriptionIdAndEventIdNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type SecurityAdvisoryImpactedResourcesListBySubscriptionIdAndEventIdNextResponse = EventImpactedResourceListResult;
+
+// @public
+export interface SecurityAdvisoryImpactedResourcesListBySubscriptionIdAndEventIdOptionalParams extends coreClient.OperationOptions {
+    filter?: string;
+}
+
+// @public
+export type SecurityAdvisoryImpactedResourcesListBySubscriptionIdAndEventIdResponse = EventImpactedResourceListResult;
+
+// @public
+export interface SecurityAdvisoryImpactedResourcesListByTenantIdAndEventIdNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type SecurityAdvisoryImpactedResourcesListByTenantIdAndEventIdNextResponse = EventImpactedResourceListResult;
+
+// @public
+export interface SecurityAdvisoryImpactedResourcesListByTenantIdAndEventIdOptionalParams extends coreClient.OperationOptions {
+    filter?: string;
+}
+
+// @public
+export type SecurityAdvisoryImpactedResourcesListByTenantIdAndEventIdResponse = EventImpactedResourceListResult;
+
 // @public
 export interface ServiceImpactingEvent {
     correlationId?: string;
@@ -373,6 +865,22 @@ export interface StatusBanner {
     title?: string;
 }
 
+// @public
+export interface SystemData {
+    createdAt?: Date;
+    createdBy?: string;
+    createdByType?: CreatedByType;
+    lastModifiedAt?: Date;
+    lastModifiedBy?: string;
+    lastModifiedByType?: CreatedByType;
+}
+
+// @public
+export interface Update {
+    summary?: string;
+    updateDateTime?: Date;
+}
+
 // (No @packageDocumentation comment for this package)
 
 ```

package/src/microsoftResourceHealth.ts

@@ -16,16 +16,26 @@ import {
 import * as coreAuth from "@azure/core-auth";
 import {
   AvailabilityStatusesImpl,
+  OperationsImpl,
+  MetadataImpl,
+  ImpactedResourcesImpl,
+  SecurityAdvisoryImpactedResourcesImpl,
+  EventsOperationsImpl,
+  EventOperationsImpl,
   ChildAvailabilityStatusesImpl,
   ChildResourcesImpl,
-  OperationsImpl,
   EmergingIssuesImpl
 } from "./operations";
 import {
   AvailabilityStatuses,
+  Operations,
+  Metadata,
+  ImpactedResources,
+  SecurityAdvisoryImpactedResources,
+  EventsOperations,
+  EventOperations,
   ChildAvailabilityStatuses,
   ChildResources,
-  Operations,
   EmergingIssues
 } from "./operationsInterfaces";
 import { MicrosoftResourceHealthOptionalParams } from "./models";
@@ -38,8 +48,7 @@ export class MicrosoftResourceHealth extends coreClient.ServiceClient {
   /**
    * Initializes a new instance of the MicrosoftResourceHealth class.
    * @param credentials Subscription credentials which uniquely identify client subscription.
-   * @param subscriptionId Subscription credentials which uniquely identify Microsoft Azure subscription.
-   *                       The subscription ID forms part of the URI for every service call.
+   * @param subscriptionId The ID of the target subscription.
    * @param options The parameter options
    */
   constructor(
@@ -63,7 +72,7 @@ export class MicrosoftResourceHealth extends coreClient.ServiceClient {
       credential: credentials
     };
 
-    const packageDetails = `azsdk-js-arm-resourcehealth/3.2.1`;
+    const packageDetails = `azsdk-js-arm-resourcehealth/4.0.1`;
     const userAgentPrefix =
       options.userAgentOptions && options.userAgentOptions.userAgentPrefix
         ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`
@@ -116,11 +125,18 @@ export class MicrosoftResourceHealth extends coreClient.ServiceClient {
 
     // Assigning values to Constant parameters
     this.$host = options.$host || "https://management.azure.com";
-    this.apiVersion = options.apiVersion || "2017-07-01";
+    this.apiVersion = options.apiVersion || "2022-10-01";
     this.availabilityStatuses = new AvailabilityStatusesImpl(this);
+    this.operations = new OperationsImpl(this);
+    this.metadata = new MetadataImpl(this);
+    this.impactedResources = new ImpactedResourcesImpl(this);
+    this.securityAdvisoryImpactedResources = new SecurityAdvisoryImpactedResourcesImpl(
+      this
+    );
+    this.eventsOperations = new EventsOperationsImpl(this);
+    this.eventOperations = new EventOperationsImpl(this);
     this.childAvailabilityStatuses = new ChildAvailabilityStatusesImpl(this);
     this.childResources = new ChildResourcesImpl(this);
-    this.operations = new OperationsImpl(this);
     this.emergingIssues = new EmergingIssuesImpl(this);
     this.addCustomApiVersionPolicy(options.apiVersion);
   }
@@ -154,8 +170,13 @@ export class MicrosoftResourceHealth extends coreClient.ServiceClient {
   }
 
   availabilityStatuses: AvailabilityStatuses;
+  operations: Operations;
+  metadata: Metadata;
+  impactedResources: ImpactedResources;
+  securityAdvisoryImpactedResources: SecurityAdvisoryImpactedResources;
+  eventsOperations: EventsOperations;
+  eventOperations: EventOperations;
   childAvailabilityStatuses: ChildAvailabilityStatuses;
   childResources: ChildResources;
-  operations: Operations;
   emergingIssues: EmergingIssues;
 }