@azure/arm-guestconfiguration 1.0.0-beta.1

package/review/arm-guestconfiguration.api.md

@@ -0,0 +1,579 @@
+## API Report File for "@azure/arm-guestconfiguration"
+
+> 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 type ActionAfterReboot = string;
+
+// @public
+export interface AssignmentInfo {
+    configuration?: ConfigurationInfo;
+    readonly name?: string;
+}
+
+// @public (undocumented)
+export interface AssignmentReport {
+    assignment?: AssignmentInfo;
+    readonly complianceStatus?: ComplianceStatus;
+    readonly endTime?: Date;
+    readonly id?: string;
+    readonly operationType?: Type;
+    readonly reportId?: string;
+    resources?: AssignmentReportResource[];
+    readonly startTime?: Date;
+    vm?: VMInfo;
+}
+
+// @public
+export interface AssignmentReportDetails {
+    readonly complianceStatus?: ComplianceStatus;
+    readonly endTime?: Date;
+    readonly jobId?: string;
+    readonly operationType?: Type;
+    resources?: AssignmentReportResource[];
+    readonly startTime?: Date;
+}
+
+// @public
+export interface AssignmentReportResource {
+    readonly complianceStatus?: ComplianceStatus;
+    readonly properties?: Record<string, unknown>;
+    reasons?: AssignmentReportResourceComplianceReason[];
+    readonly resourceId?: string;
+}
+
+// @public
+export interface AssignmentReportResourceComplianceReason {
+    readonly code?: string;
+    readonly phrase?: string;
+}
+
+// @public
+export type AssignmentType = string;
+
+// @public
+export type ComplianceStatus = string;
+
+// @public
+export interface ConfigurationInfo {
+    readonly name?: string;
+    readonly version?: string;
+}
+
+// @public
+export type ConfigurationMode = string;
+
+// @public
+export interface ConfigurationParameter {
+    name?: string;
+    value?: string;
+}
+
+// @public
+export interface ConfigurationSetting {
+    readonly actionAfterReboot?: ActionAfterReboot;
+    readonly allowModuleOverwrite?: boolean;
+    readonly configurationMode?: ConfigurationMode;
+    readonly configurationModeFrequencyMins?: number;
+    readonly rebootIfNeeded?: boolean;
+    readonly refreshFrequencyMins?: number;
+}
+
+// @public
+export type CreatedByType = string;
+
+// @public
+export interface ErrorResponse {
+    // (undocumented)
+    error?: ErrorResponseError;
+}
+
+// @public (undocumented)
+export interface ErrorResponseError {
+    code?: string;
+    message?: string;
+}
+
+// @public
+export function getContinuationToken(page: unknown): string | undefined;
+
+// @public
+export interface GuestConfigurationAssignment extends ProxyResource {
+    properties?: GuestConfigurationAssignmentProperties;
+    readonly systemData?: SystemData;
+}
+
+// @public
+export interface GuestConfigurationAssignmentList {
+    value?: GuestConfigurationAssignment[];
+}
+
+// @public
+export interface GuestConfigurationAssignmentProperties {
+    readonly assignmentHash?: string;
+    readonly complianceStatus?: ComplianceStatus;
+    context?: string;
+    guestConfiguration?: GuestConfigurationNavigation;
+    readonly lastComplianceStatusChecked?: Date;
+    latestAssignmentReport?: AssignmentReport;
+    readonly latestReportId?: string;
+    readonly parameterHash?: string;
+    readonly provisioningState?: ProvisioningState;
+    readonly resourceType?: string;
+    readonly targetResourceId?: string;
+    vmssVMList?: VmssvmInfo[];
+}
+
+// @public
+export interface GuestConfigurationAssignmentReport {
+    readonly id?: string;
+    readonly name?: string;
+    properties?: GuestConfigurationAssignmentReportProperties;
+}
+
+// @public
+export interface GuestConfigurationAssignmentReportList {
+    value?: GuestConfigurationAssignmentReport[];
+}
+
+// @public
+export interface GuestConfigurationAssignmentReportProperties {
+    assignment?: AssignmentInfo;
+    readonly complianceStatus?: ComplianceStatus;
+    details?: AssignmentReportDetails;
+    readonly endTime?: Date;
+    readonly reportId?: string;
+    readonly startTime?: Date;
+    vm?: VMInfo;
+    readonly vmssResourceId?: string;
+}
+
+// @public
+export interface GuestConfigurationAssignmentReports {
+    get(resourceGroupName: string, guestConfigurationAssignmentName: string, reportId: string, vmName: string, options?: GuestConfigurationAssignmentReportsGetOptionalParams): Promise<GuestConfigurationAssignmentReportsGetResponse>;
+    list(resourceGroupName: string, guestConfigurationAssignmentName: string, vmName: string, options?: GuestConfigurationAssignmentReportsListOptionalParams): Promise<GuestConfigurationAssignmentReportsListResponse>;
+}
+
+// @public
+export interface GuestConfigurationAssignmentReportsGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type GuestConfigurationAssignmentReportsGetResponse = GuestConfigurationAssignmentReport;
+
+// @public
+export interface GuestConfigurationAssignmentReportsListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type GuestConfigurationAssignmentReportsListResponse = GuestConfigurationAssignmentReportList;
+
+// @public
+export interface GuestConfigurationAssignmentReportsVmss {
+    get(resourceGroupName: string, vmssName: string, name: string, id: string, options?: GuestConfigurationAssignmentReportsVmssGetOptionalParams): Promise<GuestConfigurationAssignmentReportsVmssGetResponse>;
+    list(resourceGroupName: string, vmssName: string, name: string, options?: GuestConfigurationAssignmentReportsVmssListOptionalParams): PagedAsyncIterableIterator<GuestConfigurationAssignmentReport>;
+}
+
+// @public
+export interface GuestConfigurationAssignmentReportsVmssGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type GuestConfigurationAssignmentReportsVmssGetResponse = GuestConfigurationAssignmentReport;
+
+// @public
+export interface GuestConfigurationAssignmentReportsVmssListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type GuestConfigurationAssignmentReportsVmssListResponse = GuestConfigurationAssignmentReportList;
+
+// @public
+export interface GuestConfigurationAssignments {
+    createOrUpdate(guestConfigurationAssignmentName: string, resourceGroupName: string, vmName: string, parameters: GuestConfigurationAssignment, options?: GuestConfigurationAssignmentsCreateOrUpdateOptionalParams): Promise<GuestConfigurationAssignmentsCreateOrUpdateResponse>;
+    delete(resourceGroupName: string, guestConfigurationAssignmentName: string, vmName: string, options?: GuestConfigurationAssignmentsDeleteOptionalParams): Promise<void>;
+    get(resourceGroupName: string, guestConfigurationAssignmentName: string, vmName: string, options?: GuestConfigurationAssignmentsGetOptionalParams): Promise<GuestConfigurationAssignmentsGetResponse>;
+    list(resourceGroupName: string, vmName: string, options?: GuestConfigurationAssignmentsListOptionalParams): PagedAsyncIterableIterator<GuestConfigurationAssignment>;
+    listRGList(resourceGroupName: string, options?: GuestConfigurationAssignmentsRGListOptionalParams): PagedAsyncIterableIterator<GuestConfigurationAssignment>;
+    listSubscriptionList(options?: GuestConfigurationAssignmentsSubscriptionListOptionalParams): PagedAsyncIterableIterator<GuestConfigurationAssignment>;
+}
+
+// @public
+export interface GuestConfigurationAssignmentsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type GuestConfigurationAssignmentsCreateOrUpdateResponse = GuestConfigurationAssignment;
+
+// @public
+export interface GuestConfigurationAssignmentsDeleteOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export interface GuestConfigurationAssignmentsGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type GuestConfigurationAssignmentsGetResponse = GuestConfigurationAssignment;
+
+// @public
+export interface GuestConfigurationAssignmentsListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type GuestConfigurationAssignmentsListResponse = GuestConfigurationAssignmentList;
+
+// @public
+export interface GuestConfigurationAssignmentsRGListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type GuestConfigurationAssignmentsRGListResponse = GuestConfigurationAssignmentList;
+
+// @public
+export interface GuestConfigurationAssignmentsSubscriptionListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type GuestConfigurationAssignmentsSubscriptionListResponse = GuestConfigurationAssignmentList;
+
+// @public
+export interface GuestConfigurationAssignmentsVmss {
+    createOrUpdate(resourceGroupName: string, vmssName: string, name: string, parameters: GuestConfigurationAssignment, options?: GuestConfigurationAssignmentsVmssCreateOrUpdateOptionalParams): Promise<GuestConfigurationAssignmentsVmssCreateOrUpdateResponse>;
+    delete(resourceGroupName: string, vmssName: string, name: string, options?: GuestConfigurationAssignmentsVmssDeleteOptionalParams): Promise<GuestConfigurationAssignmentsVmssDeleteResponse>;
+    get(resourceGroupName: string, vmssName: string, name: string, options?: GuestConfigurationAssignmentsVmssGetOptionalParams): Promise<GuestConfigurationAssignmentsVmssGetResponse>;
+    list(resourceGroupName: string, vmssName: string, options?: GuestConfigurationAssignmentsVmssListOptionalParams): PagedAsyncIterableIterator<GuestConfigurationAssignment>;
+}
+
+// @public
+export interface GuestConfigurationAssignmentsVmssCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type GuestConfigurationAssignmentsVmssCreateOrUpdateResponse = GuestConfigurationAssignment;
+
+// @public
+export interface GuestConfigurationAssignmentsVmssDeleteOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type GuestConfigurationAssignmentsVmssDeleteResponse = GuestConfigurationAssignment;
+
+// @public
+export interface GuestConfigurationAssignmentsVmssGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type GuestConfigurationAssignmentsVmssGetResponse = GuestConfigurationAssignment;
+
+// @public
+export interface GuestConfigurationAssignmentsVmssListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type GuestConfigurationAssignmentsVmssListResponse = GuestConfigurationAssignmentList;
+
+// @public (undocumented)
+export class GuestConfigurationClient extends coreClient.ServiceClient {
+    // (undocumented)
+    $host: string;
+    constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: GuestConfigurationClientOptionalParams);
+    // (undocumented)
+    apiVersion: string;
+    // (undocumented)
+    guestConfigurationAssignmentReports: GuestConfigurationAssignmentReports;
+    // (undocumented)
+    guestConfigurationAssignmentReportsVmss: GuestConfigurationAssignmentReportsVmss;
+    // (undocumented)
+    guestConfigurationAssignments: GuestConfigurationAssignments;
+    // (undocumented)
+    guestConfigurationAssignmentsVmss: GuestConfigurationAssignmentsVmss;
+    // (undocumented)
+    guestConfigurationConnectedVMwarevSphereAssignments: GuestConfigurationConnectedVMwarevSphereAssignments;
+    // (undocumented)
+    guestConfigurationConnectedVMwarevSphereAssignmentsReports: GuestConfigurationConnectedVMwarevSphereAssignmentsReports;
+    // (undocumented)
+    guestConfigurationHcrpAssignmentReports: GuestConfigurationHcrpAssignmentReports;
+    // (undocumented)
+    guestConfigurationHcrpAssignments: GuestConfigurationHcrpAssignments;
+    // (undocumented)
+    operations: Operations;
+    // (undocumented)
+    subscriptionId: string;
+}
+
+// @public
+export interface GuestConfigurationClientOptionalParams extends coreClient.ServiceClientOptions {
+    $host?: string;
+    apiVersion?: string;
+    endpoint?: string;
+}
+
+// @public
+export interface GuestConfigurationConnectedVMwarevSphereAssignments {
+    createOrUpdate(resourceGroupName: string, vmName: string, guestConfigurationAssignmentName: string, parameters: GuestConfigurationAssignment, options?: GuestConfigurationConnectedVMwarevSphereAssignmentsCreateOrUpdateOptionalParams): Promise<GuestConfigurationConnectedVMwarevSphereAssignmentsCreateOrUpdateResponse>;
+    delete(resourceGroupName: string, vmName: string, guestConfigurationAssignmentName: string, options?: GuestConfigurationConnectedVMwarevSphereAssignmentsDeleteOptionalParams): Promise<void>;
+    get(resourceGroupName: string, vmName: string, guestConfigurationAssignmentName: string, options?: GuestConfigurationConnectedVMwarevSphereAssignmentsGetOptionalParams): Promise<GuestConfigurationConnectedVMwarevSphereAssignmentsGetResponse>;
+    list(resourceGroupName: string, vmName: string, options?: GuestConfigurationConnectedVMwarevSphereAssignmentsListOptionalParams): PagedAsyncIterableIterator<GuestConfigurationAssignment>;
+}
+
+// @public
+export interface GuestConfigurationConnectedVMwarevSphereAssignmentsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type GuestConfigurationConnectedVMwarevSphereAssignmentsCreateOrUpdateResponse = GuestConfigurationAssignment;
+
+// @public
+export interface GuestConfigurationConnectedVMwarevSphereAssignmentsDeleteOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export interface GuestConfigurationConnectedVMwarevSphereAssignmentsGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type GuestConfigurationConnectedVMwarevSphereAssignmentsGetResponse = GuestConfigurationAssignment;
+
+// @public
+export interface GuestConfigurationConnectedVMwarevSphereAssignmentsListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type GuestConfigurationConnectedVMwarevSphereAssignmentsListResponse = GuestConfigurationAssignmentList;
+
+// @public
+export interface GuestConfigurationConnectedVMwarevSphereAssignmentsReports {
+    get(resourceGroupName: string, vmName: string, guestConfigurationAssignmentName: string, reportId: string, options?: GuestConfigurationConnectedVMwarevSphereAssignmentsReportsGetOptionalParams): Promise<GuestConfigurationConnectedVMwarevSphereAssignmentsReportsGetResponse>;
+    list(resourceGroupName: string, vmName: string, guestConfigurationAssignmentName: string, options?: GuestConfigurationConnectedVMwarevSphereAssignmentsReportsListOptionalParams): Promise<GuestConfigurationConnectedVMwarevSphereAssignmentsReportsListResponse>;
+}
+
+// @public
+export interface GuestConfigurationConnectedVMwarevSphereAssignmentsReportsGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type GuestConfigurationConnectedVMwarevSphereAssignmentsReportsGetResponse = GuestConfigurationAssignmentReport;
+
+// @public
+export interface GuestConfigurationConnectedVMwarevSphereAssignmentsReportsListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type GuestConfigurationConnectedVMwarevSphereAssignmentsReportsListResponse = GuestConfigurationAssignmentReportList;
+
+// @public
+export interface GuestConfigurationHcrpAssignmentReports {
+    get(resourceGroupName: string, guestConfigurationAssignmentName: string, reportId: string, machineName: string, options?: GuestConfigurationHcrpAssignmentReportsGetOptionalParams): Promise<GuestConfigurationHcrpAssignmentReportsGetResponse>;
+    list(resourceGroupName: string, guestConfigurationAssignmentName: string, machineName: string, options?: GuestConfigurationHcrpAssignmentReportsListOptionalParams): Promise<GuestConfigurationHcrpAssignmentReportsListResponse>;
+}
+
+// @public
+export interface GuestConfigurationHcrpAssignmentReportsGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type GuestConfigurationHcrpAssignmentReportsGetResponse = GuestConfigurationAssignmentReport;
+
+// @public
+export interface GuestConfigurationHcrpAssignmentReportsListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type GuestConfigurationHcrpAssignmentReportsListResponse = GuestConfigurationAssignmentReportList;
+
+// @public
+export interface GuestConfigurationHcrpAssignments {
+    createOrUpdate(guestConfigurationAssignmentName: string, resourceGroupName: string, machineName: string, parameters: GuestConfigurationAssignment, options?: GuestConfigurationHcrpAssignmentsCreateOrUpdateOptionalParams): Promise<GuestConfigurationHcrpAssignmentsCreateOrUpdateResponse>;
+    delete(resourceGroupName: string, guestConfigurationAssignmentName: string, machineName: string, options?: GuestConfigurationHcrpAssignmentsDeleteOptionalParams): Promise<void>;
+    get(resourceGroupName: string, guestConfigurationAssignmentName: string, machineName: string, options?: GuestConfigurationHcrpAssignmentsGetOptionalParams): Promise<GuestConfigurationHcrpAssignmentsGetResponse>;
+    list(resourceGroupName: string, machineName: string, options?: GuestConfigurationHcrpAssignmentsListOptionalParams): PagedAsyncIterableIterator<GuestConfigurationAssignment>;
+}
+
+// @public
+export interface GuestConfigurationHcrpAssignmentsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type GuestConfigurationHcrpAssignmentsCreateOrUpdateResponse = GuestConfigurationAssignment;
+
+// @public
+export interface GuestConfigurationHcrpAssignmentsDeleteOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export interface GuestConfigurationHcrpAssignmentsGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type GuestConfigurationHcrpAssignmentsGetResponse = GuestConfigurationAssignment;
+
+// @public
+export interface GuestConfigurationHcrpAssignmentsListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type GuestConfigurationHcrpAssignmentsListResponse = GuestConfigurationAssignmentList;
+
+// @public
+export interface GuestConfigurationNavigation {
+    readonly assignmentSource?: string;
+    assignmentType?: AssignmentType;
+    configurationParameter?: ConfigurationParameter[];
+    configurationProtectedParameter?: ConfigurationParameter[];
+    readonly configurationSetting?: ConfigurationSetting;
+    contentHash?: string;
+    readonly contentType?: string;
+    contentUri?: string;
+    kind?: Kind;
+    name?: string;
+    version?: string;
+}
+
+// @public
+export type Kind = string;
+
+// @public
+export enum KnownActionAfterReboot {
+    ContinueConfiguration = "ContinueConfiguration",
+    StopConfiguration = "StopConfiguration"
+}
+
+// @public
+export enum KnownAssignmentType {
+    ApplyAndAutoCorrect = "ApplyAndAutoCorrect",
+    ApplyAndMonitor = "ApplyAndMonitor",
+    Audit = "Audit",
+    DeployAndAutoCorrect = "DeployAndAutoCorrect"
+}
+
+// @public
+export enum KnownComplianceStatus {
+    Compliant = "Compliant",
+    NonCompliant = "NonCompliant",
+    Pending = "Pending"
+}
+
+// @public
+export enum KnownConfigurationMode {
+    ApplyAndAutoCorrect = "ApplyAndAutoCorrect",
+    ApplyAndMonitor = "ApplyAndMonitor",
+    ApplyOnly = "ApplyOnly"
+}
+
+// @public
+export enum KnownCreatedByType {
+    Application = "Application",
+    Key = "Key",
+    ManagedIdentity = "ManagedIdentity",
+    User = "User"
+}
+
+// @public
+export enum KnownKind {
+    DSC = "DSC"
+}
+
+// @public
+export enum KnownProvisioningState {
+    Canceled = "Canceled",
+    Created = "Created",
+    Failed = "Failed",
+    Succeeded = "Succeeded"
+}
+
+// @public
+export enum KnownType {
+    Consistency = "Consistency",
+    Initial = "Initial"
+}
+
+// @public
+export interface Operation {
+    display?: OperationDisplay;
+    name?: string;
+    properties?: OperationProperties;
+}
+
+// @public
+export interface OperationDisplay {
+    description?: string;
+    operation?: string;
+    provider?: string;
+    resource?: string;
+}
+
+// @public
+export interface OperationList {
+    value?: Operation[];
+}
+
+// @public
+export interface OperationProperties {
+    statusCode?: string;
+}
+
+// @public
+export interface Operations {
+    list(options?: OperationsListOptionalParams): PagedAsyncIterableIterator<Operation>;
+}
+
+// @public
+export interface OperationsListOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type OperationsListResponse = OperationList;
+
+// @public
+export type ProvisioningState = string;
+
+// @public
+export interface ProxyResource extends Resource {
+}
+
+// @public
+export interface Resource {
+    readonly id?: string;
+    location?: string;
+    name?: string;
+    readonly type?: string;
+}
+
+// @public
+export interface SystemData {
+    createdAt?: Date;
+    createdBy?: string;
+    createdByType?: CreatedByType;
+    lastModifiedAt?: Date;
+    lastModifiedBy?: string;
+    lastModifiedByType?: CreatedByType;
+}
+
+// @public
+export type Type = string;
+
+// @public
+export interface VMInfo {
+    readonly id?: string;
+    readonly uuid?: string;
+}
+
+// @public
+export interface VmssvmInfo {
+    readonly complianceStatus?: ComplianceStatus;
+    readonly lastComplianceChecked?: Date;
+    readonly latestReportId?: string;
+    readonly vmId?: string;
+    readonly vmResourceId?: string;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```