@azure/arm-guestconfiguration 1.0.0-beta.1 → 1.0.0-beta.3

package/dist/commonjs/models/models.d.ts

@@ -0,0 +1,490 @@
+/**
+ * This file contains only generated model types and their (de)serializers.
+ * Disable the following rules for internal models with '_' prefix and deserializers which require 'any' for raw JSON input.
+ */
+/** The response model for the list of Automation operations. */
+export interface _OperationList {
+    /** List of Automation operations supported by the Automation resource provider. */
+    value: Operation[];
+    nextLink?: string;
+}
+export declare function _operationListDeserializer(item: any): _OperationList;
+export declare function operationArrayDeserializer(result: Array<Operation>): any[];
+/** GuestConfiguration REST API operation. */
+export interface Operation {
+    /** Operation name: For example, providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/write or read. */
+    name?: string;
+    /** Provider, Resource, Operation, and description values. */
+    display?: OperationDisplay;
+    /** Additional properties of the operation. */
+    properties?: OperationProperties;
+}
+export declare function operationDeserializer(item: any): Operation;
+/** Provider, Resource, Operation, and description values. */
+export interface OperationDisplay {
+    /** Service provider: Microsoft.GuestConfiguration. */
+    provider?: string;
+    /** Resource on which the operation is performed. */
+    resource?: string;
+    /** Operation type: Read, write, delete, etc. */
+    operation?: string;
+    /** Description about the operation. */
+    description?: string;
+}
+export declare function operationDisplayDeserializer(item: any): OperationDisplay;
+/** Provider, Resource, Operation and description values. */
+export interface OperationProperties {
+    /** Service provider: Microsoft.GuestConfiguration */
+    statusCode?: string;
+}
+export declare function operationPropertiesDeserializer(item: any): OperationProperties;
+/** Error response of an operation failure. */
+export interface ErrorResponse {
+    error?: {
+        code?: string;
+        message?: string;
+    };
+}
+export declare function errorResponseDeserializer(item: any): ErrorResponse;
+/** model interface _ErrorResponseError */
+export interface _ErrorResponseError {
+    /** Error code. */
+    code?: string;
+    /** Detail error message indicating why the operation failed. */
+    message?: string;
+}
+export declare function _errorResponseErrorDeserializer(item: any): _ErrorResponseError;
+/** Guest configuration assignment is an association between a machine and guest configuration. */
+export interface GuestConfigurationAssignment extends ProxyResource {
+    /** Properties of the Guest configuration assignment. */
+    properties?: GuestConfigurationAssignmentProperties;
+    /** Azure Resource Manager metadata containing createdBy and modifiedBy information. */
+    readonly systemData?: SystemData;
+}
+export declare function guestConfigurationAssignmentSerializer(item: GuestConfigurationAssignment): any;
+export declare function guestConfigurationAssignmentDeserializer(item: any): GuestConfigurationAssignment;
+/** Guest configuration assignment properties. */
+export interface GuestConfigurationAssignmentProperties {
+    /** VM resource Id. */
+    readonly targetResourceId?: string;
+    /** The guest configuration to assign. */
+    guestConfiguration?: GuestConfigurationNavigation;
+    /** A value indicating compliance status of the machine for the assigned guest configuration. */
+    readonly complianceStatus?: ComplianceStatus;
+    /** Date and time when last compliance status was checked. */
+    readonly lastComplianceStatusChecked?: Date;
+    /** Id of the latest report for the guest configuration assignment. */
+    readonly latestReportId?: string;
+    /** parameter hash for the guest configuration assignment. */
+    readonly parameterHash?: string;
+    /** Last reported guest configuration assignment report. */
+    latestAssignmentReport?: AssignmentReport;
+    /** The source which initiated the guest configuration assignment. Ex: Azure Policy */
+    context?: string;
+    /** Combined hash of the configuration package and parameters. */
+    readonly assignmentHash?: string;
+    /** The provisioning state, which only appears in the response. */
+    readonly provisioningState?: ProvisioningState;
+    /** Type of the resource - VMSS / VM */
+    readonly resourceType?: string;
+    /** The list of VM Compliance data for VMSS */
+    vmssVMList?: VmssvmInfo[];
+}
+export declare function guestConfigurationAssignmentPropertiesSerializer(item: GuestConfigurationAssignmentProperties): any;
+export declare function guestConfigurationAssignmentPropertiesDeserializer(item: any): GuestConfigurationAssignmentProperties;
+/** Guest configuration is an artifact that encapsulates DSC configuration and its dependencies. The artifact is a zip file containing DSC configuration (as MOF) and dependent resources and other dependencies like modules. */
+export interface GuestConfigurationNavigation {
+    /** Kind of the guest configuration. For example:DSC */
+    kind?: Kind;
+    /** Name of the guest configuration. */
+    name?: string;
+    /** Version of the guest configuration. */
+    version?: string;
+    /** Uri of the storage where guest configuration package is uploaded. */
+    contentUri?: string;
+    /** Combined hash of the guest configuration package and configuration parameters. */
+    contentHash?: string;
+    /** Managed identity with storage access of the guest configuration package and configuration parameters. */
+    contentManagedIdentity?: string;
+    /** Specifies the assignment type and execution of the configuration. Possible values are Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect and ApplyAndMonitor. */
+    assignmentType?: AssignmentType;
+    /** Specifies the origin of the configuration. */
+    readonly assignmentSource?: string;
+    /** Specifies the content type of the configuration. Possible values could be Builtin or Custom. */
+    readonly contentType?: string;
+    /** The configuration parameters for the guest configuration. */
+    configurationParameter?: ConfigurationParameter[];
+    /** The protected configuration parameters for the guest configuration. */
+    configurationProtectedParameter?: ConfigurationParameter[];
+    /** The configuration setting for the guest configuration. */
+    readonly configurationSetting?: ConfigurationSetting;
+}
+export declare function guestConfigurationNavigationSerializer(item: GuestConfigurationNavigation): any;
+export declare function guestConfigurationNavigationDeserializer(item: any): GuestConfigurationNavigation;
+/** Kind of the guest configuration. For example:DSC */
+export declare enum KnownKind {
+    /** DSC */
+    DSC = "DSC"
+}
+/**
+ * Kind of the guest configuration. For example:DSC \
+ * {@link KnownKind} can be used interchangeably with Kind,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **DSC**
+ */
+export type Kind = string;
+/** Specifies the assignment type and execution of the configuration. Possible values are Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect and ApplyAndMonitor. */
+export declare enum KnownAssignmentType {
+    /** Audit */
+    Audit = "Audit",
+    /** DeployAndAutoCorrect */
+    DeployAndAutoCorrect = "DeployAndAutoCorrect",
+    /** ApplyAndAutoCorrect */
+    ApplyAndAutoCorrect = "ApplyAndAutoCorrect",
+    /** ApplyAndMonitor */
+    ApplyAndMonitor = "ApplyAndMonitor"
+}
+/**
+ * Specifies the assignment type and execution of the configuration. Possible values are Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect and ApplyAndMonitor. \
+ * {@link KnownAssignmentType} can be used interchangeably with AssignmentType,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **Audit** \
+ * **DeployAndAutoCorrect** \
+ * **ApplyAndAutoCorrect** \
+ * **ApplyAndMonitor**
+ */
+export type AssignmentType = string;
+export declare function configurationParameterArraySerializer(result: Array<ConfigurationParameter>): any[];
+export declare function configurationParameterArrayDeserializer(result: Array<ConfigurationParameter>): any[];
+/** Represents a configuration parameter. */
+export interface ConfigurationParameter {
+    /** Name of the configuration parameter. */
+    name?: string;
+    /** Value of the configuration parameter. */
+    value?: string;
+}
+export declare function configurationParameterSerializer(item: ConfigurationParameter): any;
+export declare function configurationParameterDeserializer(item: any): ConfigurationParameter;
+/** Configuration setting of LCM (Local Configuration Manager). */
+export interface ConfigurationSetting {
+    /** Specifies how the LCM(Local Configuration Manager) actually applies the configuration to the target nodes. Possible values are ApplyOnly, ApplyAndMonitor, and ApplyAndAutoCorrect. */
+    readonly configurationMode?: ConfigurationMode;
+    /** If true - new configurations downloaded from the pull service are allowed to overwrite the old ones on the target node. Otherwise, false */
+    readonly allowModuleOverwrite?: boolean;
+    /** Specifies what happens after a reboot during the application of a configuration. The possible values are ContinueConfiguration and StopConfiguration */
+    readonly actionAfterReboot?: ActionAfterReboot;
+    /** The time interval, in minutes, at which the LCM checks a pull service to get updated configurations. This value is ignored if the LCM is not configured in pull mode. The default value is 30. */
+    readonly refreshFrequencyMins?: number;
+    /** Set this to true to automatically reboot the node after a configuration that requires reboot is applied. Otherwise, you will have to manually reboot the node for any configuration that requires it. The default value is false. To use this setting when a reboot condition is enacted by something other than DSC (such as Windows Installer), combine this setting with the xPendingReboot module. */
+    readonly rebootIfNeeded?: boolean;
+    /** How often, in minutes, the current configuration is checked and applied. This property is ignored if the ConfigurationMode property is set to ApplyOnly. The default value is 15. */
+    readonly configurationModeFrequencyMins?: number;
+}
+export declare function configurationSettingDeserializer(item: any): ConfigurationSetting;
+/** Specifies how the LCM(Local Configuration Manager) actually applies the configuration to the target nodes. Possible values are ApplyOnly, ApplyAndMonitor, and ApplyAndAutoCorrect. */
+export declare enum KnownConfigurationMode {
+    /** ApplyOnly */
+    ApplyOnly = "ApplyOnly",
+    /** ApplyAndMonitor */
+    ApplyAndMonitor = "ApplyAndMonitor",
+    /** ApplyAndAutoCorrect */
+    ApplyAndAutoCorrect = "ApplyAndAutoCorrect"
+}
+/**
+ * Specifies how the LCM(Local Configuration Manager) actually applies the configuration to the target nodes. Possible values are ApplyOnly, ApplyAndMonitor, and ApplyAndAutoCorrect. \
+ * {@link KnownConfigurationMode} can be used interchangeably with ConfigurationMode,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **ApplyOnly** \
+ * **ApplyAndMonitor** \
+ * **ApplyAndAutoCorrect**
+ */
+export type ConfigurationMode = string;
+/** Specifies what happens after a reboot during the application of a configuration. The possible values are ContinueConfiguration and StopConfiguration */
+export declare enum KnownActionAfterReboot {
+    /** ContinueConfiguration */
+    ContinueConfiguration = "ContinueConfiguration",
+    /** StopConfiguration */
+    StopConfiguration = "StopConfiguration"
+}
+/**
+ * Specifies what happens after a reboot during the application of a configuration. The possible values are ContinueConfiguration and StopConfiguration \
+ * {@link KnownActionAfterReboot} can be used interchangeably with ActionAfterReboot,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **ContinueConfiguration** \
+ * **StopConfiguration**
+ */
+export type ActionAfterReboot = string;
+/** A value indicating compliance status of the machine for the assigned guest configuration. */
+export declare enum KnownComplianceStatus {
+    /** Compliant */
+    Compliant = "Compliant",
+    /** NonCompliant */
+    NonCompliant = "NonCompliant",
+    /** Pending */
+    Pending = "Pending"
+}
+/**
+ * A value indicating compliance status of the machine for the assigned guest configuration. \
+ * {@link KnownComplianceStatus} can be used interchangeably with ComplianceStatus,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **Compliant** \
+ * **NonCompliant** \
+ * **Pending**
+ */
+export type ComplianceStatus = string;
+/** model interface AssignmentReport */
+export interface AssignmentReport {
+    /** ARM resource id of the report for the guest configuration assignment. */
+    readonly id?: string;
+    /** GUID that identifies the guest configuration assignment report under a subscription, resource group. */
+    readonly reportId?: string;
+    /** Configuration details of the guest configuration assignment. */
+    assignment?: AssignmentInfo;
+    /** Information about the VM. */
+    vm?: VMInfo;
+    /** Start date and time of the guest configuration assignment compliance status check. */
+    readonly startTime?: Date;
+    /** End date and time of the guest configuration assignment compliance status check. */
+    readonly endTime?: Date;
+    /** A value indicating compliance status of the machine for the assigned guest configuration. */
+    readonly complianceStatus?: ComplianceStatus;
+    /** Type of report, Consistency or Initial */
+    readonly operationType?: Type;
+    /** The list of resources for which guest configuration assignment compliance is checked. */
+    resources?: AssignmentReportResource[];
+}
+export declare function assignmentReportSerializer(item: AssignmentReport): any;
+export declare function assignmentReportDeserializer(item: any): AssignmentReport;
+/** Information about the guest configuration assignment. */
+export interface AssignmentInfo {
+    /** Name of the guest configuration assignment. */
+    readonly name?: string;
+    /** Information about the configuration. */
+    configuration?: ConfigurationInfo;
+}
+export declare function assignmentInfoSerializer(item: AssignmentInfo): any;
+export declare function assignmentInfoDeserializer(item: any): AssignmentInfo;
+/** Information about the configuration. */
+export interface ConfigurationInfo {
+    /** Name of the configuration. */
+    readonly name?: string;
+    /** Version of the configuration. */
+    readonly version?: string;
+}
+export declare function configurationInfoSerializer(_item: ConfigurationInfo): any;
+export declare function configurationInfoDeserializer(item: any): ConfigurationInfo;
+/** Information about the VM. */
+export interface VMInfo {
+    /** Azure resource Id of the VM. */
+    readonly id?: string;
+    /** UUID(Universally Unique Identifier) of the VM. */
+    readonly uuid?: string;
+}
+export declare function vmInfoSerializer(_item: VMInfo): any;
+export declare function vmInfoDeserializer(item: any): VMInfo;
+/** Type of report, Consistency or Initial */
+export declare enum KnownType {
+    /** Consistency */
+    Consistency = "Consistency",
+    /** Initial */
+    Initial = "Initial"
+}
+/**
+ * Type of report, Consistency or Initial \
+ * {@link KnownType} can be used interchangeably with Type,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **Consistency** \
+ * **Initial**
+ */
+export type Type = string;
+export declare function assignmentReportResourceArraySerializer(result: Array<AssignmentReportResource>): any[];
+export declare function assignmentReportResourceArrayDeserializer(result: Array<AssignmentReportResource>): any[];
+/** The guest configuration assignment resource. */
+export interface AssignmentReportResource {
+    /** A value indicating compliance status of the machine for the assigned guest configuration. */
+    readonly complianceStatus?: ComplianceStatus;
+    /** Name of the guest configuration assignment resource setting. */
+    readonly resourceId?: string;
+    /** Compliance reason and reason code for a resource. */
+    reasons?: AssignmentReportResourceComplianceReason[];
+    /** Properties of a guest configuration assignment resource. */
+    readonly properties?: any;
+}
+export declare function assignmentReportResourceSerializer(item: AssignmentReportResource): any;
+export declare function assignmentReportResourceDeserializer(item: any): AssignmentReportResource;
+export declare function assignmentReportResourceComplianceReasonArraySerializer(result: Array<AssignmentReportResourceComplianceReason>): any[];
+export declare function assignmentReportResourceComplianceReasonArrayDeserializer(result: Array<AssignmentReportResourceComplianceReason>): any[];
+/** Reason and code for the compliance of the guest configuration assignment resource. */
+export interface AssignmentReportResourceComplianceReason {
+    /** Reason for the compliance of the guest configuration assignment resource. */
+    readonly phrase?: string;
+    /** Code for the compliance of the guest configuration assignment resource. */
+    readonly code?: string;
+}
+export declare function assignmentReportResourceComplianceReasonSerializer(_item: AssignmentReportResourceComplianceReason): any;
+export declare function assignmentReportResourceComplianceReasonDeserializer(item: any): AssignmentReportResourceComplianceReason;
+/** The provisioning state, which only appears in the response. */
+export declare enum KnownProvisioningState {
+    /** Succeeded */
+    Succeeded = "Succeeded",
+    /** Failed */
+    Failed = "Failed",
+    /** Canceled */
+    Canceled = "Canceled",
+    /** Created */
+    Created = "Created"
+}
+/**
+ * The provisioning state, which only appears in the response. \
+ * {@link KnownProvisioningState} can be used interchangeably with ProvisioningState,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **Succeeded** \
+ * **Failed** \
+ * **Canceled** \
+ * **Created**
+ */
+export type ProvisioningState = string;
+export declare function vmssvmInfoArraySerializer(result: Array<VmssvmInfo>): any[];
+export declare function vmssvmInfoArrayDeserializer(result: Array<VmssvmInfo>): any[];
+/** Information about VMSS VM */
+export interface VmssvmInfo {
+    /** UUID of the VM. */
+    readonly vmId?: string;
+    /** Azure resource Id of the VM. */
+    readonly vmResourceId?: string;
+    /** A value indicating compliance status of the machine for the assigned guest configuration. */
+    readonly complianceStatus?: ComplianceStatus;
+    /** Id of the latest report for the guest configuration assignment. */
+    readonly latestReportId?: string;
+    /** Date and time when last compliance status was checked. */
+    readonly lastComplianceChecked?: Date;
+}
+export declare function vmssvmInfoSerializer(_item: VmssvmInfo): any;
+export declare function vmssvmInfoDeserializer(item: any): VmssvmInfo;
+/** Metadata pertaining to creation and last modification of the resource. */
+export interface SystemData {
+    /** The identity that created the resource. */
+    createdBy?: string;
+    /** The type of identity that created the resource. */
+    createdByType?: CreatedByType;
+    /** The timestamp of resource creation (UTC). */
+    createdAt?: Date;
+    /** The identity that last modified the resource. */
+    lastModifiedBy?: string;
+    /** The type of identity that last modified the resource. */
+    lastModifiedByType?: CreatedByType;
+    /** The timestamp of resource last modification (UTC) */
+    lastModifiedAt?: Date;
+}
+export declare function systemDataDeserializer(item: any): SystemData;
+/** The kind of entity that created the resource. */
+export declare enum KnownCreatedByType {
+    /** The entity was created by a user. */
+    User = "User",
+    /** The entity was created by an application. */
+    Application = "Application",
+    /** The entity was created by a managed identity. */
+    ManagedIdentity = "ManagedIdentity",
+    /** The entity was created by a key. */
+    Key = "Key"
+}
+/**
+ * The kind of entity that created the resource. \
+ * {@link KnownCreatedByType} can be used interchangeably with CreatedByType,
+ *  this enum contains the known values that the service supports.
+ * ### Known values supported by the service
+ * **User**: The entity was created by a user. \
+ * **Application**: The entity was created by an application. \
+ * **ManagedIdentity**: The entity was created by a managed identity. \
+ * **Key**: The entity was created by a key.
+ */
+export type CreatedByType = string;
+/** ARM proxy resource. */
+export interface ProxyResource {
+    /** ARM resource id of the guest configuration assignment. */
+    readonly id?: string;
+    /** The guest configuration assignment name. */
+    name: string;
+    /** Region where the VM is located. */
+    location?: string;
+    /** The type of the resource. */
+    readonly type?: string;
+}
+export declare function proxyResourceSerializer(item: ProxyResource): any;
+export declare function proxyResourceDeserializer(item: any): ProxyResource;
+/** The response of the list guest configuration assignment operation. */
+export interface _GuestConfigurationAssignmentList {
+    /** Result of the list guest configuration assignment operation. */
+    value?: GuestConfigurationAssignment[];
+    nextLink?: string;
+}
+export declare function _guestConfigurationAssignmentListDeserializer(item: any): _GuestConfigurationAssignmentList;
+export declare function guestConfigurationAssignmentArraySerializer(result: Array<GuestConfigurationAssignment>): any[];
+export declare function guestConfigurationAssignmentArrayDeserializer(result: Array<GuestConfigurationAssignment>): any[];
+/** List of guest configuration assignment reports. */
+export interface GuestConfigurationAssignmentReportList {
+    /** List of reports for the guest configuration. Report contains information such as compliance status, reason and more. */
+    value?: GuestConfigurationAssignmentReport[];
+    nextLink?: string;
+}
+export declare function guestConfigurationAssignmentReportListDeserializer(item: any): GuestConfigurationAssignmentReportList;
+export declare function guestConfigurationAssignmentReportArrayDeserializer(result: Array<GuestConfigurationAssignmentReport>): any[];
+/** Report for the guest configuration assignment. Report contains information such as compliance status, reason, and more. */
+export interface GuestConfigurationAssignmentReport {
+    /** ARM resource id of the report for the guest configuration assignment. */
+    readonly id?: string;
+    /** GUID that identifies the guest configuration assignment report under a subscription, resource group. */
+    readonly name?: string;
+    /** Properties of the guest configuration report. */
+    properties?: GuestConfigurationAssignmentReportProperties;
+}
+export declare function guestConfigurationAssignmentReportDeserializer(item: any): GuestConfigurationAssignmentReport;
+/** Report for the guest configuration assignment. Report contains information such as compliance status, reason, and more. */
+export interface GuestConfigurationAssignmentReportProperties {
+    /** A value indicating compliance status of the machine for the assigned guest configuration. */
+    readonly complianceStatus?: ComplianceStatus;
+    /** GUID that identifies the guest configuration assignment report under a subscription, resource group. */
+    readonly reportId?: string;
+    /** Configuration details of the guest configuration assignment. */
+    assignment?: AssignmentInfo;
+    /** Information about the VM. */
+    vm?: VMInfo;
+    /** Start date and time of the guest configuration assignment compliance status check. */
+    readonly startTime?: Date;
+    /** End date and time of the guest configuration assignment compliance status check. */
+    readonly endTime?: Date;
+    /** Details of the assignment report. */
+    details?: AssignmentReportDetails;
+    /** Azure resource Id of the VMSS. */
+    readonly vmssResourceId?: string;
+}
+export declare function guestConfigurationAssignmentReportPropertiesDeserializer(item: any): GuestConfigurationAssignmentReportProperties;
+/** Details of the guest configuration assignment report. */
+export interface AssignmentReportDetails {
+    /** A value indicating compliance status of the machine for the assigned guest configuration. */
+    readonly complianceStatus?: ComplianceStatus;
+    /** Start date and time of the guest configuration assignment compliance status check. */
+    readonly startTime?: Date;
+    /** End date and time of the guest configuration assignment compliance status check. */
+    readonly endTime?: Date;
+    /** GUID of the report. */
+    readonly jobId?: string;
+    /** Type of report, Consistency or Initial */
+    readonly operationType?: Type;
+    /** The list of resources for which guest configuration assignment compliance is checked. */
+    resources?: AssignmentReportResource[];
+}
+export declare function assignmentReportDetailsDeserializer(item: any): AssignmentReportDetails;
+/** The available API versions. */
+export declare enum KnownVersions {
+    /** The 2024-04-05 API version. */
+    V20240405 = "2024-04-05"
+}
+//# sourceMappingURL=models.d.ts.map