Package-level declarations

Types

data class AdvancedScheduleMonthlyOccurrenceResponse(val day: String? = null, val occurrence: Int? = null)

The properties of the create advanced schedule monthly occurrence.

Link copied to clipboard
data class AdvancedScheduleResponse(val monthDays: List<Int>? = null, val monthlyOccurrences: List<AdvancedScheduleMonthlyOccurrenceResponse>? = null, val weekDays: List<String>? = null)

The properties of the create Advanced Schedule.

Link copied to clipboard
data class AzureQueryPropertiesResponse(val locations: List<String>? = null, val scope: List<String>? = null, val tagSettings: TagSettingsPropertiesResponse? = null)

Azure query for the update configuration.

The connection type property associated with the entity.

Link copied to clipboard
data class ContentHashResponse(val algorithm: String, val value: String)

Definition of the runbook property type.

Link copied to clipboard
data class ContentLinkResponse(val contentHash: ContentHashResponse? = null, val uri: String? = null, val version: String? = null)

Definition of the content link.

Link copied to clipboard
data class ContentSourceResponse(val hash: ContentHashResponse? = null, val type: String? = null, val value: String? = null, val version: String? = null)

Definition of the content source.

The Dsc configuration property associated with the entity.

Link copied to clipboard
data class DscConfigurationParameterResponse(val defaultValue: String? = null, val isMandatory: Boolean? = null, val position: Int? = null, val type: String? = null)

Definition of the configuration parameter type.

Link copied to clipboard
data class EncryptionPropertiesResponse(val identity: EncryptionPropertiesResponseIdentity? = null, val keySource: String? = null, val keyVaultProperties: KeyVaultPropertiesResponse? = null)

The encryption settings for automation account

Link copied to clipboard
data class EncryptionPropertiesResponseIdentity(val userAssignedIdentity: Any? = null)

User identity used for CMK.

Link copied to clipboard
data class ErrorResponseResponse(val code: String? = null, val message: String? = null)

Error response of an operation failure

Link copied to clipboard
data class FieldDefinitionResponse(val isEncrypted: Boolean? = null, val isOptional: Boolean? = null, val type: String)

Definition of the connection fields.

Link copied to clipboard
data class GetAutomationAccountResult(val automationHybridServiceUrl: String? = null, val creationTime: String, val description: String? = null, val disableLocalAuth: Boolean? = null, val encryption: EncryptionPropertiesResponse? = null, val etag: String? = null, val id: String, val identity: IdentityResponse? = null, val lastModifiedBy: String? = null, val lastModifiedTime: String, val location: String? = null, val name: String, val privateEndpointConnections: List<PrivateEndpointConnectionResponse>? = null, val publicNetworkAccess: Boolean? = null, val sku: SkuResponse? = null, val state: String, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

Definition of the automation account type.

Link copied to clipboard
data class GetCertificateResult(val creationTime: String, val description: String? = null, val expiryTime: String, val id: String, val isExportable: Boolean, val lastModifiedTime: String, val name: String, val thumbprint: String, val type: String)

Definition of the certificate.

Link copied to clipboard
data class GetConnectionResult(val connectionType: ConnectionTypeAssociationPropertyResponse? = null, val creationTime: String, val description: String? = null, val fieldDefinitionValues: Map<String, String>, val id: String, val lastModifiedTime: String, val name: String, val type: String)

Definition of the connection.

Link copied to clipboard
data class GetConnectionTypeResult(val creationTime: String, val description: String? = null, val fieldDefinitions: Map<String, FieldDefinitionResponse>, val id: String, val isGlobal: Boolean? = null, val lastModifiedTime: String? = null, val name: String, val type: String)

Definition of the connection type.

Link copied to clipboard
data class GetCredentialResult(val creationTime: String, val description: String? = null, val id: String, val lastModifiedTime: String, val name: String, val type: String, val userName: String)

Definition of the credential.

Link copied to clipboard
data class GetDscConfigurationResult(val creationTime: String? = null, val description: String? = null, val etag: String? = null, val id: String, val jobCount: Int? = null, val lastModifiedTime: String? = null, val location: String? = null, val logVerbose: Boolean? = null, val name: String, val nodeConfigurationCount: Int? = null, val parameters: Map<String, DscConfigurationParameterResponse>? = null, val provisioningState: String? = null, val source: ContentSourceResponse? = null, val state: String? = null, val tags: Map<String, String>? = null, val type: String)

Definition of the configuration type.

Link copied to clipboard
data class GetDscNodeConfigurationResult(val configuration: DscConfigurationAssociationPropertyResponse? = null, val creationTime: String? = null, val id: String, val incrementNodeConfigurationBuild: Boolean? = null, val lastModifiedTime: String? = null, val name: String, val nodeCount: Double? = null, val source: String? = null, val type: String)

Definition of the dsc node configuration.

Link copied to clipboard
data class GetHybridRunbookWorkerGroupResult(val credential: RunAsCredentialAssociationPropertyResponse? = null, val groupType: String? = null, val hybridRunbookWorkers: List<HybridRunbookWorkerLegacyResponse>? = null, val id: String? = null, val name: String? = null, val systemData: SystemDataResponse, val type: String)

Definition of hybrid runbook worker group.

Link copied to clipboard
data class GetHybridRunbookWorkerResult(val id: String, val ip: String? = null, val lastSeenDateTime: String? = null, val name: String, val registeredDateTime: String? = null, val systemData: SystemDataResponse, val type: String, val vmResourceId: String? = null, val workerName: String? = null, val workerType: String? = null)

Definition of hybrid runbook worker.

Link copied to clipboard
data class GetJobScheduleResult(val id: String, val jobScheduleId: String? = null, val name: String, val parameters: Map<String, String>? = null, val runOn: String? = null, val runbook: RunbookAssociationPropertyResponse? = null, val schedule: ScheduleAssociationPropertyResponse? = null, val type: String)

Definition of the job schedule.

Link copied to clipboard
data class GetModuleResult(val activityCount: Int? = null, val contentLink: ContentLinkResponse? = null, val creationTime: String? = null, val description: String? = null, val error: ModuleErrorInfoResponse? = null, val etag: String? = null, val id: String, val isComposite: Boolean? = null, val isGlobal: Boolean? = null, val lastModifiedTime: String? = null, val location: String? = null, val name: String, val provisioningState: String? = null, val sizeInBytes: Double? = null, val tags: Map<String, String>? = null, val type: String, val version: String? = null)

Definition of the module type.

Link copied to clipboard
data class GetPrivateEndpointConnectionResult(val groupIds: List<String>? = null, val id: String, val name: String, val privateEndpoint: PrivateEndpointPropertyResponse? = null, val privateLinkServiceConnectionState: PrivateLinkServiceConnectionStatePropertyResponse? = null, val type: String)

A private endpoint connection

Link copied to clipboard
data class GetPython2PackageResult(val activityCount: Int? = null, val contentLink: ContentLinkResponse? = null, val creationTime: String? = null, val description: String? = null, val error: ModuleErrorInfoResponse? = null, val etag: String? = null, val id: String, val isComposite: Boolean? = null, val isGlobal: Boolean? = null, val lastModifiedTime: String? = null, val location: String? = null, val name: String, val provisioningState: String? = null, val sizeInBytes: Double? = null, val tags: Map<String, String>? = null, val type: String, val version: String? = null)

Definition of the module type.

Link copied to clipboard
data class GetRunbookResult(val creationTime: String? = null, val description: String? = null, val draft: RunbookDraftResponse? = null, val etag: String? = null, val id: String, val jobCount: Int? = null, val lastModifiedBy: String? = null, val lastModifiedTime: String? = null, val location: String? = null, val logActivityTrace: Int? = null, val logProgress: Boolean? = null, val logVerbose: Boolean? = null, val name: String, val outputTypes: List<String>? = null, val parameters: Map<String, RunbookParameterResponse>? = null, val provisioningState: String? = null, val publishContentLink: ContentLinkResponse? = null, val runbookType: String? = null, val state: String? = null, val tags: Map<String, String>? = null, val type: String)

Definition of the runbook type.

Link copied to clipboard
data class GetScheduleResult(val advancedSchedule: AdvancedScheduleResponse? = null, val creationTime: String? = null, val description: String? = null, val expiryTime: String? = null, val expiryTimeOffsetMinutes: Double? = null, val frequency: String? = null, val id: String, val interval: Any? = null, val isEnabled: Boolean? = null, val lastModifiedTime: String? = null, val name: String, val nextRun: String? = null, val nextRunOffsetMinutes: Double? = null, val startTime: String? = null, val startTimeOffsetMinutes: Double, val timeZone: String? = null, val type: String)

Definition of the schedule.

data class GetSoftwareUpdateConfigurationByNameResult(val createdBy: String, val creationTime: String, val error: ErrorResponseResponse? = null, val id: String, val lastModifiedBy: String, val lastModifiedTime: String, val name: String, val provisioningState: String, val scheduleInfo: SUCSchedulePropertiesResponse, val tasks: SoftwareUpdateConfigurationTasksResponse? = null, val type: String, val updateConfiguration: UpdateConfigurationResponse)

Software update configuration properties.

Link copied to clipboard
data class GetSourceControlResult(val autoSync: Boolean? = null, val branch: String? = null, val creationTime: String? = null, val description: String? = null, val folderPath: String? = null, val id: String, val lastModifiedTime: String? = null, val name: String, val publishRunbook: Boolean? = null, val repoUrl: String? = null, val sourceType: String? = null, val type: String)

Definition of the source control.

Link copied to clipboard
data class GetVariableResult(val creationTime: String? = null, val description: String? = null, val id: String, val isEncrypted: Boolean? = null, val lastModifiedTime: String? = null, val name: String, val type: String, val value: String? = null)

Definition of the variable.

Link copied to clipboard
data class GetWatcherResult(val creationTime: String, val description: String? = null, val etag: String? = null, val executionFrequencyInSeconds: Double? = null, val id: String, val lastModifiedBy: String, val lastModifiedTime: String, val location: String? = null, val name: String, val scriptName: String? = null, val scriptParameters: Map<String, String>? = null, val scriptRunOn: String? = null, val status: String, val tags: Map<String, String>? = null, val type: String)

Definition of the watcher type.

Link copied to clipboard
data class GetWebhookResult(val creationTime: String? = null, val description: String? = null, val expiryTime: String? = null, val id: String, val isEnabled: Boolean? = null, val lastInvokedTime: String? = null, val lastModifiedBy: String? = null, val lastModifiedTime: String? = null, val name: String, val parameters: Map<String, String>? = null, val runOn: String? = null, val runbook: RunbookAssociationPropertyResponse? = null, val type: String, val uri: String? = null)

Definition of the webhook type.

Link copied to clipboard
data class HybridRunbookWorkerLegacyResponse(val ip: String? = null, val lastSeenDateTime: String? = null, val name: String? = null, val registrationTime: String? = null)

Definition of hybrid runbook worker Legacy.

Link copied to clipboard
data class IdentityResponse(val principalId: String, val tenantId: String, val type: String? = null, val userAssignedIdentities: Map<String, IdentityResponseUserAssignedIdentities>? = null)

Identity for the resource.

Link copied to clipboard
data class IdentityResponseUserAssignedIdentities(val clientId: String, val principalId: String)
Link copied to clipboard
data class KeyResponse(val keyName: String, val permissions: String, val value: String)

Automation key which is used to register a DSC Node

Link copied to clipboard
data class KeyVaultPropertiesResponse(val keyName: String? = null, val keyVersion: String? = null, val keyvaultUri: String? = null)

Settings concerning key vault encryption for a configuration store.

Link copied to clipboard
data class LinuxPropertiesResponse(val excludedPackageNameMasks: List<String>? = null, val includedPackageClassifications: String? = null, val includedPackageNameMasks: List<String>? = null, val rebootSetting: String? = null)

Linux specific update configuration.

Link copied to clipboard
data class ListKeyByAutomationAccountResult(val keys: List<KeyResponse>? = null)
Link copied to clipboard
data class ModuleErrorInfoResponse(val code: String? = null, val message: String? = null)

Definition of the module error info type.

Link copied to clipboard
data class NonAzureQueryPropertiesResponse(val functionAlias: String? = null, val workspaceId: String? = null)

Non Azure query for the update configuration.

Link copied to clipboard
data class PrivateEndpointConnectionResponse(val groupIds: List<String>? = null, val id: String, val name: String, val privateEndpoint: PrivateEndpointPropertyResponse? = null, val privateLinkServiceConnectionState: PrivateLinkServiceConnectionStatePropertyResponse? = null, val type: String)

A private endpoint connection

Link copied to clipboard
data class PrivateEndpointPropertyResponse(val id: String? = null)

Private endpoint which the connection belongs to.

data class PrivateLinkServiceConnectionStatePropertyResponse(val actionsRequired: String, val description: String? = null, val status: String? = null)

Connection State of the Private Endpoint Connection.

Definition of RunAs credential to use for hybrid worker.

Link copied to clipboard
data class RunbookAssociationPropertyResponse(val name: String? = null)

The runbook property associated with the entity.

Link copied to clipboard
data class RunbookDraftResponse(val creationTime: String? = null, val draftContentLink: ContentLinkResponse? = null, val inEdit: Boolean? = null, val lastModifiedTime: String? = null, val outputTypes: List<String>? = null, val parameters: Map<String, RunbookParameterResponse>? = null)
Link copied to clipboard
data class RunbookParameterResponse(val defaultValue: String? = null, val isMandatory: Boolean? = null, val position: Int? = null, val type: String? = null)

Definition of the runbook parameter type.

Link copied to clipboard
data class ScheduleAssociationPropertyResponse(val name: String? = null)

The schedule property associated with the entity.

Link copied to clipboard
data class SkuResponse(val capacity: Int? = null, val family: String? = null, val name: String)

The account SKU.

Link copied to clipboard
data class SoftwareUpdateConfigurationTasksResponse(val postTask: TaskPropertiesResponse? = null, val preTask: TaskPropertiesResponse? = null)

Task properties of the software update configuration.

Link copied to clipboard
data class SUCSchedulePropertiesResponse(val advancedSchedule: AdvancedScheduleResponse? = null, val creationTime: String? = null, val description: String? = null, val expiryTime: String? = null, val expiryTimeOffsetMinutes: Double? = null, val frequency: String? = null, val interval: Double? = null, val isEnabled: Boolean? = null, val lastModifiedTime: String? = null, val nextRun: String? = null, val nextRunOffsetMinutes: Double? = null, val startTime: String? = null, val startTimeOffsetMinutes: Double, val timeZone: String? = null)

Definition of schedule parameters.

Link copied to clipboard
data class SystemDataResponse(val createdAt: String? = null, val createdBy: String? = null, val createdByType: String? = null, val lastModifiedAt: String? = null, val lastModifiedBy: String? = null, val lastModifiedByType: String? = null)

Metadata pertaining to creation and last modification of the resource.

Link copied to clipboard
data class TagSettingsPropertiesResponse(val filterOperator: String? = null, val tags: Map<String, List<String>>? = null)

Tag filter information for the VM.

Link copied to clipboard
data class TargetPropertiesResponse(val azureQueries: List<AzureQueryPropertiesResponse>? = null, val nonAzureQueries: List<NonAzureQueryPropertiesResponse>? = null)

Group specific to the update configuration.

Link copied to clipboard
data class TaskPropertiesResponse(val parameters: Map<String, String>? = null, val source: String? = null)

Task properties of the software update configuration.

Link copied to clipboard
data class UpdateConfigurationResponse(val azureVirtualMachines: List<String>? = null, val duration: String? = null, val linux: LinuxPropertiesResponse? = null, val nonAzureComputerNames: List<String>? = null, val operatingSystem: String, val targets: TargetPropertiesResponse? = null, val windows: WindowsPropertiesResponse? = null)

Update specific properties of the software update configuration.

Link copied to clipboard
data class WindowsPropertiesResponse(val excludedKbNumbers: List<String>? = null, val includedKbNumbers: List<String>? = null, val includedUpdateClassifications: String? = null, val rebootSetting: String? = null)

Windows specific update configuration.