@azure/arm-maintenance 1.0.0-beta.1

package/review/arm-maintenance.api.md

@@ -0,0 +1,597 @@
+## API Report File for "@azure/arm-maintenance"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import * as coreAuth from '@azure/core-auth';
+import * as coreClient from '@azure/core-client';
+import { PagedAsyncIterableIterator } from '@azure/core-paging';
+
+// @public
+export interface ApplyUpdate extends Resource {
+    lastUpdateTime?: Date;
+    resourceId?: string;
+    status?: UpdateStatus;
+}
+
+// @public
+export interface ApplyUpdateForResourceGroup {
+    list(resourceGroupName: string, options?: ApplyUpdateForResourceGroupListOptionalParams): PagedAsyncIterableIterator<ApplyUpdate>;
+}
+
+// @public
+export interface ApplyUpdateForResourceGroupListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ApplyUpdateForResourceGroupListResponse = ListApplyUpdate;
+
+// @public
+export interface ApplyUpdates {
+    createOrUpdate(resourceGroupName: string, providerName: string, resourceType: string, resourceName: string, options?: ApplyUpdatesCreateOrUpdateOptionalParams): Promise<ApplyUpdatesCreateOrUpdateResponse>;
+    createOrUpdateParent(resourceGroupName: string, providerName: string, resourceParentType: string, resourceParentName: string, resourceType: string, resourceName: string, options?: ApplyUpdatesCreateOrUpdateParentOptionalParams): Promise<ApplyUpdatesCreateOrUpdateParentResponse>;
+    get(resourceGroupName: string, providerName: string, resourceType: string, resourceName: string, applyUpdateName: string, options?: ApplyUpdatesGetOptionalParams): Promise<ApplyUpdatesGetResponse>;
+    getParent(resourceGroupName: string, providerName: string, resourceParentType: string, resourceParentName: string, resourceType: string, resourceName: string, applyUpdateName: string, options?: ApplyUpdatesGetParentOptionalParams): Promise<ApplyUpdatesGetParentResponse>;
+    list(options?: ApplyUpdatesListOptionalParams): PagedAsyncIterableIterator<ApplyUpdate>;
+}
+
+// @public
+export interface ApplyUpdatesCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export interface ApplyUpdatesCreateOrUpdateParentOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ApplyUpdatesCreateOrUpdateParentResponse = ApplyUpdate;
+
+// @public
+export type ApplyUpdatesCreateOrUpdateResponse = ApplyUpdate;
+
+// @public
+export interface ApplyUpdatesGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export interface ApplyUpdatesGetParentOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ApplyUpdatesGetParentResponse = ApplyUpdate;
+
+// @public
+export type ApplyUpdatesGetResponse = ApplyUpdate;
+
+// @public
+export interface ApplyUpdatesListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ApplyUpdatesListResponse = ListApplyUpdate;
+
+// @public
+export interface ConfigurationAssignment extends Resource {
+    filter?: ConfigurationAssignmentFilterProperties;
+    location?: string;
+    maintenanceConfigurationId?: string;
+    resourceId?: string;
+}
+
+// @public
+export interface ConfigurationAssignmentFilterProperties {
+    locations?: string[];
+    osTypes?: string[];
+    resourceGroups?: string[];
+    resourceTypes?: string[];
+    tagSettings?: TagSettingsProperties;
+}
+
+// @public
+export interface ConfigurationAssignments {
+    createOrUpdate(resourceGroupName: string, providerName: string, resourceType: string, resourceName: string, configurationAssignmentName: string, configurationAssignment: ConfigurationAssignment, options?: ConfigurationAssignmentsCreateOrUpdateOptionalParams): Promise<ConfigurationAssignmentsCreateOrUpdateResponse>;
+    createOrUpdateParent(resourceGroupName: string, providerName: string, resourceParentType: string, resourceParentName: string, resourceType: string, resourceName: string, configurationAssignmentName: string, configurationAssignment: ConfigurationAssignment, options?: ConfigurationAssignmentsCreateOrUpdateParentOptionalParams): Promise<ConfigurationAssignmentsCreateOrUpdateParentResponse>;
+    delete(resourceGroupName: string, providerName: string, resourceType: string, resourceName: string, configurationAssignmentName: string, options?: ConfigurationAssignmentsDeleteOptionalParams): Promise<ConfigurationAssignmentsDeleteResponse>;
+    deleteParent(resourceGroupName: string, providerName: string, resourceParentType: string, resourceParentName: string, resourceType: string, resourceName: string, configurationAssignmentName: string, options?: ConfigurationAssignmentsDeleteParentOptionalParams): Promise<ConfigurationAssignmentsDeleteParentResponse>;
+    get(resourceGroupName: string, providerName: string, resourceType: string, resourceName: string, configurationAssignmentName: string, options?: ConfigurationAssignmentsGetOptionalParams): Promise<ConfigurationAssignmentsGetResponse>;
+    getParent(resourceGroupName: string, providerName: string, resourceParentType: string, resourceParentName: string, resourceType: string, resourceName: string, configurationAssignmentName: string, options?: ConfigurationAssignmentsGetParentOptionalParams): Promise<ConfigurationAssignmentsGetParentResponse>;
+    list(resourceGroupName: string, providerName: string, resourceType: string, resourceName: string, options?: ConfigurationAssignmentsListOptionalParams): PagedAsyncIterableIterator<ConfigurationAssignment>;
+    listParent(resourceGroupName: string, providerName: string, resourceParentType: string, resourceParentName: string, resourceType: string, resourceName: string, options?: ConfigurationAssignmentsListParentOptionalParams): PagedAsyncIterableIterator<ConfigurationAssignment>;
+}
+
+// @public
+export interface ConfigurationAssignmentsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export interface ConfigurationAssignmentsCreateOrUpdateParentOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ConfigurationAssignmentsCreateOrUpdateParentResponse = ConfigurationAssignment;
+
+// @public
+export type ConfigurationAssignmentsCreateOrUpdateResponse = ConfigurationAssignment;
+
+// @public
+export interface ConfigurationAssignmentsDeleteOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export interface ConfigurationAssignmentsDeleteParentOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ConfigurationAssignmentsDeleteParentResponse = ConfigurationAssignment;
+
+// @public
+export type ConfigurationAssignmentsDeleteResponse = ConfigurationAssignment;
+
+// @public
+export interface ConfigurationAssignmentsForResourceGroup {
+    createOrUpdate(resourceGroupName: string, configurationAssignmentName: string, configurationAssignment: ConfigurationAssignment, options?: ConfigurationAssignmentsForResourceGroupCreateOrUpdateOptionalParams): Promise<ConfigurationAssignmentsForResourceGroupCreateOrUpdateResponse>;
+    delete(resourceGroupName: string, configurationAssignmentName: string, options?: ConfigurationAssignmentsForResourceGroupDeleteOptionalParams): Promise<ConfigurationAssignmentsForResourceGroupDeleteResponse>;
+    get(resourceGroupName: string, configurationAssignmentName: string, options?: ConfigurationAssignmentsForResourceGroupGetOptionalParams): Promise<ConfigurationAssignmentsForResourceGroupGetResponse>;
+    update(resourceGroupName: string, configurationAssignmentName: string, configurationAssignment: ConfigurationAssignment, options?: ConfigurationAssignmentsForResourceGroupUpdateOptionalParams): Promise<ConfigurationAssignmentsForResourceGroupUpdateResponse>;
+}
+
+// @public
+export interface ConfigurationAssignmentsForResourceGroupCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ConfigurationAssignmentsForResourceGroupCreateOrUpdateResponse = ConfigurationAssignment;
+
+// @public
+export interface ConfigurationAssignmentsForResourceGroupDeleteOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ConfigurationAssignmentsForResourceGroupDeleteResponse = ConfigurationAssignment;
+
+// @public
+export interface ConfigurationAssignmentsForResourceGroupGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ConfigurationAssignmentsForResourceGroupGetResponse = ConfigurationAssignment;
+
+// @public
+export interface ConfigurationAssignmentsForResourceGroupUpdateOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ConfigurationAssignmentsForResourceGroupUpdateResponse = ConfigurationAssignment;
+
+// @public
+export interface ConfigurationAssignmentsForSubscriptions {
+    createOrUpdate(configurationAssignmentName: string, configurationAssignment: ConfigurationAssignment, options?: ConfigurationAssignmentsForSubscriptionsCreateOrUpdateOptionalParams): Promise<ConfigurationAssignmentsForSubscriptionsCreateOrUpdateResponse>;
+    delete(configurationAssignmentName: string, options?: ConfigurationAssignmentsForSubscriptionsDeleteOptionalParams): Promise<ConfigurationAssignmentsForSubscriptionsDeleteResponse>;
+    get(configurationAssignmentName: string, options?: ConfigurationAssignmentsForSubscriptionsGetOptionalParams): Promise<ConfigurationAssignmentsForSubscriptionsGetResponse>;
+    update(configurationAssignmentName: string, configurationAssignment: ConfigurationAssignment, options?: ConfigurationAssignmentsForSubscriptionsUpdateOptionalParams): Promise<ConfigurationAssignmentsForSubscriptionsUpdateResponse>;
+}
+
+// @public
+export interface ConfigurationAssignmentsForSubscriptionsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ConfigurationAssignmentsForSubscriptionsCreateOrUpdateResponse = ConfigurationAssignment;
+
+// @public
+export interface ConfigurationAssignmentsForSubscriptionsDeleteOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ConfigurationAssignmentsForSubscriptionsDeleteResponse = ConfigurationAssignment;
+
+// @public
+export interface ConfigurationAssignmentsForSubscriptionsGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ConfigurationAssignmentsForSubscriptionsGetResponse = ConfigurationAssignment;
+
+// @public
+export interface ConfigurationAssignmentsForSubscriptionsUpdateOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ConfigurationAssignmentsForSubscriptionsUpdateResponse = ConfigurationAssignment;
+
+// @public
+export interface ConfigurationAssignmentsGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export interface ConfigurationAssignmentsGetParentOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ConfigurationAssignmentsGetParentResponse = ConfigurationAssignment;
+
+// @public
+export type ConfigurationAssignmentsGetResponse = ConfigurationAssignment;
+
+// @public
+export interface ConfigurationAssignmentsListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export interface ConfigurationAssignmentsListParentOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ConfigurationAssignmentsListParentResponse = ListConfigurationAssignmentsResult;
+
+// @public
+export type ConfigurationAssignmentsListResponse = ListConfigurationAssignmentsResult;
+
+// @public
+export interface ConfigurationAssignmentsWithinSubscription {
+    list(options?: ConfigurationAssignmentsWithinSubscriptionListOptionalParams): PagedAsyncIterableIterator<ConfigurationAssignment>;
+}
+
+// @public
+export interface ConfigurationAssignmentsWithinSubscriptionListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ConfigurationAssignmentsWithinSubscriptionListResponse = ListConfigurationAssignmentsResult;
+
+// @public
+export type CreatedByType = string;
+
+// @public
+export interface ErrorDetails {
+    code?: string;
+    message?: string;
+}
+
+// @public
+export function getContinuationToken(page: unknown): string | undefined;
+
+// @public
+export type ImpactType = string;
+
+// @public
+export interface InputLinuxParameters {
+    classificationsToInclude?: string[];
+    packageNameMasksToExclude?: string[];
+    packageNameMasksToInclude?: string[];
+}
+
+// @public
+export interface InputPatchConfiguration {
+    linuxParameters?: InputLinuxParameters;
+    rebootSetting?: RebootOptions;
+    windowsParameters?: InputWindowsParameters;
+}
+
+// @public
+export interface InputWindowsParameters {
+    classificationsToInclude?: string[];
+    excludeKbsRequiringReboot?: boolean;
+    kbNumbersToExclude?: string[];
+    kbNumbersToInclude?: string[];
+}
+
+// @public
+export enum KnownCreatedByType {
+    Application = "Application",
+    Key = "Key",
+    ManagedIdentity = "ManagedIdentity",
+    User = "User"
+}
+
+// @public
+export enum KnownImpactType {
+    Freeze = "Freeze",
+    None = "None",
+    Redeploy = "Redeploy",
+    Restart = "Restart"
+}
+
+// @public
+export enum KnownMaintenanceScope {
+    Extension = "Extension",
+    Host = "Host",
+    InGuestPatch = "InGuestPatch",
+    OSImage = "OSImage",
+    Resource = "Resource",
+    Sqldb = "SQLDB",
+    SQLManagedInstance = "SQLManagedInstance"
+}
+
+// @public
+export enum KnownRebootOptions {
+    Always = "Always",
+    IfRequired = "IfRequired",
+    Never = "Never"
+}
+
+// @public
+export enum KnownUpdateStatus {
+    Completed = "Completed",
+    InProgress = "InProgress",
+    Pending = "Pending",
+    RetryLater = "RetryLater",
+    RetryNow = "RetryNow"
+}
+
+// @public
+export enum KnownVisibility {
+    Custom = "Custom",
+    Public = "Public"
+}
+
+// @public
+export interface ListApplyUpdate {
+    value?: ApplyUpdate[];
+}
+
+// @public
+export interface ListConfigurationAssignmentsResult {
+    value?: ConfigurationAssignment[];
+}
+
+// @public
+export interface ListMaintenanceConfigurationsResult {
+    value?: MaintenanceConfiguration[];
+}
+
+// @public
+export interface ListUpdatesResult {
+    value?: Update[];
+}
+
+// @public
+export interface MaintenanceConfiguration extends Resource {
+    duration?: string;
+    expirationDateTime?: string;
+    extensionProperties?: {
+        [propertyName: string]: string;
+    };
+    installPatches?: InputPatchConfiguration;
+    location?: string;
+    maintenanceScope?: MaintenanceScope;
+    namespace?: string;
+    recurEvery?: string;
+    startDateTime?: string;
+    tags?: {
+        [propertyName: string]: string;
+    };
+    timeZone?: string;
+    visibility?: Visibility;
+}
+
+// @public
+export interface MaintenanceConfigurations {
+    createOrUpdate(resourceGroupName: string, resourceName: string, configuration: MaintenanceConfiguration, options?: MaintenanceConfigurationsCreateOrUpdateOptionalParams): Promise<MaintenanceConfigurationsCreateOrUpdateResponse>;
+    delete(resourceGroupName: string, resourceName: string, options?: MaintenanceConfigurationsDeleteOptionalParams): Promise<MaintenanceConfigurationsDeleteResponse>;
+    get(resourceGroupName: string, resourceName: string, options?: MaintenanceConfigurationsGetOptionalParams): Promise<MaintenanceConfigurationsGetResponse>;
+    list(options?: MaintenanceConfigurationsListOptionalParams): PagedAsyncIterableIterator<MaintenanceConfiguration>;
+    update(resourceGroupName: string, resourceName: string, configuration: MaintenanceConfiguration, options?: MaintenanceConfigurationsUpdateOptionalParams): Promise<MaintenanceConfigurationsUpdateResponse>;
+}
+
+// @public
+export interface MaintenanceConfigurationsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type MaintenanceConfigurationsCreateOrUpdateResponse = MaintenanceConfiguration;
+
+// @public
+export interface MaintenanceConfigurationsDeleteOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type MaintenanceConfigurationsDeleteResponse = MaintenanceConfiguration;
+
+// @public
+export interface MaintenanceConfigurationsForResourceGroup {
+    list(resourceGroupName: string, options?: MaintenanceConfigurationsForResourceGroupListOptionalParams): PagedAsyncIterableIterator<MaintenanceConfiguration>;
+}
+
+// @public
+export interface MaintenanceConfigurationsForResourceGroupListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type MaintenanceConfigurationsForResourceGroupListResponse = ListMaintenanceConfigurationsResult;
+
+// @public
+export interface MaintenanceConfigurationsGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type MaintenanceConfigurationsGetResponse = MaintenanceConfiguration;
+
+// @public
+export interface MaintenanceConfigurationsListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type MaintenanceConfigurationsListResponse = ListMaintenanceConfigurationsResult;
+
+// @public
+export interface MaintenanceConfigurationsUpdateOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type MaintenanceConfigurationsUpdateResponse = MaintenanceConfiguration;
+
+// @public
+export interface MaintenanceError {
+    error?: ErrorDetails;
+}
+
+// @public (undocumented)
+export class MaintenanceManagementClient extends coreClient.ServiceClient {
+    // (undocumented)
+    $host: string;
+    constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: MaintenanceManagementClientOptionalParams);
+    // (undocumented)
+    apiVersion: string;
+    // (undocumented)
+    applyUpdateForResourceGroup: ApplyUpdateForResourceGroup;
+    // (undocumented)
+    applyUpdates: ApplyUpdates;
+    // (undocumented)
+    configurationAssignments: ConfigurationAssignments;
+    // (undocumented)
+    configurationAssignmentsForResourceGroup: ConfigurationAssignmentsForResourceGroup;
+    // (undocumented)
+    configurationAssignmentsForSubscriptions: ConfigurationAssignmentsForSubscriptions;
+    // (undocumented)
+    configurationAssignmentsWithinSubscription: ConfigurationAssignmentsWithinSubscription;
+    // (undocumented)
+    maintenanceConfigurations: MaintenanceConfigurations;
+    // (undocumented)
+    maintenanceConfigurationsForResourceGroup: MaintenanceConfigurationsForResourceGroup;
+    // (undocumented)
+    operations: Operations;
+    // (undocumented)
+    publicMaintenanceConfigurations: PublicMaintenanceConfigurations;
+    // (undocumented)
+    subscriptionId: string;
+    // (undocumented)
+    updates: Updates;
+}
+
+// @public
+export interface MaintenanceManagementClientOptionalParams extends coreClient.ServiceClientOptions {
+    $host?: string;
+    apiVersion?: string;
+    endpoint?: string;
+}
+
+// @public
+export type MaintenanceScope = string;
+
+// @public
+export interface Operation {
+    display?: OperationInfo;
+    isDataAction?: boolean;
+    name?: string;
+    origin?: string;
+    properties?: Record<string, unknown>;
+}
+
+// @public
+export interface OperationInfo {
+    description?: string;
+    operation?: string;
+    provider?: string;
+    resource?: string;
+}
+
+// @public
+export interface Operations {
+    list(options?: OperationsListOptionalParams): PagedAsyncIterableIterator<Operation>;
+}
+
+// @public
+export interface OperationsListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type OperationsListResponse = OperationsListResult;
+
+// @public
+export interface OperationsListResult {
+    value?: Operation[];
+}
+
+// @public
+export interface PublicMaintenanceConfigurations {
+    get(resourceName: string, options?: PublicMaintenanceConfigurationsGetOptionalParams): Promise<PublicMaintenanceConfigurationsGetResponse>;
+    list(options?: PublicMaintenanceConfigurationsListOptionalParams): PagedAsyncIterableIterator<MaintenanceConfiguration>;
+}
+
+// @public
+export interface PublicMaintenanceConfigurationsGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type PublicMaintenanceConfigurationsGetResponse = MaintenanceConfiguration;
+
+// @public
+export interface PublicMaintenanceConfigurationsListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type PublicMaintenanceConfigurationsListResponse = ListMaintenanceConfigurationsResult;
+
+// @public
+export type RebootOptions = string;
+
+// @public
+export interface Resource {
+    readonly id?: string;
+    readonly name?: string;
+    readonly systemData?: SystemData;
+    readonly type?: string;
+}
+
+// @public
+export interface SystemData {
+    createdAt?: Date;
+    createdBy?: string;
+    createdByType?: CreatedByType;
+    lastModifiedAt?: Date;
+    lastModifiedBy?: string;
+    lastModifiedByType?: CreatedByType;
+}
+
+// @public
+export type TagOperators = "All" | "Any";
+
+// @public
+export interface TagSettingsProperties {
+    filterOperator?: TagOperators;
+    tags?: {
+        [propertyName: string]: string[];
+    };
+}
+
+// @public
+export interface Update {
+    impactDurationInSec?: number;
+    impactType?: ImpactType;
+    maintenanceScope?: MaintenanceScope;
+    notBefore?: Date;
+    resourceId?: string;
+    status?: UpdateStatus;
+}
+
+// @public
+export interface Updates {
+    list(resourceGroupName: string, providerName: string, resourceType: string, resourceName: string, options?: UpdatesListOptionalParams): PagedAsyncIterableIterator<Update>;
+    listParent(resourceGroupName: string, providerName: string, resourceParentType: string, resourceParentName: string, resourceType: string, resourceName: string, options?: UpdatesListParentOptionalParams): PagedAsyncIterableIterator<Update>;
+}
+
+// @public
+export interface UpdatesListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export interface UpdatesListParentOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type UpdatesListParentResponse = ListUpdatesResult;
+
+// @public
+export type UpdatesListResponse = ListUpdatesResult;
+
+// @public
+export type UpdateStatus = string;
+
+// @public
+export type Visibility = string;
+
+// (No @packageDocumentation comment for this package)
+
+```