Documentation
¶
Overview ¶
Example (Package) ¶
A pool is a collection of compute nodes (virtual machines) that run portions of your application's workload. A node's size determines the number of CPU cores, memory capacity, and local storage allocated to the node. See Nodes and pools in Azure Batch for more information.
A job is a collection of tasks that manages how those tasks run on a pool's nodes. A task runs one or more programs or scripts on a node. New tasks are immediately assigned to a node for execution or queued until the pool has an available node. See Jobs and tasks in Azure Batch for more information.
package main import ( "context" "github.com/Azure/azure-sdk-for-go/sdk/azcore/to" "github.com/Azure/azure-sdk-for-go/sdk/batch/azbatch" ) var client *azbatch.Client func main() { // create a pool with two dedicated nodes poolID := "HelloWorldPool" content := azbatch.CreatePoolContent{ ID: to.Ptr(poolID), TargetDedicatedNodes: to.Ptr(int32(2)), VirtualMachineConfiguration: &azbatch.VirtualMachineConfiguration{ DataDisks: []azbatch.DataDisk{ { DiskSizeGB: to.Ptr(int32(1)), LogicalUnitNumber: to.Ptr(int32(1)), }, }, ImageReference: &azbatch.ImageReference{ Offer: to.Ptr("0001-com-ubuntu-server-jammy"), Publisher: to.Ptr("canonical"), SKU: to.Ptr("22_04-lts"), }, NodeAgentSKUID: to.Ptr("batch.node.ubuntu 22.04"), }, VMSize: to.Ptr("Standard_A1_v2"), } _, err := client.CreatePool(context.TODO(), content, nil) if err != nil { // TODO: handle error } // create a job to run tasks in the pool jobID := "HelloWorldJob" jobContent := azbatch.CreateJobContent{ ID: to.Ptr(jobID), PoolInfo: &azbatch.PoolInfo{ PoolID: to.Ptr("HelloWorldPool"), }, } _, err = client.CreateJob(context.TODO(), jobContent, nil) if err != nil { // TODO: handle error } // create a task to run as soon as the pool has an available node taskContent := azbatch.CreateTaskContent{ ID: to.Ptr("HelloWorldTask"), CommandLine: to.Ptr("echo Hello, world!"), } _, err = client.CreateTask(context.TODO(), jobID, taskContent, nil) if err != nil { // TODO: handle error } }
Example (TaskOutputFile) ¶
Each task has a working directory under which it can create files and directories. A task can use this directory to store the program run by the task, the data it processes, and its output. A task's files and directories are owned by the task's user.
A portion of the node's file system is available to all tasks running on that node as a root directory located on the node's temporary storage drive. Tasks can access this root directory by referencing the AZ_BATCH_NODE_ROOT_DIR environment variable. For more information see Files and directories in Azure Batch.
package main import ( "context" "fmt" "io" "github.com/Azure/azure-sdk-for-go/sdk/azcore/to" "github.com/Azure/azure-sdk-for-go/sdk/batch/azbatch" ) var client *azbatch.Client func main() { completedTasks := client.NewListTasksPager("TODO: job ID", &azbatch.ListTasksOptions{ Filter: to.Ptr(fmt.Sprintf("state eq '%s'", azbatch.TaskStateCompleted)), }) for completedTasks.More() { page, err := completedTasks.NextPage(context.TODO()) if err != nil { // TODO: handle error } for _, task := range page.Value { file := "stdout.txt" if *task.ExecutionInfo.ExitCode != 0 { file = "stderr.txt" } fc, err := client.GetTaskFile(context.TODO(), "TODO: job ID", *task.ID, file, nil) if err != nil { // TODO: handle error } fmt.Println(io.ReadAll(fc.Body)) } } }
Index ¶
- type AccessScope
- type AccountListSupportedImagesResult
- type AddTaskCollectionResult
- type AffinityInfo
- type AllocationState
- type Application
- type ApplicationListResult
- type ApplicationPackageReference
- type AuthenticationTokenSettings
- type AutoPoolSpecification
- type AutoScaleRun
- type AutoScaleRunError
- type AutoUserScope
- type AutoUserSpecification
- type AutomaticOSUpgradePolicy
- type AzureBlobFileSystemConfiguration
- type AzureFileShareConfiguration
- type CIFSMountConfiguration
- type CachingType
- type CancelCertificateDeletionOptions
- type CancelCertificateDeletionResponse
- type Certificate
- type CertificateFormat
- type CertificateListResult
- type CertificateReference
- type CertificateState
- type CertificateStoreLocation
- type CertificateVisibility
- type Client
- func (client *Client) CancelCertificateDeletion(ctx context.Context, thumbprintAlgorithm string, thumbprint string, ...) (CancelCertificateDeletionResponse, error)
- func (client *Client) CreateCertificate(ctx context.Context, certificate Certificate, ...) (CreateCertificateResponse, error)
- func (client *Client) CreateJob(ctx context.Context, job CreateJobContent, options *CreateJobOptions) (CreateJobResponse, error)
- func (client *Client) CreateJobSchedule(ctx context.Context, jobSchedule CreateJobScheduleContent, ...) (CreateJobScheduleResponse, error)
- func (client *Client) CreateNodeUser(ctx context.Context, poolID string, nodeID string, ...) (CreateNodeUserResponse, error)
- func (client *Client) CreatePool(ctx context.Context, pool CreatePoolContent, options *CreatePoolOptions) (CreatePoolResponse, error)
- func (client *Client) CreateTask(ctx context.Context, jobID string, task CreateTaskContent, ...) (CreateTaskResponse, error)
- func (client *Client) CreateTaskCollection(ctx context.Context, jobID string, taskCollection TaskGroup, ...) (CreateTaskCollectionResponse, error)
- func (client *Client) DeallocateNode(ctx context.Context, poolID string, nodeID string, ...) (DeallocateNodeResponse, error)
- func (client *Client) DeleteCertificate(ctx context.Context, thumbprintAlgorithm string, thumbprint string, ...) (DeleteCertificateResponse, error)
- func (client *Client) DeleteJob(ctx context.Context, jobID string, options *DeleteJobOptions) (DeleteJobResponse, error)
- func (client *Client) DeleteJobSchedule(ctx context.Context, jobScheduleID string, options *DeleteJobScheduleOptions) (DeleteJobScheduleResponse, error)
- func (client *Client) DeleteNodeFile(ctx context.Context, poolID string, nodeID string, filePath string, ...) (DeleteNodeFileResponse, error)
- func (client *Client) DeleteNodeUser(ctx context.Context, poolID string, nodeID string, userName string, ...) (DeleteNodeUserResponse, error)
- func (client *Client) DeletePool(ctx context.Context, poolID string, options *DeletePoolOptions) (DeletePoolResponse, error)
- func (client *Client) DeleteTask(ctx context.Context, jobID string, taskID string, options *DeleteTaskOptions) (DeleteTaskResponse, error)
- func (client *Client) DeleteTaskFile(ctx context.Context, jobID string, taskID string, filePath string, ...) (DeleteTaskFileResponse, error)
- func (client *Client) DisableJob(ctx context.Context, jobID string, content DisableJobContent, ...) (DisableJobResponse, error)
- func (client *Client) DisableJobSchedule(ctx context.Context, jobScheduleID string, options *DisableJobScheduleOptions) (DisableJobScheduleResponse, error)
- func (client *Client) DisableNodeScheduling(ctx context.Context, poolID string, nodeID string, ...) (DisableNodeSchedulingResponse, error)
- func (client *Client) DisablePoolAutoScale(ctx context.Context, poolID string, options *DisablePoolAutoScaleOptions) (DisablePoolAutoScaleResponse, error)
- func (client *Client) EnableJob(ctx context.Context, jobID string, options *EnableJobOptions) (EnableJobResponse, error)
- func (client *Client) EnableJobSchedule(ctx context.Context, jobScheduleID string, options *EnableJobScheduleOptions) (EnableJobScheduleResponse, error)
- func (client *Client) EnableNodeScheduling(ctx context.Context, poolID string, nodeID string, ...) (EnableNodeSchedulingResponse, error)
- func (client *Client) EnablePoolAutoScale(ctx context.Context, poolID string, content EnablePoolAutoScaleContent, ...) (EnablePoolAutoScaleResponse, error)
- func (client *Client) EvaluatePoolAutoScale(ctx context.Context, poolID string, content EvaluatePoolAutoScaleContent, ...) (EvaluatePoolAutoScaleResponse, error)
- func (client *Client) GetApplication(ctx context.Context, applicationID string, options *GetApplicationOptions) (GetApplicationResponse, error)
- func (client *Client) GetCertificate(ctx context.Context, thumbprintAlgorithm string, thumbprint string, ...) (GetCertificateResponse, error)
- func (client *Client) GetJob(ctx context.Context, jobID string, options *GetJobOptions) (GetJobResponse, error)
- func (client *Client) GetJobSchedule(ctx context.Context, jobScheduleID string, options *GetJobScheduleOptions) (GetJobScheduleResponse, error)
- func (client *Client) GetJobTaskCounts(ctx context.Context, jobID string, options *GetJobTaskCountsOptions) (GetJobTaskCountsResponse, error)
- func (client *Client) GetNode(ctx context.Context, poolID string, nodeID string, options *GetNodeOptions) (GetNodeResponse, error)
- func (client *Client) GetNodeExtension(ctx context.Context, poolID string, nodeID string, extensionName string, ...) (GetNodeExtensionResponse, error)
- func (client *Client) GetNodeFile(ctx context.Context, poolID string, nodeID string, filePath string, ...) (GetNodeFileResponse, error)
- func (client *Client) GetNodeFileProperties(ctx context.Context, poolID string, nodeID string, filePath string, ...) (GetNodeFilePropertiesResponse, error)
- func (client *Client) GetNodeRemoteLoginSettings(ctx context.Context, poolID string, nodeID string, ...) (GetNodeRemoteLoginSettingsResponse, error)
- func (client *Client) GetPool(ctx context.Context, poolID string, options *GetPoolOptions) (GetPoolResponse, error)
- func (client *Client) GetTask(ctx context.Context, jobID string, taskID string, options *GetTaskOptions) (GetTaskResponse, error)
- func (client *Client) GetTaskFile(ctx context.Context, jobID string, taskID string, filePath string, ...) (GetTaskFileResponse, error)
- func (client *Client) GetTaskFileProperties(ctx context.Context, jobID string, taskID string, filePath string, ...) (GetTaskFilePropertiesResponse, error)
- func (client *Client) JobScheduleExists(ctx context.Context, jobScheduleID string, options *JobScheduleExistsOptions) (JobScheduleExistsResponse, error)
- func (client *Client) NewListApplicationsPager(options *ListApplicationsOptions) *runtime.Pager[ListApplicationsResponse]
- func (client *Client) NewListCertificatesPager(options *ListCertificatesOptions) *runtime.Pager[ListCertificatesResponse]
- func (client *Client) NewListJobPreparationAndReleaseTaskStatusPager(jobID string, options *ListJobPreparationAndReleaseTaskStatusOptions) *runtime.Pager[ListJobPreparationAndReleaseTaskStatusResponse]
- func (client *Client) NewListJobSchedulesPager(options *ListJobSchedulesOptions) *runtime.Pager[ListJobSchedulesResponse]
- func (client *Client) NewListJobsFromSchedulePager(jobScheduleID string, options *ListJobsFromScheduleOptions) *runtime.Pager[ListJobsFromScheduleResponse]
- func (client *Client) NewListJobsPager(options *ListJobsOptions) *runtime.Pager[ListJobsResponse]
- func (client *Client) NewListNodeExtensionsPager(poolID string, nodeID string, options *ListNodeExtensionsOptions) *runtime.Pager[ListNodeExtensionsResponse]
- func (client *Client) NewListNodeFilesPager(poolID string, nodeID string, options *ListNodeFilesOptions) *runtime.Pager[ListNodeFilesResponse]
- func (client *Client) NewListNodesPager(poolID string, options *ListNodesOptions) *runtime.Pager[ListNodesResponse]
- func (client *Client) NewListPoolNodeCountsPager(options *ListPoolNodeCountsOptions) *runtime.Pager[ListPoolNodeCountsResponse]
- func (client *Client) NewListPoolsPager(options *ListPoolsOptions) *runtime.Pager[ListPoolsResponse]
- func (client *Client) NewListSubTasksPager(jobID string, taskID string, options *ListSubTasksOptions) *runtime.Pager[ListSubTasksResponse]
- func (client *Client) NewListSupportedImagesPager(options *ListSupportedImagesOptions) *runtime.Pager[ListSupportedImagesResponse]
- func (client *Client) NewListTaskFilesPager(jobID string, taskID string, options *ListTaskFilesOptions) *runtime.Pager[ListTaskFilesResponse]
- func (client *Client) NewListTasksPager(jobID string, options *ListTasksOptions) *runtime.Pager[ListTasksResponse]
- func (client *Client) PoolExists(ctx context.Context, poolID string, options *PoolExistsOptions) (PoolExistsResponse, error)
- func (client *Client) ReactivateTask(ctx context.Context, jobID string, taskID string, ...) (ReactivateTaskResponse, error)
- func (client *Client) RebootNode(ctx context.Context, poolID string, nodeID string, options *RebootNodeOptions) (RebootNodeResponse, error)
- func (client *Client) ReimageNode(ctx context.Context, poolID string, nodeID string, options *ReimageNodeOptions) (ReimageNodeResponse, error)
- func (client *Client) RemoveNodes(ctx context.Context, poolID string, content RemoveNodeContent, ...) (RemoveNodesResponse, error)
- func (client *Client) ReplaceJob(ctx context.Context, jobID string, job Job, options *ReplaceJobOptions) (ReplaceJobResponse, error)
- func (client *Client) ReplaceJobSchedule(ctx context.Context, jobScheduleID string, jobSchedule JobSchedule, ...) (ReplaceJobScheduleResponse, error)
- func (client *Client) ReplaceNodeUser(ctx context.Context, poolID string, nodeID string, userName string, ...) (ReplaceNodeUserResponse, error)
- func (client *Client) ReplacePoolProperties(ctx context.Context, poolID string, pool ReplacePoolContent, ...) (ReplacePoolPropertiesResponse, error)
- func (client *Client) ReplaceTask(ctx context.Context, jobID string, taskID string, task Task, ...) (ReplaceTaskResponse, error)
- func (client *Client) ResizePool(ctx context.Context, poolID string, content ResizePoolContent, ...) (ResizePoolResponse, error)
- func (client *Client) StartNode(ctx context.Context, poolID string, nodeID string, options *StartNodeOptions) (StartNodeResponse, error)
- func (client *Client) StopPoolResize(ctx context.Context, poolID string, options *StopPoolResizeOptions) (StopPoolResizeResponse, error)
- func (client *Client) TerminateJob(ctx context.Context, jobID string, options *TerminateJobOptions) (TerminateJobResponse, error)
- func (client *Client) TerminateJobSchedule(ctx context.Context, jobScheduleID string, ...) (TerminateJobScheduleResponse, error)
- func (client *Client) TerminateTask(ctx context.Context, jobID string, taskID string, ...) (TerminateTaskResponse, error)
- func (client *Client) UpdateJob(ctx context.Context, jobID string, job UpdateJobContent, ...) (UpdateJobResponse, error)
- func (client *Client) UpdateJobSchedule(ctx context.Context, jobScheduleID string, ...) (UpdateJobScheduleResponse, error)
- func (client *Client) UpdatePool(ctx context.Context, poolID string, pool UpdatePoolContent, ...) (UpdatePoolResponse, error)
- func (client *Client) UploadNodeLogs(ctx context.Context, poolID string, nodeID string, ...) (UploadNodeLogsResponse, error)
- type ClientOptions
- type ContainerConfiguration
- type ContainerHostBindMountEntry
- type ContainerHostDataPath
- type ContainerRegistryReference
- type ContainerType
- type ContainerWorkingDirectory
- type CreateCertificateOptions
- type CreateCertificateResponse
- type CreateJobContent
- type CreateJobOptions
- type CreateJobResponse
- type CreateJobScheduleContent
- type CreateJobScheduleOptions
- type CreateJobScheduleResponse
- type CreateNodeUserContent
- type CreateNodeUserOptions
- type CreateNodeUserResponse
- type CreatePoolContent
- type CreatePoolOptions
- type CreatePoolResponse
- type CreateTaskCollectionOptions
- type CreateTaskCollectionResponse
- type CreateTaskContent
- type CreateTaskOptions
- type CreateTaskResponse
- type DataDisk
- type DeallocateNodeContent
- type DeallocateNodeOptions
- type DeallocateNodeResponse
- type DeleteCertificateError
- type DeleteCertificateOptions
- type DeleteCertificateResponse
- type DeleteJobOptions
- type DeleteJobResponse
- type DeleteJobScheduleOptions
- type DeleteJobScheduleResponse
- type DeleteNodeFileOptions
- type DeleteNodeFileResponse
- type DeleteNodeUserOptions
- type DeleteNodeUserResponse
- type DeletePoolOptions
- type DeletePoolResponse
- type DeleteTaskFileOptions
- type DeleteTaskFileResponse
- type DeleteTaskOptions
- type DeleteTaskResponse
- type DependencyAction
- type DiffDiskPlacement
- type DiffDiskSettings
- type DisableJobContent
- type DisableJobOption
- type DisableJobOptions
- type DisableJobResponse
- type DisableJobScheduleOptions
- type DisableJobScheduleResponse
- type DisableNodeSchedulingContent
- type DisableNodeSchedulingOptions
- type DisableNodeSchedulingResponse
- type DisablePoolAutoScaleOptions
- type DisablePoolAutoScaleResponse
- type DiskEncryptionConfiguration
- type DiskEncryptionTarget
- type DynamicVNetAssignmentScope
- type ElevationLevel
- type EnableJobOptions
- type EnableJobResponse
- type EnableJobScheduleOptions
- type EnableJobScheduleResponse
- type EnableNodeSchedulingOptions
- type EnableNodeSchedulingResponse
- type EnablePoolAutoScaleContent
- type EnablePoolAutoScaleOptions
- type EnablePoolAutoScaleResponse
- type EnvironmentSetting
- type Error
- type ErrorCategory
- type ErrorDetail
- type ErrorMessage
- type EvaluatePoolAutoScaleContent
- type EvaluatePoolAutoScaleOptions
- type EvaluatePoolAutoScaleResponse
- type ExitCodeMapping
- type ExitCodeRangeMapping
- type ExitConditions
- type ExitOptions
- type FileProperties
- type GetApplicationOptions
- type GetApplicationResponse
- type GetCertificateOptions
- type GetCertificateResponse
- type GetJobOptions
- type GetJobResponse
- type GetJobScheduleOptions
- type GetJobScheduleResponse
- type GetJobTaskCountsOptions
- type GetJobTaskCountsResponse
- type GetNodeExtensionOptions
- type GetNodeExtensionResponse
- type GetNodeFileOptions
- type GetNodeFilePropertiesOptions
- type GetNodeFilePropertiesResponse
- type GetNodeFileResponse
- type GetNodeOptions
- type GetNodeRemoteLoginSettingsOptions
- type GetNodeRemoteLoginSettingsResponse
- type GetNodeResponse
- type GetPoolOptions
- type GetPoolResponse
- type GetTaskFileOptions
- type GetTaskFilePropertiesOptions
- type GetTaskFilePropertiesResponse
- type GetTaskFileResponse
- type GetTaskOptions
- type GetTaskResponse
- type HTTPHeader
- type IPAddressProvisioningType
- type ImageReference
- type ImageVerificationType
- type InboundEndpoint
- type InboundEndpointProtocol
- type InboundNATPool
- type InstanceViewStatus
- type Job
- type JobAction
- type JobConstraints
- type JobExecutionInfo
- type JobListResult
- type JobManagerTask
- type JobNetworkConfiguration
- type JobPreparationAndReleaseTaskStatus
- type JobPreparationAndReleaseTaskStatusListResult
- type JobPreparationTask
- type JobPreparationTaskExecutionInfo
- type JobPreparationTaskState
- type JobReleaseTask
- type JobReleaseTaskExecutionInfo
- type JobReleaseTaskState
- type JobSchedule
- type JobScheduleConfiguration
- type JobScheduleExecutionInfo
- type JobScheduleExistsOptions
- type JobScheduleExistsResponse
- type JobScheduleListResult
- type JobScheduleState
- type JobScheduleStatistics
- type JobSchedulingError
- type JobSpecification
- type JobState
- type JobStatistics
- type LinuxUserConfiguration
- type ListApplicationsOptions
- type ListApplicationsResponse
- type ListCertificatesOptions
- type ListCertificatesResponse
- type ListJobPreparationAndReleaseTaskStatusOptions
- type ListJobPreparationAndReleaseTaskStatusResponse
- type ListJobSchedulesOptions
- type ListJobSchedulesResponse
- type ListJobsFromScheduleOptions
- type ListJobsFromScheduleResponse
- type ListJobsOptions
- type ListJobsResponse
- type ListNodeExtensionsOptions
- type ListNodeExtensionsResponse
- type ListNodeFilesOptions
- type ListNodeFilesResponse
- type ListNodesOptions
- type ListNodesResponse
- type ListPoolNodeCountsOptions
- type ListPoolNodeCountsResponse
- type ListPoolNodeCountsResult
- type ListPoolsOptions
- type ListPoolsResponse
- type ListSubTasksOptions
- type ListSubTasksResponse
- type ListSupportedImagesOptions
- type ListSupportedImagesResponse
- type ListTaskFilesOptions
- type ListTaskFilesResponse
- type ListTasksOptions
- type ListTasksResponse
- type LoginMode
- type ManagedDisk
- type MetadataItem
- type MountConfiguration
- type MultiInstanceSettings
- type NFSMountConfiguration
- type NameValuePair
- type NetworkConfiguration
- type NetworkSecurityGroupRule
- type NetworkSecurityGroupRuleAccess
- type Node
- type NodeAgentInfo
- type NodeCommunicationMode
- type NodeCounts
- type NodeDeallocateOption
- type NodeDeallocationOption
- type NodeDisableSchedulingOption
- type NodeEndpointConfiguration
- type NodeError
- type NodeFile
- type NodeFileListResult
- type NodeFillType
- type NodeIdentityReference
- type NodeInfo
- type NodeListResult
- type NodePlacementConfiguration
- type NodePlacementPolicyType
- type NodeRebootOption
- type NodeReimageOption
- type NodeRemoteLoginSettings
- type NodeState
- type NodeVMExtension
- type NodeVMExtensionListResult
- type OSDisk
- type OSType
- type OnAllTasksComplete
- type OnTaskFailure
- type OutputFile
- type OutputFileBlobContainerDestination
- type OutputFileDestination
- type OutputFileUploadCondition
- type OutputFileUploadConfig
- type Pool
- type PoolEndpointConfiguration
- type PoolExistsOptions
- type PoolExistsResponse
- type PoolIdentity
- type PoolIdentityType
- type PoolInfo
- type PoolLifetimeOption
- type PoolListResult
- type PoolNodeCounts
- type PoolResourceStatistics
- type PoolSpecification
- type PoolState
- type PoolStatistics
- type PoolUsageStatistics
- type PublicIPAddressConfiguration
- type ReactivateTaskOptions
- type ReactivateTaskResponse
- type RebootNodeContent
- type RebootNodeOptions
- type RebootNodeResponse
- type RecentJob
- type ReimageNodeContent
- type ReimageNodeOptions
- type ReimageNodeResponse
- type RemoveNodeContent
- type RemoveNodesOptions
- type RemoveNodesResponse
- type ReplaceJobOptions
- type ReplaceJobResponse
- type ReplaceJobScheduleOptions
- type ReplaceJobScheduleResponse
- type ReplaceNodeUserOptions
- type ReplaceNodeUserResponse
- type ReplacePoolContent
- type ReplacePoolPropertiesOptions
- type ReplacePoolPropertiesResponse
- type ReplaceTaskOptions
- type ReplaceTaskResponse
- type ResizeError
- type ResizePoolContent
- type ResizePoolOptions
- type ResizePoolResponse
- type ResourceFile
- type RollingUpgradePolicy
- type SchedulingState
- type SecurityEncryptionTypes
- type SecurityProfile
- type SecurityTypes
- type ServiceArtifactReference
- type StartNodeOptions
- type StartNodeResponse
- type StartTask
- type StartTaskInfo
- type StartTaskState
- type StatusLevelTypes
- type StopPoolResizeOptions
- type StopPoolResizeResponse
- type StorageAccountType
- type Subtask
- type SubtaskState
- type SupportedImage
- type Task
- type TaskAddResult
- type TaskAddStatus
- type TaskConstraints
- type TaskContainerExecutionInfo
- type TaskContainerSettings
- type TaskCounts
- type TaskCountsResult
- type TaskDependencies
- type TaskExecutionInfo
- type TaskExecutionResult
- type TaskFailureInfo
- type TaskGroup
- type TaskIDRange
- type TaskInfo
- type TaskListResult
- type TaskListSubtasksResult
- type TaskSchedulingPolicy
- type TaskSlotCounts
- type TaskState
- type TaskStatistics
- type TerminateJobContent
- type TerminateJobOptions
- type TerminateJobResponse
- type TerminateJobScheduleOptions
- type TerminateJobScheduleResponse
- type TerminateTaskOptions
- type TerminateTaskResponse
- type UEFISettings
- type UpdateJobContent
- type UpdateJobOptions
- type UpdateJobResponse
- type UpdateJobScheduleContent
- type UpdateJobScheduleOptions
- type UpdateJobScheduleResponse
- type UpdateNodeUserContent
- type UpdatePoolContent
- type UpdatePoolOptions
- type UpdatePoolResponse
- type UpgradeMode
- type UpgradePolicy
- type UploadNodeLogsContent
- type UploadNodeLogsOptions
- type UploadNodeLogsResponse
- type UploadNodeLogsResult
- type UserAccount
- type UserAssignedIdentity
- type UserIdentity
- type VMDiskSecurityProfile
- type VMExtension
- type VMExtensionInstanceView
- type VirtualMachineConfiguration
- type VirtualMachineInfo
- type WindowsConfiguration
- type WindowsUserConfiguration
Examples ¶
- Package (Package)
- Package (TaskOutputFile)
- Client.NewListJobSchedulesPager
- Client.NewListJobsFromSchedulePager
- Client.NewListJobsPager
- Client.NewListNodeExtensionsPager
- Client.NewListNodeFilesPager
- Client.NewListNodesPager
- Client.NewListPoolNodeCountsPager
- Client.NewListPoolsPager
- Client.NewListSubTasksPager
- Client.NewListSupportedImagesPager
- Client.NewListTaskFilesPager
- Client.NewListTasksPager
- NewClient
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AccessScope ¶
type AccessScope string
AccessScope - AccessScope enums
const ( // AccessScopeJob - Grants access to perform all operations on the Job containing the Task. AccessScopeJob AccessScope = "job" )
func PossibleAccessScopeValues ¶
func PossibleAccessScopeValues() []AccessScope
PossibleAccessScopeValues returns the possible values for the AccessScope const type.
type AccountListSupportedImagesResult ¶
type AccountListSupportedImagesResult struct { // The URL to get the next set of results. NextLink *string // The list of supported Virtual Machine Images. Value []SupportedImage }
AccountListSupportedImagesResult - The result of listing the supported Virtual Machine Images.
func (AccountListSupportedImagesResult) MarshalJSON ¶
func (a AccountListSupportedImagesResult) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type AccountListSupportedImagesResult.
func (*AccountListSupportedImagesResult) UnmarshalJSON ¶
func (a *AccountListSupportedImagesResult) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type AccountListSupportedImagesResult.
type AddTaskCollectionResult ¶
type AddTaskCollectionResult struct { // The results of the add Task collection operation. Value []TaskAddResult }
AddTaskCollectionResult - The result of adding a collection of Tasks to a Job.
func (AddTaskCollectionResult) MarshalJSON ¶
func (a AddTaskCollectionResult) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type AddTaskCollectionResult.
func (*AddTaskCollectionResult) UnmarshalJSON ¶
func (a *AddTaskCollectionResult) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type AddTaskCollectionResult.
type AffinityInfo ¶
type AffinityInfo struct { // REQUIRED; An opaque string representing the location of a Compute Node or a Task that has run previously. You can pass // the affinityId of a Node to indicate that this Task needs to run on that Compute Node. Note that this is just a soft affinity. // If the target Compute Node is busy or unavailable at the time the Task is scheduled, then the Task will be scheduled elsewhere. AffinityID *string }
AffinityInfo - A locality hint that can be used by the Batch service to select a Compute Node on which to start a Task.
func (AffinityInfo) MarshalJSON ¶
func (a AffinityInfo) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type AffinityInfo.
func (*AffinityInfo) UnmarshalJSON ¶
func (a *AffinityInfo) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type AffinityInfo.
type AllocationState ¶
type AllocationState string
AllocationState - AllocationState enums
const ( // AllocationStateResizing - The Pool is resizing; that is, Compute Nodes are being added to or removed from the Pool. AllocationStateResizing AllocationState = "resizing" // AllocationStateSteady - The Pool is not resizing. There are no changes to the number of Compute Nodes in the Pool in progress. // A Pool enters this state when it is created and when no operations are being performed on the Pool to change the number // of Compute Nodes. AllocationStateSteady AllocationState = "steady" // AllocationStateStopping - The Pool was resizing, but the user has requested that the resize be stopped, but the stop request // has not yet been completed. AllocationStateStopping AllocationState = "stopping" )
func PossibleAllocationStateValues ¶
func PossibleAllocationStateValues() []AllocationState
PossibleAllocationStateValues returns the possible values for the AllocationState const type.
type Application ¶
type Application struct { // REQUIRED; The display name for the application. DisplayName *string // REQUIRED; A string that uniquely identifies the application within the Account. ID *string // REQUIRED; The list of available versions of the application. Versions []string }
Application - Contains information about an application in an Azure Batch Account.
func (Application) MarshalJSON ¶
func (a Application) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type Application.
func (*Application) UnmarshalJSON ¶
func (a *Application) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type Application.
type ApplicationListResult ¶
type ApplicationListResult struct { // The URL to get the next set of results. NextLink *string // The list of applications available in the Account. Value []Application }
ApplicationListResult - The result of listing the applications available in an Account.
func (ApplicationListResult) MarshalJSON ¶
func (a ApplicationListResult) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type ApplicationListResult.
func (*ApplicationListResult) UnmarshalJSON ¶
func (a *ApplicationListResult) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationListResult.
type ApplicationPackageReference ¶
type ApplicationPackageReference struct { // REQUIRED; The ID of the application to deploy. When creating a pool, the package's application ID must be fully qualified // (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). ApplicationID *string // The version of the application to deploy. If omitted, the default version is deployed. If this is omitted on a Pool, and // no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences // and HTTP status code 409. If this is omitted on a Task, and no default version is specified for this application, the Task // fails with a pre-processing error. Version *string }
ApplicationPackageReference - A reference to an Package to be deployed to Compute Nodes.
func (ApplicationPackageReference) MarshalJSON ¶
func (a ApplicationPackageReference) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type ApplicationPackageReference.
func (*ApplicationPackageReference) UnmarshalJSON ¶
func (a *ApplicationPackageReference) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type ApplicationPackageReference.
type AuthenticationTokenSettings ¶
type AuthenticationTokenSettings struct { // The Batch resources to which the token grants access. The authentication token grants access to a limited set of Batch // service operations. Currently the only supported value for the access property is 'job', which grants access to all operations // related to the Job which contains the Task. Access []AccessScope }
AuthenticationTokenSettings - The settings for an authentication token that the Task can use to perform Batch service operations.
func (AuthenticationTokenSettings) MarshalJSON ¶
func (a AuthenticationTokenSettings) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type AuthenticationTokenSettings.
func (*AuthenticationTokenSettings) UnmarshalJSON ¶
func (a *AuthenticationTokenSettings) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type AuthenticationTokenSettings.
type AutoPoolSpecification ¶
type AutoPoolSpecification struct { // REQUIRED; The minimum lifetime of created auto Pools, and how multiple Jobs on a schedule are assigned to Pools. PoolLifetimeOption *PoolLifetimeOption // A prefix to be added to the unique identifier when a Pool is automatically created. The Batch service assigns each auto // Pool a unique identifier on creation. To distinguish between Pools created for different purposes, you can specify this // element to add a prefix to the ID that is assigned. The prefix can be up to 20 characters long. AutoPoolIDPrefix *string // Whether to keep an auto Pool alive after its lifetime expires. If false, the Batch service deletes the Pool once its lifetime // (as determined by the poolLifetimeOption setting) expires; that is, when the Job or Job Schedule completes. If true, the // Batch service does not delete the Pool automatically. It is up to the user to delete auto Pools created with this option. KeepAlive *bool // The Pool specification for the auto Pool. Pool *PoolSpecification }
AutoPoolSpecification - Specifies characteristics for a temporary 'auto pool'. The Batch service will create this auto Pool when the Job is submitted.
func (AutoPoolSpecification) MarshalJSON ¶
func (a AutoPoolSpecification) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type AutoPoolSpecification.
func (*AutoPoolSpecification) UnmarshalJSON ¶
func (a *AutoPoolSpecification) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type AutoPoolSpecification.
type AutoScaleRun ¶
type AutoScaleRun struct { // REQUIRED; The time at which the autoscale formula was last evaluated. Timestamp *time.Time // Details of the error encountered evaluating the autoscale formula on the Pool, if the evaluation was unsuccessful. Error *AutoScaleRunError // The final values of all variables used in the evaluation of the autoscale formula. Each variable value is returned in the // form $variable=value, and variables are separated by semicolons. Results *string }
AutoScaleRun - The results and errors from an execution of a Pool autoscale formula.
func (AutoScaleRun) MarshalJSON ¶
func (a AutoScaleRun) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type AutoScaleRun.
func (*AutoScaleRun) UnmarshalJSON ¶
func (a *AutoScaleRun) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type AutoScaleRun.
type AutoScaleRunError ¶
type AutoScaleRunError struct { // An identifier for the autoscale error. Codes are invariant and are intended to be consumed programmatically. Code *string // A message describing the autoscale error, intended to be suitable for display in a user interface. Message *string // A list of additional error details related to the autoscale error. Values []NameValuePair }
AutoScaleRunError - An error that occurred when executing or evaluating a Pool autoscale formula.
func (AutoScaleRunError) MarshalJSON ¶
func (a AutoScaleRunError) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type AutoScaleRunError.
func (*AutoScaleRunError) UnmarshalJSON ¶
func (a *AutoScaleRunError) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type AutoScaleRunError.
type AutoUserScope ¶
type AutoUserScope string
AutoUserScope - AutoUserScope enums
const ( // AutoUserScopePool - Specifies that the Task runs as the common auto user Account which is created on every Compute Node // in a Pool. AutoUserScopePool AutoUserScope = "pool" // AutoUserScopeTask - Specifies that the service should create a new user for the Task. AutoUserScopeTask AutoUserScope = "task" )
func PossibleAutoUserScopeValues ¶
func PossibleAutoUserScopeValues() []AutoUserScope
PossibleAutoUserScopeValues returns the possible values for the AutoUserScope const type.
type AutoUserSpecification ¶
type AutoUserSpecification struct { // The elevation level of the auto user. The default value is nonAdmin. ElevationLevel *ElevationLevel // The scope for the auto user. The default value is pool. If the pool is running Windows a value of Task should be specified // if stricter isolation between tasks is required. For example, if the task mutates the registry in a way which could impact // other tasks, or if certificates have been specified on the pool which should not be accessible by normal tasks but should // be accessible by StartTasks. Scope *AutoUserScope }
AutoUserSpecification - Specifies the options for the auto user that runs an Azure Batch Task.
func (AutoUserSpecification) MarshalJSON ¶
func (a AutoUserSpecification) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type AutoUserSpecification.
func (*AutoUserSpecification) UnmarshalJSON ¶
func (a *AutoUserSpecification) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type AutoUserSpecification.
type AutomaticOSUpgradePolicy ¶
type AutomaticOSUpgradePolicy struct { // Whether OS image rollback feature should be disabled. DisableAutomaticRollback *bool // Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer // version of the OS image becomes available. <br /><br /> If this is set to true for Windows based pools, [WindowsConfiguration.enableAutomaticUpdates](https://learn.microsoft.com/rest/api/batchservice/pool/add?tabs=HTTP#windowsconfiguration) // cannot be set to true. EnableAutomaticOsUpgrade *bool // Defer OS upgrades on the TVMs if they are running tasks. OSRollingUpgradeDeferral *bool // Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Auto OS Upgrade will fallback to the default // policy if no policy is defined on the VMSS. UseRollingUpgradePolicy *bool }
AutomaticOSUpgradePolicy - The configuration parameters used for performing automatic OS upgrade.
func (AutomaticOSUpgradePolicy) MarshalJSON ¶
func (a AutomaticOSUpgradePolicy) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type AutomaticOSUpgradePolicy.
func (*AutomaticOSUpgradePolicy) UnmarshalJSON ¶
func (a *AutomaticOSUpgradePolicy) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type AutomaticOSUpgradePolicy.
type AzureBlobFileSystemConfiguration ¶
type AzureBlobFileSystemConfiguration struct { // REQUIRED; The Azure Storage Account name. AccountName *string // REQUIRED; The Azure Blob Storage Container name. ContainerName *string // REQUIRED; The relative path on the compute node where the file system will be mounted. All file systems are mounted relative // to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. RelativeMountPath *string // The Azure Storage Account key. This property is mutually exclusive with both sasKey and identity; exactly one must be specified. AccountKey *string // Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options // in Linux. BlobfuseOptions *string // The reference to the user assigned identity to use to access containerName. This property is mutually exclusive with both // accountKey and sasKey; exactly one must be specified. IdentityReference *NodeIdentityReference // The Azure Storage SAS token. This property is mutually exclusive with both accountKey and identity; exactly one must be // specified. SASKey *string }
AzureBlobFileSystemConfiguration - Information used to connect to an Azure Storage Container using Blobfuse.
func (AzureBlobFileSystemConfiguration) MarshalJSON ¶
func (a AzureBlobFileSystemConfiguration) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type AzureBlobFileSystemConfiguration.
func (*AzureBlobFileSystemConfiguration) UnmarshalJSON ¶
func (a *AzureBlobFileSystemConfiguration) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type AzureBlobFileSystemConfiguration.
type AzureFileShareConfiguration ¶
type AzureFileShareConfiguration struct { string AccountName *string AzureFileURL *string // to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. RelativeMountPath *string // in Linux. MountOptions *string }AccountKey *
AzureFileShareConfiguration - Information used to connect to an Azure Fileshare.
func (AzureFileShareConfiguration) MarshalJSON ¶
func (a AzureFileShareConfiguration) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type AzureFileShareConfiguration.
func (*AzureFileShareConfiguration) UnmarshalJSON ¶
func (a *AzureFileShareConfiguration) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type AzureFileShareConfiguration.
type CIFSMountConfiguration ¶
type CIFSMountConfiguration struct { // REQUIRED; The password to use for authentication against the CIFS file system. Password *string // REQUIRED; The relative path on the compute node where the file system will be mounted. All file systems are mounted relative // to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. RelativeMountPath *string // REQUIRED; The URI of the file system to mount. Source *string // REQUIRED; The user to use for authentication against the CIFS file system. Username *string // Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options // in Linux. MountOptions *string }
CIFSMountConfiguration - Information used to connect to a CIFS file system.
func (CIFSMountConfiguration) MarshalJSON ¶
func (c CIFSMountConfiguration) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type CIFSMountConfiguration.
func (*CIFSMountConfiguration) UnmarshalJSON ¶
func (c *CIFSMountConfiguration) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type CIFSMountConfiguration.
type CachingType ¶
type CachingType string
CachingType - CachingType enums
const ( // CachingTypeNone - The caching mode for the disk is not enabled. CachingTypeNone CachingType = "none" // CachingTypeReadOnly - The caching mode for the disk is read only. CachingTypeReadOnly CachingType = "readonly" // CachingTypeReadWrite - The caching mode for the disk is read and write. CachingTypeReadWrite CachingType = "readwrite" )
func PossibleCachingTypeValues ¶
func PossibleCachingTypeValues() []CachingType
PossibleCachingTypeValues returns the possible values for the CachingType const type.
type CancelCertificateDeletionOptions ¶
type CancelCertificateDeletionOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
CancelCertificateDeletionOptions contains the optional parameters for the Client.CancelCertificateDeletion method.
type CancelCertificateDeletionResponse ¶
type CancelCertificateDeletionResponse struct { // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The OData ID of the resource to which the request applied. DataServiceID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
CancelCertificateDeletionResponse contains the response from method Client.CancelCertificateDeletion.
type Certificate ¶
type Certificate struct { // REQUIRED; The base64-encoded contents of the Certificate. The maximum size is 10KB. Data *string // REQUIRED; The X.509 thumbprint of the Certificate. This is a sequence of up to 40 hex digits (it may include spaces but // these are removed). Thumbprint *string // REQUIRED; The algorithm used to derive the thumbprint. This must be sha1. ThumbprintAlgorithm *string // The format of the Certificate data. Format *CertificateFormat // The password to access the Certificate's private key. This must be omitted if the Certificate format is cer. Password *string // READ-ONLY; The error that occurred on the last attempt to delete this Certificate. This property is set only if the Certificate // is in the DeleteFailed state. DeleteCertificateError *DeleteCertificateError // READ-ONLY; The previous state of the Certificate. This property is not set if the Certificate is in its initial active // state. PreviousState *CertificateState // READ-ONLY; The time at which the Certificate entered its previous state. This property is not set if the Certificate is // in its initial Active state. PreviousStateTransitionTime *time.Time // READ-ONLY; The public part of the Certificate as a base-64 encoded .cer file. PublicData *string // READ-ONLY; The state of the Certificate. State *CertificateState // READ-ONLY; The time at which the Certificate entered its current state. StateTransitionTime *time.Time // READ-ONLY; The URL of the Certificate. URL *string }
Certificate - A Certificate that can be installed on Compute Nodes and can be used to authenticate operations on the machine.
func (Certificate) MarshalJSON ¶
func (c Certificate) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type Certificate.
func (*Certificate) UnmarshalJSON ¶
func (c *Certificate) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type Certificate.
type CertificateFormat ¶
type CertificateFormat string
CertificateFormat - BatchCertificateFormat enums
const ( // CertificateFormatCER - The Certificate is a base64-encoded X.509 Certificate. CertificateFormatCER CertificateFormat = "cer" // CertificateFormatPFX - The Certificate is a PFX (PKCS#12) formatted Certificate or Certificate chain. CertificateFormatPFX CertificateFormat = "pfx" )
func PossibleCertificateFormatValues ¶
func PossibleCertificateFormatValues() []CertificateFormat
PossibleCertificateFormatValues returns the possible values for the CertificateFormat const type.
type CertificateListResult ¶
type CertificateListResult struct { // The URL to get the next set of results. NextLink *string // The list of Certificates. Value []Certificate }
CertificateListResult - The result of listing the Certificates in the Account.
func (CertificateListResult) MarshalJSON ¶
func (c CertificateListResult) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type CertificateListResult.
func (*CertificateListResult) UnmarshalJSON ¶
func (c *CertificateListResult) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type CertificateListResult.
type CertificateReference ¶
type CertificateReference struct { // REQUIRED; The thumbprint of the Certificate. Thumbprint *string // REQUIRED; The algorithm with which the thumbprint is associated. This must be sha1. ThumbprintAlgorithm *string // The location of the Certificate store on the Compute Node into which to install the Certificate. The default value is currentuser. // This property is applicable only for Pools configured with Windows Compute Nodes (that is, created with cloudServiceConfiguration, // or with virtualMachineConfiguration using a Windows Image reference). For Linux Compute Nodes, the Certificates are stored // in a directory inside the Task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the // Task to query for this location. For Certificates with visibility of 'remoteUser', a 'certs' directory is created in the // user's home directory (e.g., /home/{user-name}/certs) and Certificates are placed in that directory. StoreLocation *CertificateStoreLocation // The name of the Certificate store on the Compute Node into which to install the Certificate. This property is applicable // only for Pools configured with Windows Compute Nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration // using a Windows Image reference). Common store names include: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, // AuthRoot, AddressBook, but any custom store name can also be used. The default value is My. StoreName *string // Which user Accounts on the Compute Node should have access to the private data of the Certificate. You can specify more // than one visibility in this collection. The default is all Accounts. Visibility []CertificateVisibility }
CertificateReference - A reference to a Certificate to be installed on Compute Nodes in a Pool. Warning: This object is deprecated and will be removed after February, 2024. Please use the [Azure KeyVault Extension](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead.
func (CertificateReference) MarshalJSON ¶
func (c CertificateReference) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type CertificateReference.
func (*CertificateReference) UnmarshalJSON ¶
func (c *CertificateReference) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type CertificateReference.
type CertificateState ¶
type CertificateState string
CertificateState - BatchCertificateState enums
const ( // CertificateStateActive - The Certificate is available for use in Pools. CertificateStateActive CertificateState = "active" // CertificateStateDeleteFailed - The user requested that the Certificate be deleted, but there are Pools that still have // references to the Certificate, or it is still installed on one or more Nodes. (The latter can occur if the Certificate // has been removed from the Pool, but the Compute Node has not yet restarted. Compute Nodes refresh their Certificates only // when they restart.) You may use the cancel Certificate delete operation to cancel the delete, or the delete Certificate // operation to retry the delete. CertificateStateDeleteFailed CertificateState = "deletefailed" // CertificateStateDeleting - The user has requested that the Certificate be deleted, but the delete operation has not yet // completed. You may not reference the Certificate when creating or updating Pools. CertificateStateDeleting CertificateState = "deleting" )
func PossibleCertificateStateValues ¶
func PossibleCertificateStateValues() []CertificateState
PossibleCertificateStateValues returns the possible values for the CertificateState const type.
type CertificateStoreLocation ¶
type CertificateStoreLocation string
CertificateStoreLocation - BatchCertificateStoreLocation enums
const ( // CertificateStoreLocationCurrentUser - Certificates should be installed to the CurrentUser Certificate store. CertificateStoreLocationCurrentUser CertificateStoreLocation = "currentuser" // CertificateStoreLocationLocalMachine - Certificates should be installed to the LocalMachine Certificate store. CertificateStoreLocationLocalMachine CertificateStoreLocation = "localmachine" )
func PossibleCertificateStoreLocationValues ¶
func PossibleCertificateStoreLocationValues() []CertificateStoreLocation
PossibleCertificateStoreLocationValues returns the possible values for the CertificateStoreLocation const type.
type CertificateVisibility ¶
type CertificateVisibility string
CertificateVisibility - BatchCertificateVisibility enums
const ( // CertificateVisibilityRemoteUser - The Certificate should be visible to the user accounts under which users remotely access // the Compute Node. CertificateVisibilityRemoteUser CertificateVisibility = "remoteuser" // CertificateVisibilityStartTask - The Certificate should be visible to the user account under which the StartTask is run. // Note that if AutoUser Scope is Pool for both the StartTask and a Task, this certificate will be visible to the Task as // well. CertificateVisibilityStartTask CertificateVisibility = "starttask" // CertificateVisibilityTask - The Certificate should be visible to the user accounts under which Job Tasks are run. CertificateVisibilityTask CertificateVisibility = "task" )
func PossibleCertificateVisibilityValues ¶
func PossibleCertificateVisibilityValues() []CertificateVisibility
PossibleCertificateVisibilityValues returns the possible values for the CertificateVisibility const type.
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client contains the methods for the group. Don't use this type directly, use a constructor function instead.
func NewClient ¶
func NewClient(endpoint string, credential azcore.TokenCredential, opts *ClientOptions) (*Client, error)
NewClient constructs a Client
Example ¶
package main import ( "github.com/Azure/azure-sdk-for-go/sdk/azidentity" "github.com/Azure/azure-sdk-for-go/sdk/batch/azbatch" ) var client *azbatch.Client func main() { cred, err := azidentity.NewDefaultAzureCredential(nil) if err != nil { // TODO: handle error } client, err = azbatch.NewClient("https://TODO.batch.azure.com", cred, nil) if err != nil { // TODO: handle error } _ = client }
func (*Client) CancelCertificateDeletion ¶
func (client *Client) CancelCertificateDeletion(ctx context.Context, thumbprintAlgorithm string, thumbprint string, options *CancelCertificateDeletionOptions) (CancelCertificateDeletionResponse, error)
CancelCertificateDeletion - Cancels a failed deletion of a Certificate from the specified Account.
If you try to delete a Certificate that is being used by a Pool or Compute Node, the status of the Certificate changes to deleteFailed. If you decide that you want to continue using the Certificate, you can use this operation to set the status of the Certificate back to active. If you intend to delete the Certificate, you do not need to run this operation after the deletion failed. You must make sure that the Certificate is not being used by any resources, and then you can try again to delete the Certificate. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2024-07-01.20.0
- thumbprintAlgorithm - The algorithm used to derive the thumbprint parameter. This must be sha1.
- thumbprint - The thumbprint of the Certificate being deleted.
- options - CancelCertificateDeletionOptions contains the optional parameters for the Client.CancelCertificateDeletion method.
func (*Client) CreateCertificate ¶
func (client *Client) CreateCertificate(ctx context.Context, certificate Certificate, options *CreateCertificateOptions) (CreateCertificateResponse, error)
CreateCertificate - Creates a Certificate to the specified Account.
Creates a Certificate to the specified Account. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2024-07-01.20.0
- certificate - The Certificate to be created.
- options - CreateCertificateOptions contains the optional parameters for the Client.CreateCertificate method.
func (*Client) CreateJob ¶
func (client *Client) CreateJob(ctx context.Context, job CreateJobContent, options *CreateJobOptions) (CreateJobResponse, error)
CreateJob - Creates a Job to the specified Account.
The Batch service supports two ways to control the work done as part of a Job. In the first approach, the user specifies a Job Manager Task. The Batch service launches this Task when it is ready to start the Job. The Job Manager Task controls all other Tasks that run under this Job, by using the Task APIs. In the second approach, the user directly controls the execution of Tasks under an active Job, by using the Task APIs. Also note: when naming Jobs, avoid including sensitive information such as user names or secret project names. This information may appear in telemetry logs accessible to Microsoft Support engineers. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2024-07-01.20.0
- job - The Job to be created.
- options - CreateJobOptions contains the optional parameters for the Client.CreateJob method.
func (*Client) CreateJobSchedule ¶
func (client *Client) CreateJobSchedule(ctx context.Context, jobSchedule CreateJobScheduleContent, options *CreateJobScheduleOptions) (CreateJobScheduleResponse, error)
CreateJobSchedule - Creates a Job Schedule to the specified Account.
Creates a Job Schedule to the specified Account. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2024-07-01.20.0
- jobSchedule - The Job Schedule to be created.
- options - CreateJobScheduleOptions contains the optional parameters for the Client.CreateJobSchedule method.
func (*Client) CreateNodeUser ¶
func (client *Client) CreateNodeUser(ctx context.Context, poolID string, nodeID string, userParam CreateNodeUserContent, options *CreateNodeUserOptions) (CreateNodeUserResponse, error)
CreateNodeUser - Adds a user Account to the specified Compute Node.
You can add a user Account to a Compute Node only when it is in the idle or running state. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2024-07-01.20.0
- poolID - The ID of the Pool that contains the Compute Node.
- nodeID - The ID of the machine on which you want to create a user Account.
- userParam - The options to use for creating the user.
- options - CreateNodeUserOptions contains the optional parameters for the Client.CreateNodeUser method.
func (*Client) CreatePool ¶
func (client *Client) CreatePool(ctx context.Context, pool CreatePoolContent, options *CreatePoolOptions) (CreatePoolResponse, error)
CreatePool - Creates a Pool to the specified Account.
When naming Pools, avoid including sensitive information such as user names or secret project names. This information may appear in telemetry logs accessible to Microsoft Support engineers. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2024-07-01.20.0
- pool - The Pool to be created.
- options - CreatePoolOptions contains the optional parameters for the Client.CreatePool method.
func (*Client) CreateTask ¶
func (client *Client) CreateTask(ctx context.Context, jobID string, task CreateTaskContent, options *CreateTaskOptions) (CreateTaskResponse, error)
CreateTask - Creates a Task to the specified Job.
The maximum lifetime of a Task from addition to completion is 180 days. If a Task has not completed within 180 days of being added it will be terminated by the Batch service and left in whatever state it was in at that time. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2024-07-01.20.0
- jobID - The ID of the Job to which the Task is to be created.
- task - The Task to be created.
- options - CreateTaskOptions contains the optional parameters for the Client.CreateTask method.
func (*Client) CreateTaskCollection ¶
func (client *Client) CreateTaskCollection(ctx context.Context, jobID string, taskCollection TaskGroup, options *CreateTaskCollectionOptions) (CreateTaskCollectionResponse, error)
CreateTaskCollection - Adds a collection of Tasks to the specified Job.
Note that each Task must have a unique ID. The Batch service may not return the results for each Task in the same order the Tasks were submitted in this request. If the server times out or the connection is closed during the request, the request may have been partially or fully processed, or not at all. In such cases, the user should re-issue the request. Note that it is up to the user to correctly handle failures when re-issuing a request. For example, you should use the same Task IDs during a retry so that if the prior operation succeeded, the retry will not create extra Tasks unexpectedly. If the response contains any Tasks which failed to add, a client can retry the request. In a retry, it is most efficient to resubmit only Tasks that failed to add, and to omit Tasks that were successfully added on the first attempt. The maximum lifetime of a Task from addition to completion is 180 days. If a Task has not completed within 180 days of being added it will be terminated by the Batch service and left in whatever state it was in at that time. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2024-07-01.20.0
- jobID - The ID of the Job to which the Task collection is to be added.
- taskCollection - The Tasks to be added.
- options - CreateTaskCollectionOptions contains the optional parameters for the Client.CreateTaskCollection method.
func (*Client) DeallocateNode ¶
func (client *Client) DeallocateNode(ctx context.Context, poolID string, nodeID string, options *DeallocateNodeOptions) (DeallocateNodeResponse, error)
DeallocateNode - Deallocates the specified Compute Node.
You can deallocate a Compute Node only if it is in an idle or running state. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2024-07-01.20.0
- poolID - The ID of the Pool that contains the Compute Node.
- nodeID - The ID of the Compute Node that you want to restart.
- options - DeallocateNodeOptions contains the optional parameters for the Client.DeallocateNode method.
func (*Client) DeleteCertificate ¶
func (client *Client) DeleteCertificate(ctx context.Context, thumbprintAlgorithm string, thumbprint string, options *DeleteCertificateOptions) (DeleteCertificateResponse, error)
DeleteCertificate - Deletes a Certificate from the specified Account.
You cannot delete a Certificate if a resource (Pool or Compute Node) is using it. Before you can delete a Certificate, you must therefore make sure that the Certificate is not associated with any existing Pools, the Certificate is not installed on any Nodes (even if you remove a Certificate from a Pool, it is not removed from existing Compute Nodes in that Pool until they restart), and no running Tasks depend on the Certificate. If you try to delete a Certificate that is in use, the deletion fails. The Certificate status changes to deleteFailed. You can use Cancel Delete Certificate to set the status back to active if you decide that you want to continue using the Certificate. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2024-07-01.20.0
- thumbprintAlgorithm - The algorithm used to derive the thumbprint parameter. This must be sha1.
- thumbprint - The thumbprint of the Certificate to be deleted.
- options - DeleteCertificateOptions contains the optional parameters for the Client.DeleteCertificate method.
func (*Client) DeleteJob ¶
func (client *Client) DeleteJob(ctx context.Context, jobID string, options *DeleteJobOptions) (DeleteJobResponse, error)
DeleteJob - Deletes a Job.
Deleting a Job also deletes all Tasks that are part of that Job, and all Job statistics. This also overrides the retention period for Task data; that is, if the Job contains Tasks which are still retained on Compute Nodes, the Batch services deletes those Tasks' working directories and all their contents. When a Delete Job request is received, the Batch service sets the Job to the deleting state. All update operations on a Job that is in deleting state will fail with status code 409 (Conflict), with additional information indicating that the Job is being deleted. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2024-07-01.20.0
- jobID - The ID of the Job to delete.
- options - DeleteJobOptions contains the optional parameters for the Client.DeleteJob method.
func (*Client) DeleteJobSchedule ¶
func (client *Client) DeleteJobSchedule(ctx context.Context, jobScheduleID string, options *DeleteJobScheduleOptions) (DeleteJobScheduleResponse, error)
DeleteJobSchedule - Deletes a Job Schedule from the specified Account.
When you delete a Job Schedule, this also deletes all Jobs and Tasks under that schedule. When Tasks are deleted, all the files in their working directories on the Compute Nodes are also deleted (the retention period is ignored). The Job Schedule statistics are no longer accessible once the Job Schedule is deleted, though they are still counted towards Account lifetime statistics. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2024-07-01.20.0
- jobScheduleID - The ID of the Job Schedule to delete.
- options - DeleteJobScheduleOptions contains the optional parameters for the Client.DeleteJobSchedule method.
func (*Client) DeleteNodeFile ¶
func (client *Client) DeleteNodeFile(ctx context.Context, poolID string, nodeID string, filePath string, options *DeleteNodeFileOptions) (DeleteNodeFileResponse, error)
DeleteNodeFile - Deletes the specified file from the Compute Node.
Deletes the specified file from the Compute Node. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2024-07-01.20.0
- poolID - The ID of the Pool that contains the Compute Node.
- nodeID - The ID of the Compute Node.
- filePath - The path to the file or directory.
- options - DeleteNodeFileOptions contains the optional parameters for the Client.DeleteNodeFile method.
func (*Client) DeleteNodeUser ¶
func (client *Client) DeleteNodeUser(ctx context.Context, poolID string, nodeID string, userName string, options *DeleteNodeUserOptions) (DeleteNodeUserResponse, error)
DeleteNodeUser - Deletes a user Account from the specified Compute Node.
You can delete a user Account to a Compute Node only when it is in the idle or running state. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2024-07-01.20.0
- poolID - The ID of the Pool that contains the Compute Node.
- nodeID - The ID of the machine on which you want to delete a user Account.
- userName - The name of the user Account to delete.
- options - DeleteNodeUserOptions contains the optional parameters for the Client.DeleteNodeUser method.
func (*Client) DeletePool ¶
func (client *Client) DeletePool(ctx context.Context, poolID string, options *DeletePoolOptions) (DeletePoolResponse, error)
DeletePool - Deletes a Pool from the specified Account.
When you request that a Pool be deleted, the following actions occur: the Pool state is set to deleting; any ongoing resize operation on the Pool are stopped; the Batch service starts resizing the Pool to zero Compute Nodes; any Tasks running on existing Compute Nodes are terminated and requeued (as if a resize Pool operation had been requested with the default requeue option); finally, the Pool is removed from the system. Because running Tasks are requeued, the user can rerun these Tasks by updating their Job to target a different Pool. The Tasks can then run on the new Pool. If you want to override the requeue behavior, then you should call resize Pool explicitly to shrink the Pool to zero size before deleting the Pool. If you call an Update, Patch or Delete API on a Pool in the deleting state, it will fail with HTTP status code 409 with error code PoolBeingDeleted. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2024-07-01.20.0
- poolID - The ID of the Pool to get.
- options - DeletePoolOptions contains the optional parameters for the Client.DeletePool method.
func (*Client) DeleteTask ¶
func (client *Client) DeleteTask(ctx context.Context, jobID string, taskID string, options *DeleteTaskOptions) (DeleteTaskResponse, error)
DeleteTask - Deletes a Task from the specified Job.
When a Task is deleted, all of the files in its directory on the Compute Node where it ran are also deleted (regardless of the retention time). For multi-instance Tasks, the delete Task operation applies synchronously to the primary task; subtasks and their files are then deleted asynchronously in the background. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2024-07-01.20.0
- jobID - The ID of the Job from which to delete the Task.
- taskID - The ID of the Task to delete.
- options - DeleteTaskOptions contains the optional parameters for the Client.DeleteTask method.
func (*Client) DeleteTaskFile ¶
func (client *Client) DeleteTaskFile(ctx context.Context, jobID string, taskID string, filePath string, options *DeleteTaskFileOptions) (DeleteTaskFileResponse, error)
DeleteTaskFile - Deletes the specified Task file from the Compute Node where the Task ran.
Deletes the specified Task file from the Compute Node where the Task ran. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2024-07-01.20.0
- jobID - The ID of the Job that contains the Task.
- taskID - The ID of the Task whose file you want to retrieve.
- filePath - The path to the Task file that you want to get the content of.
- options - DeleteTaskFileOptions contains the optional parameters for the Client.DeleteTaskFile method.
func (*Client) DisableJob ¶
func (client *Client) DisableJob(ctx context.Context, jobID string, content DisableJobContent, options *DisableJobOptions) (DisableJobResponse, error)
DisableJob - Disables the specified Job, preventing new Tasks from running.
The Batch Service immediately moves the Job to the disabling state. Batch then uses the disableTasks parameter to determine what to do with the currently running Tasks of the Job. The Job remains in the disabling state until the disable operation is completed and all Tasks have been dealt with according to the disableTasks option; the Job then moves to the disabled state. No new Tasks are started under the Job until it moves back to active state. If you try to disable a Job that is in any state other than active, disabling, or disabled, the request fails with status code 409. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2024-07-01.20.0
- jobID - The ID of the Job to disable.
- content - The options to use for disabling the Job.
- options - DisableJobOptions contains the optional parameters for the Client.DisableJob method.
func (*Client) DisableJobSchedule ¶
func (client *Client) DisableJobSchedule(ctx context.Context, jobScheduleID string, options *DisableJobScheduleOptions) (DisableJobScheduleResponse, error)
DisableJobSchedule - Disables a Job Schedule.
No new Jobs will be created until the Job Schedule is enabled again. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2024-07-01.20.0
- jobScheduleID - The ID of the Job Schedule to disable.
- options - DisableJobScheduleOptions contains the optional parameters for the Client.DisableJobSchedule method.
func (*Client) DisableNodeScheduling ¶
func (client *Client) DisableNodeScheduling(ctx context.Context, poolID string, nodeID string, options *DisableNodeSchedulingOptions) (DisableNodeSchedulingResponse, error)
DisableNodeScheduling - Disables Task scheduling on the specified Compute Node.
You can disable Task scheduling on a Compute Node only if its current scheduling state is enabled. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2024-07-01.20.0
- poolID - The ID of the Pool that contains the Compute Node.
- nodeID - The ID of the Compute Node on which you want to disable Task scheduling.
- options - DisableNodeSchedulingOptions contains the optional parameters for the Client.DisableNodeScheduling method.
func (*Client) DisablePoolAutoScale ¶
func (client *Client) DisablePoolAutoScale(ctx context.Context, poolID string, options *DisablePoolAutoScaleOptions) (DisablePoolAutoScaleResponse, error)
DisablePoolAutoScale - Disables automatic scaling for a Pool.
Disables automatic scaling for a Pool. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2024-07-01.20.0
- poolID - The ID of the Pool on which to disable automatic scaling.
- options - DisablePoolAutoScaleOptions contains the optional parameters for the Client.DisablePoolAutoScale method.
func (*Client) EnableJob ¶
func (client *Client) EnableJob(ctx context.Context, jobID string, options *EnableJobOptions) (EnableJobResponse, error)
EnableJob - Enables the specified Job, allowing new Tasks to run.
When you call this API, the Batch service sets a disabled Job to the enabling state. After the this operation is completed, the Job moves to the active state, and scheduling of new Tasks under the Job resumes. The Batch service does not allow a Task to remain in the active state for more than 180 days. Therefore, if you enable a Job containing active Tasks which were added more than 180 days ago, those Tasks will not run. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2024-07-01.20.0
- jobID - The ID of the Job to enable.
- options - EnableJobOptions contains the optional parameters for the Client.EnableJob method.
func (*Client) EnableJobSchedule ¶
func (client *Client) EnableJobSchedule(ctx context.Context, jobScheduleID string, options *EnableJobScheduleOptions) (EnableJobScheduleResponse, error)
EnableJobSchedule - Enables a Job Schedule.
Enables a Job Schedule. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2024-07-01.20.0
- jobScheduleID - The ID of the Job Schedule to enable.
- options - EnableJobScheduleOptions contains the optional parameters for the Client.EnableJobSchedule method.
func (*Client) EnableNodeScheduling ¶
func (client *Client) EnableNodeScheduling(ctx context.Context, poolID string, nodeID string, options *EnableNodeSchedulingOptions) (EnableNodeSchedulingResponse, error)
EnableNodeScheduling - Enables Task scheduling on the specified Compute Node.
You can enable Task scheduling on a Compute Node only if its current scheduling state is disabled If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2024-07-01.20.0
- poolID - The ID of the Pool that contains the Compute Node.
- nodeID - The ID of the Compute Node on which you want to enable Task scheduling.
- options - EnableNodeSchedulingOptions contains the optional parameters for the Client.EnableNodeScheduling method.
func (*Client) EnablePoolAutoScale ¶
func (client *Client) EnablePoolAutoScale(ctx context.Context, poolID string, content EnablePoolAutoScaleContent, options *EnablePoolAutoScaleOptions) (EnablePoolAutoScaleResponse, error)
EnablePoolAutoScale - Enables automatic scaling for a Pool.
You cannot enable automatic scaling on a Pool if a resize operation is in progress on the Pool. If automatic scaling of the Pool is currently disabled, you must specify a valid autoscale formula as part of the request. If automatic scaling of the Pool is already enabled, you may specify a new autoscale formula and/or a new evaluation interval. You cannot call this API for the same Pool more than once every 30 seconds. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2024-07-01.20.0
- poolID - The ID of the Pool to get.
- content - The options to use for enabling automatic scaling.
- options - EnablePoolAutoScaleOptions contains the optional parameters for the Client.EnablePoolAutoScale method.
func (*Client) EvaluatePoolAutoScale ¶
func (client *Client) EvaluatePoolAutoScale(ctx context.Context, poolID string, content EvaluatePoolAutoScaleContent, options *EvaluatePoolAutoScaleOptions) (EvaluatePoolAutoScaleResponse, error)
EvaluatePoolAutoScale - Gets the result of evaluating an automatic scaling formula on the Pool.
This API is primarily for validating an autoscale formula, as it simply returns the result without applying the formula to the Pool. The Pool must have auto scaling enabled in order to evaluate a formula. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2024-07-01.20.0
- poolID - The ID of the Pool on which to evaluate the automatic scaling formula.
- content - The options to use for evaluating the automatic scaling formula.
- options - EvaluatePoolAutoScaleOptions contains the optional parameters for the Client.EvaluatePoolAutoScale method.
func (*Client) GetApplication ¶
func (client *Client) GetApplication(ctx context.Context, applicationID string, options *GetApplicationOptions) (GetApplicationResponse, error)
GetApplication - Gets information about the specified Application.
This operation returns only Applications and versions that are available for use on Compute Nodes; that is, that can be used in an Package reference. For administrator information about Applications and versions that are not yet available to Compute Nodes, use the Azure portal or the Azure Resource Manager API. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2024-07-01.20.0
- applicationID - The ID of the Application
- options - GetApplicationOptions contains the optional parameters for the Client.GetApplication method.
func (*Client) GetCertificate ¶
func (client *Client) GetCertificate(ctx context.Context, thumbprintAlgorithm string, thumbprint string, options *GetCertificateOptions) (GetCertificateResponse, error)
GetCertificate - Gets information about the specified Certificate. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2024-07-01.20.0
- thumbprintAlgorithm - The algorithm used to derive the thumbprint parameter. This must be sha1.
- thumbprint - The thumbprint of the Certificate to get.
- options - GetCertificateOptions contains the optional parameters for the Client.GetCertificate method.
func (*Client) GetJob ¶
func (client *Client) GetJob(ctx context.Context, jobID string, options *GetJobOptions) (GetJobResponse, error)
GetJob - Gets information about the specified Job.
Gets information about the specified Job. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2024-07-01.20.0
- jobID - The ID of the Job.
- options - GetJobOptions contains the optional parameters for the Client.GetJob method.
func (*Client) GetJobSchedule ¶
func (client *Client) GetJobSchedule(ctx context.Context, jobScheduleID string, options *GetJobScheduleOptions) (GetJobScheduleResponse, error)
GetJobSchedule - Gets information about the specified Job Schedule. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2024-07-01.20.0
- jobScheduleID - The ID of the Job Schedule to get.
- options - GetJobScheduleOptions contains the optional parameters for the Client.GetJobSchedule method.
func (*Client) GetJobTaskCounts ¶
func (client *Client) GetJobTaskCounts(ctx context.Context, jobID string, options *GetJobTaskCountsOptions) (GetJobTaskCountsResponse, error)
GetJobTaskCounts - Gets the Task counts for the specified Job.
Task counts provide a count of the Tasks by active, running or completed Task state, and a count of Tasks which succeeded or failed. Tasks in the preparing state are counted as running. Note that the numbers returned may not always be up to date. If you need exact task counts, use a list query. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2024-07-01.20.0
- jobID - The ID of the Job.
- options - GetJobTaskCountsOptions contains the optional parameters for the Client.GetJobTaskCounts method.
func (*Client) GetNode ¶
func (client *Client) GetNode(ctx context.Context, poolID string, nodeID string, options *GetNodeOptions) (GetNodeResponse, error)
GetNode - Gets information about the specified Compute Node.
Gets information about the specified Compute Node. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2024-07-01.20.0
- poolID - The ID of the Pool that contains the Compute Node.
- nodeID - The ID of the Compute Node that you want to get information about.
- options - GetNodeOptions contains the optional parameters for the Client.GetNode method.
func (*Client) GetNodeExtension ¶
func (client *Client) GetNodeExtension(ctx context.Context, poolID string, nodeID string, extensionName string, options *GetNodeExtensionOptions) (GetNodeExtensionResponse, error)
GetNodeExtension - Gets information about the specified Compute Node Extension.
Gets information about the specified Compute Node Extension. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2024-07-01.20.0
- poolID - The ID of the Pool that contains the Compute Node.
- nodeID - The ID of the Compute Node that contains the extensions.
- extensionName - The name of the Compute Node Extension that you want to get information about.
- options - GetNodeExtensionOptions contains the optional parameters for the Client.GetNodeExtension method.
func (*Client) GetNodeFile ¶
func (client *Client) GetNodeFile(ctx context.Context, poolID string, nodeID string, filePath string, options *GetNodeFileOptions) (GetNodeFileResponse, error)
GetNodeFile - Returns the content of the specified Compute Node file. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2024-07-01.20.0
- poolID - The ID of the Pool that contains the Compute Node.
- nodeID - The ID of the Compute Node.
- filePath - The path to the file or directory.
- options - GetNodeFileOptions contains the optional parameters for the Client.GetNodeFile method.
func (*Client) GetNodeFileProperties ¶
func (client *Client) GetNodeFileProperties(ctx context.Context, poolID string, nodeID string, filePath string, options *GetNodeFilePropertiesOptions) (GetNodeFilePropertiesResponse, error)
GetNodeFileProperties - Gets the properties of the specified Compute Node file. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2024-07-01.20.0
- poolID - The ID of the Pool that contains the Compute Node.
- nodeID - The ID of the Compute Node.
- filePath - The path to the file or directory.
- options - GetNodeFilePropertiesOptions contains the optional parameters for the Client.GetNodeFileProperties method.
func (*Client) GetNodeRemoteLoginSettings ¶
func (client *Client) GetNodeRemoteLoginSettings(ctx context.Context, poolID string, nodeID string, options *GetNodeRemoteLoginSettingsOptions) (GetNodeRemoteLoginSettingsResponse, error)
GetNodeRemoteLoginSettings - Gets the settings required for remote login to a Compute Node.
Before you can remotely login to a Compute Node using the remote login settings, you must create a user Account on the Compute Node. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2024-07-01.20.0
- poolID - The ID of the Pool that contains the Compute Node.
- nodeID - The ID of the Compute Node for which to obtain the remote login settings.
- options - GetNodeRemoteLoginSettingsOptions contains the optional parameters for the Client.GetNodeRemoteLoginSettings method.
func (*Client) GetPool ¶
func (client *Client) GetPool(ctx context.Context, poolID string, options *GetPoolOptions) (GetPoolResponse, error)
GetPool - Gets information about the specified Pool. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2024-07-01.20.0
- poolID - The ID of the Pool to get.
- options - GetPoolOptions contains the optional parameters for the Client.GetPool method.
func (*Client) GetTask ¶
func (client *Client) GetTask(ctx context.Context, jobID string, taskID string, options *GetTaskOptions) (GetTaskResponse, error)
GetTask - Gets information about the specified Task.
For multi-instance Tasks, information such as affinityId, executionInfo and nodeInfo refer to the primary Task. Use the list subtasks API to retrieve information about subtasks. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2024-07-01.20.0
- jobID - The ID of the Job that contains the Task.
- taskID - The ID of the Task to get information about.
- options - GetTaskOptions contains the optional parameters for the Client.GetTask method.
func (*Client) GetTaskFile ¶
func (client *Client) GetTaskFile(ctx context.Context, jobID string, taskID string, filePath string, options *GetTaskFileOptions) (GetTaskFileResponse, error)
GetTaskFile - Returns the content of the specified Task file. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2024-07-01.20.0
- jobID - The ID of the Job that contains the Task.
- taskID - The ID of the Task whose file you want to retrieve.
- filePath - The path to the Task file that you want to get the content of.
- options - GetTaskFileOptions contains the optional parameters for the Client.GetTaskFile method.
func (*Client) GetTaskFileProperties ¶
func (client *Client) GetTaskFileProperties(ctx context.Context, jobID string, taskID string, filePath string, options *GetTaskFilePropertiesOptions) (GetTaskFilePropertiesResponse, error)
GetTaskFileProperties - Gets the properties of the specified Task file. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2024-07-01.20.0
- jobID - The ID of the Job that contains the Task.
- taskID - The ID of the Task whose file you want to retrieve.
- filePath - The path to the Task file that you want to get the content of.
- options - GetTaskFilePropertiesOptions contains the optional parameters for the Client.GetTaskFileProperties method.
func (*Client) JobScheduleExists ¶
func (client *Client) JobScheduleExists(ctx context.Context, jobScheduleID string, options *JobScheduleExistsOptions) (JobScheduleExistsResponse, error)
JobScheduleExists - Checks the specified Job Schedule exists.
Checks the specified Job Schedule exists. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2024-07-01.20.0
- jobScheduleID - The ID of the Job Schedule which you want to check.
- options - JobScheduleExistsOptions contains the optional parameters for the Client.JobScheduleExists method.
func (*Client) NewListApplicationsPager ¶
func (client *Client) NewListApplicationsPager(options *ListApplicationsOptions) *runtime.Pager[ListApplicationsResponse]
NewListApplicationsPager - Lists all of the applications available in the specified Account.
This operation returns only Applications and versions that are available for use on Compute Nodes; that is, that can be used in an Package reference. For administrator information about applications and versions that are not yet available to Compute Nodes, use the Azure portal or the Azure Resource Manager API.
Generated from API version 2024-07-01.20.0
- options - ListApplicationsOptions contains the optional parameters for the Client.NewListApplicationsPager method.
func (*Client) NewListCertificatesPager ¶
func (client *Client) NewListCertificatesPager(options *ListCertificatesOptions) *runtime.Pager[ListCertificatesResponse]
NewListCertificatesPager - Lists all of the Certificates that have been added to the specified Account.
Lists all of the Certificates that have been added to the specified Account.
Generated from API version 2024-07-01.20.0
- options - ListCertificatesOptions contains the optional parameters for the Client.NewListCertificatesPager method.
func (*Client) NewListJobPreparationAndReleaseTaskStatusPager ¶
func (client *Client) NewListJobPreparationAndReleaseTaskStatusPager(jobID string, options *ListJobPreparationAndReleaseTaskStatusOptions) *runtime.Pager[ListJobPreparationAndReleaseTaskStatusResponse]
NewListJobPreparationAndReleaseTaskStatusPager - Lists the execution status of the Job Preparation and Job Release Task for the specified Job across the Compute Nodes where the Job has run.
This API returns the Job Preparation and Job Release Task status on all Compute Nodes that have run the Job Preparation or Job Release Task. This includes Compute Nodes which have since been removed from the Pool. If this API is invoked on a Job which has no Job Preparation or Job Release Task, the Batch service returns HTTP status code 409 (Conflict) with an error code of JobPreparationTaskNotSpecified.
Generated from API version 2024-07-01.20.0
- jobID - The ID of the Job.
- options - ListJobPreparationAndReleaseTaskStatusOptions contains the optional parameters for the Client.NewListJobPreparationAndReleaseTaskStatusPager method.
func (*Client) NewListJobSchedulesPager ¶
func (client *Client) NewListJobSchedulesPager(options *ListJobSchedulesOptions) *runtime.Pager[ListJobSchedulesResponse]
NewListJobSchedulesPager - Lists all of the Job Schedules in the specified Account.
Lists all of the Job Schedules in the specified Account.
Generated from API version 2024-07-01.20.0
- options - ListJobSchedulesOptions contains the optional parameters for the Client.NewListJobSchedulesPager method.
Example ¶
package main import ( "context" "fmt" "github.com/Azure/azure-sdk-for-go/sdk/batch/azbatch" ) var client *azbatch.Client func main() { for schedules := client.NewListJobSchedulesPager(nil); schedules.More(); { page, err := schedules.NextPage(context.TODO()) if err != nil { // TODO: handle error } for _, schedule := range page.Value { fmt.Println(*schedule.ID) } } }
func (*Client) NewListJobsFromSchedulePager ¶
func (client *Client) NewListJobsFromSchedulePager(jobScheduleID string, options *ListJobsFromScheduleOptions) *runtime.Pager[ListJobsFromScheduleResponse]
NewListJobsFromSchedulePager - Lists the Jobs that have been created under the specified Job Schedule.
Lists the Jobs that have been created under the specified Job Schedule.
Generated from API version 2024-07-01.20.0
- jobScheduleID - The ID of the Job Schedule from which you want to get a list of Jobs.
- options - ListJobsFromScheduleOptions contains the optional parameters for the Client.NewListJobsFromSchedulePager method.
Example ¶
package main import ( "context" "fmt" "github.com/Azure/azure-sdk-for-go/sdk/batch/azbatch" ) var client *azbatch.Client func main() { for jobs := client.NewListJobsFromSchedulePager("TODO: schedule ID", nil); jobs.More(); { page, err := jobs.NextPage(context.TODO()) if err != nil { // TODO: handle error } for _, job := range page.Value { fmt.Println(*job.ID) } } }
func (*Client) NewListJobsPager ¶
func (client *Client) NewListJobsPager(options *ListJobsOptions) *runtime.Pager[ListJobsResponse]
NewListJobsPager - Lists all of the Jobs in the specified Account.
Lists all of the Jobs in the specified Account.
Generated from API version 2024-07-01.20.0
- options - ListJobsOptions contains the optional parameters for the Client.NewListJobsPager method.
Example ¶
package main import ( "context" "fmt" "github.com/Azure/azure-sdk-for-go/sdk/batch/azbatch" ) var client *azbatch.Client func main() { for jobs := client.NewListJobsPager(nil); jobs.More(); { page, err := jobs.NextPage(context.TODO()) if err != nil { // TODO: handle error } for _, job := range page.Value { fmt.Println(*job.ID) } } }
func (*Client) NewListNodeExtensionsPager ¶
func (client *Client) NewListNodeExtensionsPager(poolID string, nodeID string, options *ListNodeExtensionsOptions) *runtime.Pager[ListNodeExtensionsResponse]
NewListNodeExtensionsPager - Lists the Compute Nodes Extensions in the specified Pool.
Lists the Compute Nodes Extensions in the specified Pool.
Generated from API version 2024-07-01.20.0
- poolID - The ID of the Pool that contains Compute Node.
- nodeID - The ID of the Compute Node that you want to list extensions.
- options - ListNodeExtensionsOptions contains the optional parameters for the Client.NewListNodeExtensionsPager method.
Example ¶
package main import ( "context" "fmt" "github.com/Azure/azure-sdk-for-go/sdk/batch/azbatch" ) var client *azbatch.Client func main() { for extensions := client.NewListNodeExtensionsPager("TODO: pool ID", "TODO: node ID", nil); extensions.More(); { page, err := extensions.NextPage(context.TODO()) if err != nil { // TODO: handle error } for _, extension := range page.Value { fmt.Println(*extension.VMExtension.Name) } } }
func (*Client) NewListNodeFilesPager ¶
func (client *Client) NewListNodeFilesPager(poolID string, nodeID string, options *ListNodeFilesOptions) *runtime.Pager[ListNodeFilesResponse]
NewListNodeFilesPager - Lists all of the files in Task directories on the specified Compute Node.
Lists all of the files in Task directories on the specified Compute Node.
Generated from API version 2024-07-01.20.0
- poolID - The ID of the Pool that contains the Compute Node.
- nodeID - The ID of the Compute Node whose files you want to list.
- options - ListNodeFilesOptions contains the optional parameters for the Client.NewListNodeFilesPager method.
Example ¶
package main import ( "context" "fmt" "github.com/Azure/azure-sdk-for-go/sdk/batch/azbatch" ) var client *azbatch.Client func main() { for files := client.NewListNodeFilesPager("TODO: pool ID", "TODO: node ID", nil); files.More(); { page, err := files.NextPage(context.TODO()) if err != nil { // TODO: handle error } for _, file := range page.Value { fmt.Println(*file.Name) } } }
func (*Client) NewListNodesPager ¶
func (client *Client) NewListNodesPager(poolID string, options *ListNodesOptions) *runtime.Pager[ListNodesResponse]
NewListNodesPager - Lists the Compute Nodes in the specified Pool.
Lists the Compute Nodes in the specified Pool.
Generated from API version 2024-07-01.20.0
- poolID - The ID of the Pool from which you want to list Compute Nodes.
- options - ListNodesOptions contains the optional parameters for the Client.NewListNodesPager method.
Example ¶
package main import ( "context" "fmt" "github.com/Azure/azure-sdk-for-go/sdk/batch/azbatch" ) var client *azbatch.Client func main() { for nodes := client.NewListNodesPager("TODO: pool ID", nil); nodes.More(); { page, err := nodes.NextPage(context.TODO()) if err != nil { // TODO: handle error } for _, node := range page.Value { fmt.Println(*node.ID) } } }
func (*Client) NewListPoolNodeCountsPager ¶
func (client *Client) NewListPoolNodeCountsPager(options *ListPoolNodeCountsOptions) *runtime.Pager[ListPoolNodeCountsResponse]
NewListPoolNodeCountsPager - Gets the number of Compute Nodes in each state, grouped by Pool. Note that the numbers returned may not always be up to date. If you need exact node counts, use a list query.
Generated from API version 2024-07-01.20.0
- options - ListPoolNodeCountsOptions contains the optional parameters for the Client.NewListPoolNodeCountsPager method.
Example ¶
package main import ( "context" "fmt" "github.com/Azure/azure-sdk-for-go/sdk/batch/azbatch" ) var client *azbatch.Client func main() { for counts := client.NewListPoolNodeCountsPager(nil); counts.More(); { page, err := counts.NextPage(context.TODO()) if err != nil { // TODO: handle error } for _, count := range page.Value { fmt.Println(*count.Dedicated) } } }
func (*Client) NewListPoolsPager ¶
func (client *Client) NewListPoolsPager(options *ListPoolsOptions) *runtime.Pager[ListPoolsResponse]
NewListPoolsPager - Lists all of the Pools which be mounted.
Lists all of the Pools which be mounted.
Generated from API version 2024-07-01.20.0
- options - ListPoolsOptions contains the optional parameters for the Client.NewListPoolsPager method.
Example ¶
package main import ( "context" "fmt" "github.com/Azure/azure-sdk-for-go/sdk/batch/azbatch" ) var client *azbatch.Client func main() { for pools := client.NewListPoolsPager(nil); pools.More(); { page, err := pools.NextPage(context.TODO()) if err != nil { // TODO: handle error } for _, pool := range page.Value { fmt.Println(*pool.ID) } } }
func (*Client) NewListSubTasksPager ¶
func (client *Client) NewListSubTasksPager(jobID string, taskID string, options *ListSubTasksOptions) *runtime.Pager[ListSubTasksResponse]
NewListSubTasksPager - Lists all of the subtasks that are associated with the specified multi-instance Task.
If the Task is not a multi-instance Task then this returns an empty collection.
Generated from API version 2024-07-01.20.0
- jobID - The ID of the Job.
- taskID - The ID of the Task.
- options - ListSubTasksOptions contains the optional parameters for the Client.NewListSubTasksPager method.
Example ¶
package main import ( "context" "fmt" "github.com/Azure/azure-sdk-for-go/sdk/batch/azbatch" ) var client *azbatch.Client func main() { for subtasks := client.NewListSubTasksPager("TODO: job ID", "TODO: task ID", nil); subtasks.More(); { page, err := subtasks.NextPage(context.TODO()) if err != nil { // TODO: handle error } for _, subtask := range page.Value { fmt.Println(*subtask.State) } } }
func (*Client) NewListSupportedImagesPager ¶
func (client *Client) NewListSupportedImagesPager(options *ListSupportedImagesOptions) *runtime.Pager[ListSupportedImagesResponse]
NewListSupportedImagesPager - Lists all Virtual Machine Images supported by the Azure Batch service.
Lists all Virtual Machine Images supported by the Azure Batch service.
Generated from API version 2024-07-01.20.0
- options - ListSupportedImagesOptions contains the optional parameters for the Client.NewListSupportedImagesPager method.
Example ¶
package main import ( "context" "fmt" "github.com/Azure/azure-sdk-for-go/sdk/batch/azbatch" ) var client *azbatch.Client func main() { for images := client.NewListSupportedImagesPager(nil); images.More(); { page, err := images.NextPage(context.TODO()) if err != nil { // TODO: handle error } for _, image := range page.Value { fmt.Println(*image.ImageReference.Offer) } } }
func (*Client) NewListTaskFilesPager ¶
func (client *Client) NewListTaskFilesPager(jobID string, taskID string, options *ListTaskFilesOptions) *runtime.Pager[ListTaskFilesResponse]
NewListTaskFilesPager - Lists the files in a Task's directory on its Compute Node.
Lists the files in a Task's directory on its Compute Node.
Generated from API version 2024-07-01.20.0
- jobID - The ID of the Job that contains the Task.
- taskID - The ID of the Task whose files you want to list.
- options - ListTaskFilesOptions contains the optional parameters for the Client.NewListTaskFilesPager method.
Example ¶
package main import ( "context" "fmt" "github.com/Azure/azure-sdk-for-go/sdk/batch/azbatch" ) var client *azbatch.Client func main() { for files := client.NewListTaskFilesPager("TODO: job ID", "TODO: task ID", nil); files.More(); { page, err := files.NextPage(context.TODO()) if err != nil { // TODO: handle error } for _, file := range page.Value { fmt.Println(*file.Name) } } }
func (*Client) NewListTasksPager ¶
func (client *Client) NewListTasksPager(jobID string, options *ListTasksOptions) *runtime.Pager[ListTasksResponse]
NewListTasksPager - Lists all of the Tasks that are associated with the specified Job.
For multi-instance Tasks, information such as affinityId, executionInfo and nodeInfo refer to the primary Task. Use the list subtasks API to retrieve information about subtasks.
Generated from API version 2024-07-01.20.0
- jobID - The ID of the Job.
- options - ListTasksOptions contains the optional parameters for the Client.NewListTasksPager method.
Example ¶
package main import ( "context" "fmt" "github.com/Azure/azure-sdk-for-go/sdk/batch/azbatch" ) var client *azbatch.Client func main() { for tasks := client.NewListTasksPager("TODO: job ID", nil); tasks.More(); { page, err := tasks.NextPage(context.TODO()) if err != nil { // TODO: handle error } for _, task := range page.Value { fmt.Println(*task.ID) } } }
func (*Client) PoolExists ¶
func (client *Client) PoolExists(ctx context.Context, poolID string, options *PoolExistsOptions) (PoolExistsResponse, error)
PoolExists - Gets basic properties of a Pool. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2024-07-01.20.0
- poolID - The ID of the Pool to get.
- options - PoolExistsOptions contains the optional parameters for the Client.PoolExists method.
func (*Client) ReactivateTask ¶
func (client *Client) ReactivateTask(ctx context.Context, jobID string, taskID string, options *ReactivateTaskOptions) (ReactivateTaskResponse, error)
ReactivateTask - Reactivates a Task, allowing it to run again even if its retry count has been exhausted.
Reactivation makes a Task eligible to be retried again up to its maximum retry count. The Task's state is changed to active. As the Task is no longer in the completed state, any previous exit code or failure information is no longer available after reactivation. Each time a Task is reactivated, its retry count is reset to 0. Reactivation will fail for Tasks that are not completed or that previously completed successfully (with an exit code of 0). Additionally, it will fail if the Job has completed (or is terminating or deleting). If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2024-07-01.20.0
- jobID - The ID of the Job containing the Task.
- taskID - The ID of the Task to reactivate.
- options - ReactivateTaskOptions contains the optional parameters for the Client.ReactivateTask method.
func (*Client) RebootNode ¶
func (client *Client) RebootNode(ctx context.Context, poolID string, nodeID string, options *RebootNodeOptions) (RebootNodeResponse, error)
RebootNode - Restarts the specified Compute Node.
You can restart a Compute Node only if it is in an idle or running state. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2024-07-01.20.0
- poolID - The ID of the Pool that contains the Compute Node.
- nodeID - The ID of the Compute Node that you want to restart.
- options - RebootNodeOptions contains the optional parameters for the Client.RebootNode method.
func (*Client) ReimageNode ¶
func (client *Client) ReimageNode(ctx context.Context, poolID string, nodeID string, options *ReimageNodeOptions) (ReimageNodeResponse, error)
ReimageNode - Reinstalls the operating system on the specified Compute Node.
You can reinstall the operating system on a Compute Node only if it is in an idle or running state. This API can be invoked only on Pools created with the cloud service configuration property. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2024-07-01.20.0
- poolID - The ID of the Pool that contains the Compute Node.
- nodeID - The ID of the Compute Node that you want to restart.
- options - ReimageNodeOptions contains the optional parameters for the Client.ReimageNode method.
func (*Client) RemoveNodes ¶
func (client *Client) RemoveNodes(ctx context.Context, poolID string, content RemoveNodeContent, options *RemoveNodesOptions) (RemoveNodesResponse, error)
RemoveNodes - Removes Compute Nodes from the specified Pool.
This operation can only run when the allocation state of the Pool is steady. When this operation runs, the allocation state changes from steady to resizing. Each request may remove up to 100 nodes. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2024-07-01.20.0
- poolID - The ID of the Pool to get.
- content - The options to use for removing the node.
- options - RemoveNodesOptions contains the optional parameters for the Client.RemoveNodes method.
func (*Client) ReplaceJob ¶
func (client *Client) ReplaceJob(ctx context.Context, jobID string, job Job, options *ReplaceJobOptions) (ReplaceJobResponse, error)
ReplaceJob - Updates the properties of the specified Job.
This fully replaces all the updatable properties of the Job. For example, if the Job has constraints associated with it and if constraints is not specified with this request, then the Batch service will remove the existing constraints. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2024-07-01.20.0
- jobID - The ID of the Job whose properties you want to update.
- job - A job with updated properties
- options - ReplaceJobOptions contains the optional parameters for the Client.ReplaceJob method.
func (*Client) ReplaceJobSchedule ¶
func (client *Client) ReplaceJobSchedule(ctx context.Context, jobScheduleID string, jobSchedule JobSchedule, options *ReplaceJobScheduleOptions) (ReplaceJobScheduleResponse, error)
ReplaceJobSchedule - Updates the properties of the specified Job Schedule.
This fully replaces all the updatable properties of the Job Schedule. For example, if the schedule property is not specified with this request, then the Batch service will remove the existing schedule. Changes to a Job Schedule only impact Jobs created by the schedule after the update has taken place; currently running Jobs are unaffected. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2024-07-01.20.0
- jobScheduleID - The ID of the Job Schedule to update.
- jobSchedule - A Job Schedule with updated properties
- options - ReplaceJobScheduleOptions contains the optional parameters for the Client.ReplaceJobSchedule method.
func (*Client) ReplaceNodeUser ¶
func (client *Client) ReplaceNodeUser(ctx context.Context, poolID string, nodeID string, userName string, content UpdateNodeUserContent, options *ReplaceNodeUserOptions) (ReplaceNodeUserResponse, error)
ReplaceNodeUser - Updates the password and expiration time of a user Account on the specified Compute Node.
This operation replaces of all the updatable properties of the Account. For example, if the expiryTime element is not specified, the current value is replaced with the default value, not left unmodified. You can update a user Account on a Compute Node only when it is in the idle or running state. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2024-07-01.20.0
- poolID - The ID of the Pool that contains the Compute Node.
- nodeID - The ID of the machine on which you want to update a user Account.
- userName - The name of the user Account to update.
- content - The options to use for updating the user.
- options - ReplaceNodeUserOptions contains the optional parameters for the Client.ReplaceNodeUser method.
func (*Client) ReplacePoolProperties ¶
func (client *Client) ReplacePoolProperties(ctx context.Context, poolID string, pool ReplacePoolContent, options *ReplacePoolPropertiesOptions) (ReplacePoolPropertiesResponse, error)
ReplacePoolProperties - Updates the properties of the specified Pool.
This fully replaces all the updatable properties of the Pool. For example, if the Pool has a StartTask associated with it and if StartTask is not specified with this request, then the Batch service will remove the existing StartTask. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2024-07-01.20.0
- poolID - The ID of the Pool to update.
- pool - The options to use for replacing properties on the pool.
- options - ReplacePoolPropertiesOptions contains the optional parameters for the Client.ReplacePoolProperties method.
func (*Client) ReplaceTask ¶
func (client *Client) ReplaceTask(ctx context.Context, jobID string, taskID string, task Task, options *ReplaceTaskOptions) (ReplaceTaskResponse, error)
ReplaceTask - Updates the properties of the specified Task. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2024-07-01.20.0
- jobID - The ID of the Job containing the Task.
- taskID - The ID of the Task to update.
- task - The Task to update.
- options - ReplaceTaskOptions contains the optional parameters for the Client.ReplaceTask method.
func (*Client) ResizePool ¶
func (client *Client) ResizePool(ctx context.Context, poolID string, content ResizePoolContent, options *ResizePoolOptions) (ResizePoolResponse, error)
ResizePool - Changes the number of Compute Nodes that are assigned to a Pool.
You can only resize a Pool when its allocation state is steady. If the Pool is already resizing, the request fails with status code 409. When you resize a Pool, the Pool's allocation state changes from steady to resizing. You cannot resize Pools which are configured for automatic scaling. If you try to do this, the Batch service returns an error 409. If you resize a Pool downwards, the Batch service chooses which Compute Nodes to remove. To remove specific Compute Nodes, use the Pool remove Compute Nodes API instead. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2024-07-01.20.0
- poolID - The ID of the Pool to get.
- content - The options to use for resizing the pool.
- options - ResizePoolOptions contains the optional parameters for the Client.ResizePool method.
func (*Client) StartNode ¶
func (client *Client) StartNode(ctx context.Context, poolID string, nodeID string, options *StartNodeOptions) (StartNodeResponse, error)
StartNode - Starts the specified Compute Node.
You can start a Compute Node only if it has been deallocated. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2024-07-01.20.0
- poolID - The ID of the Pool that contains the Compute Node.
- nodeID - The ID of the Compute Node that you want to restart.
- options - StartNodeOptions contains the optional parameters for the Client.StartNode method.
func (*Client) StopPoolResize ¶
func (client *Client) StopPoolResize(ctx context.Context, poolID string, options *StopPoolResizeOptions) (StopPoolResizeResponse, error)
StopPoolResize - Stops an ongoing resize operation on the Pool.
This does not restore the Pool to its previous state before the resize operation: it only stops any further changes being made, and the Pool maintains its current state. After stopping, the Pool stabilizes at the number of Compute Nodes it was at when the stop operation was done. During the stop operation, the Pool allocation state changes first to stopping and then to steady. A resize operation need not be an explicit resize Pool request; this API can also be used to halt the initial sizing of the Pool when it is created. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2024-07-01.20.0
- poolID - The ID of the Pool to get.
- options - StopPoolResizeOptions contains the optional parameters for the Client.StopPoolResize method.
func (*Client) TerminateJob ¶
func (client *Client) TerminateJob(ctx context.Context, jobID string, options *TerminateJobOptions) (TerminateJobResponse, error)
TerminateJob - Terminates the specified Job, marking it as completed.
When a Terminate Job request is received, the Batch service sets the Job to the terminating state. The Batch service then terminates any running Tasks associated with the Job and runs any required Job release Tasks. Then the Job moves into the completed state. If there are any Tasks in the Job in the active state, they will remain in the active state. Once a Job is terminated, new Tasks cannot be added and any remaining active Tasks will not be scheduled. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2024-07-01.20.0
- jobID - The ID of the Job to terminate.
- options - TerminateJobOptions contains the optional parameters for the Client.TerminateJob method.
func (*Client) TerminateJobSchedule ¶
func (client *Client) TerminateJobSchedule(ctx context.Context, jobScheduleID string, options *TerminateJobScheduleOptions) (TerminateJobScheduleResponse, error)
TerminateJobSchedule - Terminates a Job Schedule.
Terminates a Job Schedule. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2024-07-01.20.0
- jobScheduleID - The ID of the Job Schedule to terminates.
- options - TerminateJobScheduleOptions contains the optional parameters for the Client.TerminateJobSchedule method.
func (*Client) TerminateTask ¶
func (client *Client) TerminateTask(ctx context.Context, jobID string, taskID string, options *TerminateTaskOptions) (TerminateTaskResponse, error)
TerminateTask - Terminates the specified Task.
When the Task has been terminated, it moves to the completed state. For multi-instance Tasks, the terminate Task operation applies synchronously to the primary task; subtasks are then terminated asynchronously in the background. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2024-07-01.20.0
- jobID - The ID of the Job containing the Task.
- taskID - The ID of the Task to terminate.
- options - TerminateTaskOptions contains the optional parameters for the Client.TerminateTask method.
func (*Client) UpdateJob ¶
func (client *Client) UpdateJob(ctx context.Context, jobID string, job UpdateJobContent, options *UpdateJobOptions) (UpdateJobResponse, error)
UpdateJob - Updates the properties of the specified Job.
This replaces only the Job properties specified in the request. For example, if the Job has constraints, and a request does not specify the constraints element, then the Job keeps the existing constraints. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2024-07-01.20.0
- jobID - The ID of the Job whose properties you want to update.
- job - The options to use for updating the Job.
- options - UpdateJobOptions contains the optional parameters for the Client.UpdateJob method.
func (*Client) UpdateJobSchedule ¶
func (client *Client) UpdateJobSchedule(ctx context.Context, jobScheduleID string, jobSchedule UpdateJobScheduleContent, options *UpdateJobScheduleOptions) (UpdateJobScheduleResponse, error)
UpdateJobSchedule - Updates the properties of the specified Job Schedule.
This replaces only the Job Schedule properties specified in the request. For example, if the schedule property is not specified with this request, then the Batch service will keep the existing schedule. Changes to a Job Schedule only impact Jobs created by the schedule after the update has taken place; currently running Jobs are unaffected. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2024-07-01.20.0
- jobScheduleID - The ID of the Job Schedule to update.
- jobSchedule - The options to use for updating the Job Schedule.
- options - UpdateJobScheduleOptions contains the optional parameters for the Client.UpdateJobSchedule method.
func (*Client) UpdatePool ¶
func (client *Client) UpdatePool(ctx context.Context, poolID string, pool UpdatePoolContent, options *UpdatePoolOptions) (UpdatePoolResponse, error)
UpdatePool - Updates the properties of the specified Pool.
This only replaces the Pool properties specified in the request. For example, if the Pool has a StartTask associated with it, and a request does not specify a StartTask element, then the Pool keeps the existing StartTask. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2024-07-01.20.0
- poolID - The ID of the Pool to get.
- pool - The pool properties to update.
- options - UpdatePoolOptions contains the optional parameters for the Client.UpdatePool method.
func (*Client) UploadNodeLogs ¶
func (client *Client) UploadNodeLogs(ctx context.Context, poolID string, nodeID string, content UploadNodeLogsContent, options *UploadNodeLogsOptions) (UploadNodeLogsResponse, error)
UploadNodeLogs - Upload Azure Batch service log files from the specified Compute Node to Azure Blob Storage.
This is for gathering Azure Batch service log files in an automated fashion from Compute Nodes if you are experiencing an error and wish to escalate to Azure support. The Azure Batch service log files should be shared with Azure support to aid in debugging issues with the Batch service. If the operation fails it returns an *azcore.ResponseError type.
Generated from API version 2024-07-01.20.0
- poolID - The ID of the Pool that contains the Compute Node.
- nodeID - The ID of the Compute Node for which you want to get the Remote Desktop Protocol file.
- content - The Azure Batch service log files upload options.
- options - UploadNodeLogsOptions contains the optional parameters for the Client.UploadNodeLogs method.
type ClientOptions ¶
type ClientOptions struct {
azcore.ClientOptions
}
ClientOptions contains optional settings for Client.
type ContainerConfiguration ¶
type ContainerConfiguration struct { // REQUIRED; The container technology to be used. Type *ContainerType // The collection of container Image names. This is the full Image reference, as would be specified to "docker pull". An Image // will be sourced from the default Docker registry unless the Image is fully qualified with an alternative registry. ContainerImageNames []string // Additional private registries from which containers can be pulled. If any Images must be downloaded from a private registry // which requires credentials, then those credentials must be provided here. ContainerRegistries []ContainerRegistryReference }
ContainerConfiguration - The configuration for container-enabled Pools.
func (ContainerConfiguration) MarshalJSON ¶
func (c ContainerConfiguration) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type ContainerConfiguration.
func (*ContainerConfiguration) UnmarshalJSON ¶
func (c *ContainerConfiguration) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type ContainerConfiguration.
type ContainerHostBindMountEntry ¶
type ContainerHostBindMountEntry struct { // Mount this source path as read-only mode or not. Default value is false (read/write mode). For Linux, if you mount this // path as a read/write mode, this does not mean that all users in container have the read/write access for the path, it depends // on the access in host VM. If this path is mounted read-only, all users within the container will not be able to modify // the path. IsReadOnly *bool // The path which be mounted to container customer can select. Source *ContainerHostDataPath }
ContainerHostBindMountEntry - The entry of path and mount mode you want to mount into task container.
func (ContainerHostBindMountEntry) MarshalJSON ¶
func (c ContainerHostBindMountEntry) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type ContainerHostBindMountEntry.
func (*ContainerHostBindMountEntry) UnmarshalJSON ¶
func (c *ContainerHostBindMountEntry) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type ContainerHostBindMountEntry.
type ContainerHostDataPath ¶
type ContainerHostDataPath string
ContainerHostDataPath - The paths which will be mounted to container task's container.
const ( // ContainerHostDataPathApplications - The applications path. ContainerHostDataPathApplications ContainerHostDataPath = "Applications" // ContainerHostDataPathJobPrep - The job-prep task path. ContainerHostDataPathJobPrep ContainerHostDataPath = "JobPrep" ContainerHostDataPathShared ContainerHostDataPath = "Shared" // ContainerHostDataPathStartup - The path for start task. ContainerHostDataPathStartup ContainerHostDataPath = "Startup" // ContainerHostDataPathTask - The task path. ContainerHostDataPathTask ContainerHostDataPath = "Task" // ContainerHostDataPathVfsMounts - The path contains all virtual file systems are mounted on this node. ContainerHostDataPathVfsMounts ContainerHostDataPath = "VfsMounts" )
func PossibleContainerHostDataPathValues ¶
func PossibleContainerHostDataPathValues() []ContainerHostDataPath
PossibleContainerHostDataPathValues returns the possible values for the ContainerHostDataPath const type.
type ContainerRegistryReference ¶
type ContainerRegistryReference struct { // The reference to the user assigned identity to use to access an Azure Container Registry instead of username and password. IdentityReference *NodeIdentityReference // The password to log into the registry server. Password *string // The registry URL. If omitted, the default is "docker.io". RegistryServer *string // The user name to log into the registry server. Username *string }
ContainerRegistryReference - A private container registry.
func (ContainerRegistryReference) MarshalJSON ¶
func (c ContainerRegistryReference) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type ContainerRegistryReference.
func (*ContainerRegistryReference) UnmarshalJSON ¶
func (c *ContainerRegistryReference) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type ContainerRegistryReference.
type ContainerType ¶
type ContainerType string
ContainerType - ContainerType enums
const ( // ContainerTypeCriCompatible - A CRI based technology will be used to launch the containers. ContainerTypeCriCompatible ContainerType = "criCompatible" // ContainerTypeDockerCompatible - A Docker compatible container technology will be used to launch the containers. ContainerTypeDockerCompatible ContainerType = "dockerCompatible" )
func PossibleContainerTypeValues ¶
func PossibleContainerTypeValues() []ContainerType
PossibleContainerTypeValues returns the possible values for the ContainerType const type.
type ContainerWorkingDirectory ¶
type ContainerWorkingDirectory string
ContainerWorkingDirectory - ContainerWorkingDirectory enums
const ( // ContainerWorkingDirectoryContainerImageDefault - Use the working directory defined in the container Image. Beware that // this directory will not contain the Resource Files downloaded by Batch. ContainerWorkingDirectoryContainerImageDefault ContainerWorkingDirectory = "containerImageDefault" // ContainerWorkingDirectoryTaskWorkingDirectory - Use the standard Batch service Task working directory, which will contain // the Task Resource Files populated by Batch. ContainerWorkingDirectoryTaskWorkingDirectory ContainerWorkingDirectory = "taskWorkingDirectory" )
func PossibleContainerWorkingDirectoryValues ¶
func PossibleContainerWorkingDirectoryValues() []ContainerWorkingDirectory
PossibleContainerWorkingDirectoryValues returns the possible values for the ContainerWorkingDirectory const type.
type CreateCertificateOptions ¶
type CreateCertificateOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
CreateCertificateOptions contains the optional parameters for the Client.CreateCertificate method.
type CreateCertificateResponse ¶
type CreateCertificateResponse struct { // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The OData ID of the resource to which the request applied. DataServiceID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
CreateCertificateResponse contains the response from method Client.CreateCertificate.
type CreateJobContent ¶
type CreateJobContent struct { // REQUIRED; A string that uniquely identifies the Job within the Account. The ID can contain any combination of alphanumeric // characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and // case-insensitive (that is, you may not have two IDs within an Account that differ only by case). ID *string // REQUIRED; The Pool on which the Batch service runs the Job's Tasks. PoolInfo *PoolInfo // Whether Tasks in this job can be preempted by other high priority jobs. If the value is set to True, other high priority // jobs submitted to the system will take precedence and will be able requeue tasks from this job. You can update a job's // allowTaskPreemption after it has been created using the update job API. AllowTaskPreemption *bool // The list of common environment variable settings. These environment variables are set for all Tasks in the Job (including // the Job Manager, Job Preparation and Job Release Tasks). Individual Tasks can override an environment setting specified // here by specifying the same setting name with a different value. CommonEnvironmentSettings []EnvironmentSetting // The execution constraints for the Job. Constraints *JobConstraints // The display name for the Job. The display name need not be unique and can contain any Unicode characters up to a maximum // length of 1024. DisplayName *string // Details of a Job Manager Task to be launched when the Job is started. If the Job does not specify a Job Manager Task, the // user must explicitly add Tasks to the Job. If the Job does specify a Job Manager Task, the Batch service creates the Job // Manager Task when the Job is created, and will try to schedule the Job Manager Task before scheduling other Tasks in the // Job. The Job Manager Task's typical purpose is to control and/or monitor Job execution, for example by deciding what additional // Tasks to run, determining when the work is complete, etc. (However, a Job Manager Task is not restricted to these activities // - it is a fully-fledged Task in the system and perform whatever actions are required for the Job.) For example, a Job Manager // Task might download a file specified as a parameter, analyze the contents of that file and submit additional Tasks based // on those contents. JobManagerTask *JobManagerTask // The Job Preparation Task. If a Job has a Job Preparation Task, the Batch service will run the Job Preparation Task on a // Node before starting any Tasks of that Job on that Compute Node. JobPreparationTask *JobPreparationTask // The Job Release Task. A Job Release Task cannot be specified without also specifying a Job Preparation Task for the Job. // The Batch service runs the Job Release Task on the Nodes that have run the Job Preparation Task. The primary purpose of // the Job Release Task is to undo changes to Compute Nodes made by the Job Preparation Task. Example activities include deleting // local files, or shutting down services that were started as part of Job preparation. JobReleaseTask *JobReleaseTask // The maximum number of tasks that can be executed in parallel for the job. The value of maxParallelTasks must be -1 or greater // than 0 if specified. If not specified, the default value is -1, which means there's no limit to the number of tasks that // can be run at once. You can update a job's maxParallelTasks after it has been created using the update job API. MaxParallelTasks *int32 // A list of name-value pairs associated with the Job as metadata. The Batch service does not assign any meaning to metadata; // it is solely for the use of user code. Metadata []MetadataItem // The network configuration for the Job. NetworkConfiguration *JobNetworkConfiguration // The action the Batch service should take when all Tasks in the Job are in the completed state. Note that if a Job contains // no Tasks, then all Tasks are considered complete. This option is therefore most commonly used with a Job Manager task; // if you want to use automatic Job termination without a Job Manager, you should initially set onAllTasksComplete to noaction // and update the Job properties to set onAllTasksComplete to terminatejob once you have finished adding Tasks. The default // is noaction. OnAllTasksComplete *OnAllTasksComplete // The action the Batch service should take when any Task in the Job fails. A Task is considered to have failed if has a failureInfo. // A failureInfo is set if the Task completes with a non-zero exit code after exhausting its retry count, or if there was // an error starting the Task, for example due to a resource file download error. The default is noaction. OnTaskFailure *OnTaskFailure // The priority of the Job. Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being // the highest priority. The default value is 0. Priority *int32 // Whether Tasks in the Job can define dependencies on each other. The default is false. UsesTaskDependencies *bool }
CreateJobContent - Parameters for creating an Azure Batch Job.
func (CreateJobContent) MarshalJSON ¶
func (c CreateJobContent) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type CreateJobContent.
func (*CreateJobContent) UnmarshalJSON ¶
func (c *CreateJobContent) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type CreateJobContent.
type CreateJobOptions ¶
type CreateJobOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
CreateJobOptions contains the optional parameters for the Client.CreateJob method.
type CreateJobResponse ¶
type CreateJobResponse struct { // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The OData ID of the resource to which the request applied. DataServiceID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
CreateJobResponse contains the response from method Client.CreateJob.
type CreateJobScheduleContent ¶
type CreateJobScheduleContent struct { // REQUIRED; A string that uniquely identifies the schedule within the Account. The ID can contain any combination of alphanumeric // characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and // case-insensitive (that is, you may not have two IDs within an Account that differ only by case). ID *string // REQUIRED; The details of the Jobs to be created on this schedule. JobSpecification *JobSpecification // REQUIRED; The schedule according to which Jobs will be created. All times are fixed respective to UTC and are not impacted // by daylight saving time. Schedule *JobScheduleConfiguration // The display name for the schedule. The display name need not be unique and can contain any Unicode characters up to a maximum // length of 1024. DisplayName *string // A list of name-value pairs associated with the schedule as metadata. The Batch service does not assign any meaning to metadata; // it is solely for the use of user code. Metadata []MetadataItem }
CreateJobScheduleContent - Parameters for creating an Azure Batch Job Schedule
func (CreateJobScheduleContent) MarshalJSON ¶
func (c CreateJobScheduleContent) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type CreateJobScheduleContent.
func (*CreateJobScheduleContent) UnmarshalJSON ¶
func (c *CreateJobScheduleContent) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type CreateJobScheduleContent.
type CreateJobScheduleOptions ¶
type CreateJobScheduleOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
CreateJobScheduleOptions contains the optional parameters for the Client.CreateJobSchedule method.
type CreateJobScheduleResponse ¶
type CreateJobScheduleResponse struct { // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The OData ID of the resource to which the request applied. DataServiceID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
CreateJobScheduleResponse contains the response from method Client.CreateJobSchedule.
type CreateNodeUserContent ¶
type CreateNodeUserContent struct { // REQUIRED; The user name of the Account. Name *string // The time at which the Account should expire. If omitted, the default is 1 day from the current time. For Linux Compute // Nodes, the expiryTime has a precision up to a day. ExpiryTime *time.Time // Whether the Account should be an administrator on the Compute Node. The default value is false. IsAdmin *bool // The password of the Account. The password is required for Windows Compute Nodes. For Linux Compute Nodes, the password // can optionally be specified along with the sshPublicKey property. Password *string // The SSH public key that can be used for remote login to the Compute Node. The public key should be compatible with OpenSSH // encoding and should be base 64 encoded. This property can be specified only for Linux Compute Nodes. If this is specified // for a Windows Compute Node, then the Batch service rejects the request; if you are calling the REST API directly, the HTTP // status code is 400 (Bad Request). SSHPublicKey *string }
CreateNodeUserContent - Parameters for creating a user account for RDP or SSH access on an Azure Batch Compute Node.
func (CreateNodeUserContent) MarshalJSON ¶
func (c CreateNodeUserContent) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type CreateNodeUserContent.
func (*CreateNodeUserContent) UnmarshalJSON ¶
func (c *CreateNodeUserContent) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type CreateNodeUserContent.
type CreateNodeUserOptions ¶
type CreateNodeUserOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
CreateNodeUserOptions contains the optional parameters for the Client.CreateNodeUser method.
type CreateNodeUserResponse ¶
type CreateNodeUserResponse struct { // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The OData ID of the resource to which the request applied. DataServiceID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
CreateNodeUserResponse contains the response from method Client.CreateNodeUser.
type CreatePoolContent ¶
type CreatePoolContent struct { // REQUIRED; A string that uniquely identifies the Pool within the Account. The ID can contain any combination of alphanumeric // characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and // case-insensitive (that is, you may not have two Pool IDs within an Account that differ only by case). ID *string // REQUIRED; The size of virtual machines in the Pool. All virtual machines in a Pool are the same size. For information about // available VM sizes for Pools using Images from the Virtual Machines Marketplace (pools created with virtualMachineConfiguration), // see Sizes for Virtual Machines in Azure (https://learn.microsoft.com/azure/virtual-machines/sizes/overview). Batch supports // all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series). VMSize *string // The list of Packages to be installed on each Compute Node in the Pool. When creating a pool, the package's application // ID must be fully qualified (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). // Changes to Package references affect all new Nodes joining the Pool, but do not affect Compute Nodes that are already in // the Pool until they are rebooted or reimaged. There is a maximum of 10 Package references on any given Pool. ApplicationPackageReferences []ApplicationPackageReference // The time interval at which to automatically adjust the Pool size according to the autoscale formula. The default value // is 15 minutes. The minimum and maximum value are 5 minutes and 168 hours respectively. If you specify a value less than // 5 minutes or greater than 168 hours, the Batch service returns an error; if you are calling the REST API directly, the // HTTP status code is 400 (Bad Request). AutoScaleEvaluationInterval *string // A formula for the desired number of Compute Nodes in the Pool. This property must not be specified if enableAutoScale is // set to false. It is required if enableAutoScale is set to true. The formula is checked for validity before the Pool is // created. If the formula is not valid, the Batch service rejects the request with detailed error information. For more information // about specifying this formula, see 'Automatically scale Compute Nodes in an Azure Batch Pool' (https://learn.microsoft.com/azure/batch/batch-automatic-scaling). AutoScaleFormula *string // For Windows Nodes, the Batch service installs the Certificates to the specified Certificate store and location. // For Linux Compute Nodes, the Certificates are stored in a directory inside the Task working directory and an environment // variable AZ_BATCH_CERTIFICATES_DIR is supplied to the Task to query for this location. // For Certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) // and Certificates are placed in that directory. // Warning: This property is deprecated and will be removed after February, 2024. Please use the [Azure KeyVault Extension](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) // instead. CertificateReferences []CertificateReference // The display name for the Pool. The display name need not be unique and can contain any Unicode characters up to a maximum // length of 1024. DisplayName *string // Whether the Pool size should automatically adjust over time. If false, at least one of targetDedicatedNodes and targetLowPriorityNodes // must be specified. If true, the autoScaleFormula property is required and the Pool automatically resizes according to the // formula. The default value is false. EnableAutoScale *bool // Whether the Pool permits direct communication between Compute Nodes. Enabling inter-node communication limits the maximum // size of the Pool due to deployment restrictions on the Compute Nodes of the Pool. This may result in the Pool not reaching // its desired size. The default value is false. EnableInterNodeCommunication *bool // A list of name-value pairs associated with the Pool as metadata. The Batch service does not assign any meaning to metadata; // it is solely for the use of user code. Metadata []MetadataItem // Mount storage using specified file system for the entire lifetime of the pool. Mount the storage using Azure fileshare, // NFS, CIFS or Blobfuse based file system. MountConfiguration []MountConfiguration // The network configuration for the Pool. NetworkConfiguration *NetworkConfiguration // The timeout for allocation of Compute Nodes to the Pool. This timeout applies only to manual scaling; it has no effect // when enableAutoScale is set to true. The default value is 15 minutes. The minimum value is 5 minutes. If you specify a // value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status // code is 400 (Bad Request). ResizeTimeout *string // The user-specified tags associated with the pool. The user-defined tags to be associated with the Azure Batch Pool. When // specified, these tags are propagated to the backing Azure resources associated with the pool. This property can only be // specified when the Batch account was created with the poolAllocationMode property set to 'UserSubscription'. ResourceTags map[string]*string // A Task specified to run on each Compute Node as it joins the Pool. The Task runs when the Compute Node is added to the // Pool or when the Compute Node is restarted. StartTask *StartTask // The desired number of dedicated Compute Nodes in the Pool. This property must not be specified if enableAutoScale is set // to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or // both. TargetDedicatedNodes *int32 // The desired number of Spot/Low-priority Compute Nodes in the Pool. This property must not be specified if enableAutoScale // is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, // or both. TargetLowPriorityNodes *int32 // The desired node communication mode for the pool. If omitted, the default value is Default. TargetNodeCommunicationMode *NodeCommunicationMode // How Tasks are distributed across Compute Nodes in a Pool. If not specified, the default is spread. TaskSchedulingPolicy *TaskSchedulingPolicy // The number of task slots that can be used to run concurrent tasks on a single compute node in the pool. The default value // is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256. TaskSlotsPerNode *int32 // The upgrade policy for the Pool. Describes an upgrade policy - automatic, manual, or rolling. UpgradePolicy *UpgradePolicy // The list of user Accounts to be created on each Compute Node in the Pool. UserAccounts []UserAccount // The virtual machine configuration for the Pool. This property must be specified. VirtualMachineConfiguration *VirtualMachineConfiguration }
CreatePoolContent - Parameters for creating an Azure Batch Pool.
func (CreatePoolContent) MarshalJSON ¶
func (c CreatePoolContent) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type CreatePoolContent.
func (*CreatePoolContent) UnmarshalJSON ¶
func (c *CreatePoolContent) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type CreatePoolContent.
type CreatePoolOptions ¶
type CreatePoolOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
CreatePoolOptions contains the optional parameters for the Client.CreatePool method.
type CreatePoolResponse ¶
type CreatePoolResponse struct { // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The OData ID of the resource to which the request applied. DataServiceID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
CreatePoolResponse contains the response from method Client.CreatePool.
type CreateTaskCollectionOptions ¶
type CreateTaskCollectionOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
CreateTaskCollectionOptions contains the optional parameters for the Client.CreateTaskCollection method.
type CreateTaskCollectionResponse ¶
type CreateTaskCollectionResponse struct { // The result of adding a collection of Tasks to a Job. AddTaskCollectionResult // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
CreateTaskCollectionResponse contains the response from method Client.CreateTaskCollection.
type CreateTaskContent ¶
type CreateTaskContent struct { // REQUIRED; The command line of the Task. For multi-instance Tasks, the command line is executed as the primary Task, after // the primary Task and all subtasks have finished executing the coordination command line. The command line does not run // under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want // to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" // in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path // (relative to the Task working directory), or use the Batch provided environment variable (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables). CommandLine *string // REQUIRED; A string that uniquely identifies the Task within the Job. The ID can contain any combination of alphanumeric // characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and // case-insensitive (that is, you may not have two IDs within a Job that differ only by case). ID *string // A locality hint that can be used by the Batch service to select a Compute Node on which to start the new Task. AffinityInfo *AffinityInfo // A list of Packages that the Batch service will deploy to the Compute Node before running the command line. Application // packages are downloaded and deployed to a shared directory, not the Task working directory. Therefore, if a referenced // package is already on the Node, and is up to date, then it is not re-downloaded; the existing copy on the Compute Node // is used. If a referenced Package cannot be installed, for example because the package has been deleted or because download // failed, the Task fails. ApplicationPackageReferences []ApplicationPackageReference // The settings for an authentication token that the Task can use to perform Batch service operations. If this property is // set, the Batch service provides the Task with an authentication token which can be used to authenticate Batch service operations // without requiring an Account access key. The token is provided via the AZ_BATCH_AUTHENTICATION_TOKEN environment variable. // The operations that the Task can carry out using the token depend on the settings. For example, a Task can request Job // permissions in order to add other Tasks to the Job, or check the status of the Job or of other Tasks under the Job. AuthenticationTokenSettings *AuthenticationTokenSettings // The execution constraints that apply to this Task. If you do not specify constraints, the maxTaskRetryCount is the maxTaskRetryCount // specified for the Job, the maxWallClockTime is infinite, and the retentionTime is 7 days. Constraints *TaskConstraints // The settings for the container under which the Task runs. If the Pool that will run this Task has containerConfiguration // set, this must be set as well. If the Pool that will run this Task doesn't have containerConfiguration set, this must not // be set. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories // on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task // command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not // be reflected to the host disk, meaning that Batch file APIs will not be able to access those files. ContainerSettings *TaskContainerSettings // The Tasks that this Task depends on. This Task will not be scheduled until all Tasks that it depends on have completed // successfully. If any of those Tasks fail and exhaust their retry counts, this Task will never be scheduled. If the Job // does not have usesTaskDependencies set to true, and this element is present, the request fails with error code TaskDependenciesNotSpecifiedOnJob. DependsOn *TaskDependencies // A display name for the Task. The display name need not be unique and can contain any Unicode characters up to a maximum // length of 1024. DisplayName *string // A list of environment variable settings for the Task. EnvironmentSettings []EnvironmentSetting // How the Batch service should respond when the Task completes. ExitConditions *ExitConditions // An object that indicates that the Task is a multi-instance Task, and contains information about how to run the multi-instance // Task. MultiInstanceSettings *MultiInstanceSettings // A list of files that the Batch service will upload from the Compute Node after running the command line. For multi-instance // Tasks, the files will only be uploaded from the Compute Node on which the primary Task is executed. OutputFiles []OutputFile // The number of scheduling slots that the Task required to run. The default is 1. A Task can only be scheduled to run on // a compute node if the node has enough free scheduling slots available. For multi-instance Tasks, this must be 1. RequiredSlots *int32 // A list of files that the Batch service will download to the Compute Node before running the command line. For multi-instance // Tasks, the resource files will only be downloaded to the Compute Node on which the primary Task is executed. There is a // maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error // code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be // achieved using .zip files, Application Packages, or Docker Containers. ResourceFiles []ResourceFile // The user identity under which the Task runs. If omitted, the Task runs as a non-administrative user unique to the Task. UserIdentity *UserIdentity }
CreateTaskContent - Parameters for creating an Azure Batch Task.
func (CreateTaskContent) MarshalJSON ¶
func (c CreateTaskContent) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type CreateTaskContent.
func (*CreateTaskContent) UnmarshalJSON ¶
func (c *CreateTaskContent) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type CreateTaskContent.
type CreateTaskOptions ¶
type CreateTaskOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
CreateTaskOptions contains the optional parameters for the Client.CreateTask method.
type CreateTaskResponse ¶
type CreateTaskResponse struct { // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The OData ID of the resource to which the request applied. DataServiceID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
CreateTaskResponse contains the response from method Client.CreateTask.
type DataDisk ¶
type DataDisk struct { // REQUIRED; The initial disk size in gigabytes. DiskSizeGB *int32 // REQUIRED; The logical unit number. The logicalUnitNumber is used to uniquely identify each data disk. If attaching multiple // disks, each should have a distinct logicalUnitNumber. The value must be between 0 and 63, inclusive. LogicalUnitNumber *int32 // The type of caching to be enabled for the data disks. The default value for caching is readwrite. For information about // the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/. Caching *CachingType // The storage Account type to be used for the data disk. If omitted, the default is "standard_lrs". StorageAccountType *StorageAccountType }
DataDisk - Settings which will be used by the data disks associated to Compute Nodes in the Pool. When using attached data disks, you need to mount and format the disks from within a VM to use them.
func (DataDisk) MarshalJSON ¶
MarshalJSON implements the json.Marshaller interface for type DataDisk.
func (*DataDisk) UnmarshalJSON ¶
UnmarshalJSON implements the json.Unmarshaller interface for type DataDisk.
type DeallocateNodeContent ¶
type DeallocateNodeContent struct { // When to deallocate the Compute Node and what to do with currently running Tasks. The default value is requeue. NodeDeallocateOption *NodeDeallocateOption }
DeallocateNodeContent - Options for deallocating a Compute Node.
func (DeallocateNodeContent) MarshalJSON ¶
func (d DeallocateNodeContent) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type DeallocateNodeContent.
func (*DeallocateNodeContent) UnmarshalJSON ¶
func (d *DeallocateNodeContent) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type DeallocateNodeContent.
type DeallocateNodeOptions ¶
type DeallocateNodeOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // The options to use for deallocating the Compute Node. Parameters *DeallocateNodeContent // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
DeallocateNodeOptions contains the optional parameters for the Client.DeallocateNode method.
type DeallocateNodeResponse ¶
type DeallocateNodeResponse struct { // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The OData ID of the resource to which the request applied. DataServiceID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
DeallocateNodeResponse contains the response from method Client.DeallocateNode.
type DeleteCertificateError ¶
type DeleteCertificateError struct { // An identifier for the Certificate deletion error. Codes are invariant and are intended to be consumed programmatically. Code *string // A message describing the Certificate deletion error, intended to be suitable for display in a user interface. Message *string // A list of additional error details related to the Certificate deletion error. This list includes details such as the active // Pools and Compute Nodes referencing this Certificate. However, if a large number of resources reference the Certificate, // the list contains only about the first hundred. Values []NameValuePair }
DeleteCertificateError - An error encountered by the Batch service when deleting a Certificate.
func (DeleteCertificateError) MarshalJSON ¶
func (d DeleteCertificateError) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type DeleteCertificateError.
func (*DeleteCertificateError) UnmarshalJSON ¶
func (d *DeleteCertificateError) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type DeleteCertificateError.
type DeleteCertificateOptions ¶
type DeleteCertificateOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
DeleteCertificateOptions contains the optional parameters for the Client.DeleteCertificate method.
type DeleteCertificateResponse ¶
type DeleteCertificateResponse struct { // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
DeleteCertificateResponse contains the response from method Client.DeleteCertificate.
type DeleteJobOptions ¶
type DeleteJobOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // If true, the server will delete the Job even if the corresponding nodes have not fully processed the deletion. The default // value is false. Force *bool // An ETag value associated with the version of the resource known to the client. // The operation will be performed only if the resource's current ETag on the // service exactly matches the value specified by the client. IfMatch *azcore.ETag // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // been modified since the specified time. IfModifiedSince *time.Time // An ETag value associated with the version of the resource known to the client. // The operation will be performed only if the resource's current ETag on the // service does not match the value specified by the client. IfNoneMatch *azcore.ETag // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // not been modified since the specified time. IfUnmodifiedSince *time.Time // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
DeleteJobOptions contains the optional parameters for the Client.DeleteJob method.
type DeleteJobResponse ¶
type DeleteJobResponse struct { // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
DeleteJobResponse contains the response from method Client.DeleteJob.
type DeleteJobScheduleOptions ¶
type DeleteJobScheduleOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // If true, the server will delete the JobSchedule even if the corresponding nodes have not fully processed the deletion. // The default value is false. Force *bool // An ETag value associated with the version of the resource known to the client. // The operation will be performed only if the resource's current ETag on the // service exactly matches the value specified by the client. IfMatch *azcore.ETag // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // been modified since the specified time. IfModifiedSince *time.Time // An ETag value associated with the version of the resource known to the client. // The operation will be performed only if the resource's current ETag on the // service does not match the value specified by the client. IfNoneMatch *azcore.ETag // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // not been modified since the specified time. IfUnmodifiedSince *time.Time // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
DeleteJobScheduleOptions contains the optional parameters for the Client.DeleteJobSchedule method.
type DeleteJobScheduleResponse ¶
type DeleteJobScheduleResponse struct { // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
DeleteJobScheduleResponse contains the response from method Client.DeleteJobSchedule.
type DeleteNodeFileOptions ¶
type DeleteNodeFileOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether to delete children of a directory. If the filePath parameter represents // a directory instead of a file, you can set recursive to true to delete the // directory and all of the files and subdirectories in it. If recursive is false // then the directory must be empty or deletion will fail. Recursive *bool // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
DeleteNodeFileOptions contains the optional parameters for the Client.DeleteNodeFile method.
type DeleteNodeFileResponse ¶
type DeleteNodeFileResponse struct { // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
DeleteNodeFileResponse contains the response from method Client.DeleteNodeFile.
type DeleteNodeUserOptions ¶
type DeleteNodeUserOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
DeleteNodeUserOptions contains the optional parameters for the Client.DeleteNodeUser method.
type DeleteNodeUserResponse ¶
type DeleteNodeUserResponse struct { // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
DeleteNodeUserResponse contains the response from method Client.DeleteNodeUser.
type DeletePoolOptions ¶
type DeletePoolOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // An ETag value associated with the version of the resource known to the client. // The operation will be performed only if the resource's current ETag on the // service exactly matches the value specified by the client. IfMatch *azcore.ETag // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // been modified since the specified time. IfModifiedSince *time.Time // An ETag value associated with the version of the resource known to the client. // The operation will be performed only if the resource's current ETag on the // service does not match the value specified by the client. IfNoneMatch *azcore.ETag // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // not been modified since the specified time. IfUnmodifiedSince *time.Time // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
DeletePoolOptions contains the optional parameters for the Client.DeletePool method.
type DeletePoolResponse ¶
type DeletePoolResponse struct { // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
DeletePoolResponse contains the response from method Client.DeletePool.
type DeleteTaskFileOptions ¶
type DeleteTaskFileOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether to delete children of a directory. If the filePath parameter represents // a directory instead of a file, you can set recursive to true to delete the // directory and all of the files and subdirectories in it. If recursive is false // then the directory must be empty or deletion will fail. Recursive *bool // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
DeleteTaskFileOptions contains the optional parameters for the Client.DeleteTaskFile method.
type DeleteTaskFileResponse ¶
type DeleteTaskFileResponse struct { // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
DeleteTaskFileResponse contains the response from method Client.DeleteTaskFile.
type DeleteTaskOptions ¶
type DeleteTaskOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // An ETag value associated with the version of the resource known to the client. // The operation will be performed only if the resource's current ETag on the // service exactly matches the value specified by the client. IfMatch *azcore.ETag // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // been modified since the specified time. IfModifiedSince *time.Time // An ETag value associated with the version of the resource known to the client. // The operation will be performed only if the resource's current ETag on the // service does not match the value specified by the client. IfNoneMatch *azcore.ETag // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // not been modified since the specified time. IfUnmodifiedSince *time.Time // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
DeleteTaskOptions contains the optional parameters for the Client.DeleteTask method.
type DeleteTaskResponse ¶
type DeleteTaskResponse struct { // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
DeleteTaskResponse contains the response from method Client.DeleteTask.
type DependencyAction ¶
type DependencyAction string
DependencyAction - DependencyAction enums
const ( // DependencyActionBlock - Blocks tasks waiting on this task, preventing them from being scheduled. DependencyActionBlock DependencyAction = "block" // DependencyActionSatisfy - Satisfy tasks waiting on this task; once all dependencies are satisfied, the task will be scheduled // to run. DependencyActionSatisfy DependencyAction = "satisfy" )
func PossibleDependencyActionValues ¶
func PossibleDependencyActionValues() []DependencyAction
PossibleDependencyActionValues returns the possible values for the DependencyAction const type.
type DiffDiskPlacement ¶
type DiffDiskPlacement string
DiffDiskPlacement - Specifies the ephemeral disk placement for operating system disk for all compute nodes (VMs) in the pool. This property can be used by user in the request to choose which location the operating system should be in. e.g., cache disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer to Ephemeral OS disk size requirements for Windows VMs at https://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VMs at https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements
const ( // DiffDiskPlacementCacheDisk - The Ephemeral OS Disk is stored on the VM cache. DiffDiskPlacementCacheDisk DiffDiskPlacement = "cachedisk" )
func PossibleDiffDiskPlacementValues ¶
func PossibleDiffDiskPlacementValues() []DiffDiskPlacement
PossibleDiffDiskPlacementValues returns the possible values for the DiffDiskPlacement const type.
type DiffDiskSettings ¶
type DiffDiskSettings struct { // Specifies the ephemeral disk placement for operating system disk for all VMs in the pool. This property can be used by // user in the request to choose the location e.g., cache disk space for Ephemeral OS disk provisioning. For more information // on Ephemeral OS disk size requirements, please refer to Ephemeral OS disk size requirements for Windows VMs at https://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements // and Linux VMs at https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements. Placement *DiffDiskPlacement }
DiffDiskSettings - Specifies the ephemeral Disk Settings for the operating system disk used by the compute node (VM).
func (DiffDiskSettings) MarshalJSON ¶
func (d DiffDiskSettings) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type DiffDiskSettings.
func (*DiffDiskSettings) UnmarshalJSON ¶
func (d *DiffDiskSettings) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type DiffDiskSettings.
type DisableJobContent ¶
type DisableJobContent struct { // REQUIRED; What to do with active Tasks associated with the Job. DisableTasks *DisableJobOption }
DisableJobContent - Parameters for disabling an Azure Batch Job.
func (DisableJobContent) MarshalJSON ¶
func (d DisableJobContent) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type DisableJobContent.
func (*DisableJobContent) UnmarshalJSON ¶
func (d *DisableJobContent) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type DisableJobContent.
type DisableJobOption ¶
type DisableJobOption string
DisableJobOption - DisableBatchJobOption enums
const ( // DisableJobOptionRequeue - Terminate running Tasks and requeue them. The Tasks will run again when the Job is enabled. DisableJobOptionRequeue DisableJobOption = "requeue" // DisableJobOptionTerminate - Terminate running Tasks. The Tasks will be completed with failureInfo indicating that they // were terminated, and will not run again. DisableJobOptionTerminate DisableJobOption = "terminate" // DisableJobOptionWait - Allow currently running Tasks to complete. DisableJobOptionWait DisableJobOption = "wait" )
func PossibleDisableJobOptionValues ¶
func PossibleDisableJobOptionValues() []DisableJobOption
PossibleDisableJobOptionValues returns the possible values for the DisableJobOption const type.
type DisableJobOptions ¶
type DisableJobOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // An ETag value associated with the version of the resource known to the client. // The operation will be performed only if the resource's current ETag on the // service exactly matches the value specified by the client. IfMatch *azcore.ETag // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // been modified since the specified time. IfModifiedSince *time.Time // An ETag value associated with the version of the resource known to the client. // The operation will be performed only if the resource's current ETag on the // service does not match the value specified by the client. IfNoneMatch *azcore.ETag // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // not been modified since the specified time. IfUnmodifiedSince *time.Time // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
DisableJobOptions contains the optional parameters for the Client.DisableJob method.
type DisableJobResponse ¶
type DisableJobResponse struct { // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The OData ID of the resource to which the request applied. DataServiceID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
DisableJobResponse contains the response from method Client.DisableJob.
type DisableJobScheduleOptions ¶
type DisableJobScheduleOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // An ETag value associated with the version of the resource known to the client. // The operation will be performed only if the resource's current ETag on the // service exactly matches the value specified by the client. IfMatch *azcore.ETag // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // been modified since the specified time. IfModifiedSince *time.Time // An ETag value associated with the version of the resource known to the client. // The operation will be performed only if the resource's current ETag on the // service does not match the value specified by the client. IfNoneMatch *azcore.ETag // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // not been modified since the specified time. IfUnmodifiedSince *time.Time // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
DisableJobScheduleOptions contains the optional parameters for the Client.DisableJobSchedule method.
type DisableJobScheduleResponse ¶
type DisableJobScheduleResponse struct { // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The OData ID of the resource to which the request applied. DataServiceID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
DisableJobScheduleResponse contains the response from method Client.DisableJobSchedule.
type DisableNodeSchedulingContent ¶
type DisableNodeSchedulingContent struct { // What to do with currently running Tasks when disabling Task scheduling on the Compute Node. The default value is requeue. NodeDisableSchedulingOption *NodeDisableSchedulingOption }
DisableNodeSchedulingContent - Parameters for disabling scheduling on an Azure Batch Compute Node.
func (DisableNodeSchedulingContent) MarshalJSON ¶
func (d DisableNodeSchedulingContent) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type DisableNodeSchedulingContent.
func (*DisableNodeSchedulingContent) UnmarshalJSON ¶
func (d *DisableNodeSchedulingContent) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type DisableNodeSchedulingContent.
type DisableNodeSchedulingOptions ¶
type DisableNodeSchedulingOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // The options to use for disabling scheduling on the Compute Node. Parameters *DisableNodeSchedulingContent // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
DisableNodeSchedulingOptions contains the optional parameters for the Client.DisableNodeScheduling method.
type DisableNodeSchedulingResponse ¶
type DisableNodeSchedulingResponse struct { // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The OData ID of the resource to which the request applied. DataServiceID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
DisableNodeSchedulingResponse contains the response from method Client.DisableNodeScheduling.
type DisablePoolAutoScaleOptions ¶
type DisablePoolAutoScaleOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
DisablePoolAutoScaleOptions contains the optional parameters for the Client.DisablePoolAutoScale method.
type DisablePoolAutoScaleResponse ¶
type DisablePoolAutoScaleResponse struct { // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The OData ID of the resource to which the request applied. DataServiceID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
DisablePoolAutoScaleResponse contains the response from method Client.DisablePoolAutoScale.
type DiskEncryptionConfiguration ¶
type DiskEncryptionConfiguration struct { // The list of disk targets Batch Service will encrypt on the compute node. The list of disk targets Batch Service will encrypt // on the compute node. Targets []DiskEncryptionTarget }
DiskEncryptionConfiguration - The disk encryption configuration applied on compute nodes in the pool. Disk encryption configuration is not supported on Linux pool created with Azure Compute Gallery Image.
func (DiskEncryptionConfiguration) MarshalJSON ¶
func (d DiskEncryptionConfiguration) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type DiskEncryptionConfiguration.
func (*DiskEncryptionConfiguration) UnmarshalJSON ¶
func (d *DiskEncryptionConfiguration) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type DiskEncryptionConfiguration.
type DiskEncryptionTarget ¶
type DiskEncryptionTarget string
DiskEncryptionTarget - DiskEncryptionTarget enums
const ( // DiskEncryptionTargetOsDisk - The OS Disk on the compute node is encrypted. DiskEncryptionTargetOsDisk DiskEncryptionTarget = "osdisk" // DiskEncryptionTargetTemporaryDisk - The temporary disk on the compute node is encrypted. On Linux this encryption applies // to other partitions (such as those on mounted data disks) when encryption occurs at boot time. DiskEncryptionTargetTemporaryDisk DiskEncryptionTarget = "temporarydisk" )
func PossibleDiskEncryptionTargetValues ¶
func PossibleDiskEncryptionTargetValues() []DiskEncryptionTarget
PossibleDiskEncryptionTargetValues returns the possible values for the DiskEncryptionTarget const type.
type DynamicVNetAssignmentScope ¶
type DynamicVNetAssignmentScope string
DynamicVNetAssignmentScope - DynamicVNetAssignmentScope enums
const ( // DynamicVNetAssignmentScopeJob - Dynamic VNet assignment is done per-job. DynamicVNetAssignmentScopeJob DynamicVNetAssignmentScope = "job" // DynamicVNetAssignmentScopeNone - No dynamic VNet assignment is enabled. DynamicVNetAssignmentScopeNone DynamicVNetAssignmentScope = "none" )
func PossibleDynamicVNetAssignmentScopeValues ¶
func PossibleDynamicVNetAssignmentScopeValues() []DynamicVNetAssignmentScope
PossibleDynamicVNetAssignmentScopeValues returns the possible values for the DynamicVNetAssignmentScope const type.
type ElevationLevel ¶
type ElevationLevel string
ElevationLevel - ElevationLevel enums
const ( // ElevationLevelAdmin - The user is a user with elevated access and operates with full Administrator permissions. ElevationLevelAdmin ElevationLevel = "admin" // ElevationLevelNonAdmin - The user is a standard user without elevated access. ElevationLevelNonAdmin ElevationLevel = "nonadmin" )
func PossibleElevationLevelValues ¶
func PossibleElevationLevelValues() []ElevationLevel
PossibleElevationLevelValues returns the possible values for the ElevationLevel const type.
type EnableJobOptions ¶
type EnableJobOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // An ETag value associated with the version of the resource known to the client. // The operation will be performed only if the resource's current ETag on the // service exactly matches the value specified by the client. IfMatch *azcore.ETag // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // been modified since the specified time. IfModifiedSince *time.Time // An ETag value associated with the version of the resource known to the client. // The operation will be performed only if the resource's current ETag on the // service does not match the value specified by the client. IfNoneMatch *azcore.ETag // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // not been modified since the specified time. IfUnmodifiedSince *time.Time // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
EnableJobOptions contains the optional parameters for the Client.EnableJob method.
type EnableJobResponse ¶
type EnableJobResponse struct { // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The OData ID of the resource to which the request applied. DataServiceID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
EnableJobResponse contains the response from method Client.EnableJob.
type EnableJobScheduleOptions ¶
type EnableJobScheduleOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // An ETag value associated with the version of the resource known to the client. // The operation will be performed only if the resource's current ETag on the // service exactly matches the value specified by the client. IfMatch *azcore.ETag // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // been modified since the specified time. IfModifiedSince *time.Time // An ETag value associated with the version of the resource known to the client. // The operation will be performed only if the resource's current ETag on the // service does not match the value specified by the client. IfNoneMatch *azcore.ETag // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // not been modified since the specified time. IfUnmodifiedSince *time.Time // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
EnableJobScheduleOptions contains the optional parameters for the Client.EnableJobSchedule method.
type EnableJobScheduleResponse ¶
type EnableJobScheduleResponse struct { // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The OData ID of the resource to which the request applied. DataServiceID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
EnableJobScheduleResponse contains the response from method Client.EnableJobSchedule.
type EnableNodeSchedulingOptions ¶
type EnableNodeSchedulingOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
EnableNodeSchedulingOptions contains the optional parameters for the Client.EnableNodeScheduling method.
type EnableNodeSchedulingResponse ¶
type EnableNodeSchedulingResponse struct { // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The OData ID of the resource to which the request applied. DataServiceID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
EnableNodeSchedulingResponse contains the response from method Client.EnableNodeScheduling.
type EnablePoolAutoScaleContent ¶
type EnablePoolAutoScaleContent struct { // The time interval at which to automatically adjust the Pool size according to the autoscale formula. The default value // is 15 minutes. The minimum and maximum value are 5 minutes and 168 hours respectively. If you specify a value less than // 5 minutes or greater than 168 hours, the Batch service rejects the request with an invalid property value error; if you // are calling the REST API directly, the HTTP status code is 400 (Bad Request). If you specify a new interval, then the existing // autoscale evaluation schedule will be stopped and a new autoscale evaluation schedule will be started, with its starting // time being the time when this request was issued. AutoScaleEvaluationInterval *string // The formula for the desired number of Compute Nodes in the Pool. The default value is 15 minutes. The minimum and maximum // value are 5 minutes and 168 hours respectively. If you specify a value less than 5 minutes or greater than 168 hours, the // Batch service rejects the request with an invalid property value error; if you are calling the REST API directly, the HTTP // status code is 400 (Bad Request). If you specify a new interval, then the existing autoscale evaluation schedule will be // stopped and a new autoscale evaluation schedule will be started, with its starting time being the time when this request // was issued. AutoScaleFormula *string }
EnablePoolAutoScaleContent - Parameters for enabling automatic scaling on an Azure Batch Pool.
func (EnablePoolAutoScaleContent) MarshalJSON ¶
func (e EnablePoolAutoScaleContent) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type EnablePoolAutoScaleContent.
func (*EnablePoolAutoScaleContent) UnmarshalJSON ¶
func (e *EnablePoolAutoScaleContent) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type EnablePoolAutoScaleContent.
type EnablePoolAutoScaleOptions ¶
type EnablePoolAutoScaleOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // An ETag value associated with the version of the resource known to the client. // The operation will be performed only if the resource's current ETag on the // service exactly matches the value specified by the client. IfMatch *azcore.ETag // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // been modified since the specified time. IfModifiedSince *time.Time // An ETag value associated with the version of the resource known to the client. // The operation will be performed only if the resource's current ETag on the // service does not match the value specified by the client. IfNoneMatch *azcore.ETag // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // not been modified since the specified time. IfUnmodifiedSince *time.Time // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
EnablePoolAutoScaleOptions contains the optional parameters for the Client.EnablePoolAutoScale method.
type EnablePoolAutoScaleResponse ¶
type EnablePoolAutoScaleResponse struct { // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The OData ID of the resource to which the request applied. DataServiceID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
EnablePoolAutoScaleResponse contains the response from method Client.EnablePoolAutoScale.
type EnvironmentSetting ¶
type EnvironmentSetting struct { // REQUIRED; The name of the environment variable. Name *string // The value of the environment variable. Value *string }
EnvironmentSetting - An environment variable to be set on a Task process.
func (EnvironmentSetting) MarshalJSON ¶
func (e EnvironmentSetting) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type EnvironmentSetting.
func (*EnvironmentSetting) UnmarshalJSON ¶
func (e *EnvironmentSetting) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type EnvironmentSetting.
type Error ¶
type Error struct { // REQUIRED; An identifier for the error. Codes are invariant and are intended to be consumed programmatically. Code *string // A message describing the error, intended to be suitable for display in a user interface. Message *ErrorMessage // A collection of key-value pairs containing additional details about the error. Values []ErrorDetail }
Error - An error response received from the Azure Batch service.
func (Error) MarshalJSON ¶
MarshalJSON implements the json.Marshaller interface for type Error.
func (*Error) UnmarshalJSON ¶
UnmarshalJSON implements the json.Unmarshaller interface for type Error.
type ErrorCategory ¶
type ErrorCategory string
ErrorCategory - ErrorCategory enums
const ( // ErrorCategoryServerError - The error is due to an internal server issue. ErrorCategoryServerError ErrorCategory = "servererror" // ErrorCategoryUserError - The error is due to a user issue, such as misconfiguration. ErrorCategoryUserError ErrorCategory = "usererror" )
func PossibleErrorCategoryValues ¶
func PossibleErrorCategoryValues() []ErrorCategory
PossibleErrorCategoryValues returns the possible values for the ErrorCategory const type.
type ErrorDetail ¶
type ErrorDetail struct { // An identifier specifying the meaning of the Value property. Key *string // The additional information included with the error response. Value *string }
ErrorDetail - An item of additional information included in an Azure Batch error response.
func (ErrorDetail) MarshalJSON ¶
func (e ErrorDetail) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type ErrorDetail.
func (*ErrorDetail) UnmarshalJSON ¶
func (e *ErrorDetail) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type ErrorDetail.
type ErrorMessage ¶
type ErrorMessage struct { // The language code of the error message. Lang *string // The text of the message. Value *string }
ErrorMessage - An error message received in an Azure Batch error response.
func (ErrorMessage) MarshalJSON ¶
func (e ErrorMessage) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type ErrorMessage.
func (*ErrorMessage) UnmarshalJSON ¶
func (e *ErrorMessage) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type ErrorMessage.
type EvaluatePoolAutoScaleContent ¶
type EvaluatePoolAutoScaleContent struct { // REQUIRED; The formula for the desired number of Compute Nodes in the Pool. The formula is validated and its results calculated, // but it is not applied to the Pool. To apply the formula to the Pool, 'Enable automatic scaling on a Pool'. For more information // about specifying this formula, see Automatically scale Compute Nodes in an Azure Batch Pool (https://learn.microsoft.com/azure/batch/batch-automatic-scaling). AutoScaleFormula *string }
EvaluatePoolAutoScaleContent - Parameters for evaluating an automatic scaling formula on an Azure Batch Pool.
func (EvaluatePoolAutoScaleContent) MarshalJSON ¶
func (e EvaluatePoolAutoScaleContent) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type EvaluatePoolAutoScaleContent.
func (*EvaluatePoolAutoScaleContent) UnmarshalJSON ¶
func (e *EvaluatePoolAutoScaleContent) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type EvaluatePoolAutoScaleContent.
type EvaluatePoolAutoScaleOptions ¶
type EvaluatePoolAutoScaleOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
EvaluatePoolAutoScaleOptions contains the optional parameters for the Client.EvaluatePoolAutoScale method.
type EvaluatePoolAutoScaleResponse ¶
type EvaluatePoolAutoScaleResponse struct { // The results and errors from an execution of a Pool autoscale formula. AutoScaleRun // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The OData ID of the resource to which the request applied. DataServiceID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
EvaluatePoolAutoScaleResponse contains the response from method Client.EvaluatePoolAutoScale.
type ExitCodeMapping ¶
type ExitCodeMapping struct { // REQUIRED; A process exit code. Code *int32 // REQUIRED; How the Batch service should respond if the Task exits with this exit code. ExitOptions *ExitOptions }
ExitCodeMapping - How the Batch service should respond if a Task exits with a particular exit code.
func (ExitCodeMapping) MarshalJSON ¶
func (e ExitCodeMapping) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type ExitCodeMapping.
func (*ExitCodeMapping) UnmarshalJSON ¶
func (e *ExitCodeMapping) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type ExitCodeMapping.
type ExitCodeRangeMapping ¶
type ExitCodeRangeMapping struct { // REQUIRED; The last exit code in the range. End *int32 // REQUIRED; How the Batch service should respond if the Task exits with an exit code in the range start to end (inclusive). ExitOptions *ExitOptions // REQUIRED; The first exit code in the range. Start *int32 }
ExitCodeRangeMapping - A range of exit codes and how the Batch service should respond to exit codes within that range.
func (ExitCodeRangeMapping) MarshalJSON ¶
func (e ExitCodeRangeMapping) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type ExitCodeRangeMapping.
func (*ExitCodeRangeMapping) UnmarshalJSON ¶
func (e *ExitCodeRangeMapping) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type ExitCodeRangeMapping.
type ExitConditions ¶
type ExitConditions struct { // How the Batch service should respond if the Task fails with an exit condition not covered by any of the other properties. // This value is used if the Task exits with any nonzero exit code not listed in the exitCodes or exitCodeRanges collection, // with a pre-processing error if the preProcessingError property is not present, or with a file upload error if the fileUploadError // property is not present. If you want non-default behavior on exit code 0, you must list it explicitly using the exitCodes // or exitCodeRanges collection. Default *ExitOptions // A list of Task exit code ranges and how the Batch service should respond to them. ExitCodeRanges []ExitCodeRangeMapping // A list of individual Task exit codes and how the Batch service should respond to them. ExitCodes []ExitCodeMapping // How the Batch service should respond if a file upload error occurs. If the Task exited with an exit code that was specified // via exitCodes or exitCodeRanges, and then encountered a file upload error, then the action specified by the exit code takes // precedence. FileUploadError *ExitOptions // How the Batch service should respond if the Task fails to start due to an error. PreProcessingError *ExitOptions }
ExitConditions - Specifies how the Batch service should respond when the Task completes.
func (ExitConditions) MarshalJSON ¶
func (e ExitConditions) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type ExitConditions.
func (*ExitConditions) UnmarshalJSON ¶
func (e *ExitConditions) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type ExitConditions.
type ExitOptions ¶
type ExitOptions struct { // An action that the Batch service performs on Tasks that depend on this Task. Possible values are 'satisfy' (allowing dependent // tasks to progress) and 'block' (dependent tasks continue to wait). Batch does not yet support cancellation of dependent // tasks. DependencyAction *DependencyAction // An action to take on the Job containing the Task, if the Task completes with the given exit condition and the Job's onTaskFailed // property is 'performExitOptionsJobAction'. The default is none for exit code 0 and terminate for all other exit conditions. // If the Job's onTaskFailed property is noaction, then specifying this property returns an error and the add Task request // fails with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad // Request). JobAction *JobAction }
ExitOptions - Specifies how the Batch service responds to a particular exit condition.
func (ExitOptions) MarshalJSON ¶
func (e ExitOptions) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type ExitOptions.
func (*ExitOptions) UnmarshalJSON ¶
func (e *ExitOptions) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type ExitOptions.
type FileProperties ¶
type FileProperties struct { // REQUIRED; The length of the file. ContentLength *int64 // REQUIRED; The time at which the file was last modified. LastModified *time.Time // The content type of the file. ContentType *string // The file creation time. The creation time is not returned for files on Linux Compute Nodes. CreationTime *time.Time // The file mode attribute in octal format. The file mode is returned only for files on Linux Compute Nodes. FileMode *string }
FileProperties - The properties of a file on a Compute Node.
func (FileProperties) MarshalJSON ¶
func (f FileProperties) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type FileProperties.
func (*FileProperties) UnmarshalJSON ¶
func (f *FileProperties) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type FileProperties.
type GetApplicationOptions ¶
type GetApplicationOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
GetApplicationOptions contains the optional parameters for the Client.GetApplication method.
type GetApplicationResponse ¶
type GetApplicationResponse struct { // Contains information about an application in an Azure Batch Account. Application // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
GetApplicationResponse contains the response from method Client.GetApplication.
type GetCertificateOptions ¶
type GetCertificateOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // An OData $select clause. SelectParam []string // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
GetCertificateOptions contains the optional parameters for the Client.GetCertificate method.
type GetCertificateResponse ¶
type GetCertificateResponse struct { // A Certificate that can be installed on Compute Nodes and can be used to // authenticate operations on the machine. Certificate // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
GetCertificateResponse contains the response from method Client.GetCertificate.
type GetJobOptions ¶
type GetJobOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // An OData $expand clause. Expand []string // An ETag value associated with the version of the resource known to the client. // The operation will be performed only if the resource's current ETag on the // service exactly matches the value specified by the client. IfMatch *azcore.ETag // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // been modified since the specified time. IfModifiedSince *time.Time // An ETag value associated with the version of the resource known to the client. // The operation will be performed only if the resource's current ETag on the // service does not match the value specified by the client. IfNoneMatch *azcore.ETag // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // not been modified since the specified time. IfUnmodifiedSince *time.Time // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // An OData $select clause. SelectParam []string // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
GetJobOptions contains the optional parameters for the Client.GetJob method.
type GetJobResponse ¶
type GetJobResponse struct { // An Azure Batch Job. Job // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
GetJobResponse contains the response from method Client.GetJob.
type GetJobScheduleOptions ¶
type GetJobScheduleOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // An OData $expand clause. Expand []string // An ETag value associated with the version of the resource known to the client. // The operation will be performed only if the resource's current ETag on the // service exactly matches the value specified by the client. IfMatch *azcore.ETag // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // been modified since the specified time. IfModifiedSince *time.Time // An ETag value associated with the version of the resource known to the client. // The operation will be performed only if the resource's current ETag on the // service does not match the value specified by the client. IfNoneMatch *azcore.ETag // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // not been modified since the specified time. IfUnmodifiedSince *time.Time // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // An OData $select clause. SelectParam []string // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
GetJobScheduleOptions contains the optional parameters for the Client.GetJobSchedule method.
type GetJobScheduleResponse ¶
type GetJobScheduleResponse struct { // A Job Schedule that allows recurring Jobs by specifying when to run Jobs and a // specification used to create each Job. JobSchedule // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
GetJobScheduleResponse contains the response from method Client.GetJobSchedule.
type GetJobTaskCountsOptions ¶
type GetJobTaskCountsOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
GetJobTaskCountsOptions contains the optional parameters for the Client.GetJobTaskCounts method.
type GetJobTaskCountsResponse ¶
type GetJobTaskCountsResponse struct { // The Task and TaskSlot counts for a Job. TaskCountsResult // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
GetJobTaskCountsResponse contains the response from method Client.GetJobTaskCounts.
type GetNodeExtensionOptions ¶
type GetNodeExtensionOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // An OData $select clause. SelectParam []string // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
GetNodeExtensionOptions contains the optional parameters for the Client.GetNodeExtension method.
type GetNodeExtensionResponse ¶
type GetNodeExtensionResponse struct { // The configuration for virtual machine extension instance view. NodeVMExtension // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
GetNodeExtensionResponse contains the response from method Client.GetNodeExtension.
type GetNodeFileOptions ¶
type GetNodeFileOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // been modified since the specified time. IfModifiedSince *time.Time // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // not been modified since the specified time. IfUnmodifiedSince *time.Time // The byte range to be retrieved. The default is to retrieve the entire file. The // format is bytes=startRange-endRange. OCPRange *string // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
GetNodeFileOptions contains the optional parameters for the Client.GetNodeFile method.
type GetNodeFilePropertiesOptions ¶
type GetNodeFilePropertiesOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // been modified since the specified time. IfModifiedSince *time.Time // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // not been modified since the specified time. IfUnmodifiedSince *time.Time // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
GetNodeFilePropertiesOptions contains the optional parameters for the Client.GetNodeFileProperties method.
type GetNodeFilePropertiesResponse ¶
type GetNodeFilePropertiesResponse struct { // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The length of the file. ContentLength *int64 // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // Whether the object represents a directory. OCPBatchFileIsDirectory *bool // The file mode attribute in octal format. OCPBatchFileMode *string // The URL of the file. OCPBatchFileURL *string // The file creation time. OCPCreationTime *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
GetNodeFilePropertiesResponse contains the response from method Client.GetNodeFileProperties.
type GetNodeFileResponse ¶
type GetNodeFileResponse struct { // Body contains the streaming response. Body io.ReadCloser // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The length of the file. ContentLength *int64 // Type of content ContentType *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // Whether the object represents a directory. OCPBatchFileIsDirectory *bool // The file mode attribute in octal format. OCPBatchFileMode *string // The URL of the file. OCPBatchFileURL *string // The file creation time. OCPCreationTime *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
GetNodeFileResponse contains the response from method Client.GetNodeFile.
type GetNodeOptions ¶
type GetNodeOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // An OData $select clause. SelectParam []string // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
GetNodeOptions contains the optional parameters for the Client.GetNode method.
type GetNodeRemoteLoginSettingsOptions ¶
type GetNodeRemoteLoginSettingsOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
GetNodeRemoteLoginSettingsOptions contains the optional parameters for the Client.GetNodeRemoteLoginSettings method.
type GetNodeRemoteLoginSettingsResponse ¶
type GetNodeRemoteLoginSettingsResponse struct { // The remote login settings for a Compute Node. NodeRemoteLoginSettings // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
GetNodeRemoteLoginSettingsResponse contains the response from method Client.GetNodeRemoteLoginSettings.
type GetNodeResponse ¶
type GetNodeResponse struct { // A Compute Node in the Batch service. Node // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
GetNodeResponse contains the response from method Client.GetNode.
type GetPoolOptions ¶
type GetPoolOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // An OData $expand clause. Expand []string // An ETag value associated with the version of the resource known to the client. // The operation will be performed only if the resource's current ETag on the // service exactly matches the value specified by the client. IfMatch *azcore.ETag // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // been modified since the specified time. IfModifiedSince *time.Time // An ETag value associated with the version of the resource known to the client. // The operation will be performed only if the resource's current ETag on the // service does not match the value specified by the client. IfNoneMatch *azcore.ETag // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // not been modified since the specified time. IfUnmodifiedSince *time.Time // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // An OData $select clause. SelectParam []string // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
GetPoolOptions contains the optional parameters for the Client.GetPool method.
type GetPoolResponse ¶
type GetPoolResponse struct { // A Pool in the Azure Batch service. Pool // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
GetPoolResponse contains the response from method Client.GetPool.
type GetTaskFileOptions ¶
type GetTaskFileOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // been modified since the specified time. IfModifiedSince *time.Time // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // not been modified since the specified time. IfUnmodifiedSince *time.Time // The byte range to be retrieved. The default is to retrieve the entire file. The // format is bytes=startRange-endRange. OCPRange *string // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
GetTaskFileOptions contains the optional parameters for the Client.GetTaskFile method.
type GetTaskFilePropertiesOptions ¶
type GetTaskFilePropertiesOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // been modified since the specified time. IfModifiedSince *time.Time // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // not been modified since the specified time. IfUnmodifiedSince *time.Time // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
GetTaskFilePropertiesOptions contains the optional parameters for the Client.GetTaskFileProperties method.
type GetTaskFilePropertiesResponse ¶
type GetTaskFilePropertiesResponse struct { // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The length of the file. ContentLength *int64 // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // Whether the object represents a directory. OCPBatchFileIsDirectory *bool // The file mode attribute in octal format. OCPBatchFileMode *string // The URL of the file. OCPBatchFileURL *string // The file creation time. OCPCreationTime *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
GetTaskFilePropertiesResponse contains the response from method Client.GetTaskFileProperties.
type GetTaskFileResponse ¶
type GetTaskFileResponse struct { // Body contains the streaming response. Body io.ReadCloser // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The length of the file. ContentLength *int64 // Type of content ContentType *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // Whether the object represents a directory. OCPBatchFileIsDirectory *bool // The file mode attribute in octal format. OCPBatchFileMode *string // The URL of the file. OCPBatchFileURL *string // The file creation time. OCPCreationTime *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
GetTaskFileResponse contains the response from method Client.GetTaskFile.
type GetTaskOptions ¶
type GetTaskOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // An OData $expand clause. Expand []string // An ETag value associated with the version of the resource known to the client. // The operation will be performed only if the resource's current ETag on the // service exactly matches the value specified by the client. IfMatch *azcore.ETag // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // been modified since the specified time. IfModifiedSince *time.Time // An ETag value associated with the version of the resource known to the client. // The operation will be performed only if the resource's current ETag on the // service does not match the value specified by the client. IfNoneMatch *azcore.ETag // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // not been modified since the specified time. IfUnmodifiedSince *time.Time // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // An OData $select clause. SelectParam []string // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
GetTaskOptions contains the optional parameters for the Client.GetTask method.
type GetTaskResponse ¶
type GetTaskResponse struct { // Batch will retry Tasks when a recovery operation is triggered on a Node. // Examples of recovery operations include (but are not limited to) when an // unhealthy Node is rebooted or a Compute Node disappeared due to host failure. // Retries due to recovery operations are independent of and are not counted // against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal // retry due to a recovery operation may occur. Because of this, all Tasks should // be idempotent. This means Tasks need to tolerate being interrupted and // restarted without causing any corruption or duplicate data. The best practice // for long running Tasks is to use some form of checkpointing. Task // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The OData ID of the resource to which the request applied. DataServiceID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
GetTaskResponse contains the response from method Client.GetTask.
type HTTPHeader ¶
type HTTPHeader struct { // REQUIRED; The case-insensitive name of the header to be used while uploading output files. Name *string // The value of the header to be used while uploading output files. Value *string }
HTTPHeader - An HTTP header name-value pair
func (HTTPHeader) MarshalJSON ¶
func (h HTTPHeader) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type HTTPHeader.
func (*HTTPHeader) UnmarshalJSON ¶
func (h *HTTPHeader) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type HTTPHeader.
type IPAddressProvisioningType ¶
type IPAddressProvisioningType string
IPAddressProvisioningType - IPAddressProvisioningType enums
const ( // IPAddressProvisioningTypeBatchManaged - A public IP will be created and managed by Batch. There may be multiple public // IPs depending on the size of the Pool. IPAddressProvisioningTypeBatchManaged IPAddressProvisioningType = "batchmanaged" // IPAddressProvisioningTypeNoPublicIPAddresses - No public IP Address will be created. IPAddressProvisioningTypeNoPublicIPAddresses IPAddressProvisioningType = "nopublicipaddresses" // IPAddressProvisioningTypeUserManaged - Public IPs are provided by the user and will be used to provision the Compute Nodes. IPAddressProvisioningTypeUserManaged IPAddressProvisioningType = "usermanaged" )
func PossibleIPAddressProvisioningTypeValues ¶
func PossibleIPAddressProvisioningTypeValues() []IPAddressProvisioningType
PossibleIPAddressProvisioningTypeValues returns the possible values for the IPAddressProvisioningType const type.
type ImageReference ¶
type ImageReference struct { // The community gallery image unique identifier. This property is mutually exclusive with other properties and can be fetched // from community gallery image GET call. CommunityGalleryImageID *string // The offer type of the Azure Virtual Machines Marketplace Image. For example, UbuntuServer or WindowsServer. Offer *string // The publisher of the Azure Virtual Machines Marketplace Image. For example, Canonical or MicrosoftWindowsServer. Publisher *string // The SKU of the Azure Virtual Machines Marketplace Image. For example, 18.04-LTS or 2019-Datacenter. SKU *string // from shared gallery image GET call. SharedGalleryImageID *string // The version of the Azure Virtual Machines Marketplace Image. A value of 'latest' can be specified to select the latest // version of an Image. If omitted, the default is 'latest'. Version *string // The ARM resource identifier of the Azure Compute Gallery Image. Compute Nodes in the Pool will be created using this Image // Id. This is of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} // or /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} // for always defaulting to the latest image version. This property is mutually exclusive with other ImageReference properties. // The Azure Compute Gallery Image must have replicas in the same region and must be in the same subscription as the Azure // Batch account. If the image version is not specified in the imageId, the latest version will be used. For information about // the firewall settings for the Batch Compute Node agent to communicate with the Batch service see https://learn.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration. VirtualMachineImageID *string // READ-ONLY; The specific version of the platform image or marketplace image used to create the node. This read-only field // differs from 'version' only if the value specified for 'version' when the pool was created was 'latest'. ExactVersion *string }
ImageReference - A reference to an Azure Virtual Machines Marketplace Image or a Azure Compute Gallery Image. To get the list of all Azure Marketplace Image references verified by Azure Batch, see the ' List Supported Images ' operation.
func (ImageReference) MarshalJSON ¶
func (i ImageReference) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type ImageReference.
func (*ImageReference) UnmarshalJSON ¶
func (i *ImageReference) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type ImageReference.
type ImageVerificationType ¶
type ImageVerificationType string
ImageVerificationType - ImageVerificationType enums
const ( // ImageVerificationTypeUnverified - The associated Compute Node agent SKU should have binary compatibility with the Image, // but specific functionality has not been verified. ImageVerificationTypeUnverified ImageVerificationType = "unverified" // ImageVerificationTypeVerified - The Image is guaranteed to be compatible with the associated Compute Node agent SKU and // all Batch features have been confirmed to work as expected. ImageVerificationTypeVerified ImageVerificationType = "verified" )
func PossibleImageVerificationTypeValues ¶
func PossibleImageVerificationTypeValues() []ImageVerificationType
PossibleImageVerificationTypeValues returns the possible values for the ImageVerificationType const type.
type InboundEndpoint ¶
type InboundEndpoint struct { // REQUIRED; The backend port number of the endpoint. BackendPort *int32 // REQUIRED; The public port number of the endpoint. FrontendPort *int32 // REQUIRED; The name of the endpoint. Name *string // REQUIRED; The protocol of the endpoint. Protocol *InboundEndpointProtocol // REQUIRED; The public fully qualified domain name for the Compute Node. PublicFQDN *string // REQUIRED; The public IP address of the Compute Node. PublicIPAddress *string }
InboundEndpoint - An inbound endpoint on a Compute Node.
func (InboundEndpoint) MarshalJSON ¶
func (i InboundEndpoint) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type InboundEndpoint.
func (*InboundEndpoint) UnmarshalJSON ¶
func (i *InboundEndpoint) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type InboundEndpoint.
type InboundEndpointProtocol ¶
type InboundEndpointProtocol string
InboundEndpointProtocol - InboundEndpointProtocol enums
const ( // InboundEndpointProtocolTCP - Use TCP for the endpoint. InboundEndpointProtocolTCP InboundEndpointProtocol = "tcp" // InboundEndpointProtocolUDP - Use UDP for the endpoint. InboundEndpointProtocolUDP InboundEndpointProtocol = "udp" )
func PossibleInboundEndpointProtocolValues ¶
func PossibleInboundEndpointProtocolValues() []InboundEndpointProtocol
PossibleInboundEndpointProtocolValues returns the possible values for the InboundEndpointProtocol const type.
type InboundNATPool ¶
type InboundNATPool struct { // REQUIRED; The port number on the Compute Node. This must be unique within a Batch Pool. Acceptable values are between 1 // and 65535 except for 29876 and 29877 as these are reserved. If any reserved values are provided the request fails with // HTTP status code 400. BackendPort *int32 // REQUIRED; The last port number in the range of external ports that will be used to provide inbound access to the backendPort // on individual Compute Nodes. Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved // by the Batch service. All ranges within a Pool must be distinct and cannot overlap. Each range must contain at least 40 // ports. If any reserved or overlapping values are provided the request fails with HTTP status code 400. FrontendPortRangeEnd *int32 // REQUIRED; The first port number in the range of external ports that will be used to provide inbound access to the backendPort // on individual Compute Nodes. Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved. // All ranges within a Pool must be distinct and cannot overlap. Each range must contain at least 40 ports. If any reserved // or overlapping values are provided the request fails with HTTP status code 400. FrontendPortRangeStart *int32 // REQUIRED; The name of the endpoint. The name must be unique within a Batch Pool, can contain letters, numbers, underscores, // periods, and hyphens. Names must start with a letter or number, must end with a letter, number, or underscore, and cannot // exceed 77 characters. If any invalid values are provided the request fails with HTTP status code 400. Name *string // REQUIRED; The protocol of the endpoint. Protocol *InboundEndpointProtocol // A list of network security group rules that will be applied to the endpoint. The maximum number of rules that can be specified // across all the endpoints on a Batch Pool is 25. If no network security group rules are specified, a default rule will be // created to allow inbound access to the specified backendPort. If the maximum number of network security group rules is // exceeded the request fails with HTTP status code 400. NetworkSecurityGroupRules []NetworkSecurityGroupRule }
InboundNATPool - A inbound NAT Pool that can be used to address specific ports on Compute Nodes in a Batch Pool externally.
func (InboundNATPool) MarshalJSON ¶
func (i InboundNATPool) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type InboundNATPool.
func (*InboundNATPool) UnmarshalJSON ¶
func (i *InboundNATPool) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type InboundNATPool.
type InstanceViewStatus ¶
type InstanceViewStatus struct { // The status code. Code *string // The localized label for the status. DisplayStatus *string // Level code. Level *StatusLevelTypes // The detailed status message. Message *string // The time of the status. Time *time.Time }
InstanceViewStatus - The instance view status.
func (InstanceViewStatus) MarshalJSON ¶
func (i InstanceViewStatus) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type InstanceViewStatus.
func (*InstanceViewStatus) UnmarshalJSON ¶
func (i *InstanceViewStatus) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type InstanceViewStatus.
type Job ¶
type Job struct { // REQUIRED; The Pool settings associated with the Job. PoolInfo *PoolInfo // Whether Tasks in this job can be preempted by other high priority jobs. If the value is set to True, other high priority // jobs submitted to the system will take precedence and will be able requeue tasks from this job. You can update a job's // allowTaskPreemption after it has been created using the update job API. AllowTaskPreemption *bool // The execution constraints for the Job. Constraints *JobConstraints // The maximum number of tasks that can be executed in parallel for the job. The value of maxParallelTasks must be -1 or greater // than 0 if specified. If not specified, the default value is -1, which means there's no limit to the number of tasks that // can be run at once. You can update a job's maxParallelTasks after it has been created using the update job API. MaxParallelTasks *int32 // A list of name-value pairs associated with the Job as metadata. The Batch service does not assign any meaning to metadata; // it is solely for the use of user code. Metadata []MetadataItem // The action the Batch service should take when all Tasks in the Job are in the completed state. The default is noaction. OnAllTasksComplete *OnAllTasksComplete // The priority of the Job. Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being // the highest priority. The default value is 0. Priority *int32 // READ-ONLY; The list of common environment variable settings. These environment variables are set for all Tasks in the Job // (including the Job Manager, Job Preparation and Job Release Tasks). Individual Tasks can override an environment setting // specified here by specifying the same setting name with a different value. CommonEnvironmentSettings []EnvironmentSetting // READ-ONLY; The creation time of the Job. CreationTime *time.Time // READ-ONLY; The display name for the Job. DisplayName *string // READ-ONLY; The ETag of the Job. This is an opaque string. You can use it to detect whether the Job has changed between // requests. In particular, you can be pass the ETag when updating a Job to specify that your changes should take effect only // if nobody else has modified the Job in the meantime. ETag *azcore.ETag // READ-ONLY; The execution information for the Job. ExecutionInfo *JobExecutionInfo // READ-ONLY; A string that uniquely identifies the Job within the Account. The ID is case-preserving and case-insensitive // (that is, you may not have two IDs within an Account that differ only by case). ID *string // READ-ONLY; Details of a Job Manager Task to be launched when the Job is started. JobManagerTask *JobManagerTask // READ-ONLY; The Job Preparation Task. The Job Preparation Task is a special Task run on each Compute Node before any other // Task of the Job. JobPreparationTask *JobPreparationTask // READ-ONLY; The Job Release Task. The Job Release Task is a special Task run at the end of the Job on each Compute Node // that has run any other Task of the Job. JobReleaseTask *JobReleaseTask // READ-ONLY; The last modified time of the Job. This is the last time at which the Job level data, such as the Job state // or priority, changed. It does not factor in task-level changes such as adding new Tasks or Tasks changing state. LastModified *time.Time // READ-ONLY; The network configuration for the Job. NetworkConfiguration *JobNetworkConfiguration // READ-ONLY; The action the Batch service should take when any Task in the Job fails. A Task is considered to have failed // if has a failureInfo. A failureInfo is set if the Task completes with a non-zero exit code after exhausting its retry count, // or if there was an error starting the Task, for example due to a resource file download error. The default is noaction. OnTaskFailure *OnTaskFailure // READ-ONLY; The previous state of the Job. This property is not set if the Job is in its initial Active state. PreviousState *JobState // READ-ONLY; The time at which the Job entered its previous state. This property is not set if the Job is in its initial // Active state. PreviousStateTransitionTime *time.Time // READ-ONLY; The current state of the Job. State *JobState // READ-ONLY; The time at which the Job entered its current state. StateTransitionTime *time.Time // READ-ONLY; Resource usage statistics for the entire lifetime of the Job. This property is populated only if the BatchJob // was retrieved with an expand clause including the 'stats' attribute; otherwise it is null. The statistics may not be immediately // available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes. Stats *JobStatistics // READ-ONLY; The URL of the Job. URL *string // READ-ONLY; Whether Tasks in the Job can define dependencies on each other. The default is false. UsesTaskDependencies *bool }
Job - An Azure Batch Job.
func (Job) MarshalJSON ¶
MarshalJSON implements the json.Marshaller interface for type Job.
func (*Job) UnmarshalJSON ¶
UnmarshalJSON implements the json.Unmarshaller interface for type Job.
type JobAction ¶
type JobAction string
JobAction - BatchJobAction enums
const ( // JobActionDisable - Disable the Job. This is equivalent to calling the disable Job API, with a disableTasks value of requeue. JobActionDisable JobAction = "disable" // JobActionNone - Take no action. JobActionNone JobAction = "none" // JobActionTerminate - Terminate the Job. The terminationReason in the Job's executionInfo is set to "TaskFailed". JobActionTerminate JobAction = "terminate" )
func PossibleJobActionValues ¶
func PossibleJobActionValues() []JobAction
PossibleJobActionValues returns the possible values for the JobAction const type.
type JobConstraints ¶
type JobConstraints struct { // The maximum number of times each Task may be retried. The Batch service retries a Task if its exit code is nonzero. Note // that this value specifically controls the number of retries. The Batch service will try each Task once, and may then retry // up to this limit. For example, if the maximum retry count is 3, Batch tries a Task up to 4 times (one initial try and 3 // retries). If the maximum retry count is 0, the Batch service does not retry Tasks. If the maximum retry count is -1, the // Batch service retries Tasks without limit. The default value is 0 (no retries). MaxTaskRetryCount *int32 // The maximum elapsed time that the Job may run, measured from the time the Job is created. If the Job does not complete // within the time limit, the Batch service terminates it and any Tasks that are still running. In this case, the termination // reason will be MaxWallClockTimeExpiry. If this property is not specified, there is no time limit on how long the Job may // run. MaxWallClockTime *string }
JobConstraints - The execution constraints for a Job.
func (JobConstraints) MarshalJSON ¶
func (j JobConstraints) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type JobConstraints.
func (*JobConstraints) UnmarshalJSON ¶
func (j *JobConstraints) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type JobConstraints.
type JobExecutionInfo ¶
type JobExecutionInfo struct { // REQUIRED; The start time of the Job. This is the time at which the Job was created. StartTime *time.Time // The completion time of the Job. This property is set only if the Job is in the completed state. EndTime *time.Time // The ID of the Pool to which this Job is assigned. This element contains the actual Pool where the Job is assigned. When // you get Job details from the service, they also contain a poolInfo element, which contains the Pool configuration data // from when the Job was added or updated. That poolInfo element may also contain a poolId element. If it does, the two IDs // are the same. If it does not, it means the Job ran on an auto Pool, and this property contains the ID of that auto Pool. PoolID *string // Details of any error encountered by the service in starting the Job. This property is not set if there was no error starting // the Job. SchedulingError *JobSchedulingError // A string describing the reason the Job ended. This property is set only if the Job is in the completed state. If the Batch // service terminates the Job, it sets the reason as follows: JMComplete - the Job Manager Task completed, and killJobOnCompletion // was set to true. MaxWallClockTimeExpiry - the Job reached its maxWallClockTime constraint. TerminateJobSchedule - the Job // ran as part of a schedule, and the schedule terminated. AllTasksComplete - the Job's onAllTasksComplete attribute is set // to terminatejob, and all Tasks in the Job are complete. TaskFailed - the Job's onTaskFailure attribute is set to performExitOptionsJobAction, // and a Task in the Job failed with an exit condition that specified a jobAction of terminatejob. Any other string is a user-defined // reason specified in a call to the 'Terminate a Job' operation. TerminationReason *string }
JobExecutionInfo - Contains information about the execution of a Job in the Azure Batch service.
func (JobExecutionInfo) MarshalJSON ¶
func (j JobExecutionInfo) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type JobExecutionInfo.
func (*JobExecutionInfo) UnmarshalJSON ¶
func (j *JobExecutionInfo) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type JobExecutionInfo.
type JobListResult ¶
type JobListResult struct { // The URL to get the next set of results. NextLink *string // The list of Jobs. Value []Job }
JobListResult - The result of listing the Jobs in an Account.
func (JobListResult) MarshalJSON ¶
func (j JobListResult) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type JobListResult.
func (*JobListResult) UnmarshalJSON ¶
func (j *JobListResult) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type JobListResult.
type JobManagerTask ¶
type JobManagerTask struct { // REQUIRED; The command line of the Job Manager Task. The command line does not run under a shell, and therefore cannot take // advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you // should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" // in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), // or use the Batch provided environment variable (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables). CommandLine *string // REQUIRED; A string that uniquely identifies the Job Manager Task within the Job. The ID can contain any combination of // alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters. ID *string // Whether the Job Manager Task may run on a Spot/Low-priority Compute Node. The default value is true. AllowLowPriorityNode *bool // A list of Application Packages that the Batch service will deploy to the // Compute Node before running the command line.Application Packages are // downloaded and deployed to a shared directory, not the Task working // directory. Therefore, if a referenced Application Package is already // on the Compute Node, and is up to date, then it is not re-downloaded; // the existing copy on the Compute Node is used. If a referenced Application // Package cannot be installed, for example because the package has been deleted // or because download failed, the Task fails. ApplicationPackageReferences []ApplicationPackageReference // The settings for an authentication token that the Task can use to perform Batch service operations. If this property is // set, the Batch service provides the Task with an authentication token which can be used to authenticate Batch service operations // without requiring an Account access key. The token is provided via the AZ_BATCH_AUTHENTICATION_TOKEN environment variable. // The operations that the Task can carry out using the token depend on the settings. For example, a Task can request Job // permissions in order to add other Tasks to the Job, or check the status of the Job or of other Tasks under the Job. AuthenticationTokenSettings *AuthenticationTokenSettings // Constraints that apply to the Job Manager Task. Constraints *TaskConstraints // The settings for the container under which the Job Manager Task runs. If the Pool that will run this Task has containerConfiguration // set, this must be set as well. If the Pool that will run this Task doesn't have containerConfiguration set, this must not // be set. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories // on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task // command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not // be reflected to the host disk, meaning that Batch file APIs will not be able to access those files. ContainerSettings *TaskContainerSettings // The display name of the Job Manager Task. It need not be unique and can contain any Unicode characters up to a maximum // length of 1024. DisplayName *string // A list of environment variable settings for the Job Manager Task. EnvironmentSettings []EnvironmentSetting // Whether completion of the Job Manager Task signifies completion of the entire Job. If true, when the Job Manager Task completes, // the Batch service marks the Job as complete. If any Tasks are still running at this time (other than Job Release), those // Tasks are terminated. If false, the completion of the Job Manager Task does not affect the Job status. In this case, you // should either use the onAllTasksComplete attribute to terminate the Job, or have a client or user terminate the Job explicitly. // An example of this is if the Job Manager creates a set of Tasks but then takes no further role in their execution. The // default value is true. If you are using the onAllTasksComplete and onTaskFailure attributes to control Job lifetime, and // using the Job Manager Task only to create the Tasks for the Job (not to monitor progress), then it is important to set // killJobOnCompletion to false. KillJobOnCompletion *bool // A list of files that the Batch service will upload from the Compute Node after running the command line. For multi-instance // Tasks, the files will only be uploaded from the Compute Node on which the primary Task is executed. OutputFiles []OutputFile // The number of scheduling slots that the Task requires to run. The default is 1. A Task can only be scheduled to run on // a compute node if the node has enough free scheduling slots available. For multi-instance Tasks, this property is not supported // and must not be specified. RequiredSlots *int32 // A list of files that the Batch service will download to the Compute Node before running the command line. Files listed // under this element are located in the Task's working directory. There is a maximum size for the list of resource files. // When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this // occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, // or Docker Containers. ResourceFiles []ResourceFile // Whether the Job Manager Task requires exclusive use of the Compute Node where it runs. If true, no other Tasks will run // on the same Node for as long as the Job Manager is running. If false, other Tasks can run simultaneously with the Job Manager // on a Compute Node. The Job Manager Task counts normally against the Compute Node's concurrent Task limit, so this is only // relevant if the Compute Node allows multiple concurrent Tasks. The default value is true. RunExclusive *bool // The user identity under which the Job Manager Task runs. If omitted, the Task runs as a non-administrative user unique // to the Task. UserIdentity *UserIdentity }
JobManagerTask - Specifies details of a Job Manager Task. The Job Manager Task is automatically started when the Job is created. The Batch service tries to schedule the Job Manager Task before any other Tasks in the Job. When shrinking a Pool, the Batch service tries to preserve Nodes where Job Manager Tasks are running for as long as possible (that is, Compute Nodes running 'normal' Tasks are removed before Compute Nodes running Job Manager Tasks). When a Job Manager Task fails and needs to be restarted, the system tries to schedule it at the highest priority. If there are no idle Compute Nodes available, the system may terminate one of the running Tasks in the Pool and return it to the queue in order to make room for the Job Manager Task to restart. Note that a Job Manager Task in one Job does not have priority over Tasks in other Jobs. Across Jobs, only Job level priorities are observed. For example, if a Job Manager in a priority 0 Job needs to be restarted, it will not displace Tasks of a priority 1 Job. Batch will retry Tasks when a recovery operation is triggered on a Node. Examples of recovery operations include (but are not limited to) when an unhealthy Node is rebooted or a Compute Node disappeared due to host failure. Retries due to recovery operations are independent of and are not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal retry due to a recovery operation may occur. Because of this, all Tasks should be idempotent. This means Tasks need to tolerate being interrupted and restarted without causing any corruption or duplicate data. The best practice for long running Tasks is to use some form of checkpointing.
func (JobManagerTask) MarshalJSON ¶
func (j JobManagerTask) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type JobManagerTask.
func (*JobManagerTask) UnmarshalJSON ¶
func (j *JobManagerTask) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type JobManagerTask.
type JobNetworkConfiguration ¶
type JobNetworkConfiguration struct { // REQUIRED; Whether to withdraw Compute Nodes from the virtual network to DNC when the job is terminated or deleted. If true, // nodes will remain joined to the virtual network to DNC. If false, nodes will automatically withdraw when the job ends. // Defaults to false. SkipWithdrawFromVNet *bool // REQUIRED; The ARM resource identifier of the virtual network subnet which Compute Nodes running Tasks from the Job will // join for the duration of the Task. The virtual network must be in the same region and subscription as the Azure Batch Account. // The specified subnet should have enough free IP addresses to accommodate the number of Compute Nodes which will run Tasks // from the Job. This can be up to the number of Compute Nodes in the Pool. The 'MicrosoftAzureBatch' service principal must // have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet so that Azure // Batch service can schedule Tasks on the Nodes. This can be verified by checking if the specified VNet has any associated // Network Security Groups (NSG). If communication to the Nodes in the specified subnet is denied by an NSG, then the Batch // service will set the state of the Compute Nodes to unusable. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. // If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled // for inbound communication from the Azure Batch service. For Pools created with a Virtual Machine configuration, enable // ports 29876 and 29877, as well as port 22 for Linux and port 3389 for Windows. Port 443 is also required to be open for // outbound connections for communications to Azure Storage. For more details see: https://learn.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration. SubnetID *string }
JobNetworkConfiguration - The network configuration for the Job.
func (JobNetworkConfiguration) MarshalJSON ¶
func (j JobNetworkConfiguration) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type JobNetworkConfiguration.
func (*JobNetworkConfiguration) UnmarshalJSON ¶
func (j *JobNetworkConfiguration) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type JobNetworkConfiguration.
type JobPreparationAndReleaseTaskStatus ¶
type JobPreparationAndReleaseTaskStatus struct { // Information about the execution status of the Job Preparation Task on this Compute Node. JobPreparationTaskExecutionInfo *JobPreparationTaskExecutionInfo // Information about the execution status of the Job Release Task on this Compute Node. This property is set only if the Job // Release Task has run on the Compute Node. JobReleaseTaskExecutionInfo *JobReleaseTaskExecutionInfo // The ID of the Compute Node to which this entry refers. NodeID *string // The URL of the Compute Node to which this entry refers. NodeURL *string // The ID of the Pool containing the Compute Node to which this entry refers. PoolID *string }
JobPreparationAndReleaseTaskStatus - The status of the Job Preparation and Job Release Tasks on a Compute Node.
func (JobPreparationAndReleaseTaskStatus) MarshalJSON ¶
func (j JobPreparationAndReleaseTaskStatus) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type JobPreparationAndReleaseTaskStatus.
func (*JobPreparationAndReleaseTaskStatus) UnmarshalJSON ¶
func (j *JobPreparationAndReleaseTaskStatus) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type JobPreparationAndReleaseTaskStatus.
type JobPreparationAndReleaseTaskStatusListResult ¶
type JobPreparationAndReleaseTaskStatusListResult struct { // The URL to get the next set of results. NextLink *string // A list of Job Preparation and Job Release Task execution information. Value []JobPreparationAndReleaseTaskStatus }
JobPreparationAndReleaseTaskStatusListResult - The result of listing the status of the Job Preparation and Job Release Tasks for a Job.
func (JobPreparationAndReleaseTaskStatusListResult) MarshalJSON ¶
func (j JobPreparationAndReleaseTaskStatusListResult) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type JobPreparationAndReleaseTaskStatusListResult.
func (*JobPreparationAndReleaseTaskStatusListResult) UnmarshalJSON ¶
func (j *JobPreparationAndReleaseTaskStatusListResult) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type JobPreparationAndReleaseTaskStatusListResult.
type JobPreparationTask ¶
type JobPreparationTask struct { // REQUIRED; The command line of the Job Preparation Task. The command line does not run under a shell, and therefore cannot // take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, // you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" // in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), // or use the Batch provided environment variable (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables). CommandLine *string // Constraints that apply to the Job Preparation Task. Constraints *TaskConstraints // The settings for the container under which the Job Preparation Task runs. When this is specified, all directories recursively // below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task // environment variables are mapped into the container, and the Task command line is executed in the container. Files produced // in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs // will not be able to access those files. ContainerSettings *TaskContainerSettings // A list of environment variable settings for the Job Preparation Task. EnvironmentSettings []EnvironmentSetting // A string that uniquely identifies the Job Preparation Task within the Job. The ID can contain any combination of alphanumeric // characters including hyphens and underscores and cannot contain more than 64 characters. If you do not specify this property, // the Batch service assigns a default value of 'jobpreparation'. No other Task in the Job can have the same ID as the Job // Preparation Task. If you try to submit a Task with the same id, the Batch service rejects the request with error code TaskIdSameAsJobPreparationTask; // if you are calling the REST API directly, the HTTP status code is 409 (Conflict). ID *string // Whether the Batch service should rerun the Job Preparation Task after a Compute Node reboots. The Job Preparation Task // is always rerun if a Compute Node is reimaged, or if the Job Preparation Task did not complete (e.g. because the reboot // occurred while the Task was running). Therefore, you should always write a Job Preparation Task to be idempotent and to // behave correctly if run multiple times. The default value is true. RerunOnNodeRebootAfterSuccess *bool // A list of files that the Batch service will download to the Compute Node before running the command line. Files listed // under this element are located in the Task's working directory. There is a maximum size for the list of resource files. // When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this // occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, // or Docker Containers. ResourceFiles []ResourceFile // The user identity under which the Job Preparation Task runs. If omitted, the Task runs as a non-administrative user unique // to the Task on Windows Compute Nodes, or a non-administrative user unique to the Pool on Linux Compute Nodes. UserIdentity *UserIdentity // Whether the Batch service should wait for the Job Preparation Task to complete successfully before scheduling any other // Tasks of the Job on the Compute Node. A Job Preparation Task has completed successfully if it exits with exit code 0. If // true and the Job Preparation Task fails on a Node, the Batch service retries the Job Preparation Task up to its maximum // retry count (as specified in the constraints element). If the Task has still not completed successfully after all retries, // then the Batch service will not schedule Tasks of the Job to the Node. The Node remains active and eligible to run Tasks // of other Jobs. If false, the Batch service will not wait for the Job Preparation Task to complete. In this case, other // Tasks of the Job can start executing on the Compute Node while the Job Preparation Task is still running; and even if the // Job Preparation Task fails, new Tasks will continue to be scheduled on the Compute Node. The default value is true. WaitForSuccess *bool }
JobPreparationTask - A Job Preparation Task to run before any Tasks of the Job on any given Compute Node. You can use Job Preparation to prepare a Node to run Tasks for the Job. Activities commonly performed in Job Preparation include: Downloading common resource files used by all the Tasks in the Job. The Job Preparation Task can download these common resource files to the shared location on the Node. (AZ_BATCH_NODE_ROOT_DIR\shared), or starting a local service on the Node so that all Tasks of that Job can communicate with it. If the Job Preparation Task fails (that is, exhausts its retry count before exiting with exit code 0), Batch will not run Tasks of this Job on the Node. The Compute Node remains ineligible to run Tasks of this Job until it is reimaged. The Compute Node remains active and can be used for other Jobs. The Job Preparation Task can run multiple times on the same Node. Therefore, you should write the Job Preparation Task to handle re-execution. If the Node is rebooted, the Job Preparation Task is run again on the Compute Node before scheduling any other Task of the Job, if rerunOnNodeRebootAfterSuccess is true or if the Job Preparation Task did not previously complete. If the Node is reimaged, the Job Preparation Task is run again before scheduling any Task of the Job. Batch will retry Tasks when a recovery operation is triggered on a Node. Examples of recovery operations include (but are not limited to) when an unhealthy Node is rebooted or a Compute Node disappeared due to host failure. Retries due to recovery operations are independent of and are not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal retry due to a recovery operation may occur. Because of this, all Tasks should be idempotent. This means Tasks need to tolerate being interrupted and restarted without causing any corruption or duplicate data. The best practice for long running Tasks is to use some form of checkpointing.
func (JobPreparationTask) MarshalJSON ¶
func (j JobPreparationTask) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type JobPreparationTask.
func (*JobPreparationTask) UnmarshalJSON ¶
func (j *JobPreparationTask) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type JobPreparationTask.
type JobPreparationTaskExecutionInfo ¶
type JobPreparationTaskExecutionInfo struct { // REQUIRED; The number of times the Task has been retried by the Batch service. Task application failures (non-zero exit // code) are retried, pre-processing errors (the Task could not be run) and file upload errors are not retried. The Batch // service will retry the Task up to the limit specified by the constraints. Task application failures (non-zero exit code) // are retried, pre-processing errors (the Task could not be run) and file upload errors are not retried. The Batch service // will retry the Task up to the limit specified by the constraints. RetryCount *int32 // REQUIRED; The time at which the Task started running. If the Task has been restarted or retried, this is the most recent // time at which the Task started running. StartTime *time.Time // REQUIRED; The current state of the Job Preparation Task on the Compute Node. State *JobPreparationTaskState // Information about the container under which the Task is executing. This property is set only if the Task runs in a container // context. ContainerInfo *TaskContainerExecutionInfo // The time at which the Job Preparation Task completed. This property is set only if the Task is in the Completed state. EndTime *time.Time // The exit code of the program specified on the Task command line. This parameter is returned only if the Task is in the // completed state. The exit code for a process reflects the specific convention implemented by the application developer // for that process. If you use the exit code value to make decisions in your code, be sure that you know the exit code convention // used by the application process. Note that the exit code may also be generated by the Compute Node operating system, such // as when a process is forcibly terminated. ExitCode *int32 // Information describing the Task failure, if any. This property is set only if the Task is in the completed state and encountered // a failure. FailureInfo *TaskFailureInfo // The most recent time at which a retry of the Job Preparation Task started running. This property is set only if the Task // was retried (i.e. retryCount is nonzero). If present, this is typically the same as startTime, but may be different if // the Task has been restarted for reasons other than retry; for example, if the Compute Node was rebooted during a retry, // then the startTime is updated but the lastRetryTime is not. LastRetryTime *time.Time // The result of the Task execution. If the value is 'failed', then the details of the failure can be found in the failureInfo // property. Result *TaskExecutionResult // The root directory of the Job Preparation Task on the Compute Node. You can use this path to retrieve files created by // the Task, such as log files. TaskRootDirectory *string // The URL to the root directory of the Job Preparation Task on the Compute Node. TaskRootDirectoryURL *string }
JobPreparationTaskExecutionInfo - Contains information about the execution of a Job Preparation Task on a Compute Node.
func (JobPreparationTaskExecutionInfo) MarshalJSON ¶
func (j JobPreparationTaskExecutionInfo) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type JobPreparationTaskExecutionInfo.
func (*JobPreparationTaskExecutionInfo) UnmarshalJSON ¶
func (j *JobPreparationTaskExecutionInfo) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type JobPreparationTaskExecutionInfo.
type JobPreparationTaskState ¶
type JobPreparationTaskState string
JobPreparationTaskState - BatchJobPreparationTaskState enums
const ( // JobPreparationTaskStateCompleted - The Task has exited with exit code 0, or the Task has exhausted its retry limit, or // the Batch service was unable to start the Task due to Task preparation errors (such as resource file download failures). JobPreparationTaskStateCompleted JobPreparationTaskState = "completed" // JobPreparationTaskStateRunning - The Task is currently running (including retrying). JobPreparationTaskStateRunning JobPreparationTaskState = "running" )
func PossibleJobPreparationTaskStateValues ¶
func PossibleJobPreparationTaskStateValues() []JobPreparationTaskState
PossibleJobPreparationTaskStateValues returns the possible values for the JobPreparationTaskState const type.
type JobReleaseTask ¶
type JobReleaseTask struct { // REQUIRED; The command line of the Job Release Task. The command line does not run under a shell, and therefore cannot take // advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you // should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" // in Linux. If the command line refers to file paths, it should use a relative path (relative to the Task working directory), // or use the Batch provided environment variable (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables). CommandLine *string // The settings for the container under which the Job Release Task runs. When this is specified, all directories recursively // below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task // environment variables are mapped into the container, and the Task command line is executed in the container. Files produced // in the container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs // will not be able to access those files. ContainerSettings *TaskContainerSettings // A list of environment variable settings for the Job Release Task. EnvironmentSettings []EnvironmentSetting // A string that uniquely identifies the Job Release Task within the Job. The ID can contain any combination of alphanumeric // characters including hyphens and underscores and cannot contain more than 64 characters. If you do not specify this property, // the Batch service assigns a default value of 'jobrelease'. No other Task in the Job can have the same ID as the Job Release // Task. If you try to submit a Task with the same id, the Batch service rejects the request with error code TaskIdSameAsJobReleaseTask; // if you are calling the REST API directly, the HTTP status code is 409 (Conflict). ID *string // The maximum elapsed time that the Job Release Task may run on a given Compute Node, measured from the time the Task starts. // If the Task does not complete within the time limit, the Batch service terminates it. The default value is 15 minutes. // You may not specify a timeout longer than 15 minutes. If you do, the Batch service rejects it with an error; if you are // calling the REST API directly, the HTTP status code is 400 (Bad Request). MaxWallClockTime *string // A list of files that the Batch service will download to the Compute Node before running the command line. There is a maximum // size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will // be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved // using .zip files, Application Packages, or Docker Containers. Files listed under this element are located in the Task's // working directory. ResourceFiles []ResourceFile // The minimum time to retain the Task directory for the Job Release Task on the Compute Node. After this time, the Batch // service may delete the Task directory and all its contents. The default is 7 days, i.e. the Task directory will be retained // for 7 days unless the Compute Node is removed or the Job is deleted. RetentionTime *string // The user identity under which the Job Release Task runs. If omitted, the Task runs as a non-administrative user unique // to the Task. UserIdentity *UserIdentity }
JobReleaseTask - A Job Release Task to run on Job completion on any Compute Node where the Job has run. The Job Release Task runs when the Job ends, because of one of the following: The user calls the Terminate Job API, or the Delete Job API while the Job is still active, the Job's maximum wall clock time constraint is reached, and the Job is still active, or the Job's Job Manager Task completed, and the Job is configured to terminate when the Job Manager completes. The Job Release Task runs on each Node where Tasks of the Job have run and the Job Preparation Task ran and completed. If you reimage a Node after it has run the Job Preparation Task, and the Job ends without any further Tasks of the Job running on that Node (and hence the Job Preparation Task does not re-run), then the Job Release Task does not run on that Compute Node. If a Node reboots while the Job Release Task is still running, the Job Release Task runs again when the Compute Node starts up. The Job is not marked as complete until all Job Release Tasks have completed. The Job Release Task runs in the background. It does not occupy a scheduling slot; that is, it does not count towards the taskSlotsPerNode limit specified on the Pool.
func (JobReleaseTask) MarshalJSON ¶
func (j JobReleaseTask) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type JobReleaseTask.
func (*JobReleaseTask) UnmarshalJSON ¶
func (j *JobReleaseTask) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type JobReleaseTask.
type JobReleaseTaskExecutionInfo ¶
type JobReleaseTaskExecutionInfo struct { // REQUIRED; The time at which the Task started running. If the Task has been restarted or retried, this is the most recent // time at which the Task started running. StartTime *time.Time // REQUIRED; The current state of the Job Release Task on the Compute Node. State *JobReleaseTaskState // Information about the container under which the Task is executing. This property is set only if the Task runs in a container // context. ContainerInfo *TaskContainerExecutionInfo // The time at which the Job Release Task completed. This property is set only if the Task is in the Completed state. EndTime *time.Time // The exit code of the program specified on the Task command line. This parameter is returned only if the Task is in the // completed state. The exit code for a process reflects the specific convention implemented by the application developer // for that process. If you use the exit code value to make decisions in your code, be sure that you know the exit code convention // used by the application process. Note that the exit code may also be generated by the Compute Node operating system, such // as when a process is forcibly terminated. ExitCode *int32 // Information describing the Task failure, if any. This property is set only if the Task is in the completed state and encountered // a failure. FailureInfo *TaskFailureInfo // The result of the Task execution. If the value is 'failed', then the details of the failure can be found in the failureInfo // property. Result *TaskExecutionResult // The root directory of the Job Release Task on the Compute Node. You can use this path to retrieve files created by the // Task, such as log files. TaskRootDirectory *string // The URL to the root directory of the Job Release Task on the Compute Node. TaskRootDirectoryURL *string }
JobReleaseTaskExecutionInfo - Contains information about the execution of a Job Release Task on a Compute Node.
func (JobReleaseTaskExecutionInfo) MarshalJSON ¶
func (j JobReleaseTaskExecutionInfo) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type JobReleaseTaskExecutionInfo.
func (*JobReleaseTaskExecutionInfo) UnmarshalJSON ¶
func (j *JobReleaseTaskExecutionInfo) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type JobReleaseTaskExecutionInfo.
type JobReleaseTaskState ¶
type JobReleaseTaskState string
JobReleaseTaskState - BatchJobReleaseTaskState enums
const ( // JobReleaseTaskStateCompleted - The Task has exited with exit code 0, or the Task has exhausted its retry limit, or the // Batch service was unable to start the Task due to Task preparation errors (such as resource file download failures). JobReleaseTaskStateCompleted JobReleaseTaskState = "completed" // JobReleaseTaskStateRunning - The Task is currently running (including retrying). JobReleaseTaskStateRunning JobReleaseTaskState = "running" )
func PossibleJobReleaseTaskStateValues ¶
func PossibleJobReleaseTaskStateValues() []JobReleaseTaskState
PossibleJobReleaseTaskStateValues returns the possible values for the JobReleaseTaskState const type.
type JobSchedule ¶
type JobSchedule struct { // REQUIRED; The details of the Jobs to be created on this schedule. JobSpecification *JobSpecification // A list of name-value pairs associated with the schedule as metadata. The Batch service does not assign any meaning to metadata; // it is solely for the use of user code. Metadata []MetadataItem // The schedule according to which Jobs will be created. All times are fixed respective to UTC and are not impacted by daylight // saving time. Schedule *JobScheduleConfiguration // READ-ONLY; The creation time of the Job Schedule. CreationTime *time.Time // READ-ONLY; The display name for the schedule. DisplayName *string // READ-ONLY; The ETag of the Job Schedule. This is an opaque string. You can use it to detect whether the Job Schedule has // changed between requests. In particular, you can be pass the ETag with an Update Job Schedule request to specify that your // changes should take effect only if nobody else has modified the schedule in the meantime. ETag *azcore.ETag // READ-ONLY; Information about Jobs that have been and will be run under this schedule. ExecutionInfo *JobScheduleExecutionInfo // READ-ONLY; A string that uniquely identifies the schedule within the Account. ID *string // READ-ONLY; The last modified time of the Job Schedule. This is the last time at which the schedule level data, such as // the Job specification or recurrence information, changed. It does not factor in job-level changes such as new Jobs being // created or Jobs changing state. LastModified *time.Time // READ-ONLY; The previous state of the Job Schedule. This property is not present if the Job Schedule is in its initial active // state. PreviousState *JobScheduleState // READ-ONLY; The time at which the Job Schedule entered its previous state. This property is not present if the Job Schedule // is in its initial active state. PreviousStateTransitionTime *time.Time // READ-ONLY; The current state of the Job Schedule. State *JobScheduleState // READ-ONLY; The time at which the Job Schedule entered the current state. StateTransitionTime *time.Time // READ-ONLY; The lifetime resource usage statistics for the Job Schedule. The statistics may not be immediately available. // The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes. Stats *JobScheduleStatistics // READ-ONLY; The URL of the Job Schedule. URL *string }
JobSchedule - A Job Schedule that allows recurring Jobs by specifying when to run Jobs and a specification used to create each Job.
func (JobSchedule) MarshalJSON ¶
func (j JobSchedule) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type JobSchedule.
func (*JobSchedule) UnmarshalJSON ¶
func (j *JobSchedule) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type JobSchedule.
type JobScheduleConfiguration ¶
type JobScheduleConfiguration struct { // A time after which no Job will be created under this Job Schedule. The schedule will move to the completed state as soon // as this deadline is past and there is no active Job under this Job Schedule. If you do not specify a doNotRunAfter time, // and you are creating a recurring Job Schedule, the Job Schedule will remain active until you explicitly terminate it. DoNotRunAfter *time.Time // The earliest time at which any Job may be created under this Job Schedule. If you do not specify a doNotRunUntil time, // the schedule becomes ready to create Jobs immediately. DoNotRunUntil *time.Time // The time interval between the start times of two successive Jobs under the Job Schedule. A Job Schedule can have at most // one active Job under it at any given time. Because a Job Schedule can have at most one active Job under it at any given // time, if it is time to create a new Job under a Job Schedule, but the previous Job is still running, the Batch service // will not create the new Job until the previous Job finishes. If the previous Job does not finish within the startWindow // period of the new recurrenceInterval, then no new Job will be scheduled for that interval. For recurring Jobs, you should // normally specify a jobManagerTask in the jobSpecification. If you do not use jobManagerTask, you will need an external // process to monitor when Jobs are created, add Tasks to the Jobs and terminate the Jobs ready for the next recurrence. The // default is that the schedule does not recur: one Job is created, within the startWindow after the doNotRunUntil time, and // the schedule is complete as soon as that Job finishes. The minimum value is 1 minute. If you specify a lower value, the // Batch service rejects the schedule with an error; if you are calling the REST API directly, the HTTP status code is 400 // (Bad Request). RecurrenceInterval *string // The time interval, starting from the time at which the schedule indicates a Job should be created, within which a Job must // be created. If a Job is not created within the startWindow interval, then the 'opportunity' is lost; no Job will be created // until the next recurrence of the schedule. If the schedule is recurring, and the startWindow is longer than the recurrence // interval, then this is equivalent to an infinite startWindow, because the Job that is 'due' in one recurrenceInterval is // not carried forward into the next recurrence interval. The default is infinite. The minimum value is 1 minute. If you specify // a lower value, the Batch service rejects the schedule with an error; if you are calling the REST API directly, the HTTP // status code is 400 (Bad Request). StartWindow *string }
JobScheduleConfiguration - The schedule according to which Jobs will be created. All times are fixed respective to UTC and are not impacted by daylight saving time.
func (JobScheduleConfiguration) MarshalJSON ¶
func (j JobScheduleConfiguration) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type JobScheduleConfiguration.
func (*JobScheduleConfiguration) UnmarshalJSON ¶
func (j *JobScheduleConfiguration) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type JobScheduleConfiguration.
type JobScheduleExecutionInfo ¶
type JobScheduleExecutionInfo struct { // The time at which the schedule ended. This property is set only if the Job Schedule is in the completed state. EndTime *time.Time // The next time at which a Job will be created under this schedule. This property is meaningful only if the schedule is in // the active state when the time comes around. For example, if the schedule is disabled, no Job will be created at nextRunTime // unless the Job is enabled before then. NextRunTime *time.Time // Information about the most recent Job under the Job Schedule. This property is present only if the at least one Job has // run under the schedule. RecentJob *RecentJob }
JobScheduleExecutionInfo - Contains information about Jobs that have been and will be run under a Job Schedule.
func (JobScheduleExecutionInfo) MarshalJSON ¶
func (j JobScheduleExecutionInfo) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type JobScheduleExecutionInfo.
func (*JobScheduleExecutionInfo) UnmarshalJSON ¶
func (j *JobScheduleExecutionInfo) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type JobScheduleExecutionInfo.
type JobScheduleExistsOptions ¶
type JobScheduleExistsOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // An ETag value associated with the version of the resource known to the client. // The operation will be performed only if the resource's current ETag on the // service exactly matches the value specified by the client. IfMatch *azcore.ETag // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // been modified since the specified time. IfModifiedSince *time.Time // An ETag value associated with the version of the resource known to the client. // The operation will be performed only if the resource's current ETag on the // service does not match the value specified by the client. IfNoneMatch *azcore.ETag // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // not been modified since the specified time. IfUnmodifiedSince *time.Time // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
JobScheduleExistsOptions contains the optional parameters for the Client.JobScheduleExists method.
type JobScheduleExistsResponse ¶
type JobScheduleExistsResponse struct { // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
JobScheduleExistsResponse contains the response from method Client.JobScheduleExists.
type JobScheduleListResult ¶
type JobScheduleListResult struct { // The URL to get the next set of results. NextLink *string // The list of Job Schedules. Value []JobSchedule }
JobScheduleListResult - The result of listing the Job Schedules in an Account.
func (JobScheduleListResult) MarshalJSON ¶
func (j JobScheduleListResult) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type JobScheduleListResult.
func (*JobScheduleListResult) UnmarshalJSON ¶
func (j *JobScheduleListResult) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type JobScheduleListResult.
type JobScheduleState ¶
type JobScheduleState string
JobScheduleState - BatchJobScheduleState enums
const ( // JobScheduleStateActive - The Job Schedule is active and will create Jobs as per its schedule. JobScheduleStateActive JobScheduleState = "active" // JobScheduleStateCompleted - The Job Schedule has terminated, either by reaching its end time or by the user terminating // it explicitly. JobScheduleStateCompleted JobScheduleState = "completed" // JobScheduleStateDeleting - The user has requested that the Job Schedule be deleted, but the delete operation is still in // progress. The scheduler will not initiate any new Jobs for this Job Schedule, and will delete any existing Jobs and Tasks // under the Job Schedule, including any active Job. The Job Schedule will be deleted when all Jobs and Tasks under the Job // Schedule have been deleted. JobScheduleStateDeleting JobScheduleState = "deleting" // JobScheduleStateDisabled - The user has disabled the Job Schedule. The scheduler will not initiate any new Jobs will on // this schedule, but any existing active Job will continue to run. JobScheduleStateDisabled JobScheduleState = "disabled" // JobScheduleStateTerminating - The Job Schedule has no more work to do, or has been explicitly terminated by the user, but // the termination operation is still in progress. The scheduler will not initiate any new Jobs for this Job Schedule, nor // is any existing Job active. JobScheduleStateTerminating JobScheduleState = "terminating" )
func PossibleJobScheduleStateValues ¶
func PossibleJobScheduleStateValues() []JobScheduleState
PossibleJobScheduleStateValues returns the possible values for the JobScheduleState const type.
type JobScheduleStatistics ¶
type JobScheduleStatistics struct { // REQUIRED; The total kernel mode CPU time (summed across all cores and all Compute Nodes) consumed by all Tasks in all Jobs // created under the schedule. KernelCPUTime *string // REQUIRED; The time at which the statistics were last updated. All statistics are limited to the range between startTime // and lastUpdateTime. LastUpdateTime *time.Time // REQUIRED; The total number of Tasks that failed during the given time range in Jobs created under the schedule. A Task // fails if it exhausts its maximum retry count without returning exit code 0. NumFailedTasks *int64 // REQUIRED; The total number of Tasks successfully completed during the given time range in Jobs created under the schedule. // A Task completes successfully if it returns exit code 0. NumSucceededTasks *int64 // REQUIRED; The total number of retries during the given time range on all Tasks in all Jobs created under the schedule. NumTaskRetries *int64 // REQUIRED; The total gibibytes read from disk by all Tasks in all Jobs created under the schedule. ReadIOGiB *float32 // REQUIRED; The total number of disk read operations made by all Tasks in all Jobs created under the schedule. ReadIOPS *int64 // REQUIRED; The start time of the time range covered by the statistics. StartTime *time.Time // REQUIRED; The URL of the statistics. URL *string // REQUIRED; The total user mode CPU time (summed across all cores and all Compute Nodes) consumed by all Tasks in all Jobs // created under the schedule. UserCPUTime *string // REQUIRED; The total wait time of all Tasks in all Jobs created under the schedule. The wait time for a Task is defined // as the elapsed time between the creation of the Task and the start of Task execution. (If the Task is retried due to failures, // the wait time is the time to the most recent Task execution.). This value is only reported in the Account lifetime statistics; // it is not included in the Job statistics. WaitTime *string // REQUIRED; The total wall clock time of all the Tasks in all the Jobs created under the schedule. The wall clock time is // the elapsed time from when the Task started running on a Compute Node to when it finished (or to the last time the statistics // were updated, if the Task had not finished by then). If a Task was retried, this includes the wall clock time of all the // Task retries. WallClockTime *string // REQUIRED; The total gibibytes written to disk by all Tasks in all Jobs created under the schedule. WriteIOGiB *float32 // REQUIRED; The total number of disk write operations made by all Tasks in all Jobs created under the schedule. WriteIOPS *int64 }
JobScheduleStatistics - Resource usage statistics for a Job Schedule.
func (JobScheduleStatistics) MarshalJSON ¶
func (j JobScheduleStatistics) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type JobScheduleStatistics.
func (*JobScheduleStatistics) UnmarshalJSON ¶
func (j *JobScheduleStatistics) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type JobScheduleStatistics.
type JobSchedulingError ¶
type JobSchedulingError struct { // REQUIRED; The category of the Job scheduling error. Category *ErrorCategory // An identifier for the Job scheduling error. Codes are invariant and are intended to be consumed programmatically. Code *string // A list of additional error details related to the scheduling error. Details []NameValuePair // A message describing the Job scheduling error, intended to be suitable for display in a user interface. Message *string }
JobSchedulingError - An error encountered by the Batch service when scheduling a Job.
func (JobSchedulingError) MarshalJSON ¶
func (j JobSchedulingError) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type JobSchedulingError.
func (*JobSchedulingError) UnmarshalJSON ¶
func (j *JobSchedulingError) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type JobSchedulingError.
type JobSpecification ¶
type JobSpecification struct { // REQUIRED; The Pool on which the Batch service runs the Tasks of Jobs created under this schedule. PoolInfo *PoolInfo // Whether Tasks in this job can be preempted by other high priority jobs. If the value is set to True, other high priority // jobs submitted to the system will take precedence and will be able requeue tasks from this job. You can update a job's // allowTaskPreemption after it has been created using the update job API. AllowTaskPreemption *bool // A list of common environment variable settings. These environment variables are set for all Tasks in Jobs created under // this schedule (including the Job Manager, Job Preparation and Job Release Tasks). Individual Tasks can override an environment // setting specified here by specifying the same setting name with a different value. CommonEnvironmentSettings []EnvironmentSetting // The execution constraints for Jobs created under this schedule. Constraints *JobConstraints // The display name for Jobs created under this schedule. The name need not be unique and can contain any Unicode characters // up to a maximum length of 1024. DisplayName *string // The details of a Job Manager Task to be launched when a Job is started under this schedule. If the Job does not specify // a Job Manager Task, the user must explicitly add Tasks to the Job using the Task API. If the Job does specify a Job Manager // Task, the Batch service creates the Job Manager Task when the Job is created, and will try to schedule the Job Manager // Task before scheduling other Tasks in the Job. JobManagerTask *JobManagerTask // The Job Preparation Task for Jobs created under this schedule. If a Job has a Job Preparation Task, the Batch service will // run the Job Preparation Task on a Node before starting any Tasks of that Job on that Compute Node. JobPreparationTask *JobPreparationTask // The Job Release Task for Jobs created under this schedule. The primary purpose of the Job Release Task is to undo changes // to Nodes made by the Job Preparation Task. Example activities include deleting local files, or shutting down services that // were started as part of Job preparation. A Job Release Task cannot be specified without also specifying a Job Preparation // Task for the Job. The Batch service runs the Job Release Task on the Compute Nodes that have run the Job Preparation Task. JobReleaseTask *JobReleaseTask // The maximum number of tasks that can be executed in parallel for the job. The value of maxParallelTasks must be -1 or greater // than 0 if specified. If not specified, the default value is -1, which means there's no limit to the number of tasks that // can be run at once. You can update a job's maxParallelTasks after it has been created using the update job API. MaxParallelTasks *int32 // A list of name-value pairs associated with each Job created under this schedule as metadata. The Batch service does not // assign any meaning to metadata; it is solely for the use of user code. Metadata []MetadataItem // The network configuration for the Job. NetworkConfiguration *JobNetworkConfiguration // The action the Batch service should take when all Tasks in a Job created under this schedule are in the completed state. // Note that if a Job contains no Tasks, then all Tasks are considered complete. This option is therefore most commonly used // with a Job Manager task; if you want to use automatic Job termination without a Job Manager, you should initially set onAllTasksComplete // to noaction and update the Job properties to set onAllTasksComplete to terminatejob once you have finished adding Tasks. // The default is noaction. OnAllTasksComplete *OnAllTasksComplete // The action the Batch service should take when any Task fails in a Job created under this schedule. A Task is considered // to have failed if it have failed if has a failureInfo. A failureInfo is set if the Task completes with a non-zero exit // code after exhausting its retry count, or if there was an error starting the Task, for example due to a resource file download // error. The default is noaction. OnTaskFailure *OnTaskFailure // The priority of Jobs created under this schedule. Priority values can range from -1000 to 1000, with -1000 being the lowest // priority and 1000 being the highest priority. The default value is 0. This priority is used as the default for all Jobs // under the Job Schedule. You can update a Job's priority after it has been created using by using the update Job API. Priority *int32 // Whether Tasks in the Job can define dependencies on each other. The default is false. UsesTaskDependencies *bool }
JobSpecification - Specifies details of the Jobs to be created on a schedule.
func (JobSpecification) MarshalJSON ¶
func (j JobSpecification) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type JobSpecification.
func (*JobSpecification) UnmarshalJSON ¶
func (j *JobSpecification) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type JobSpecification.
type JobState ¶
type JobState string
JobState - BatchJobState enums
const ( // JobStateActive - The Job is available to have Tasks scheduled. JobStateActive JobState = "active" // JobStateCompleted - All Tasks have terminated, and the system will not accept any more Tasks or any further changes to // the Job. JobStateCompleted JobState = "completed" // JobStateDeleting - A user has requested that the Job be deleted, but the delete operation is still in progress (for example, // because the system is still terminating running Tasks). JobStateDeleting JobState = "deleting" // JobStateDisabled - A user has disabled the Job. No Tasks are running, and no new Tasks will be scheduled. JobStateDisabled JobState = "disabled" // JobStateDisabling - A user has requested that the Job be disabled, but the disable operation is still in progress (for // example, waiting for Tasks to terminate). JobStateDisabling JobState = "disabling" // JobStateEnabling - A user has requested that the Job be enabled, but the enable operation is still in progress. JobStateEnabling JobState = "enabling" // JobStateTerminating - The Job is about to complete, either because a Job Manager Task has completed or because the user // has terminated the Job, but the terminate operation is still in progress (for example, because Job Release Tasks are running). JobStateTerminating JobState = "terminating" )
func PossibleJobStateValues ¶
func PossibleJobStateValues() []JobState
PossibleJobStateValues returns the possible values for the JobState const type.
type JobStatistics ¶
type JobStatistics struct { // REQUIRED; The total kernel mode CPU time (summed across all cores and all Compute Nodes) consumed by all Tasks in the Job. KernelCPUTime *string // REQUIRED; The time at which the statistics were last updated. All statistics are limited to the range between startTime // and lastUpdateTime. LastUpdateTime *time.Time // REQUIRED; The total number of Tasks in the Job that failed during the given time range. A Task fails if it exhausts its // maximum retry count without returning exit code 0. NumFailedTasks *int64 // REQUIRED; The total number of Tasks successfully completed in the Job during the given time range. A Task completes successfully // if it returns exit code 0. NumSucceededTasks *int64 // REQUIRED; The total number of retries on all the Tasks in the Job during the given time range. NumTaskRetries *int64 // REQUIRED; The total amount of data in GiB read from disk by all Tasks in the Job. ReadIOGiB *float32 // REQUIRED; The total number of disk read operations made by all Tasks in the Job. ReadIOps *int64 // REQUIRED; The start time of the time range covered by the statistics. StartTime *time.Time // REQUIRED; The URL of the statistics. URL *string // REQUIRED; The total user mode CPU time (summed across all cores and all Compute Nodes) consumed by all Tasks in the Job. UserCPUTime *string // REQUIRED; The total wait time of all Tasks in the Job. The wait time for a Task is defined as the elapsed time between // the creation of the Task and the start of Task execution. (If the Task is retried due to failures, the wait time is the // time to the most recent Task execution.) This value is only reported in the Account lifetime statistics; it is not included // in the Job statistics. WaitTime *string // REQUIRED; The total wall clock time of all Tasks in the Job. The wall clock time is the elapsed time from when the Task // started running on a Compute Node to when it finished (or to the last time the statistics were updated, if the Task had // not finished by then). If a Task was retried, this includes the wall clock time of all the Task retries. WallClockTime *string // REQUIRED; The total amount of data in GiB written to disk by all Tasks in the Job. WriteIOGiB *float32 // REQUIRED; The total number of disk write operations made by all Tasks in the Job. WriteIOps *int64 }
JobStatistics - Resource usage statistics for a Job.
func (JobStatistics) MarshalJSON ¶
func (j JobStatistics) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type JobStatistics.
func (*JobStatistics) UnmarshalJSON ¶
func (j *JobStatistics) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type JobStatistics.
type LinuxUserConfiguration ¶
type LinuxUserConfiguration struct { // The group ID for the user Account. The uid and gid properties must be specified together or not at all. If not specified // the underlying operating system picks the gid. GID *int32 // The SSH private key for the user Account. The private key must not be password protected. The private key is used to automatically // configure asymmetric-key based authentication for SSH between Compute Nodes in a Linux Pool when the Pool's enableInterNodeCommunication // property is true (it is ignored if enableInterNodeCommunication is false). It does this by placing the key pair into the // user's .ssh directory. If not specified, password-less SSH is not configured between Compute Nodes (no modification of // the user's .ssh directory is done). SSHPrivateKey *string // The user ID of the user Account. The uid and gid properties must be specified together or not at all. If not specified // the underlying operating system picks the uid. UID *int32 }
LinuxUserConfiguration - Properties used to create a user Account on a Linux Compute Node.
func (LinuxUserConfiguration) MarshalJSON ¶
func (l LinuxUserConfiguration) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type LinuxUserConfiguration.
func (*LinuxUserConfiguration) UnmarshalJSON ¶
func (l *LinuxUserConfiguration) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type LinuxUserConfiguration.
type ListApplicationsOptions ¶
type ListApplicationsOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // The maximum number of items to return in the response. A maximum of 1000 // applications can be returned. MaxResults *int32 // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
ListApplicationsOptions contains the optional parameters for the Client.NewListApplicationsPager method.
type ListApplicationsResponse ¶
type ListApplicationsResponse struct { // The result of listing the applications available in an Account. ApplicationListResult // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
ListApplicationsResponse contains the response from method Client.NewListApplicationsPager.
type ListCertificatesOptions ¶
type ListCertificatesOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // An OData $filter clause. For more information on constructing this filter, see // https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-certificates. Filter *string // The maximum number of items to return in the response. A maximum of 1000 // applications can be returned. MaxResults *int32 // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // An OData $select clause. SelectParam []string // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
ListCertificatesOptions contains the optional parameters for the Client.NewListCertificatesPager method.
type ListCertificatesResponse ¶
type ListCertificatesResponse struct { // The result of listing the Certificates in the Account. CertificateListResult // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
ListCertificatesResponse contains the response from method Client.NewListCertificatesPager.
type ListJobPreparationAndReleaseTaskStatusOptions ¶
type ListJobPreparationAndReleaseTaskStatusOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // An OData $filter clause. For more information on constructing this filter, see // https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-job-preparation-and-release-status. Filter *string // The maximum number of items to return in the response. A maximum of 1000 // applications can be returned. MaxResults *int32 // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // An OData $select clause. SelectParam []string // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
ListJobPreparationAndReleaseTaskStatusOptions contains the optional parameters for the Client.NewListJobPreparationAndReleaseTaskStatusPager method.
type ListJobPreparationAndReleaseTaskStatusResponse ¶
type ListJobPreparationAndReleaseTaskStatusResponse struct { // The result of listing the status of the Job Preparation and Job Release Tasks // for a Job. JobPreparationAndReleaseTaskStatusListResult // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
ListJobPreparationAndReleaseTaskStatusResponse contains the response from method Client.NewListJobPreparationAndReleaseTaskStatusPager.
type ListJobSchedulesOptions ¶
type ListJobSchedulesOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // An OData $expand clause. Expand []string // An OData $filter clause. For more information on constructing this filter, see // https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-job-schedules. Filter *string // The maximum number of items to return in the response. A maximum of 1000 // applications can be returned. MaxResults *int32 // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // An OData $select clause. SelectParam []string // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
ListJobSchedulesOptions contains the optional parameters for the Client.NewListJobSchedulesPager method.
type ListJobSchedulesResponse ¶
type ListJobSchedulesResponse struct { // The result of listing the Job Schedules in an Account. JobScheduleListResult // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
ListJobSchedulesResponse contains the response from method Client.NewListJobSchedulesPager.
type ListJobsFromScheduleOptions ¶
type ListJobsFromScheduleOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // An OData $expand clause. Expand []string // An OData $filter clause. For more information on constructing this filter, see // https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-jobs-in-a-job-schedule. Filter *string // The maximum number of items to return in the response. A maximum of 1000 // applications can be returned. MaxResults *int32 // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // An OData $select clause. SelectParam []string // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
ListJobsFromScheduleOptions contains the optional parameters for the Client.NewListJobsFromSchedulePager method.
type ListJobsFromScheduleResponse ¶
type ListJobsFromScheduleResponse struct { // The result of listing the Jobs in an Account. JobListResult // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
ListJobsFromScheduleResponse contains the response from method Client.NewListJobsFromSchedulePager.
type ListJobsOptions ¶
type ListJobsOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // An OData $expand clause. Expand []string // An OData $filter clause. For more information on constructing this filter, see // https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-jobs. Filter *string // The maximum number of items to return in the response. A maximum of 1000 // applications can be returned. MaxResults *int32 // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // An OData $select clause. SelectParam []string // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
ListJobsOptions contains the optional parameters for the Client.NewListJobsPager method.
type ListJobsResponse ¶
type ListJobsResponse struct { // The result of listing the Jobs in an Account. JobListResult // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
ListJobsResponse contains the response from method Client.NewListJobsPager.
type ListNodeExtensionsOptions ¶
type ListNodeExtensionsOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // The maximum number of items to return in the response. A maximum of 1000 // applications can be returned. MaxResults *int32 // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // An OData $select clause. SelectParam []string // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
ListNodeExtensionsOptions contains the optional parameters for the Client.NewListNodeExtensionsPager method.
type ListNodeExtensionsResponse ¶
type ListNodeExtensionsResponse struct { // The result of listing the Compute Node extensions in a Node. NodeVMExtensionListResult // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
ListNodeExtensionsResponse contains the response from method Client.NewListNodeExtensionsPager.
type ListNodeFilesOptions ¶
type ListNodeFilesOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // An OData $filter clause. For more information on constructing this filter, see // https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-compute-node-files. Filter *string // The maximum number of items to return in the response. A maximum of 1000 // applications can be returned. MaxResults *int32 // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether to list children of a directory. Recursive *bool // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
ListNodeFilesOptions contains the optional parameters for the Client.NewListNodeFilesPager method.
type ListNodeFilesResponse ¶
type ListNodeFilesResponse struct { // The result of listing the files on a Compute Node, or the files associated with // a Task on a Compute Node. NodeFileListResult // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
ListNodeFilesResponse contains the response from method Client.NewListNodeFilesPager.
type ListNodesOptions ¶
type ListNodesOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // An OData $filter clause. For more information on constructing this filter, see // https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-nodes-in-a-pool. Filter *string // The maximum number of items to return in the response. A maximum of 1000 // applications can be returned. MaxResults *int32 // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // An OData $select clause. SelectParam []string // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
ListNodesOptions contains the optional parameters for the Client.NewListNodesPager method.
type ListNodesResponse ¶
type ListNodesResponse struct { // The result of listing the Compute Nodes in a Pool. NodeListResult // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
ListNodesResponse contains the response from method Client.NewListNodesPager.
type ListPoolNodeCountsOptions ¶
type ListPoolNodeCountsOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // An OData $filter clause. For more information on constructing this filter, see // https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-support-images. Filter *string // The maximum number of items to return in the response. A maximum of 1000 // applications can be returned. MaxResults *int32 // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
ListPoolNodeCountsOptions contains the optional parameters for the Client.NewListPoolNodeCountsPager method.
type ListPoolNodeCountsResponse ¶
type ListPoolNodeCountsResponse struct { // The result of listing the Compute Node counts in the Account. ListPoolNodeCountsResult // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
ListPoolNodeCountsResponse contains the response from method Client.NewListPoolNodeCountsPager.
type ListPoolNodeCountsResult ¶
type ListPoolNodeCountsResult struct { // The URL to get the next set of results. NextLink *string // A list of Compute Node counts by Pool. Value []PoolNodeCounts }
ListPoolNodeCountsResult - The result of listing the Compute Node counts in the Account.
func (ListPoolNodeCountsResult) MarshalJSON ¶
func (l ListPoolNodeCountsResult) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type ListPoolNodeCountsResult.
func (*ListPoolNodeCountsResult) UnmarshalJSON ¶
func (l *ListPoolNodeCountsResult) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type ListPoolNodeCountsResult.
type ListPoolsOptions ¶
type ListPoolsOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // An OData $expand clause. Expand []string // An OData $filter clause. For more information on constructing this filter, see // https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-pools. Filter *string // The maximum number of items to return in the response. A maximum of 1000 // applications can be returned. MaxResults *int32 // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // An OData $select clause. SelectParam []string // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
ListPoolsOptions contains the optional parameters for the Client.NewListPoolsPager method.
type ListPoolsResponse ¶
type ListPoolsResponse struct { // The result of listing the Pools in an Account. PoolListResult // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
ListPoolsResponse contains the response from method Client.NewListPoolsPager.
type ListSubTasksOptions ¶
type ListSubTasksOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // An OData $select clause. SelectParam []string // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
ListSubTasksOptions contains the optional parameters for the Client.NewListSubTasksPager method.
type ListSubTasksResponse ¶
type ListSubTasksResponse struct { // The result of listing the subtasks of a Task. TaskListSubtasksResult // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
ListSubTasksResponse contains the response from method Client.NewListSubTasksPager.
type ListSupportedImagesOptions ¶
type ListSupportedImagesOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // An OData $filter clause. For more information on constructing this filter, see // https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-support-images. Filter *string // The maximum number of items to return in the response. A maximum of 1000 // applications can be returned. MaxResults *int32 // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
ListSupportedImagesOptions contains the optional parameters for the Client.NewListSupportedImagesPager method.
type ListSupportedImagesResponse ¶
type ListSupportedImagesResponse struct { // The result of listing the supported Virtual Machine Images. AccountListSupportedImagesResult // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
ListSupportedImagesResponse contains the response from method Client.NewListSupportedImagesPager.
type ListTaskFilesOptions ¶
type ListTaskFilesOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // An OData $filter clause. For more information on constructing this filter, see // https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-task-files. Filter *string // The maximum number of items to return in the response. A maximum of 1000 // applications can be returned. MaxResults *int32 // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether to list children of the Task directory. This parameter can be used in // combination with the filter parameter to list specific type of files. Recursive *bool // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
ListTaskFilesOptions contains the optional parameters for the Client.NewListTaskFilesPager method.
type ListTaskFilesResponse ¶
type ListTaskFilesResponse struct { // The result of listing the files on a Compute Node, or the files associated with // a Task on a Compute Node. NodeFileListResult // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
ListTaskFilesResponse contains the response from method Client.NewListTaskFilesPager.
type ListTasksOptions ¶
type ListTasksOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // An OData $expand clause. Expand []string // An OData $filter clause. For more information on constructing this filter, see // https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-tasks. Filter *string // The maximum number of items to return in the response. A maximum of 1000 // applications can be returned. MaxResults *int32 // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // An OData $select clause. SelectParam []string // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
ListTasksOptions contains the optional parameters for the Client.NewListTasksPager method.
type ListTasksResponse ¶
type ListTasksResponse struct { // The result of listing the Tasks in a Job. TaskListResult // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
ListTasksResponse contains the response from method Client.NewListTasksPager.
type LoginMode ¶
type LoginMode string
LoginMode - LoginMode enums
const ( // LoginModeBatch - The LOGON32_LOGON_BATCH Win32 login mode. The batch login mode is recommended for long running parallel // processes. LoginModeBatch LoginMode = "batch" // LoginModeInteractive - The LOGON32_LOGON_INTERACTIVE Win32 login mode. UAC is enabled on Windows VirtualMachineConfiguration // Pools. If this option is used with an elevated user identity in a Windows VirtualMachineConfiguration Pool, the user session // will not be elevated unless the application executed by the Task command line is configured to always require administrative // privilege or to always require maximum privilege. LoginModeInteractive LoginMode = "interactive" )
func PossibleLoginModeValues ¶
func PossibleLoginModeValues() []LoginMode
PossibleLoginModeValues returns the possible values for the LoginMode const type.
type ManagedDisk ¶
type ManagedDisk struct { // Specifies the security profile settings for the managed disk. SecurityProfile *VMDiskSecurityProfile // The storage account type for managed disk. StorageAccountType *StorageAccountType }
ManagedDisk - The managed disk parameters.
func (ManagedDisk) MarshalJSON ¶
func (m ManagedDisk) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type ManagedDisk.
func (*ManagedDisk) UnmarshalJSON ¶
func (m *ManagedDisk) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type ManagedDisk.
type MetadataItem ¶
type MetadataItem struct { // REQUIRED; The name of the metadata item. Name *string // REQUIRED; The value of the metadata item. Value *string }
MetadataItem - The Batch service does not assign any meaning to this metadata; it is solely for the use of user code.
func (MetadataItem) MarshalJSON ¶
func (m MetadataItem) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type MetadataItem.
func (*MetadataItem) UnmarshalJSON ¶
func (m *MetadataItem) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type MetadataItem.
type MountConfiguration ¶
type MountConfiguration struct { // The Azure Storage Container to mount using blob FUSE on each node. This property is mutually exclusive with all other properties. AzureBlobFileSystemConfiguration *AzureBlobFileSystemConfiguration AzureFileShareConfiguration *AzureFileShareConfiguration // The CIFS/SMB file system to mount on each node. This property is mutually exclusive with all other properties. CifsMountConfiguration *CIFSMountConfiguration // The NFS file system to mount on each node. This property is mutually exclusive with all other properties. NfsMountConfiguration *NFSMountConfiguration }
MountConfiguration - The file system to mount on each node.
func (MountConfiguration) MarshalJSON ¶
func (m MountConfiguration) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type MountConfiguration.
func (*MountConfiguration) UnmarshalJSON ¶
func (m *MountConfiguration) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type MountConfiguration.
type MultiInstanceSettings ¶
type MultiInstanceSettings struct { // REQUIRED; The command line to run on all the Compute Nodes to enable them to coordinate when the primary runs the main // Task command. A typical coordination command line launches a background service and verifies that the service is ready // to process inter-node messages. CoordinationCommandLine *string // A list of files that the Batch service will download before running the coordination command line. The difference between // common resource files and Task resource files is that common resource files are downloaded for all subtasks including the // primary, whereas Task resource files are downloaded only for the primary. Also note that these resource files are not downloaded // to the Task working directory, but instead are downloaded to the Task root directory (one directory above the working directory). // There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response // error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This // can be achieved using .zip files, Application Packages, or Docker Containers. CommonResourceFiles []ResourceFile // The number of Compute Nodes required by the Task. If omitted, the default is 1. NumberOfInstances *int32 }
MultiInstanceSettings - Multi-instance Tasks are commonly used to support MPI Tasks. In the MPI case, if any of the subtasks fail (for example due to exiting with a non-zero exit code) the entire multi-instance Task fails. The multi-instance Task is then terminated and retried, up to its retry limit.
func (MultiInstanceSettings) MarshalJSON ¶
func (m MultiInstanceSettings) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type MultiInstanceSettings.
func (*MultiInstanceSettings) UnmarshalJSON ¶
func (m *MultiInstanceSettings) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type MultiInstanceSettings.
type NFSMountConfiguration ¶
type NFSMountConfiguration struct { // REQUIRED; The relative path on the compute node where the file system will be mounted. All file systems are mounted relative // to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. RelativeMountPath *string // REQUIRED; The URI of the file system to mount. Source *string // Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options // in Linux. MountOptions *string }
NFSMountConfiguration - Information used to connect to an NFS file system.
func (NFSMountConfiguration) MarshalJSON ¶
func (n NFSMountConfiguration) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type NFSMountConfiguration.
func (*NFSMountConfiguration) UnmarshalJSON ¶
func (n *NFSMountConfiguration) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type NFSMountConfiguration.
type NameValuePair ¶
type NameValuePair struct { // The name in the name-value pair. Name *string // The value in the name-value pair. Value *string }
NameValuePair - Represents a name-value pair.
func (NameValuePair) MarshalJSON ¶
func (n NameValuePair) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type NameValuePair.
func (*NameValuePair) UnmarshalJSON ¶
func (n *NameValuePair) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type NameValuePair.
type NetworkConfiguration ¶
type NetworkConfiguration struct { // The scope of dynamic vnet assignment. DynamicVNetAssignmentScope *DynamicVNetAssignmentScope // Whether this pool should enable accelerated networking. Accelerated networking enables single root I/O virtualization (SR-IOV) // to a VM, which may lead to improved networking performance. For more details, see: https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview. EnableAcceleratedNetworking *bool // The configuration for endpoints on Compute Nodes in the Batch Pool. EndpointConfiguration *PoolEndpointConfiguration // The Public IPAddress configuration for Compute Nodes in the Batch Pool. PublicIPAddressConfiguration *PublicIPAddressConfiguration // The ARM resource identifier of the virtual network subnet which the Compute Nodes of the Pool will join. This is of the // form /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. // The virtual network must be in the same region and subscription as the Azure Batch Account. The specified subnet should // have enough free IP addresses to accommodate the number of Compute Nodes in the Pool. If the subnet doesn't have enough // free IP addresses, the Pool will partially allocate Nodes and a resize error will occur. The 'MicrosoftAzureBatch' service // principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet. // The specified subnet must allow communication from the Azure Batch service to be able to schedule Tasks on the Nodes. This // can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to // the Nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the Compute Nodes to // unusable. Only ARM virtual networks ('Microsoft.Network/virtualNetworks') are supported. If the specified VNet has any // associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication, including // ports 29876 and 29877. Also enable outbound connections to Azure Storage on port 443. For more details see: https://learn.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration SubnetID *string }
NetworkConfiguration - The network configuration for a Pool.
func (NetworkConfiguration) MarshalJSON ¶
func (n NetworkConfiguration) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type NetworkConfiguration.
func (*NetworkConfiguration) UnmarshalJSON ¶
func (n *NetworkConfiguration) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type NetworkConfiguration.
type NetworkSecurityGroupRule ¶
type NetworkSecurityGroupRule struct { // REQUIRED; The action that should be taken for a specified IP address, subnet range or tag. Access *NetworkSecurityGroupRuleAccess // REQUIRED; The priority for this rule. Priorities within a Pool must be unique and are evaluated in order of priority. The // lower the number the higher the priority. For example, rules could be specified with order numbers of 150, 250, and 350. // The rule with the order number of 150 takes precedence over the rule that has an order of 250. Allowed priorities are 150 // to 4096. If any reserved or duplicate values are provided the request fails with HTTP status code 400. Priority *int32 // REQUIRED; The source address prefix or tag to match for the rule. Valid values are a single IP address (i.e. 10.10.10.10), // IP subnet (i.e. 192.168.1.0/24), default tag, or * (for all addresses). If any other values are provided the request fails // with HTTP status code 400. SourceAddressPrefix *string // The source port ranges to match for the rule. Valid values are '*' (for all ports 0 - 65535), a specific port (i.e. 22), // or a port range (i.e. 100-200). The ports must be in the range of 0 to 65535. Each entry in this collection must not overlap // any other entry (either a range or an individual port). If any other values are provided the request fails with HTTP status // code 400. The default value is '*'. SourcePortRanges []string }
NetworkSecurityGroupRule - A network security group rule to apply to an inbound endpoint.
func (NetworkSecurityGroupRule) MarshalJSON ¶
func (n NetworkSecurityGroupRule) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type NetworkSecurityGroupRule.
func (*NetworkSecurityGroupRule) UnmarshalJSON ¶
func (n *NetworkSecurityGroupRule) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type NetworkSecurityGroupRule.
type NetworkSecurityGroupRuleAccess ¶
type NetworkSecurityGroupRuleAccess string
NetworkSecurityGroupRuleAccess - NetworkSecurityGroupRuleAccess enums
const ( // NetworkSecurityGroupRuleAccessAllow - Allow access. NetworkSecurityGroupRuleAccessAllow NetworkSecurityGroupRuleAccess = "allow" // NetworkSecurityGroupRuleAccessDeny - Deny access. NetworkSecurityGroupRuleAccessDeny NetworkSecurityGroupRuleAccess = "deny" )
func PossibleNetworkSecurityGroupRuleAccessValues ¶
func PossibleNetworkSecurityGroupRuleAccessValues() []NetworkSecurityGroupRuleAccess
PossibleNetworkSecurityGroupRuleAccessValues returns the possible values for the NetworkSecurityGroupRuleAccess const type.
type Node ¶
type Node struct { // An identifier which can be passed when adding a Task to request that the Task be scheduled on this Compute Node. Note that // this is just a soft affinity. If the target Compute Node is busy or unavailable at the time the Task is scheduled, then // the Task will be scheduled elsewhere. AffinityID *string // The time at which this Compute Node was allocated to the Pool. This is the time when the Compute Node was initially allocated // and doesn't change once set. It is not updated when the Compute Node is service healed or preempted. AllocationTime *time.Time // For Windows Nodes, the Batch service installs the Certificates to the specified Certificate store and location. // For Linux Compute Nodes, the Certificates are stored in a directory inside the Task working directory and an environment // variable AZ_BATCH_CERTIFICATES_DIR is supplied to the Task to query for this location. // For Certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) // and Certificates are placed in that directory. // Warning: This property is deprecated and will be removed after February, 2024. Please use the [Azure KeyVault Extension](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) // instead. CertificateReferences []CertificateReference // The endpoint configuration for the Compute Node. EndpointConfiguration *NodeEndpointConfiguration // The list of errors that are currently being encountered by the Compute Node. Errors []NodeError // The ID of the Compute Node. Every Compute Node that is added to a Pool is assigned a unique ID. Whenever a Compute Node // is removed from a Pool, all of its local files are deleted, and the ID is reclaimed and could be reused for new Compute // Nodes. ID *string // The IP address that other Nodes can use to communicate with this Compute Node. Every Compute Node that is added to a Pool // is assigned a unique IP address. Whenever a Compute Node is removed from a Pool, all of its local files are deleted, and // the IP address is reclaimed and could be reused for new Compute Nodes. IPAddress *string // Whether this Compute Node is a dedicated Compute Node. If false, the Compute Node is a Spot/Low-priority Compute Node. IsDedicated *bool // The last time at which the Compute Node was started. This property may not be present if the Compute Node state is unusable. LastBootTime *time.Time // Information about the Compute Node agent version and the time the Compute Node upgraded to a new version. NodeAgentInfo *NodeAgentInfo // A list of Tasks whose state has recently changed. This property is present only if at least one Task has run on this Compute // Node since it was assigned to the Pool. RecentTasks []TaskInfo // The total number of scheduling slots used by currently running Job Tasks on the Compute Node. This includes Job Manager // Tasks and normal Tasks, but not Job Preparation, Job Release or Start Tasks. RunningTaskSlotsCount *int32 // The total number of currently running Job Tasks on the Compute Node. This includes Job Manager Tasks and normal Tasks, // but not Job Preparation, Job Release or Start Tasks. RunningTasksCount *int32 // Whether the Compute Node is available for Task scheduling. SchedulingState *SchedulingState // The Task specified to run on the Compute Node as it joins the Pool. StartTask *StartTask // Runtime information about the execution of the StartTask on the Compute Node. StartTaskInfo *StartTaskInfo // The current state of the Compute Node. The Spot/Low-priority Compute Node has been preempted. Tasks which were running // on the Compute Node when it was preempted will be rescheduled when another Compute Node becomes available. State *NodeState // The time at which the Compute Node entered its current state. StateTransitionTime *time.Time // The total number of Job Tasks completed on the Compute Node. This includes Job Manager Tasks and normal Tasks, but not // Job Preparation, Job Release or Start Tasks. TotalTasksRun *int32 // The total number of Job Tasks which completed successfully (with exitCode 0) on the Compute Node. This includes Job Manager // Tasks and normal Tasks, but not Job Preparation, Job Release or Start Tasks. TotalTasksSucceeded *int32 // The URL of the Compute Node. URL *string // The size of the virtual machine hosting the Compute Node. For information about available sizes of virtual machines in // Pools, see Choose a VM size for Compute Nodes in an Azure Batch Pool (https://learn.microsoft.com/azure/batch/batch-pool-vm-sizes). VMSize *string // Info about the current state of the virtual machine. VirtualMachineInfo *VirtualMachineInfo }
Node - A Compute Node in the Batch service.
func (Node) MarshalJSON ¶
MarshalJSON implements the json.Marshaller interface for type Node.
func (*Node) UnmarshalJSON ¶
UnmarshalJSON implements the json.Unmarshaller interface for type Node.
type NodeAgentInfo ¶
type NodeAgentInfo struct { // REQUIRED; The time when the Compute Node agent was updated on the Compute Node. This is the most recent time that the Compute // Node agent was updated to a new version. LastUpdateTime *time.Time // REQUIRED; The version of the Batch Compute Node agent running on the Compute Node. This version number can be checked against // the Compute Node agent release notes located at https://github.com/Azure/Batch/blob/master/changelogs/nodeagent/CHANGELOG.md. Version *string }
NodeAgentInfo - The Batch Compute Node agent is a program that runs on each Compute Node in the Pool and provides Batch capability on the Compute Node.
func (NodeAgentInfo) MarshalJSON ¶
func (n NodeAgentInfo) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type NodeAgentInfo.
func (*NodeAgentInfo) UnmarshalJSON ¶
func (n *NodeAgentInfo) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type NodeAgentInfo.
type NodeCommunicationMode ¶
type NodeCommunicationMode string
NodeCommunicationMode - BatchNodeCommunicationMode enums
const ( // NodeCommunicationModeClassic - Nodes using the classic communication mode require inbound TCP communication on ports 29876 // and 29877 from the "BatchNodeManagement.{region}" service tag and outbound TCP communication on port 443 to the "Storage.region" // and "BatchNodeManagement.{region}" service tags. NodeCommunicationModeClassic NodeCommunicationMode = "classic" // NodeCommunicationModeDefault - The node communication mode is automatically set by the Batch service. NodeCommunicationModeDefault NodeCommunicationMode = "default" // NodeCommunicationModeSimplified - Nodes using the simplified communication mode require outbound TCP communication on port // 443 to the "BatchNodeManagement.{region}" service tag. No open inbound ports are required. NodeCommunicationModeSimplified NodeCommunicationMode = "simplified" )
func PossibleNodeCommunicationModeValues ¶
func PossibleNodeCommunicationModeValues() []NodeCommunicationMode
PossibleNodeCommunicationModeValues returns the possible values for the NodeCommunicationMode const type.
type NodeCounts ¶
type NodeCounts struct { // REQUIRED; The number of Compute Nodes in the creating state. Creating *int32 // REQUIRED; The number of Compute Nodes in the deallocated state. Deallocated *int32 // REQUIRED; The number of Compute Nodes in the deallocating state. Deallocating *int32 // REQUIRED; The number of Compute Nodes in the idle state. Idle *int32 // REQUIRED; The number of Compute Nodes in the leavingPool state. LeavingPool *int32 // REQUIRED; The number of Compute Nodes in the offline state. Offline *int32 // REQUIRED; The number of Compute Nodes in the preempted state. Preempted *int32 // REQUIRED; The count of Compute Nodes in the rebooting state. Rebooting *int32 // REQUIRED; The number of Compute Nodes in the reimaging state. Reimaging *int32 // REQUIRED; The number of Compute Nodes in the running state. Running *int32 // REQUIRED; The number of Compute Nodes in the startTaskFailed state. StartTaskFailed *int32 // REQUIRED; The number of Compute Nodes in the starting state. Starting *int32 // REQUIRED; The total number of Compute Nodes. Total *int32 // REQUIRED; The number of Compute Nodes in the unknown state. Unknown *int32 // REQUIRED; The number of Compute Nodes in the unusable state. Unusable *int32 // REQUIRED; The number of Compute Nodes in the upgradingOS state. UpgradingOS *int32 // REQUIRED; The number of Compute Nodes in the waitingForStartTask state. WaitingForStartTask *int32 }
NodeCounts - The number of Compute Nodes in each Compute Node state.
func (NodeCounts) MarshalJSON ¶
func (n NodeCounts) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type NodeCounts.
func (*NodeCounts) UnmarshalJSON ¶
func (n *NodeCounts) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type NodeCounts.
type NodeDeallocateOption ¶
type NodeDeallocateOption string
NodeDeallocateOption - BatchNodeDeallocateOption enums
const ( // NodeDeallocateOptionRequeue - Terminate running Task processes and requeue the Tasks. The Tasks will run again when a Compute // Node is available. Deallocate the Compute Node as soon as Tasks have been terminated. NodeDeallocateOptionRequeue NodeDeallocateOption = "requeue" // NodeDeallocateOptionRetainedData - Allow currently running Tasks to complete, then wait for all Task data retention periods // to expire. Schedule no new Tasks while waiting. Deallocate the Compute Node when all Task retention periods have expired. NodeDeallocateOptionRetainedData NodeDeallocateOption = "retaineddata" // NodeDeallocateOptionTaskCompletion - Allow currently running Tasks to complete. Schedule no new Tasks while waiting. Deallocate // the Compute Node when all Tasks have completed. NodeDeallocateOptionTaskCompletion NodeDeallocateOption = "taskcompletion" // NodeDeallocateOptionTerminate - Terminate running Tasks. The Tasks will be completed with failureInfo indicating that they // were terminated, and will not run again. Deallocate the Compute Node as soon as Tasks have been terminated. NodeDeallocateOptionTerminate NodeDeallocateOption = "terminate" )
func PossibleNodeDeallocateOptionValues ¶
func PossibleNodeDeallocateOptionValues() []NodeDeallocateOption
PossibleNodeDeallocateOptionValues returns the possible values for the NodeDeallocateOption const type.
type NodeDeallocationOption ¶
type NodeDeallocationOption string
NodeDeallocationOption - BatchNodeDeallocationOption enums
const ( // NodeDeallocationOptionRequeue - Terminate running Task processes and requeue the Tasks. The Tasks will run again when a // Compute Node is available. Remove Compute Nodes as soon as Tasks have been terminated. NodeDeallocationOptionRequeue NodeDeallocationOption = "requeue" // NodeDeallocationOptionRetainedData - Allow currently running Tasks to complete, then wait for all Task data retention periods // to expire. Schedule no new Tasks while waiting. Remove Compute Nodes when all Task retention periods have expired. NodeDeallocationOptionRetainedData NodeDeallocationOption = "retaineddata" // NodeDeallocationOptionTaskCompletion - Allow currently running Tasks to complete. Schedule no new Tasks while waiting. // Remove Compute Nodes when all Tasks have completed. NodeDeallocationOptionTaskCompletion NodeDeallocationOption = "taskcompletion" // NodeDeallocationOptionTerminate - Terminate running Tasks. The Tasks will be completed with failureInfo indicating that // they were terminated, and will not run again. Remove Compute Nodes as soon as Tasks have been terminated. NodeDeallocationOptionTerminate NodeDeallocationOption = "terminate" )
func PossibleNodeDeallocationOptionValues ¶
func PossibleNodeDeallocationOptionValues() []NodeDeallocationOption
PossibleNodeDeallocationOptionValues returns the possible values for the NodeDeallocationOption const type.
type NodeDisableSchedulingOption ¶
type NodeDisableSchedulingOption string
NodeDisableSchedulingOption - BatchNodeDisableSchedulingOption enums
const ( // NodeDisableSchedulingOptionRequeue - Terminate running Task processes and requeue the Tasks. The Tasks may run again on // other Compute Nodes, or when Task scheduling is re-enabled on this Compute Node. Enter offline state as soon as Tasks have // been terminated. NodeDisableSchedulingOptionRequeue NodeDisableSchedulingOption = "requeue" // NodeDisableSchedulingOptionTaskCompletion - Allow currently running Tasks to complete. Schedule no new Tasks while waiting. // Enter offline state when all Tasks have completed. NodeDisableSchedulingOptionTaskCompletion NodeDisableSchedulingOption = "taskcompletion" // NodeDisableSchedulingOptionTerminate - Terminate running Tasks. The Tasks will be completed with failureInfo indicating // that they were terminated, and will not run again. Enter offline state as soon as Tasks have been terminated. NodeDisableSchedulingOptionTerminate NodeDisableSchedulingOption = "terminate" )
func PossibleNodeDisableSchedulingOptionValues ¶
func PossibleNodeDisableSchedulingOptionValues() []NodeDisableSchedulingOption
PossibleNodeDisableSchedulingOptionValues returns the possible values for the NodeDisableSchedulingOption const type.
type NodeEndpointConfiguration ¶
type NodeEndpointConfiguration struct { // REQUIRED; The list of inbound endpoints that are accessible on the Compute Node. InboundEndpoints []InboundEndpoint }
NodeEndpointConfiguration - The endpoint configuration for the Compute Node.
func (NodeEndpointConfiguration) MarshalJSON ¶
func (n NodeEndpointConfiguration) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type NodeEndpointConfiguration.
func (*NodeEndpointConfiguration) UnmarshalJSON ¶
func (n *NodeEndpointConfiguration) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type NodeEndpointConfiguration.
type NodeError ¶
type NodeError struct { // An identifier for the Compute Node error. Codes are invariant and are intended to be consumed programmatically. Code *string // The list of additional error details related to the Compute Node error. ErrorDetails []NameValuePair // A message describing the Compute Node error, intended to be suitable for display in a user interface. Message *string }
NodeError - An error encountered by a Compute Node.
func (NodeError) MarshalJSON ¶
MarshalJSON implements the json.Marshaller interface for type NodeError.
func (*NodeError) UnmarshalJSON ¶
UnmarshalJSON implements the json.Unmarshaller interface for type NodeError.
type NodeFile ¶
type NodeFile struct { // Whether the object represents a directory. IsDirectory *bool // The file path. Name *string // The file properties. Properties *FileProperties // The URL of the file. URL *string }
NodeFile - Information about a file or directory on a Compute Node.
func (NodeFile) MarshalJSON ¶
MarshalJSON implements the json.Marshaller interface for type NodeFile.
func (*NodeFile) UnmarshalJSON ¶
UnmarshalJSON implements the json.Unmarshaller interface for type NodeFile.
type NodeFileListResult ¶
type NodeFileListResult struct { // The URL to get the next set of results. NextLink *string // The list of files. Value []NodeFile }
NodeFileListResult - The result of listing the files on a Compute Node, or the files associated with a Task on a Compute Node.
func (NodeFileListResult) MarshalJSON ¶
func (n NodeFileListResult) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type NodeFileListResult.
func (*NodeFileListResult) UnmarshalJSON ¶
func (n *NodeFileListResult) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type NodeFileListResult.
type NodeFillType ¶
type NodeFillType string
NodeFillType - BatchNodeFillType enums
const ( // NodeFillTypePack - As many Tasks as possible (taskSlotsPerNode) should be assigned to each Compute Node in the Pool before // any Tasks are assigned to the next Compute Node in the Pool. NodeFillTypePack NodeFillType = "pack" // NodeFillTypeSpread - Tasks should be assigned evenly across all Compute Nodes in the Pool. NodeFillTypeSpread NodeFillType = "spread" )
func PossibleNodeFillTypeValues ¶
func PossibleNodeFillTypeValues() []NodeFillType
PossibleNodeFillTypeValues returns the possible values for the NodeFillType const type.
type NodeIdentityReference ¶
type NodeIdentityReference struct { // The ARM resource id of the user assigned identity. ResourceID *string }
NodeIdentityReference - The reference to a user assigned identity associated with the Batch pool which a compute node will use.
func (NodeIdentityReference) MarshalJSON ¶
func (n NodeIdentityReference) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type NodeIdentityReference.
func (*NodeIdentityReference) UnmarshalJSON ¶
func (n *NodeIdentityReference) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type NodeIdentityReference.
type NodeInfo ¶
type NodeInfo struct { // An identifier for the Node on which the Task ran, which can be passed when adding a Task to request that the Task be scheduled // on this Compute Node. AffinityID *string // The ID of the Compute Node on which the Task ran. NodeID *string // The URL of the Compute Node on which the Task ran. NodeURL *string // The ID of the Pool on which the Task ran. PoolID *string // The root directory of the Task on the Compute Node. TaskRootDirectory *string // The URL to the root directory of the Task on the Compute Node. TaskRootDirectoryURL *string }
NodeInfo - Information about the Compute Node on which a Task ran.
func (NodeInfo) MarshalJSON ¶
MarshalJSON implements the json.Marshaller interface for type NodeInfo.
func (*NodeInfo) UnmarshalJSON ¶
UnmarshalJSON implements the json.Unmarshaller interface for type NodeInfo.
type NodeListResult ¶
type NodeListResult struct { // The URL to get the next set of results. NextLink *string // The list of Compute Nodes. Value []Node }
NodeListResult - The result of listing the Compute Nodes in a Pool.
func (NodeListResult) MarshalJSON ¶
func (n NodeListResult) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type NodeListResult.
func (*NodeListResult) UnmarshalJSON ¶
func (n *NodeListResult) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type NodeListResult.
type NodePlacementConfiguration ¶
type NodePlacementConfiguration struct { // Node placement Policy type on Batch Pools. Allocation policy used by Batch Service to provision the nodes. If not specified, // Batch will use the regional policy. Policy *NodePlacementPolicyType }
NodePlacementConfiguration - For regional placement, nodes in the pool will be allocated in the same region. For zonal placement, nodes in the pool will be spread across different zones with best effort balancing.
func (NodePlacementConfiguration) MarshalJSON ¶
func (n NodePlacementConfiguration) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type NodePlacementConfiguration.
func (*NodePlacementConfiguration) UnmarshalJSON ¶
func (n *NodePlacementConfiguration) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type NodePlacementConfiguration.
type NodePlacementPolicyType ¶
type NodePlacementPolicyType string
NodePlacementPolicyType - BatchNodePlacementPolicyType enums
const ( // NodePlacementPolicyTypeRegional - All nodes in the pool will be allocated in the same region. NodePlacementPolicyTypeRegional NodePlacementPolicyType = "regional" // NodePlacementPolicyTypeZonal - Nodes in the pool will be spread across different availability zones with best effort balancing. NodePlacementPolicyTypeZonal NodePlacementPolicyType = "zonal" )
func PossibleNodePlacementPolicyTypeValues ¶
func PossibleNodePlacementPolicyTypeValues() []NodePlacementPolicyType
PossibleNodePlacementPolicyTypeValues returns the possible values for the NodePlacementPolicyType const type.
type NodeRebootOption ¶
type NodeRebootOption string
NodeRebootOption - BatchNodeRebootOption enums
const ( // NodeRebootOptionRequeue - Terminate running Task processes and requeue the Tasks. The Tasks will run again when a Compute // Node is available. Restart the Compute Node as soon as Tasks have been terminated. NodeRebootOptionRequeue NodeRebootOption = "requeue" // NodeRebootOptionRetainedData - Allow currently running Tasks to complete, then wait for all Task data retention periods // to expire. Schedule no new Tasks while waiting. Restart the Compute Node when all Task retention periods have expired. NodeRebootOptionRetainedData NodeRebootOption = "retaineddata" // NodeRebootOptionTaskCompletion - Allow currently running Tasks to complete. Schedule no new Tasks while waiting. Restart // the Compute Node when all Tasks have completed. NodeRebootOptionTaskCompletion NodeRebootOption = "taskcompletion" // NodeRebootOptionTerminate - Terminate running Tasks. The Tasks will be completed with failureInfo indicating that they // were terminated, and will not run again. Restart the Compute Node as soon as Tasks have been terminated. NodeRebootOptionTerminate NodeRebootOption = "terminate" )
func PossibleNodeRebootOptionValues ¶
func PossibleNodeRebootOptionValues() []NodeRebootOption
PossibleNodeRebootOptionValues returns the possible values for the NodeRebootOption const type.
type NodeReimageOption ¶
type NodeReimageOption string
NodeReimageOption - BatchNodeReimageOption enums
const ( // NodeReimageOptionRequeue - Terminate running Task processes and requeue the Tasks. The Tasks will run again when a Compute // Node is available. Reimage the Compute Node as soon as Tasks have been terminated. NodeReimageOptionRequeue NodeReimageOption = "requeue" // NodeReimageOptionRetainedData - Allow currently running Tasks to complete, then wait for all Task data retention periods // to expire. Schedule no new Tasks while waiting. Reimage the Compute Node when all Task retention periods have expired. NodeReimageOptionRetainedData NodeReimageOption = "retaineddata" // NodeReimageOptionTaskCompletion - Allow currently running Tasks to complete. Schedule no new Tasks while waiting. Reimage // the Compute Node when all Tasks have completed. NodeReimageOptionTaskCompletion NodeReimageOption = "taskcompletion" // NodeReimageOptionTerminate - Terminate running Tasks. The Tasks will be completed with failureInfo indicating that they // were terminated, and will not run again. Reimage the Compute Node as soon as Tasks have been terminated. NodeReimageOptionTerminate NodeReimageOption = "terminate" )
func PossibleNodeReimageOptionValues ¶
func PossibleNodeReimageOptionValues() []NodeReimageOption
PossibleNodeReimageOptionValues returns the possible values for the NodeReimageOption const type.
type NodeRemoteLoginSettings ¶
type NodeRemoteLoginSettings struct { // REQUIRED; The IP address used for remote login to the Compute Node. RemoteLoginIPAddress *string // REQUIRED; The port used for remote login to the Compute Node. RemoteLoginPort *int32 }
NodeRemoteLoginSettings - The remote login settings for a Compute Node.
func (NodeRemoteLoginSettings) MarshalJSON ¶
func (n NodeRemoteLoginSettings) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type NodeRemoteLoginSettings.
func (*NodeRemoteLoginSettings) UnmarshalJSON ¶
func (n *NodeRemoteLoginSettings) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type NodeRemoteLoginSettings.
type NodeState ¶
type NodeState string
NodeState - BatchNodeState enums
const ( // NodeStateCreating - The Batch service has obtained the underlying virtual machine from Azure Compute, but it has not yet // started to join the Pool. NodeStateCreating NodeState = "creating" // NodeStateDeallocated - The Compute Node is deallocated. NodeStateDeallocated NodeState = "deallocated" // NodeStateDeallocating - The Compute Node is deallocating. NodeStateDeallocating NodeState = "deallocating" // NodeStateIdle - The Compute Node is not currently running a Task. NodeStateIdle NodeState = "idle" // NodeStateLeavingPool - The Compute Node is leaving the Pool, either because the user explicitly removed it or because the // Pool is resizing or autoscaling down. NodeStateLeavingPool NodeState = "leavingpool" // NodeStateOffline - The Compute Node is not currently running a Task, and scheduling of new Tasks to the Compute Node is // disabled. NodeStateOffline NodeState = "offline" // NodeStatePreempted - The Spot/Low-priority Compute Node has been preempted. Tasks which were running on the Compute Node // when it was preempted will be rescheduled when another Compute Node becomes available. NodeStatePreempted NodeState = "preempted" // NodeStateRebooting - The Compute Node is rebooting. NodeStateRebooting NodeState = "rebooting" // NodeStateReimaging - The Compute Node is reimaging. NodeStateReimaging NodeState = "reimaging" // NodeStateRunning - The Compute Node is running one or more Tasks (other than a StartTask). NodeStateRunning NodeState = "running" // NodeStateStartTaskFailed - The StartTask has failed on the Compute Node (and exhausted all retries), and waitForSuccess // is set. The Compute Node is not usable for running Tasks. NodeStateStartTaskFailed NodeState = "starttaskfailed" // NodeStateStarting - The Batch service is starting on the underlying virtual machine. NodeStateStarting NodeState = "starting" // NodeStateUnknown - The Batch service has lost contact with the Compute Node, and does not know its true state. NodeStateUnknown NodeState = "unknown" // NodeStateUnusable - The Compute Node cannot be used for Task execution due to errors. NodeStateUnusable NodeState = "unusable" // NodeStateUpgradingOS - The Compute Node is undergoing an OS upgrade operation. NodeStateUpgradingOS NodeState = "upgradingos" // NodeStateWaitingForStartTask - The StartTask has started running on the Compute Node, but waitForSuccess is set and the // StartTask has not yet completed. NodeStateWaitingForStartTask NodeState = "waitingforstarttask" )
func PossibleNodeStateValues ¶
func PossibleNodeStateValues() []NodeState
PossibleNodeStateValues returns the possible values for the NodeState const type.
type NodeVMExtension ¶
type NodeVMExtension struct { // The vm extension instance view. InstanceView *VMExtensionInstanceView // The provisioning state of the virtual machine extension. ProvisioningState *string // The virtual machine extension. VMExtension *VMExtension }
NodeVMExtension - The configuration for virtual machine extension instance view.
func (NodeVMExtension) MarshalJSON ¶
func (n NodeVMExtension) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type NodeVMExtension.
func (*NodeVMExtension) UnmarshalJSON ¶
func (n *NodeVMExtension) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type NodeVMExtension.
type NodeVMExtensionListResult ¶
type NodeVMExtensionListResult struct { // The URL to get the next set of results. NextLink *string // The list of Compute Node extensions. Value []NodeVMExtension }
NodeVMExtensionListResult - The result of listing the Compute Node extensions in a Node.
func (NodeVMExtensionListResult) MarshalJSON ¶
func (n NodeVMExtensionListResult) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type NodeVMExtensionListResult.
func (*NodeVMExtensionListResult) UnmarshalJSON ¶
func (n *NodeVMExtensionListResult) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type NodeVMExtensionListResult.
type OSDisk ¶
type OSDisk struct { // Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The default values are: None for Standard // storage. ReadOnly for Premium storage. Caching *CachingType // The initial disk size in GB when creating new OS disk. DiskSizeGB *int32 // Specifies the ephemeral Disk Settings for the operating system disk used by the compute node (VM). EphemeralOSDiskSettings *DiffDiskSettings // The managed disk parameters. ManagedDisk *ManagedDisk // Specifies whether writeAccelerator should be enabled or disabled on the disk. WriteAcceleratorEnabled *bool }
OSDisk - Settings for the operating system disk of the compute node (VM).
func (OSDisk) MarshalJSON ¶
MarshalJSON implements the json.Marshaller interface for type OSDisk.
func (*OSDisk) UnmarshalJSON ¶
UnmarshalJSON implements the json.Unmarshaller interface for type OSDisk.
type OSType ¶
type OSType string
OSType - OSType enums
func PossibleOSTypeValues ¶
func PossibleOSTypeValues() []OSType
PossibleOSTypeValues returns the possible values for the OSType const type.
type OnAllTasksComplete ¶
type OnAllTasksComplete string
OnAllTasksComplete - The action the Batch service should take when all Tasks in the Job are in the completed state.
const ( // OnAllTasksCompleteNoAction - Do nothing. The Job remains active unless terminated or disabled by some other means. OnAllTasksCompleteNoAction OnAllTasksComplete = "noaction" // OnAllTasksCompleteTerminateJob - Terminate the Job. The Job's terminationReason is set to 'AllTasksComplete'. OnAllTasksCompleteTerminateJob OnAllTasksComplete = "terminatejob" )
func PossibleOnAllTasksCompleteValues ¶
func PossibleOnAllTasksCompleteValues() []OnAllTasksComplete
PossibleOnAllTasksCompleteValues returns the possible values for the OnAllTasksComplete const type.
type OnTaskFailure ¶
type OnTaskFailure string
OnTaskFailure - OnTaskFailure enums
const ( // OnTaskFailureNoAction - Do nothing. The Job remains active unless terminated or disabled by some other means. OnTaskFailureNoAction OnTaskFailure = "noaction" // OnTaskFailurePerformExitOptionsJobAction - Terminate the Job. The Job's terminationReason is set to 'AllTasksComplete'. OnTaskFailurePerformExitOptionsJobAction OnTaskFailure = "performexitoptionsjobaction" )
func PossibleOnTaskFailureValues ¶
func PossibleOnTaskFailureValues() []OnTaskFailure
PossibleOnTaskFailureValues returns the possible values for the OnTaskFailure const type.
type OutputFile ¶
type OutputFile struct { // REQUIRED; The destination for the output file(s). Destination *OutputFileDestination // REQUIRED; A pattern indicating which file(s) to upload. Both relative and absolute paths are supported. Relative paths // are relative to the Task working directory. The following wildcards are supported: * matches 0 or more characters (for // example pattern abc* would match abc or abcdef), ** matches any directory, ? matches any single character, [abc] matches // one character in the brackets, and [a-c] matches one character in the range. Brackets can include a negation to match any // character not specified (for example [!abc] matches any character but a, b, or c). If a file name starts with "." it is // ignored by default but may be matched by specifying it explicitly (for example *.gif will not match .a.gif, but .*.gif // will). A simple example: **\*.txt matches any file that does not start in '.' and ends with .txt in the Task working directory // or any subdirectory. If the filename contains a wildcard character it can be escaped using brackets (for example abc[*] // would match a file named abc*). Note that both \ and / are treated as directory separators on Windows, but only / is on // Linux. Environment variables (%var% on Windows or $var on Linux) are expanded prior to the pattern being applied. FilePattern *string // REQUIRED; Additional options for the upload operation, including under what conditions to perform the upload. UploadOptions *OutputFileUploadConfig }
OutputFile - On every file uploads, Batch service writes two log files to the compute node, 'fileuploadout.txt' and 'fileuploaderr.txt'. These log files are used to learn more about a specific failure.
func (OutputFile) MarshalJSON ¶
func (o OutputFile) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type OutputFile.
func (*OutputFile) UnmarshalJSON ¶
func (o *OutputFile) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type OutputFile.
type OutputFileBlobContainerDestination ¶
type OutputFileBlobContainerDestination struct { // REQUIRED; The URL of the container within Azure Blob Storage to which to upload the file(s). If not using a managed identity, // the URL must include a Shared Access Signature (SAS) granting write permissions to the container. ContainerURL *string // The reference to the user assigned identity to use to access Azure Blob Storage specified by containerUrl. The identity // must have write access to the Azure Blob Storage container. IdentityReference *NodeIdentityReference // The destination blob or virtual directory within the Azure Storage container. If filePattern refers to a specific file // (i.e. contains no wildcards), then path is the name of the blob to which to upload that file. If filePattern contains one // or more wildcards (and therefore may match multiple files), then path is the name of the blob virtual directory (which // is prepended to each blob name) to which to upload the file(s). If omitted, file(s) are uploaded to the root of the container // with a blob name matching their file name. Path *string // A list of name-value pairs for headers to be used in uploading output files. These headers will be specified when uploading // files to Azure Storage. Official document on allowed headers when uploading blobs: https://learn.microsoft.com/rest/api/storageservices/put-blob#request-headers-all-blob-types. UploadHeaders []HTTPHeader }
OutputFileBlobContainerDestination - Specifies a file upload destination within an Azure blob storage container.
func (OutputFileBlobContainerDestination) MarshalJSON ¶
func (o OutputFileBlobContainerDestination) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type OutputFileBlobContainerDestination.
func (*OutputFileBlobContainerDestination) UnmarshalJSON ¶
func (o *OutputFileBlobContainerDestination) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type OutputFileBlobContainerDestination.
type OutputFileDestination ¶
type OutputFileDestination struct { // A location in Azure blob storage to which files are uploaded. Container *OutputFileBlobContainerDestination }
OutputFileDestination - The destination to which a file should be uploaded.
func (OutputFileDestination) MarshalJSON ¶
func (o OutputFileDestination) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type OutputFileDestination.
func (*OutputFileDestination) UnmarshalJSON ¶
func (o *OutputFileDestination) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type OutputFileDestination.
type OutputFileUploadCondition ¶
type OutputFileUploadCondition string
OutputFileUploadCondition - OutputFileUploadCondition enums
const ( // OutputFileUploadConditionTaskCompletion - Upload the file(s) after the Task process exits, no matter what the exit code // was. OutputFileUploadConditionTaskCompletion OutputFileUploadCondition = "taskcompletion" // OutputFileUploadConditionTaskFailure - Upload the file(s) only after the Task process exits with a nonzero exit code. OutputFileUploadConditionTaskFailure OutputFileUploadCondition = "taskfailure" // OutputFileUploadConditionTaskSuccess - Upload the file(s) only after the Task process exits with an exit code of 0. OutputFileUploadConditionTaskSuccess OutputFileUploadCondition = "tasksuccess" )
func PossibleOutputFileUploadConditionValues ¶
func PossibleOutputFileUploadConditionValues() []OutputFileUploadCondition
PossibleOutputFileUploadConditionValues returns the possible values for the OutputFileUploadCondition const type.
type OutputFileUploadConfig ¶
type OutputFileUploadConfig struct { // REQUIRED; The conditions under which the Task output file or set of files should be uploaded. The default is taskcompletion. UploadCondition *OutputFileUploadCondition }
OutputFileUploadConfig - Options for an output file upload operation, including under what conditions to perform the upload.
func (OutputFileUploadConfig) MarshalJSON ¶
func (o OutputFileUploadConfig) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type OutputFileUploadConfig.
func (*OutputFileUploadConfig) UnmarshalJSON ¶
func (o *OutputFileUploadConfig) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type OutputFileUploadConfig.
type Pool ¶
type Pool struct { // A Task specified to run on each Compute Node as it joins the Pool. StartTask *StartTask // The desired node communication mode for the pool. If omitted, the default value is Default. TargetNodeCommunicationMode *NodeCommunicationMode // The upgrade policy for the Pool. Describes an upgrade policy - automatic, manual, or rolling. UpgradePolicy *UpgradePolicy // READ-ONLY; Whether the Pool is resizing. AllocationState *AllocationState // READ-ONLY; The time at which the Pool entered its current allocation state. AllocationStateTransitionTime *time.Time // READ-ONLY; The list of Packages to be installed on each Compute Node in the Pool. Changes to Package references affect // all new Nodes joining the Pool, but do not affect Compute Nodes that are already in the Pool until they are rebooted or // reimaged. There is a maximum of 10 Package references on any given Pool. ApplicationPackageReferences []ApplicationPackageReference // READ-ONLY; The time interval at which to automatically adjust the Pool size according to the autoscale formula. This property // is set only if the Pool automatically scales, i.e. enableAutoScale is true. AutoScaleEvaluationInterval *string // READ-ONLY; A formula for the desired number of Compute Nodes in the Pool. This property is set only if the Pool automatically // scales, i.e. enableAutoScale is true. AutoScaleFormula *string // READ-ONLY; The results and errors from the last execution of the autoscale formula. This property is set only if the Pool // automatically scales, i.e. enableAutoScale is true. AutoScaleRun *AutoScaleRun // READ-ONLY; For Windows Nodes, the Batch service installs the Certificates to the specified Certificate store and location. // For Linux Compute Nodes, the Certificates are stored in a directory inside the Task working directory and an environment // variable AZ_BATCH_CERTIFICATES_DIR is supplied to the Task to query for this location. // For Certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) // and Certificates are placed in that directory. // Warning: This property is deprecated and will be removed after February, 2024. Please use the [Azure KeyVault Extension](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) // instead. CertificateReferences []CertificateReference // READ-ONLY; The creation time of the Pool. CreationTime *time.Time // READ-ONLY; The number of dedicated Compute Nodes currently in the Pool. CurrentDedicatedNodes *int32 // READ-ONLY; The number of Spot/Low-priority Compute Nodes currently in the Pool. Spot/Low-priority Compute Nodes which have // been preempted are included in this count. CurrentLowPriorityNodes *int32 // READ-ONLY; The current state of the pool communication mode. CurrentNodeCommunicationMode *NodeCommunicationMode // READ-ONLY; The display name for the Pool. The display name need not be unique and can contain any Unicode characters up // to a maximum length of 1024. DisplayName *string // READ-ONLY; The ETag of the Pool. This is an opaque string. You can use it to detect whether the Pool has changed between // requests. In particular, you can be pass the ETag when updating a Pool to specify that your changes should take effect // only if nobody else has modified the Pool in the meantime. ETag *azcore.ETag // READ-ONLY; Whether the Pool size should automatically adjust over time. If false, at least one of targetDedicatedNodes // and targetLowPriorityNodes must be specified. If true, the autoScaleFormula property is required and the Pool automatically // resizes according to the formula. The default value is false. EnableAutoScale *bool // READ-ONLY; Whether the Pool permits direct communication between Compute Nodes. This imposes restrictions on which Compute // Nodes can be assigned to the Pool. Specifying this value can reduce the chance of the requested number of Compute Nodes // to be allocated in the Pool. EnableInterNodeCommunication *bool // READ-ONLY; A string that uniquely identifies the Pool within the Account. The ID can contain any combination of alphanumeric // characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and // case-insensitive (that is, you may not have two IDs within an Account that differ only by case). ID *string // READ-ONLY; The identity of the Batch pool, if configured. The list of user identities associated with the Batch pool. The // user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. Identity *PoolIdentity // READ-ONLY; The last modified time of the Pool. This is the last time at which the Pool level data, such as the targetDedicatedNodes // or enableAutoscale settings, changed. It does not factor in node-level changes such as a Compute Node changing state. LastModified *time.Time // READ-ONLY; A list of name-value pairs associated with the Pool as metadata. Metadata []MetadataItem // READ-ONLY; A list of file systems to mount on each node in the pool. This supports Azure Files, NFS, CIFS/SMB, and Blobfuse. MountConfiguration []MountConfiguration // READ-ONLY; The network configuration for the Pool. NetworkConfiguration *NetworkConfiguration // READ-ONLY; A list of errors encountered while performing the last resize on the Pool. This property is set only if one // or more errors occurred during the last Pool resize, and only when the Pool allocationState is Steady. ResizeErrors []ResizeError // READ-ONLY; The timeout for allocation of Compute Nodes to the Pool. This is the timeout for the most recent resize operation. // (The initial sizing when the Pool is created counts as a resize.) The default value is 15 minutes. ResizeTimeout *string // READ-ONLY; The user-specified tags associated with the pool. The user-defined tags to be associated with the Azure Batch // Pool. When specified, these tags are propagated to the backing Azure resources associated with the pool. This property // can only be specified when the Batch account was created with the poolAllocationMode property set to 'UserSubscription'. ResourceTags map[string]*string // READ-ONLY; The current state of the Pool. State *PoolState // READ-ONLY; The time at which the Pool entered its current state. StateTransitionTime *time.Time // READ-ONLY; Utilization and resource usage statistics for the entire lifetime of the Pool. This property is populated only // if the BatchPool was retrieved with an expand clause including the 'stats' attribute; otherwise it is null. The statistics // may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about // 30 minutes. Stats *PoolStatistics // READ-ONLY; The desired number of dedicated Compute Nodes in the Pool. TargetDedicatedNodes *int32 // READ-ONLY; The desired number of Spot/Low-priority Compute Nodes in the Pool. TargetLowPriorityNodes *int32 // READ-ONLY; How Tasks are distributed across Compute Nodes in a Pool. If not specified, the default is spread. TaskSchedulingPolicy *TaskSchedulingPolicy // READ-ONLY; The number of task slots that can be used to run concurrent tasks on a single compute node in the pool. The // default value is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256. TaskSlotsPerNode *int32 // READ-ONLY; The URL of the Pool. URL *string // READ-ONLY; The list of user Accounts to be created on each Compute Node in the Pool. UserAccounts []UserAccount // READ-ONLY; The size of virtual machines in the Pool. All virtual machines in a Pool are the same size. For information // about available VM sizes, see Sizes for Virtual Machines in Azure (https://learn.microsoft.com/azure/virtual-machines/sizes/overview). // Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 // series). VMSize *string // READ-ONLY; The virtual machine configuration for the Pool. This property must be specified. VirtualMachineConfiguration *VirtualMachineConfiguration }
Pool - A Pool in the Azure Batch service.
func (Pool) MarshalJSON ¶
MarshalJSON implements the json.Marshaller interface for type Pool.
func (*Pool) UnmarshalJSON ¶
UnmarshalJSON implements the json.Unmarshaller interface for type Pool.
type PoolEndpointConfiguration ¶
type PoolEndpointConfiguration struct { // REQUIRED; A list of inbound NAT Pools that can be used to address specific ports on an individual Compute Node externally. // The maximum number of inbound NAT Pools per Batch Pool is 5. If the maximum number of inbound NAT Pools is exceeded the // request fails with HTTP status code 400. This cannot be specified if the IPAddressProvisioningType is NoPublicIPAddresses. InboundNATPools []InboundNATPool }
PoolEndpointConfiguration - The endpoint configuration for a Pool.
func (PoolEndpointConfiguration) MarshalJSON ¶
func (p PoolEndpointConfiguration) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type PoolEndpointConfiguration.
func (*PoolEndpointConfiguration) UnmarshalJSON ¶
func (p *PoolEndpointConfiguration) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type PoolEndpointConfiguration.
type PoolExistsOptions ¶
type PoolExistsOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // An ETag value associated with the version of the resource known to the client. // The operation will be performed only if the resource's current ETag on the // service exactly matches the value specified by the client. IfMatch *azcore.ETag // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // been modified since the specified time. IfModifiedSince *time.Time // An ETag value associated with the version of the resource known to the client. // The operation will be performed only if the resource's current ETag on the // service does not match the value specified by the client. IfNoneMatch *azcore.ETag // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // not been modified since the specified time. IfUnmodifiedSince *time.Time // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
PoolExistsOptions contains the optional parameters for the Client.PoolExists method.
type PoolExistsResponse ¶
type PoolExistsResponse struct { // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
PoolExistsResponse contains the response from method Client.PoolExists.
type PoolIdentity ¶
type PoolIdentity struct { // REQUIRED; The identity of the Batch pool, if configured. The list of user identities associated with the Batch pool. The // user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. Type *PoolIdentityType // The list of user identities associated with the Batch account. The user identity dictionary key references will be ARM // resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. UserAssignedIdentities []UserAssignedIdentity }
PoolIdentity - The identity of the Batch pool, if configured.
func (PoolIdentity) MarshalJSON ¶
func (p PoolIdentity) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type PoolIdentity.
func (*PoolIdentity) UnmarshalJSON ¶
func (p *PoolIdentity) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type PoolIdentity.
type PoolIdentityType ¶
type PoolIdentityType string
PoolIdentityType - BatchPoolIdentityType enums
const ( // PoolIdentityTypeNone - Batch pool has no identity associated with it. Setting `None` in update pool will remove existing // identities. PoolIdentityTypeNone PoolIdentityType = "None" // PoolIdentityTypeUserAssigned - Batch pool has user assigned identities with it. PoolIdentityTypeUserAssigned PoolIdentityType = "UserAssigned" )
func PossiblePoolIdentityTypeValues ¶
func PossiblePoolIdentityTypeValues() []PoolIdentityType
PossiblePoolIdentityTypeValues returns the possible values for the PoolIdentityType const type.
type PoolInfo ¶
type PoolInfo struct { // Characteristics for a temporary 'auto pool'. The Batch service will create this auto Pool when the Job is submitted. If // auto Pool creation fails, the Batch service moves the Job to a completed state, and the Pool creation error is set in the // Job's scheduling error property. The Batch service manages the lifetime (both creation and, unless keepAlive is specified, // deletion) of the auto Pool. Any user actions that affect the lifetime of the auto Pool while the Job is active will result // in unexpected behavior. You must specify either the Pool ID or the auto Pool specification, but not both. AutoPoolSpecification *AutoPoolSpecification // The ID of an existing Pool. All the Tasks of the Job will run on the specified Pool. You must ensure that the Pool referenced // by this property exists. If the Pool does not exist at the time the Batch service tries to schedule a Job, no Tasks for // the Job will run until you create a Pool with that id. Note that the Batch service will not reject the Job request; it // will simply not run Tasks until the Pool exists. You must specify either the Pool ID or the auto Pool specification, but // not both. PoolID *string }
PoolInfo - Specifies how a Job should be assigned to a Pool.
func (PoolInfo) MarshalJSON ¶
MarshalJSON implements the json.Marshaller interface for type PoolInfo.
func (*PoolInfo) UnmarshalJSON ¶
UnmarshalJSON implements the json.Unmarshaller interface for type PoolInfo.
type PoolLifetimeOption ¶
type PoolLifetimeOption string
PoolLifetimeOption - BatchPoolLifetimeOption enums
const ( // PoolLifetimeOptionJob - The Pool exists for the lifetime of the Job to which it is dedicated. The Batch service creates // the Pool when it creates the Job. If the 'job' option is applied to a Job Schedule, the Batch service creates a new auto // Pool for every Job created on the schedule. PoolLifetimeOptionJob PoolLifetimeOption = "job" // PoolLifetimeOptionJobSchedule - The Pool exists for the lifetime of the Job Schedule. The Batch Service creates the Pool // when it creates the first Job on the schedule. You may apply this option only to Job Schedules, not to Jobs. PoolLifetimeOptionJobSchedule PoolLifetimeOption = "jobschedule" )
func PossiblePoolLifetimeOptionValues ¶
func PossiblePoolLifetimeOptionValues() []PoolLifetimeOption
PossiblePoolLifetimeOptionValues returns the possible values for the PoolLifetimeOption const type.
type PoolListResult ¶
type PoolListResult struct { // The URL to get the next set of results. NextLink *string // The list of Pools. Value []Pool }
PoolListResult - The result of listing the Pools in an Account.
func (PoolListResult) MarshalJSON ¶
func (p PoolListResult) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type PoolListResult.
func (*PoolListResult) UnmarshalJSON ¶
func (p *PoolListResult) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type PoolListResult.
type PoolNodeCounts ¶
type PoolNodeCounts struct { // REQUIRED; The ID of the Pool. PoolID *string // The number of dedicated Compute Nodes in each state. Dedicated *NodeCounts // The number of Spot/Low-priority Compute Nodes in each state. LowPriority *NodeCounts }
PoolNodeCounts - The number of Compute Nodes in each state for a Pool.
func (PoolNodeCounts) MarshalJSON ¶
func (p PoolNodeCounts) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type PoolNodeCounts.
func (*PoolNodeCounts) UnmarshalJSON ¶
func (p *PoolNodeCounts) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type PoolNodeCounts.
type PoolResourceStatistics ¶
type PoolResourceStatistics struct { // REQUIRED; The average CPU usage across all Compute Nodes in the Pool (percentage per node). AvgCPUPercentage *float32 // REQUIRED; The average used disk space in GiB across all Compute Nodes in the Pool. AvgDiskGiB *float32 // REQUIRED; The average memory usage in GiB across all Compute Nodes in the Pool. AvgMemoryGiB *float32 // REQUIRED; The total amount of data in GiB of disk reads across all Compute Nodes in the Pool. DiskReadGiB *float32 // REQUIRED; The total number of disk read operations across all Compute Nodes in the Pool. DiskReadIOPS *int64 // REQUIRED; The total amount of data in GiB of disk writes across all Compute Nodes in the Pool. DiskWriteGiB *float32 // REQUIRED; The total number of disk write operations across all Compute Nodes in the Pool. DiskWriteIOPS *int64 // REQUIRED; The time at which the statistics were last updated. All statistics are limited to the range between startTime // and lastUpdateTime. LastUpdateTime *time.Time // REQUIRED; The total amount of data in GiB of network reads across all Compute Nodes in the Pool. NetworkReadGiB *float32 // REQUIRED; The total amount of data in GiB of network writes across all Compute Nodes in the Pool. NetworkWriteGiB *float32 // REQUIRED; The peak used disk space in GiB across all Compute Nodes in the Pool. PeakDiskGiB *float32 // REQUIRED; The peak memory usage in GiB across all Compute Nodes in the Pool. PeakMemoryGiB *float32 // REQUIRED; The start time of the time range covered by the statistics. StartTime *time.Time }
PoolResourceStatistics - Statistics related to resource consumption by Compute Nodes in a Pool.
func (PoolResourceStatistics) MarshalJSON ¶
func (p PoolResourceStatistics) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type PoolResourceStatistics.
func (*PoolResourceStatistics) UnmarshalJSON ¶
func (p *PoolResourceStatistics) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type PoolResourceStatistics.
type PoolSpecification ¶
type PoolSpecification struct { // REQUIRED; The size of the virtual machines in the Pool. All virtual machines in a Pool are the same size. For information // about available sizes of virtual machines in Pools, see Choose a VM size for Compute Nodes in an Azure Batch Pool (https://learn.microsoft.com/azure/batch/batch-pool-vm-sizes). VMSize *string // The list of Packages to be installed on each Compute Node in the Pool. When creating a pool, the package's application // ID must be fully qualified (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). // Changes to Package references affect all new Nodes joining the Pool, but do not affect Compute Nodes that are already in // the Pool until they are rebooted or reimaged. There is a maximum of 10 Package references on any given Pool. ApplicationPackageReferences []ApplicationPackageReference // The time interval at which to automatically adjust the Pool size according to the autoscale formula. The default value // is 15 minutes. The minimum and maximum value are 5 minutes and 168 hours respectively. If you specify a value less than // 5 minutes or greater than 168 hours, the Batch service rejects the request with an invalid property value error; if you // are calling the REST API directly, the HTTP status code is 400 (Bad Request). AutoScaleEvaluationInterval *string // The formula for the desired number of Compute Nodes in the Pool. This property must not be specified if enableAutoScale // is set to false. It is required if enableAutoScale is set to true. The formula is checked for validity before the Pool // is created. If the formula is not valid, the Batch service rejects the request with detailed error information. AutoScaleFormula *string // For Windows Nodes, the Batch service installs the Certificates to the specified Certificate store and location. For Linux // Compute Nodes, the Certificates are stored in a directory inside the Task working directory and an environment variable // AZ_BATCH_CERTIFICATES_DIR is supplied to the Task to query for this location. For Certificates with visibility of 'remoteUser', // a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and Certificates are placed // in that directory. // Warning: This property is deprecated and will be removed after February, 2024. // Please use the [Azure KeyVault Extension](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead. CertificateReferences []CertificateReference // The display name for the Pool. The display name need not be unique and can contain any Unicode characters up to a maximum // length of 1024. DisplayName *string // Whether the Pool size should automatically adjust over time. If false, at least one of targetDedicatedNodes and targetLowPriorityNodes // must be specified. If true, the autoScaleFormula element is required. The Pool automatically resizes according to the formula. // The default value is false. EnableAutoScale *bool // Whether the Pool permits direct communication between Compute Nodes. Enabling inter-node communication limits the maximum // size of the Pool due to deployment restrictions on the Compute Nodes of the Pool. This may result in the Pool not reaching // its desired size. The default value is false. EnableInterNodeCommunication *bool // A list of name-value pairs associated with the Pool as metadata. The Batch service does not assign any meaning to metadata; // it is solely for the use of user code. Metadata []MetadataItem // A list of file systems to mount on each node in the pool. This supports Azure Files, NFS, CIFS/SMB, and Blobfuse. MountConfiguration []MountConfiguration // The network configuration for the Pool. NetworkConfiguration *NetworkConfiguration // The timeout for allocation of Compute Nodes to the Pool. This timeout applies only to manual scaling; it has no effect // when enableAutoScale is set to true. The default value is 15 minutes. The minimum value is 5 minutes. If you specify a // value less than 5 minutes, the Batch service rejects the request with an error; if you are calling the REST API directly, // the HTTP status code is 400 (Bad Request). ResizeTimeout *string // The user-specified tags associated with the pool.The user-defined tags to be associated with the Azure Batch Pool. When // specified, these tags are propagated to the backing Azure resources associated with the pool. This property can only be // specified when the Batch account was created with the poolAllocationMode property set to 'UserSubscription'. ResourceTags *string // A Task to run on each Compute Node as it joins the Pool. The Task runs when the Compute Node is added to the Pool or when // the Compute Node is restarted. StartTask *StartTask // The desired number of dedicated Compute Nodes in the Pool. This property must not be specified if enableAutoScale is set // to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or // both. TargetDedicatedNodes *int32 // The desired number of Spot/Low-priority Compute Nodes in the Pool. This property must not be specified if enableAutoScale // is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, // or both. TargetLowPriorityNodes *int32 // The desired node communication mode for the pool. If omitted, the default value is Default. TargetNodeCommunicationMode *NodeCommunicationMode // How Tasks are distributed across Compute Nodes in a Pool. If not specified, the default is spread. TaskSchedulingPolicy *TaskSchedulingPolicy // The number of task slots that can be used to run concurrent tasks on a single compute node in the pool. The default value // is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256. TaskSlotsPerNode *int32 // The upgrade policy for the Pool. Describes an upgrade policy - automatic, manual, or rolling. UpgradePolicy *UpgradePolicy // The list of user Accounts to be created on each Compute Node in the Pool. UserAccounts []UserAccount // The virtual machine configuration for the Pool. This property must be specified. VirtualMachineConfiguration *VirtualMachineConfiguration }
PoolSpecification - Specification for creating a new Pool.
func (PoolSpecification) MarshalJSON ¶
func (p PoolSpecification) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type PoolSpecification.
func (*PoolSpecification) UnmarshalJSON ¶
func (p *PoolSpecification) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type PoolSpecification.
type PoolState ¶
type PoolState string
PoolState - BatchPoolState enums
const ( // PoolStateActive - The Pool is available to run Tasks subject to the availability of Compute Nodes. PoolStateActive PoolState = "active" // PoolStateDeleting - The user has requested that the Pool be deleted, but the delete operation has not yet completed. PoolStateDeleting PoolState = "deleting" )
func PossiblePoolStateValues ¶
func PossiblePoolStateValues() []PoolState
PossiblePoolStateValues returns the possible values for the PoolState const type.
type PoolStatistics ¶
type PoolStatistics struct { // REQUIRED; The time at which the statistics were last updated. All statistics are limited to the range between startTime // and lastUpdateTime. LastUpdateTime *time.Time // REQUIRED; The start time of the time range covered by the statistics. StartTime *time.Time // REQUIRED; The URL for the statistics. URL *string // Statistics related to resource consumption by Compute Nodes in the Pool. ResourceStats *PoolResourceStatistics // Statistics related to Pool usage, such as the amount of core-time used. UsageStats *PoolUsageStatistics }
PoolStatistics - Contains utilization and resource usage statistics for the lifetime of a Pool.
func (PoolStatistics) MarshalJSON ¶
func (p PoolStatistics) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type PoolStatistics.
func (*PoolStatistics) UnmarshalJSON ¶
func (p *PoolStatistics) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type PoolStatistics.
type PoolUsageStatistics ¶
type PoolUsageStatistics struct { // REQUIRED; The aggregated wall-clock time of the dedicated Compute Node cores being part of the Pool. DedicatedCoreTime *string // REQUIRED; The time at which the statistics were last updated. All statistics are limited to the range between startTime // and lastUpdateTime. LastUpdateTime *time.Time // REQUIRED; The start time of the time range covered by the statistics. StartTime *time.Time }
PoolUsageStatistics - Statistics related to Pool usage information.
func (PoolUsageStatistics) MarshalJSON ¶
func (p PoolUsageStatistics) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type PoolUsageStatistics.
func (*PoolUsageStatistics) UnmarshalJSON ¶
func (p *PoolUsageStatistics) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type PoolUsageStatistics.
type PublicIPAddressConfiguration ¶
type PublicIPAddressConfiguration struct { // The list of public IPs which the Batch service will use when provisioning Compute Nodes. The number of IPs specified here // limits the maximum size of the Pool - 100 dedicated nodes or 100 Spot/Low-priority nodes can be allocated for each public // IP. For example, a pool needing 250 dedicated VMs would need at least 3 public IPs specified. Each element of this collection // is of the form: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}. IPAddressIDs []string // The provisioning type for Public IP Addresses for the Pool. The default value is BatchManaged. IPAddressProvisioningType *IPAddressProvisioningType }
PublicIPAddressConfiguration - The public IP Address configuration of the networking configuration of a Pool.
func (PublicIPAddressConfiguration) MarshalJSON ¶
func (p PublicIPAddressConfiguration) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type PublicIPAddressConfiguration.
func (*PublicIPAddressConfiguration) UnmarshalJSON ¶
func (p *PublicIPAddressConfiguration) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type PublicIPAddressConfiguration.
type ReactivateTaskOptions ¶
type ReactivateTaskOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // An ETag value associated with the version of the resource known to the client. // The operation will be performed only if the resource's current ETag on the // service exactly matches the value specified by the client. IfMatch *azcore.ETag // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // been modified since the specified time. IfModifiedSince *time.Time // An ETag value associated with the version of the resource known to the client. // The operation will be performed only if the resource's current ETag on the // service does not match the value specified by the client. IfNoneMatch *azcore.ETag // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // not been modified since the specified time. IfUnmodifiedSince *time.Time // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
ReactivateTaskOptions contains the optional parameters for the Client.ReactivateTask method.
type ReactivateTaskResponse ¶
type ReactivateTaskResponse struct { // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The OData ID of the resource to which the request applied. DataServiceID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
ReactivateTaskResponse contains the response from method Client.ReactivateTask.
type RebootNodeContent ¶
type RebootNodeContent struct { // When to reboot the Compute Node and what to do with currently running Tasks. The default value is requeue. NodeRebootOption *NodeRebootOption }
RebootNodeContent - Parameters for rebooting an Azure Batch Compute Node.
func (RebootNodeContent) MarshalJSON ¶
func (r RebootNodeContent) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type RebootNodeContent.
func (*RebootNodeContent) UnmarshalJSON ¶
func (r *RebootNodeContent) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type RebootNodeContent.
type RebootNodeOptions ¶
type RebootNodeOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // The options to use for rebooting the Compute Node. Parameters *RebootNodeContent // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
RebootNodeOptions contains the optional parameters for the Client.RebootNode method.
type RebootNodeResponse ¶
type RebootNodeResponse struct { // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The OData ID of the resource to which the request applied. DataServiceID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
RebootNodeResponse contains the response from method Client.RebootNode.
type RecentJob ¶
RecentJob - Information about the most recent Job to run under the Job Schedule.
func (RecentJob) MarshalJSON ¶
MarshalJSON implements the json.Marshaller interface for type RecentJob.
func (*RecentJob) UnmarshalJSON ¶
UnmarshalJSON implements the json.Unmarshaller interface for type RecentJob.
type ReimageNodeContent ¶
type ReimageNodeContent struct { // When to reimage the Compute Node and what to do with currently running Tasks. The default value is requeue. NodeReimageOption *NodeReimageOption }
ReimageNodeContent - Parameters for reimaging an Azure Batch Compute Node.
func (ReimageNodeContent) MarshalJSON ¶
func (r ReimageNodeContent) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type ReimageNodeContent.
func (*ReimageNodeContent) UnmarshalJSON ¶
func (r *ReimageNodeContent) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type ReimageNodeContent.
type ReimageNodeOptions ¶
type ReimageNodeOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // The options to use for reimaging the Compute Node. Parameters *ReimageNodeContent // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
ReimageNodeOptions contains the optional parameters for the Client.ReimageNode method.
type ReimageNodeResponse ¶
type ReimageNodeResponse struct { // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The OData ID of the resource to which the request applied. DataServiceID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
ReimageNodeResponse contains the response from method Client.ReimageNode.
type RemoveNodeContent ¶
type RemoveNodeContent struct { // REQUIRED; A list containing the IDs of the Compute Nodes to be removed from the specified Pool. A maximum of 100 nodes // may be removed per request. NodeList []string // Determines what to do with a Compute Node and its running task(s) after it has been selected for deallocation. The default // value is requeue. NodeDeallocationOption *NodeDeallocationOption // The timeout for removal of Compute Nodes to the Pool. The default value is 15 minutes. The minimum value is 5 minutes. // If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, // the HTTP status code is 400 (Bad Request). ResizeTimeout *string }
RemoveNodeContent - Parameters for removing nodes from an Azure Batch Pool.
func (RemoveNodeContent) MarshalJSON ¶
func (r RemoveNodeContent) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type RemoveNodeContent.
func (*RemoveNodeContent) UnmarshalJSON ¶
func (r *RemoveNodeContent) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type RemoveNodeContent.
type RemoveNodesOptions ¶
type RemoveNodesOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // An ETag value associated with the version of the resource known to the client. // The operation will be performed only if the resource's current ETag on the // service exactly matches the value specified by the client. IfMatch *azcore.ETag // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // been modified since the specified time. IfModifiedSince *time.Time // An ETag value associated with the version of the resource known to the client. // The operation will be performed only if the resource's current ETag on the // service does not match the value specified by the client. IfNoneMatch *azcore.ETag // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // not been modified since the specified time. IfUnmodifiedSince *time.Time // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
RemoveNodesOptions contains the optional parameters for the Client.RemoveNodes method.
type RemoveNodesResponse ¶
type RemoveNodesResponse struct { // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The OData ID of the resource to which the request applied. DataServiceID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
RemoveNodesResponse contains the response from method Client.RemoveNodes.
type ReplaceJobOptions ¶
type ReplaceJobOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // An ETag value associated with the version of the resource known to the client. // The operation will be performed only if the resource's current ETag on the // service exactly matches the value specified by the client. IfMatch *azcore.ETag // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // been modified since the specified time. IfModifiedSince *time.Time // An ETag value associated with the version of the resource known to the client. // The operation will be performed only if the resource's current ETag on the // service does not match the value specified by the client. IfNoneMatch *azcore.ETag // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // not been modified since the specified time. IfUnmodifiedSince *time.Time // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
ReplaceJobOptions contains the optional parameters for the Client.ReplaceJob method.
type ReplaceJobResponse ¶
type ReplaceJobResponse struct { // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The OData ID of the resource to which the request applied. DataServiceID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
ReplaceJobResponse contains the response from method Client.ReplaceJob.
type ReplaceJobScheduleOptions ¶
type ReplaceJobScheduleOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // An ETag value associated with the version of the resource known to the client. // The operation will be performed only if the resource's current ETag on the // service exactly matches the value specified by the client. IfMatch *azcore.ETag // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // been modified since the specified time. IfModifiedSince *time.Time // An ETag value associated with the version of the resource known to the client. // The operation will be performed only if the resource's current ETag on the // service does not match the value specified by the client. IfNoneMatch *azcore.ETag // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // not been modified since the specified time. IfUnmodifiedSince *time.Time // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
ReplaceJobScheduleOptions contains the optional parameters for the Client.ReplaceJobSchedule method.
type ReplaceJobScheduleResponse ¶
type ReplaceJobScheduleResponse struct { // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The OData ID of the resource to which the request applied. DataServiceID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
ReplaceJobScheduleResponse contains the response from method Client.ReplaceJobSchedule.
type ReplaceNodeUserOptions ¶
type ReplaceNodeUserOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
ReplaceNodeUserOptions contains the optional parameters for the Client.ReplaceNodeUser method.
type ReplaceNodeUserResponse ¶
type ReplaceNodeUserResponse struct { // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The OData ID of the resource to which the request applied. DataServiceID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
ReplaceNodeUserResponse contains the response from method Client.ReplaceNodeUser.
type ReplacePoolContent ¶
type ReplacePoolContent struct { // REQUIRED; The list of Application Packages to be installed on each Compute Node in the Pool. The list replaces any existing // Application Package references on the Pool. Changes to Application Package references affect all new Compute Nodes joining // the Pool, but do not affect Compute Nodes that are already in the Pool until they are rebooted or reimaged. There is a // maximum of 10 Application Package references on any given Pool. If omitted, or if you specify an empty collection, any // existing Application Packages references are removed from the Pool. A maximum of 10 references may be specified on a given // Pool. ApplicationPackageReferences []ApplicationPackageReference // REQUIRED; This list replaces any existing Certificate references configured on the Pool. // If you specify an empty collection, any existing Certificate references are removed from the Pool. // For Windows Nodes, the Batch service installs the Certificates to the specified Certificate store and location. // For Linux Compute Nodes, the Certificates are stored in a directory inside the Task working directory and an environment // variable AZ_BATCH_CERTIFICATES_DIR is supplied to the Task to query for this location. // For Certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) // and Certificates are placed in that directory. // Warning: This property is deprecated and will be removed after February, 2024. Please use the [Azure KeyVault Extension](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) // instead. CertificateReferences []CertificateReference // REQUIRED; A list of name-value pairs associated with the Pool as metadata. This list replaces any existing metadata configured // on the Pool. If omitted, or if you specify an empty collection, any existing metadata is removed from the Pool. Metadata []MetadataItem // A Task to run on each Compute Node as it joins the Pool. The Task runs when the Compute Node is added to the Pool or when // the Compute Node is restarted. If this element is present, it overwrites any existing StartTask. If omitted, any existing // StartTask is removed from the Pool. StartTask *StartTask // The desired node communication mode for the pool. This setting replaces any existing targetNodeCommunication setting on // the Pool. If omitted, the existing setting is default. TargetNodeCommunicationMode *NodeCommunicationMode }
ReplacePoolContent - Parameters for replacing properties on an Azure Batch Pool.
func (ReplacePoolContent) MarshalJSON ¶
func (r ReplacePoolContent) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type ReplacePoolContent.
func (*ReplacePoolContent) UnmarshalJSON ¶
func (r *ReplacePoolContent) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type ReplacePoolContent.
type ReplacePoolPropertiesOptions ¶
type ReplacePoolPropertiesOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
ReplacePoolPropertiesOptions contains the optional parameters for the Client.ReplacePoolProperties method.
type ReplacePoolPropertiesResponse ¶
type ReplacePoolPropertiesResponse struct { // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The OData ID of the resource to which the request applied. DataServiceID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
ReplacePoolPropertiesResponse contains the response from method Client.ReplacePoolProperties.
type ReplaceTaskOptions ¶
type ReplaceTaskOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // An ETag value associated with the version of the resource known to the client. // The operation will be performed only if the resource's current ETag on the // service exactly matches the value specified by the client. IfMatch *azcore.ETag // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // been modified since the specified time. IfModifiedSince *time.Time // An ETag value associated with the version of the resource known to the client. // The operation will be performed only if the resource's current ETag on the // service does not match the value specified by the client. IfNoneMatch *azcore.ETag // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // not been modified since the specified time. IfUnmodifiedSince *time.Time // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
ReplaceTaskOptions contains the optional parameters for the Client.ReplaceTask method.
type ReplaceTaskResponse ¶
type ReplaceTaskResponse struct { // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The OData ID of the resource to which the request applied. DataServiceID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
ReplaceTaskResponse contains the response from method Client.ReplaceTask.
type ResizeError ¶
type ResizeError struct { // An identifier for the Pool resize error. Codes are invariant and are intended to be consumed programmatically. Code *string // A message describing the Pool resize error, intended to be suitable for display in a user interface. Message *string // A list of additional error details related to the Pool resize error. Values []NameValuePair }
ResizeError - An error that occurred when resizing a Pool.
func (ResizeError) MarshalJSON ¶
func (r ResizeError) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type ResizeError.
func (*ResizeError) UnmarshalJSON ¶
func (r *ResizeError) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type ResizeError.
type ResizePoolContent ¶
type ResizePoolContent struct { // Determines what to do with a Compute Node and its running task(s) if the Pool size is decreasing. The default value is // requeue. NodeDeallocationOption *NodeDeallocationOption // The timeout for allocation of Nodes to the Pool or removal of Compute Nodes from the Pool. The default value is 15 minutes. // The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you // are calling the REST API directly, the HTTP status code is 400 (Bad Request). ResizeTimeout *string // The desired number of dedicated Compute Nodes in the Pool. TargetDedicatedNodes *int32 // The desired number of Spot/Low-priority Compute Nodes in the Pool. TargetLowPriorityNodes *int32 }
ResizePoolContent - Parameters for changing the size of an Azure Batch Pool.
func (ResizePoolContent) MarshalJSON ¶
func (r ResizePoolContent) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type ResizePoolContent.
func (*ResizePoolContent) UnmarshalJSON ¶
func (r *ResizePoolContent) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type ResizePoolContent.
type ResizePoolOptions ¶
type ResizePoolOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // An ETag value associated with the version of the resource known to the client. // The operation will be performed only if the resource's current ETag on the // service exactly matches the value specified by the client. IfMatch *azcore.ETag // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // been modified since the specified time. IfModifiedSince *time.Time // An ETag value associated with the version of the resource known to the client. // The operation will be performed only if the resource's current ETag on the // service does not match the value specified by the client. IfNoneMatch *azcore.ETag // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // not been modified since the specified time. IfUnmodifiedSince *time.Time // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
ResizePoolOptions contains the optional parameters for the Client.ResizePool method.
type ResizePoolResponse ¶
type ResizePoolResponse struct { // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The OData ID of the resource to which the request applied. DataServiceID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
ResizePoolResponse contains the response from method Client.ResizePool.
type ResourceFile ¶
type ResourceFile struct { // The storage container name in the auto storage Account. The autoStorageContainerName, storageContainerUrl and httpUrl properties // are mutually exclusive and one of them must be specified. AutoStorageContainerName *string // The blob prefix to use when downloading blobs from an Azure Storage container. Only the blobs whose names begin with the // specified prefix will be downloaded. The property is valid only when autoStorageContainerName or storageContainerUrl is // used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container // will be downloaded. BlobPrefix *string // The file permission mode attribute in octal format. This property applies only to files being downloaded to Linux Compute // Nodes. It will be ignored if it is specified for a resourceFile which will be downloaded to a Windows Compute Node. If // this property is not specified for a Linux Compute Node, then a default value of 0770 is applied to the file. FileMode *string // The location on the Compute Node to which to download the file(s), relative to the Task's working directory. If the httpUrl // property is specified, the filePath is required and describes the path which the file will be downloaded to, including // the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional // and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure // already associated with the input data will be retained in full and appended to the specified filePath directory. The specified // relative path cannot break out of the Task's working directory (for example by using '..'). FilePath *string // The URL of the file to download. The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually // exclusive and one of them must be specified. If the URL points to Azure Blob Storage, it must be readable from compute // nodes. There are three ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting // read permissions on the blob, use a managed identity with read permission, or set the ACL for the blob or its container // to allow public access. HTTPURL *string // The reference to the user assigned identity to use to access Azure Blob Storage specified by storageContainerUrl or httpUrl. IdentityReference *NodeIdentityReference // The URL of the blob container within Azure Blob Storage. The autoStorageContainerName, storageContainerUrl and httpUrl // properties are mutually exclusive and one of them must be specified. This URL must be readable and listable from compute // nodes. There are three ways to get such a URL for a container in Azure storage: include a Shared Access Signature (SAS) // granting read and list permissions on the container, use a managed identity with read and list permissions, or set the // ACL for the container to allow public access. StorageContainerURL *string }
ResourceFile - A single file or multiple files to be downloaded to a Compute Node.
func (ResourceFile) MarshalJSON ¶
func (r ResourceFile) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type ResourceFile.
func (*ResourceFile) UnmarshalJSON ¶
func (r *ResourceFile) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type ResourceFile.
type RollingUpgradePolicy ¶
type RollingUpgradePolicy struct { // Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent // to determine the batch size. This field is able to be set to true or false only when using NodePlacementConfiguration as // Zonal. EnableCrossZoneUpgrade *bool // The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one // batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in // a batch to decrease to ensure higher reliability. The value of this field should be between 5 and 100, inclusive. If both // maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should // not be more than maxUnhealthyInstancePercent. MaxBatchInstancePercent *int32 // The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either // as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the // rolling upgrade aborts. This constraint will be checked prior to starting any batch. The value of this field should be // between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, // the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent. MaxUnhealthyInstancePercent *int32 // The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check // will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The value of // this field should be between 0 and 100, inclusive. MaxUnhealthyUpgradedInstancePercent *int32 // The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time // duration should be specified in ISO 8601 format.. PauseTimeBetweenBatches *string // Upgrade all unhealthy instances in a scale set before any healthy instances. PrioritizeUnhealthyInstances *bool // Rollback failed instances to previous model if the Rolling Upgrade policy is violated. RollbackFailedInstancesOnPolicyBreach *bool }
RollingUpgradePolicy - The configuration parameters used while performing a rolling upgrade.
func (RollingUpgradePolicy) MarshalJSON ¶
func (r RollingUpgradePolicy) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type RollingUpgradePolicy.
func (*RollingUpgradePolicy) UnmarshalJSON ¶
func (r *RollingUpgradePolicy) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type RollingUpgradePolicy.
type SchedulingState ¶
type SchedulingState string
SchedulingState - SchedulingState enums
const ( // SchedulingStateDisabled - No new Tasks will be scheduled on the Compute Node. Tasks already running on the Compute Node // may still run to completion. All Compute Nodes start with scheduling enabled. SchedulingStateDisabled SchedulingState = "disabled" // SchedulingStateEnabled - Tasks can be scheduled on the Compute Node. SchedulingStateEnabled SchedulingState = "enabled" )
func PossibleSchedulingStateValues ¶
func PossibleSchedulingStateValues() []SchedulingState
PossibleSchedulingStateValues returns the possible values for the SchedulingState const type.
type SecurityEncryptionTypes ¶
type SecurityEncryptionTypes string
SecurityEncryptionTypes - SecurityEncryptionTypes enums
const ( // SecurityEncryptionTypesNonPersistedTPM - NonPersistedTPM SecurityEncryptionTypesNonPersistedTPM SecurityEncryptionTypes = "NonPersistedTPM" // SecurityEncryptionTypesVMGuestStateOnly - VMGuestStateOnly SecurityEncryptionTypesVMGuestStateOnly SecurityEncryptionTypes = "VMGuestStateOnly" )
func PossibleSecurityEncryptionTypesValues ¶
func PossibleSecurityEncryptionTypesValues() []SecurityEncryptionTypes
PossibleSecurityEncryptionTypesValues returns the possible values for the SecurityEncryptionTypes const type.
type SecurityProfile ¶
type SecurityProfile struct { // REQUIRED; This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine // or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. // For more information on encryption at host requirements, please refer to https://learn.microsoft.com/azure/virtual-machines/disk-encryption#supported-vm-sizes. EncryptionAtHost *bool // REQUIRED; Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. SecurityType *SecurityTypes // REQUIRED; Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Specifies // the security settings like secure boot and vTPM used while creating the virtual machine. UefiSettings *UEFISettings }
SecurityProfile - Specifies the security profile settings for the virtual machine or virtual machine scale set.
func (SecurityProfile) MarshalJSON ¶
func (s SecurityProfile) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type SecurityProfile.
func (*SecurityProfile) UnmarshalJSON ¶
func (s *SecurityProfile) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type SecurityProfile.
type SecurityTypes ¶
type SecurityTypes string
SecurityTypes - Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings.
const ( // SecurityTypesConfidentialVM - Azure confidential computing offers confidential VMs are for tenants with high security and // confidentiality requirements. These VMs provide a strong, hardware-enforced boundary to help meet your security needs. // You can use confidential VMs for migrations without making changes to your code, with the platform protecting your VM's // state from being read or modified. SecurityTypesConfidentialVM SecurityTypes = "confidentialVM" // SecurityTypesTrustedLaunch - Trusted launch protects against advanced and persistent attack techniques. SecurityTypesTrustedLaunch SecurityTypes = "trustedLaunch" )
func PossibleSecurityTypesValues ¶
func PossibleSecurityTypesValues() []SecurityTypes
PossibleSecurityTypesValues returns the possible values for the SecurityTypes const type.
type ServiceArtifactReference ¶
type ServiceArtifactReference struct { // REQUIRED; The service artifact reference id of ServiceArtifactReference. The service artifact reference id in the form // of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} ID *string }
ServiceArtifactReference - Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version.
func (ServiceArtifactReference) MarshalJSON ¶
func (s ServiceArtifactReference) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type ServiceArtifactReference.
func (*ServiceArtifactReference) UnmarshalJSON ¶
func (s *ServiceArtifactReference) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type ServiceArtifactReference.
type StartNodeOptions ¶
type StartNodeOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
StartNodeOptions contains the optional parameters for the Client.StartNode method.
type StartNodeResponse ¶
type StartNodeResponse struct { // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The OData ID of the resource to which the request applied. DataServiceID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
StartNodeResponse contains the response from method Client.StartNode.
type StartTask ¶
type StartTask struct { // REQUIRED; The command line of the StartTask. The command line does not run under a shell, and therefore cannot take advantage // of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke // the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. If the // command line refers to file paths, it should use a relative path (relative to the Task working directory), or use the Batch // provided environment variable (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables). CommandLine *string // The settings for the container under which the StartTask runs. When this is specified, all directories recursively below // the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all Task environment // variables are mapped into the container, and the Task command line is executed in the container. Files produced in the // container outside of AZ_BATCH_NODE_ROOT_DIR might not be reflected to the host disk, meaning that Batch file APIs will // not be able to access those files. ContainerSettings *TaskContainerSettings // A list of environment variable settings for the StartTask. EnvironmentSettings []EnvironmentSetting // The maximum number of times the Task may be retried. The Batch service retries a Task if its exit code is nonzero. Note // that this value specifically controls the number of retries. The Batch service will try the Task once, and may then retry // up to this limit. For example, if the maximum retry count is 3, Batch tries the Task up to 4 times (one initial try and // 3 retries). If the maximum retry count is 0, the Batch service does not retry the Task. If the maximum retry count is -1, // the Batch service retries the Task without limit, however this is not recommended for a start task or any task. The default // value is 0 (no retries). MaxTaskRetryCount *int32 // A list of files that the Batch service will download to the Compute Node before running the command line. There is a maximum // size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will // be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved // using .zip files, Application Packages, or Docker Containers. Files listed under this element are located in the Task's // working directory. ResourceFiles []ResourceFile // The user identity under which the StartTask runs. If omitted, the Task runs as a non-administrative user unique to the // Task. UserIdentity *UserIdentity // Whether the Batch service should wait for the StartTask to complete successfully (that is, to exit with exit code 0) before // scheduling any Tasks on the Compute Node. If true and the StartTask fails on a Node, the Batch service retries the StartTask // up to its maximum retry count (maxTaskRetryCount). If the Task has still not completed successfully after all retries, // then the Batch service marks the Node unusable, and will not schedule Tasks to it. This condition can be detected via the // Compute Node state and failure info details. If false, the Batch service will not wait for the StartTask to complete. In // this case, other Tasks can start executing on the Compute Node while the StartTask is still running; and even if the StartTask // fails, new Tasks will continue to be scheduled on the Compute Node. The default is true. WaitForSuccess *bool }
StartTask - Batch will retry Tasks when a recovery operation is triggered on a Node. Examples of recovery operations include (but are not limited to) when an unhealthy Node is rebooted or a Compute Node disappeared due to host failure. Retries due to recovery operations are independent of and are not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal retry due to a recovery operation may occur. Because of this, all Tasks should be idempotent. This means Tasks need to tolerate being interrupted and restarted without causing any corruption or duplicate data. The best practice for long running Tasks is to use some form of checkpointing. In some cases the StartTask may be re-run even though the Compute Node was not rebooted. Special care should be taken to avoid StartTasks which create breakaway process or install/launch services from the StartTask working directory, as this will block Batch from being able to re-run the StartTask.
func (StartTask) MarshalJSON ¶
MarshalJSON implements the json.Marshaller interface for type StartTask.
func (*StartTask) UnmarshalJSON ¶
UnmarshalJSON implements the json.Unmarshaller interface for type StartTask.
type StartTaskInfo ¶
type StartTaskInfo struct { // REQUIRED; The number of times the Task has been retried by the Batch service. Task application failures (non-zero exit // code) are retried, pre-processing errors (the Task could not be run) and file upload errors are not retried. The Batch // service will retry the Task up to the limit specified by the constraints. RetryCount *int32 // REQUIRED; The time at which the StartTask started running. This value is reset every time the Task is restarted or retried // (that is, this is the most recent time at which the StartTask started running). StartTime *time.Time // REQUIRED; The state of the StartTask on the Compute Node. State *StartTaskState // Information about the container under which the Task is executing. This property is set only if the Task runs in a container // context. ContainerInfo *TaskContainerExecutionInfo // The time at which the StartTask stopped running. This is the end time of the most recent run of the StartTask, if that // run has completed (even if that run failed and a retry is pending). This element is not present if the StartTask is currently // running. EndTime *time.Time // The exit code of the program specified on the StartTask command line. This property is set only if the StartTask is in // the completed state. In general, the exit code for a process reflects the specific convention implemented by the application // developer for that process. If you use the exit code value to make decisions in your code, be sure that you know the exit // code convention used by the application process. However, if the Batch service terminates the StartTask (due to timeout, // or user termination via the API) you may see an operating system-defined exit code. ExitCode *int32 // Information describing the Task failure, if any. This property is set only if the Task is in the completed state and encountered // a failure. FailureInfo *TaskFailureInfo // The most recent time at which a retry of the Task started running. This element is present only if the Task was retried // (i.e. retryCount is nonzero). If present, this is typically the same as startTime, but may be different if the Task has // been restarted for reasons other than retry; for example, if the Compute Node was rebooted during a retry, then the startTime // is updated but the lastRetryTime is not. LastRetryTime *time.Time // The result of the Task execution. If the value is 'failed', then the details of the failure can be found in the failureInfo // property. Result *TaskExecutionResult }
StartTaskInfo - Information about a StartTask running on a Compute Node.
func (StartTaskInfo) MarshalJSON ¶
func (s StartTaskInfo) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type StartTaskInfo.
func (*StartTaskInfo) UnmarshalJSON ¶
func (s *StartTaskInfo) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type StartTaskInfo.
type StartTaskState ¶
type StartTaskState string
StartTaskState - BatchStartTaskState enums
const ( // StartTaskStateCompleted - The StartTask has exited with exit code 0, or the StartTask has failed and the retry limit has // reached, or the StartTask process did not run due to Task preparation errors (such as resource file download failures). StartTaskStateCompleted StartTaskState = "completed" // StartTaskStateRunning - The StartTask is currently running. StartTaskStateRunning StartTaskState = "running" )
func PossibleStartTaskStateValues ¶
func PossibleStartTaskStateValues() []StartTaskState
PossibleStartTaskStateValues returns the possible values for the StartTaskState const type.
type StatusLevelTypes ¶
type StatusLevelTypes string
StatusLevelTypes - Level code.
const ( // StatusLevelTypesError - Error StatusLevelTypesError StatusLevelTypes = "Error" // StatusLevelTypesInfo - Info StatusLevelTypesInfo StatusLevelTypes = "Info" // StatusLevelTypesWarning - Warning StatusLevelTypesWarning StatusLevelTypes = "Warning" )
func PossibleStatusLevelTypesValues ¶
func PossibleStatusLevelTypesValues() []StatusLevelTypes
PossibleStatusLevelTypesValues returns the possible values for the StatusLevelTypes const type.
type StopPoolResizeOptions ¶
type StopPoolResizeOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // An ETag value associated with the version of the resource known to the client. // The operation will be performed only if the resource's current ETag on the // service exactly matches the value specified by the client. IfMatch *azcore.ETag // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // been modified since the specified time. IfModifiedSince *time.Time // An ETag value associated with the version of the resource known to the client. // The operation will be performed only if the resource's current ETag on the // service does not match the value specified by the client. IfNoneMatch *azcore.ETag // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // not been modified since the specified time. IfUnmodifiedSince *time.Time // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
StopPoolResizeOptions contains the optional parameters for the Client.StopPoolResize method.
type StopPoolResizeResponse ¶
type StopPoolResizeResponse struct { // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The OData ID of the resource to which the request applied. DataServiceID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
StopPoolResizeResponse contains the response from method Client.StopPoolResize.
type StorageAccountType ¶
type StorageAccountType string
StorageAccountType - StorageAccountType enums
const ( // StorageAccountTypePremiumLRS - The data disk should use premium locally redundant storage. StorageAccountTypePremiumLRS StorageAccountType = "premium_lrs" // StorageAccountTypeStandardLRS - The data disk should use standard locally redundant storage. StorageAccountTypeStandardLRS StorageAccountType = "standard_lrs" // StorageAccountTypeStandardSSDLRS - The data disk / OS disk should use standard SSD locally redundant storage. StorageAccountTypeStandardSSDLRS StorageAccountType = "standardssd_lrs" )
func PossibleStorageAccountTypeValues ¶
func PossibleStorageAccountTypeValues() []StorageAccountType
PossibleStorageAccountTypeValues returns the possible values for the StorageAccountType const type.
type Subtask ¶
type Subtask struct { // Information about the container under which the Task is executing. This property is set only if the Task runs in a container // context. ContainerInfo *TaskContainerExecutionInfo // The time at which the subtask completed. This property is set only if the subtask is in the Completed state. EndTime *time.Time // The exit code of the program specified on the subtask command line. This property is set only if the subtask is in the // completed state. In general, the exit code for a process reflects the specific convention implemented by the application // developer for that process. If you use the exit code value to make decisions in your code, be sure that you know the exit // code convention used by the application process. However, if the Batch service terminates the subtask (due to timeout, // or user termination via the API) you may see an operating system-defined exit code. ExitCode *int32 // Information describing the Task failure, if any. This property is set only if the Task is in the completed state and encountered // a failure. FailureInfo *TaskFailureInfo // The ID of the subtask. ID *int32 // Information about the Compute Node on which the subtask ran. NodeInfo *NodeInfo // The previous state of the subtask. This property is not set if the subtask is in its initial running state. PreviousState *SubtaskState // The time at which the subtask entered its previous state. This property is not set if the subtask is in its initial running // state. PreviousStateTransitionTime *time.Time // The result of the Task execution. If the value is 'failed', then the details of the failure can be found in the failureInfo // property. Result *TaskExecutionResult // The time at which the subtask started running. If the subtask has been restarted or retried, this is the most recent time // at which the subtask started running. StartTime *time.Time // The current state of the subtask. State *SubtaskState // The time at which the subtask entered its current state. StateTransitionTime *time.Time }
Subtask - Information about an Azure Batch subtask.
func (Subtask) MarshalJSON ¶
MarshalJSON implements the json.Marshaller interface for type Subtask.
func (*Subtask) UnmarshalJSON ¶
UnmarshalJSON implements the json.Unmarshaller interface for type Subtask.
type SubtaskState ¶
type SubtaskState string
SubtaskState - BatchSubtaskState enums
const ( // SubtaskStateCompleted - The Task is no longer eligible to run, usually because the Task has finished successfully, or the // Task has finished unsuccessfully and has exhausted its retry limit. A Task is also marked as completed if an error occurred // launching the Task, or when the Task has been terminated. SubtaskStateCompleted SubtaskState = "completed" // SubtaskStatePreparing - The Task has been assigned to a Compute Node, but is waiting for a required Job Preparation Task // to complete on the Compute Node. If the Job Preparation Task succeeds, the Task will move to running. If the Job Preparation // Task fails, the Task will return to active and will be eligible to be assigned to a different Compute Node. SubtaskStatePreparing SubtaskState = "preparing" // SubtaskStateRunning - The Task is running on a Compute Node. This includes task-level preparation such as downloading resource // files or deploying Packages specified on the Task - it does not necessarily mean that the Task command line has started // executing. SubtaskStateRunning SubtaskState = "running" )
func PossibleSubtaskStateValues ¶
func PossibleSubtaskStateValues() []SubtaskState
PossibleSubtaskStateValues returns the possible values for the SubtaskState const type.
type SupportedImage ¶
type SupportedImage struct { // REQUIRED; The reference to the Azure Virtual Machine's Marketplace Image. ImageReference *ImageReference // REQUIRED; The ID of the Compute Node agent SKU which the Image supports. NodeAgentSKUID *string // REQUIRED; The type of operating system (e.g. Windows or Linux) of the Image. OSType *OSType // REQUIRED; Whether the Azure Batch service actively verifies that the Image is compatible with the associated Compute Node // agent SKU. VerificationType *ImageVerificationType // The time when the Azure Batch service will stop accepting create Pool requests for the Image. BatchSupportEndOfLife *time.Time // The capabilities or features which the Image supports. Not every capability of the Image is listed. Capabilities in this // list are considered of special interest and are generally related to integration with other features in the Azure Batch // service. Capabilities []string }
SupportedImage - A reference to the Azure Virtual Machines Marketplace Image and additional information about the Image.
func (SupportedImage) MarshalJSON ¶
func (s SupportedImage) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type SupportedImage.
func (*SupportedImage) UnmarshalJSON ¶
func (s *SupportedImage) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type SupportedImage.
type Task ¶
type Task struct { // The execution constraints that apply to this Task. Constraints *TaskConstraints // READ-ONLY; A locality hint that can be used by the Batch service to select a Compute Node on which to start the new Task. AffinityInfo *AffinityInfo // READ-ONLY; A list of Packages that the Batch service will deploy to the Compute Node before running the command line. Application // packages are downloaded and deployed to a shared directory, not the Task working directory. Therefore, if a referenced // package is already on the Node, and is up to date, then it is not re-downloaded; the existing copy on the Compute Node // is used. If a referenced Package cannot be installed, for example because the package has been deleted or because download // failed, the Task fails. ApplicationPackageReferences []ApplicationPackageReference // READ-ONLY; The settings for an authentication token that the Task can use to perform Batch service operations. If this // property is set, the Batch service provides the Task with an authentication token which can be used to authenticate Batch // service operations without requiring an Account access key. The token is provided via the AZ_BATCH_AUTHENTICATION_TOKEN // environment variable. The operations that the Task can carry out using the token depend on the settings. For example, a // Task can request Job permissions in order to add other Tasks to the Job, or check the status of the Job or of other Tasks // under the Job. AuthenticationTokenSettings *AuthenticationTokenSettings // READ-ONLY; The command line of the Task. For multi-instance Tasks, the command line is executed as the primary Task, after // the primary Task and all subtasks have finished executing the coordination command line. The command line does not run // under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want // to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" // in Windows or "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths, it should use a relative path // (relative to the Task working directory), or use the Batch provided environment variable (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables). CommandLine *string // READ-ONLY; The settings for the container under which the Task runs. If the Pool that will run this Task has containerConfiguration // set, this must be set as well. If the Pool that will run this Task doesn't have containerConfiguration set, this must not // be set. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories // on the node) are mapped into the container, all Task environment variables are mapped into the container, and the Task // command line is executed in the container. Files produced in the container outside of AZ_BATCH_NODE_ROOT_DIR might not // be reflected to the host disk, meaning that Batch file APIs will not be able to access those files. ContainerSettings *TaskContainerSettings // READ-ONLY; The creation time of the Task. CreationTime *time.Time // READ-ONLY; The Tasks that this Task depends on. This Task will not be scheduled until all Tasks that it depends on have // completed successfully. If any of those Tasks fail and exhaust their retry counts, this Task will never be scheduled. DependsOn *TaskDependencies // READ-ONLY; A display name for the Task. The display name need not be unique and can contain any Unicode characters up to // a maximum length of 1024. DisplayName *string // READ-ONLY; The ETag of the Task. This is an opaque string. You can use it to detect whether the Task has changed between // requests. In particular, you can be pass the ETag when updating a Task to specify that your changes should take effect // only if nobody else has modified the Task in the meantime. ETag *azcore.ETag // READ-ONLY; A list of environment variable settings for the Task. EnvironmentSettings []EnvironmentSetting // READ-ONLY; Information about the execution of the Task. ExecutionInfo *TaskExecutionInfo // READ-ONLY; How the Batch service should respond when the Task completes. ExitConditions *ExitConditions // READ-ONLY; A string that uniquely identifies the Task within the Job. The ID can contain any combination of alphanumeric // characters including hyphens and underscores, and cannot contain more than 64 characters. ID *string // READ-ONLY; The last modified time of the Task. LastModified *time.Time // READ-ONLY; An object that indicates that the Task is a multi-instance Task, and contains information about how to run the // multi-instance Task. MultiInstanceSettings *MultiInstanceSettings // READ-ONLY; Information about the Compute Node on which the Task ran. NodeInfo *NodeInfo // READ-ONLY; A list of files that the Batch service will upload from the Compute Node after running the command line. For // multi-instance Tasks, the files will only be uploaded from the Compute Node on which the primary Task is executed. OutputFiles []OutputFile // READ-ONLY; The previous state of the Task. This property is not set if the Task is in its initial Active state. PreviousState *TaskState // READ-ONLY; The time at which the Task entered its previous state. This property is not set if the Task is in its initial // Active state. PreviousStateTransitionTime *time.Time // READ-ONLY; The number of scheduling slots that the Task requires to run. The default is 1. A Task can only be scheduled // to run on a compute node if the node has enough free scheduling slots available. For multi-instance Tasks, this must be // 1. RequiredSlots *int32 // READ-ONLY; A list of files that the Batch service will download to the Compute Node before running the command line. For // multi-instance Tasks, the resource files will only be downloaded to the Compute Node on which the primary Task is executed. // There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response // error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This // can be achieved using .zip files, Application Packages, or Docker Containers. ResourceFiles []ResourceFile // READ-ONLY; The current state of the Task. State *TaskState // READ-ONLY; The time at which the Task entered its current state. StateTransitionTime *time.Time // READ-ONLY; Resource usage statistics for the Task. Stats *TaskStatistics // READ-ONLY; The URL of the Task. URL *string // READ-ONLY; The user identity under which the Task runs. If omitted, the Task runs as a non-administrative user unique to // the Task. UserIdentity *UserIdentity }
Task - Batch will retry Tasks when a recovery operation is triggered on a Node. Examples of recovery operations include (but are not limited to) when an unhealthy Node is rebooted or a Compute Node disappeared due to host failure. Retries due to recovery operations are independent of and are not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal retry due to a recovery operation may occur. Because of this, all Tasks should be idempotent. This means Tasks need to tolerate being interrupted and restarted without causing any corruption or duplicate data. The best practice for long running Tasks is to use some form of checkpointing.
func (Task) MarshalJSON ¶
MarshalJSON implements the json.Marshaller interface for type Task.
func (*Task) UnmarshalJSON ¶
UnmarshalJSON implements the json.Unmarshaller interface for type Task.
type TaskAddResult ¶
type TaskAddResult struct { // REQUIRED; The status of the add Task request. Status *TaskAddStatus // REQUIRED; The ID of the Task for which this is the result. TaskID *string // The ETag of the Task, if the Task was successfully added. You can use this to detect whether the Task has changed between // requests. In particular, you can be pass the ETag with an Update Task request to specify that your changes should take // effect only if nobody else has modified the Job in the meantime. ETag *azcore.ETag // The error encountered while attempting to add the Task. Error *Error // The last modified time of the Task. LastModified *time.Time // The URL of the Task, if the Task was successfully added. Location *string }
TaskAddResult - Result for a single Task added as part of an add Task collection operation.
func (TaskAddResult) MarshalJSON ¶
func (t TaskAddResult) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type TaskAddResult.
func (*TaskAddResult) UnmarshalJSON ¶
func (t *TaskAddResult) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type TaskAddResult.
type TaskAddStatus ¶
type TaskAddStatus string
TaskAddStatus - BatchTaskAddStatus enums
const ( // TaskAddStatusClientError - The Task failed to add due to a client error and should not be retried without modifying the // request as appropriate. TaskAddStatusClientError TaskAddStatus = "clienterror" // TaskAddStatusServerError - Task failed to add due to a server error and can be retried without modification. TaskAddStatusServerError TaskAddStatus = "servererror" // TaskAddStatusSuccess - The Task was added successfully. TaskAddStatusSuccess TaskAddStatus = "success" )
func PossibleTaskAddStatusValues ¶
func PossibleTaskAddStatusValues() []TaskAddStatus
PossibleTaskAddStatusValues returns the possible values for the TaskAddStatus const type.
type TaskConstraints ¶
type TaskConstraints struct { // The maximum number of times the Task may be retried. The Batch service retries a Task if its exit code is nonzero. Note // that this value specifically controls the number of retries for the Task executable due to a nonzero exit code. The Batch // service will try the Task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch // tries the Task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not // retry the Task after the first attempt. If the maximum retry count is -1, the Batch service retries the Task without limit, // however this is not recommended for a start task or any task. The default value is 0 (no retries). MaxTaskRetryCount *int32 // The maximum elapsed time that the Task may run, measured from the time the Task starts. If the Task does not complete within // the time limit, the Batch service terminates it. If this is not specified, there is no time limit on how long the Task // may run. MaxWallClockTime *string // The minimum time to retain the Task directory on the Compute Node where it ran, from the time it completes execution. After // this time, the Batch service may delete the Task directory and all its contents. The default is 7 days, i.e. the Task directory // will be retained for 7 days unless the Compute Node is removed or the Job is deleted. RetentionTime *string }
TaskConstraints - Execution constraints to apply to a Task.
func (TaskConstraints) MarshalJSON ¶
func (t TaskConstraints) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type TaskConstraints.
func (*TaskConstraints) UnmarshalJSON ¶
func (t *TaskConstraints) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type TaskConstraints.
type TaskContainerExecutionInfo ¶
type TaskContainerExecutionInfo struct { // The ID of the container. ContainerID *string // Detailed error information about the container. This is the detailed error string from the Docker service, if available. // It is equivalent to the error field returned by "docker inspect". Error *string // The state of the container. This is the state of the container according to the Docker service. It is equivalent to the // status field returned by "docker inspect". State *string }
TaskContainerExecutionInfo - Contains information about the container which a Task is executing.
func (TaskContainerExecutionInfo) MarshalJSON ¶
func (t TaskContainerExecutionInfo) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type TaskContainerExecutionInfo.
func (*TaskContainerExecutionInfo) UnmarshalJSON ¶
func (t *TaskContainerExecutionInfo) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type TaskContainerExecutionInfo.
type TaskContainerSettings ¶
type TaskContainerSettings struct { // REQUIRED; The Image to use to create the container in which the Task will run. This is the full Image reference, as would // be specified to "docker pull". If no tag is provided as part of the Image name, the tag ":latest" is used as a default. ImageName *string // The paths you want to mounted to container task. If this array is null or be not present, container task will mount entire // temporary disk drive in windows (or AZ_BATCH_NODE_ROOT_DIR in Linux). It won't' mount any data paths into container if // this array is set as empty. ContainerHostBatchBindMounts []ContainerHostBindMountEntry // Additional options to the container create command. These additional options are supplied as arguments to the "docker create" // command, in addition to those controlled by the Batch Service. ContainerRunOptions *string // The private registry which contains the container Image. This setting can be omitted if was already provided at Pool creation. Registry *ContainerRegistryReference // The location of the container Task working directory. The default is 'taskWorkingDirectory'. WorkingDirectory *ContainerWorkingDirectory }
TaskContainerSettings - The container settings for a Task.
func (TaskContainerSettings) MarshalJSON ¶
func (t TaskContainerSettings) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type TaskContainerSettings.
func (*TaskContainerSettings) UnmarshalJSON ¶
func (t *TaskContainerSettings) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type TaskContainerSettings.
type TaskCounts ¶
type TaskCounts struct { // REQUIRED; The number of Tasks in the active state. Active *int32 // REQUIRED; The number of Tasks in the completed state. Completed *int32 // REQUIRED; The number of Tasks which failed. A Task fails if its result (found in the executionInfo property) is 'failure'. Failed *int32 // REQUIRED; The number of Tasks in the running or preparing state. Running *int32 // REQUIRED; The number of Tasks which succeeded. A Task succeeds if its result (found in the executionInfo property) is 'success'. Succeeded *int32 }
TaskCounts - The Task counts for a Job.
func (TaskCounts) MarshalJSON ¶
func (t TaskCounts) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type TaskCounts.
func (*TaskCounts) UnmarshalJSON ¶
func (t *TaskCounts) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type TaskCounts.
type TaskCountsResult ¶
type TaskCountsResult struct { // REQUIRED; The number of Tasks per state. TaskCounts *TaskCounts // REQUIRED; The number of TaskSlots required by Tasks per state. TaskSlotCounts *TaskSlotCounts }
TaskCountsResult - The Task and TaskSlot counts for a Job.
func (TaskCountsResult) MarshalJSON ¶
func (t TaskCountsResult) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type TaskCountsResult.
func (*TaskCountsResult) UnmarshalJSON ¶
func (t *TaskCountsResult) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type TaskCountsResult.
type TaskDependencies ¶
type TaskDependencies struct { // The list of Task ID ranges that this Task depends on. All Tasks in all ranges must complete successfully before the dependent // Task can be scheduled. TaskIDRanges []TaskIDRange // The list of Task IDs that this Task depends on. All Tasks in this list must complete successfully before the dependent // Task can be scheduled. The taskIds collection is limited to 64000 characters total (i.e. the combined length of all Task // IDs). If the taskIds collection exceeds the maximum length, the Add Task request fails with error code TaskDependencyListTooLong. // In this case consider using Task ID ranges instead. TaskIDs []string }
TaskDependencies - Specifies any dependencies of a Task. Any Task that is explicitly specified or within a dependency range must complete before the dependant Task will be scheduled.
func (TaskDependencies) MarshalJSON ¶
func (t TaskDependencies) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type TaskDependencies.
func (*TaskDependencies) UnmarshalJSON ¶
func (t *TaskDependencies) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type TaskDependencies.
type TaskExecutionInfo ¶
type TaskExecutionInfo struct { // REQUIRED; The number of times the Task has been requeued by the Batch service as the result of a user request. When the // user removes Compute Nodes from a Pool (by resizing/shrinking the pool) or when the Job is being disabled, the user can // specify that running Tasks on the Compute Nodes be requeued for execution. This count tracks how many times the Task has // been requeued for these reasons. RequeueCount *int32 // REQUIRED; The number of times the Task has been retried by the Batch service. Task application failures (non-zero exit // code) are retried, pre-processing errors (the Task could not be run) and file upload errors are not retried. The Batch // service will retry the Task up to the limit specified by the constraints. RetryCount *int32 // Information about the container under which the Task is executing. This property is set only if the Task runs in a container // context. ContainerInfo *TaskContainerExecutionInfo // The time at which the Task completed. This property is set only if the Task is in the Completed state. EndTime *time.Time // The exit code of the program specified on the Task command line. This property is set only if the Task is in the completed // state. In general, the exit code for a process reflects the specific convention implemented by the application developer // for that process. If you use the exit code value to make decisions in your code, be sure that you know the exit code convention // used by the application process. However, if the Batch service terminates the Task (due to timeout, or user termination // via the API) you may see an operating system-defined exit code. ExitCode *int32 // Information describing the Task failure, if any. This property is set only if the Task is in the completed state and encountered // a failure. FailureInfo *TaskFailureInfo // The most recent time at which the Task has been requeued by the Batch service as the result of a user request. This property // is set only if the requeueCount is nonzero. LastRequeueTime *time.Time // The most recent time at which a retry of the Task started running. This element is present only if the Task was retried // (i.e. retryCount is nonzero). If present, this is typically the same as startTime, but may be different if the Task has // been restarted for reasons other than retry; for example, if the Compute Node was rebooted during a retry, then the startTime // is updated but the lastRetryTime is not. LastRetryTime *time.Time // The result of the Task execution. If the value is 'failed', then the details of the failure can be found in the failureInfo // property. Result *TaskExecutionResult // The time at which the Task started running. 'Running' corresponds to the running state, so if the Task specifies resource // files or Packages, then the start time reflects the time at which the Task started downloading or deploying these. If the // Task has been restarted or retried, this is the most recent time at which the Task started running. This property is present // only for Tasks that are in the running or completed state. StartTime *time.Time }
TaskExecutionInfo - Information about the execution of a Task.
func (TaskExecutionInfo) MarshalJSON ¶
func (t TaskExecutionInfo) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type TaskExecutionInfo.
func (*TaskExecutionInfo) UnmarshalJSON ¶
func (t *TaskExecutionInfo) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type TaskExecutionInfo.
type TaskExecutionResult ¶
type TaskExecutionResult string
TaskExecutionResult - BatchTaskExecutionResult enums
const ( // TaskExecutionResultFailure - There was an error during processing of the Task. The failure may have occurred before the // Task process was launched, while the Task process was executing, or after the Task process exited. TaskExecutionResultFailure TaskExecutionResult = "failure" // TaskExecutionResultSuccess - The Task ran successfully. TaskExecutionResultSuccess TaskExecutionResult = "success" )
func PossibleTaskExecutionResultValues ¶
func PossibleTaskExecutionResultValues() []TaskExecutionResult
PossibleTaskExecutionResultValues returns the possible values for the TaskExecutionResult const type.
type TaskFailureInfo ¶
type TaskFailureInfo struct { // REQUIRED; The category of the Task error. Category *ErrorCategory // An identifier for the Task error. Codes are invariant and are intended to be consumed programmatically. Code *string // A list of additional details related to the error. Details []NameValuePair // A message describing the Task error, intended to be suitable for display in a user interface. Message *string }
TaskFailureInfo - Information about a Task failure.
func (TaskFailureInfo) MarshalJSON ¶
func (t TaskFailureInfo) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type TaskFailureInfo.
func (*TaskFailureInfo) UnmarshalJSON ¶
func (t *TaskFailureInfo) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type TaskFailureInfo.
type TaskGroup ¶
type TaskGroup struct { // REQUIRED; The collection of Tasks to add. The maximum count of Tasks is 100. The total serialized size of this collection // must be less than 1MB. If it is greater than 1MB (for example if each Task has 100's of resource files or environment variables), // the request will fail with code 'RequestBodyTooLarge' and should be retried again with fewer Tasks. Value []CreateTaskContent }
TaskGroup - A collection of Azure Batch Tasks to add.
func (TaskGroup) MarshalJSON ¶
MarshalJSON implements the json.Marshaller interface for type TaskGroup.
func (*TaskGroup) UnmarshalJSON ¶
UnmarshalJSON implements the json.Unmarshaller interface for type TaskGroup.
type TaskIDRange ¶
type TaskIDRange struct { // REQUIRED; The last Task ID in the range. End *int32 // REQUIRED; The first Task ID in the range. Start *int32 }
TaskIDRange - The start and end of the range are inclusive. For example, if a range has start 9 and end 12, then it represents Tasks '9', '10', '11' and '12'.
func (TaskIDRange) MarshalJSON ¶
func (t TaskIDRange) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type TaskIDRange.
func (*TaskIDRange) UnmarshalJSON ¶
func (t *TaskIDRange) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type TaskIDRange.
type TaskInfo ¶
type TaskInfo struct { // REQUIRED; The current state of the Task. TaskState *TaskState // Information about the execution of the Task. ExecutionInfo *TaskExecutionInfo // The ID of the Job to which the Task belongs. JobID *string // The ID of the subtask if the Task is a multi-instance Task. SubtaskID *int32 // The ID of the Task. TaskID *string // The URL of the Task. TaskURL *string }
TaskInfo - Information about a Task running on a Compute Node.
func (TaskInfo) MarshalJSON ¶
MarshalJSON implements the json.Marshaller interface for type TaskInfo.
func (*TaskInfo) UnmarshalJSON ¶
UnmarshalJSON implements the json.Unmarshaller interface for type TaskInfo.
type TaskListResult ¶
type TaskListResult struct { // The URL to get the next set of results. NextLink *string // The list of Tasks. Value []Task }
TaskListResult - The result of listing the Tasks in a Job.
func (TaskListResult) MarshalJSON ¶
func (t TaskListResult) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type TaskListResult.
func (*TaskListResult) UnmarshalJSON ¶
func (t *TaskListResult) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type TaskListResult.
type TaskListSubtasksResult ¶
type TaskListSubtasksResult struct { // The URL to get the next set of results. NextLink *string // The list of subtasks. Value []Subtask }
TaskListSubtasksResult - The result of listing the subtasks of a Task.
func (TaskListSubtasksResult) MarshalJSON ¶
func (t TaskListSubtasksResult) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type TaskListSubtasksResult.
func (*TaskListSubtasksResult) UnmarshalJSON ¶
func (t *TaskListSubtasksResult) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type TaskListSubtasksResult.
type TaskSchedulingPolicy ¶
type TaskSchedulingPolicy struct { // REQUIRED; How Tasks are distributed across Compute Nodes in a Pool. If not specified, the default is spread. NodeFillType *NodeFillType }
TaskSchedulingPolicy - Specifies how Tasks should be distributed across Compute Nodes.
func (TaskSchedulingPolicy) MarshalJSON ¶
func (t TaskSchedulingPolicy) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type TaskSchedulingPolicy.
func (*TaskSchedulingPolicy) UnmarshalJSON ¶
func (t *TaskSchedulingPolicy) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type TaskSchedulingPolicy.
type TaskSlotCounts ¶
type TaskSlotCounts struct { // REQUIRED; The number of TaskSlots for active Tasks. Active *int32 // REQUIRED; The number of TaskSlots for completed Tasks. Completed *int32 // REQUIRED; The number of TaskSlots for failed Tasks. Failed *int32 // REQUIRED; The number of TaskSlots for running Tasks. Running *int32 // REQUIRED; The number of TaskSlots for succeeded Tasks. Succeeded *int32 }
TaskSlotCounts - The TaskSlot counts for a Job.
func (TaskSlotCounts) MarshalJSON ¶
func (t TaskSlotCounts) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type TaskSlotCounts.
func (*TaskSlotCounts) UnmarshalJSON ¶
func (t *TaskSlotCounts) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type TaskSlotCounts.
type TaskState ¶
type TaskState string
TaskState - BatchTaskState enums
const ( // TaskStateActive - The Task is queued and able to run, but is not currently assigned to a Compute Node. A Task enters this // state when it is created, when it is enabled after being disabled, or when it is awaiting a retry after a failed run. TaskStateActive TaskState = "active" // TaskStateCompleted - The Task is no longer eligible to run, usually because the Task has finished successfully, or the // Task has finished unsuccessfully and has exhausted its retry limit. A Task is also marked as completed if an error occurred // launching the Task, or when the Task has been terminated. TaskStateCompleted TaskState = "completed" // TaskStatePreparing - The Task has been assigned to a Compute Node, but is waiting for a required Job Preparation Task to // complete on the Compute Node. If the Job Preparation Task succeeds, the Task will move to running. If the Job Preparation // Task fails, the Task will return to active and will be eligible to be assigned to a different Compute Node. TaskStatePreparing TaskState = "preparing" // TaskStateRunning - The Task is running on a Compute Node. This includes task-level preparation such as downloading resource // files or deploying Packages specified on the Task - it does not necessarily mean that the Task command line has started // executing. TaskStateRunning TaskState = "running" )
func PossibleTaskStateValues ¶
func PossibleTaskStateValues() []TaskState
PossibleTaskStateValues returns the possible values for the TaskState const type.
type TaskStatistics ¶
type TaskStatistics struct { // REQUIRED; The total kernel mode CPU time (summed across all cores and all Compute Nodes) consumed by the Task. KernelCPUTime *string // REQUIRED; The time at which the statistics were last updated. All statistics are limited to the range between startTime // and lastUpdateTime. LastUpdateTime *time.Time // REQUIRED; The total gibibytes read from disk by the Task. ReadIOGiB *float32 // REQUIRED; The total number of disk read operations made by the Task. ReadIOPS *int64 // REQUIRED; The start time of the time range covered by the statistics. StartTime *time.Time // REQUIRED; The URL of the statistics. URL *string // REQUIRED; The total user mode CPU time (summed across all cores and all Compute Nodes) consumed by the Task. UserCPUTime *string // REQUIRED; The total wait time of the Task. The wait time for a Task is defined as the elapsed time between the creation // of the Task and the start of Task execution. (If the Task is retried due to failures, the wait time is the time to the // most recent Task execution.). WaitTime *string // REQUIRED; The total wall clock time of the Task. The wall clock time is the elapsed time from when the Task started running // on a Compute Node to when it finished (or to the last time the statistics were updated, if the Task had not finished by // then). If the Task was retried, this includes the wall clock time of all the Task retries. WallClockTime *string // REQUIRED; The total gibibytes written to disk by the Task. WriteIOGiB *float32 // REQUIRED; The total number of disk write operations made by the Task. WriteIOPS *int64 }
TaskStatistics - Resource usage statistics for a Task.
func (TaskStatistics) MarshalJSON ¶
func (t TaskStatistics) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type TaskStatistics.
func (*TaskStatistics) UnmarshalJSON ¶
func (t *TaskStatistics) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type TaskStatistics.
type TerminateJobContent ¶
type TerminateJobContent struct { // The text you want to appear as the Job's TerminationReason. The default is 'UserTerminate'. TerminationReason *string }
TerminateJobContent - Parameters for terminating an Azure Batch Job.
func (TerminateJobContent) MarshalJSON ¶
func (t TerminateJobContent) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type TerminateJobContent.
func (*TerminateJobContent) UnmarshalJSON ¶
func (t *TerminateJobContent) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type TerminateJobContent.
type TerminateJobOptions ¶
type TerminateJobOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // If true, the server will terminate the Job even if the corresponding nodes have not fully processed the termination. The // default value is false. Force *bool // An ETag value associated with the version of the resource known to the client. // The operation will be performed only if the resource's current ETag on the // service exactly matches the value specified by the client. IfMatch *azcore.ETag // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // been modified since the specified time. IfModifiedSince *time.Time // An ETag value associated with the version of the resource known to the client. // The operation will be performed only if the resource's current ETag on the // service does not match the value specified by the client. IfNoneMatch *azcore.ETag // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // not been modified since the specified time. IfUnmodifiedSince *time.Time // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // The options to use for terminating the Job. Parameters *TerminateJobContent // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
TerminateJobOptions contains the optional parameters for the Client.TerminateJob method.
type TerminateJobResponse ¶
type TerminateJobResponse struct { // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The OData ID of the resource to which the request applied. DataServiceID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
TerminateJobResponse contains the response from method Client.TerminateJob.
type TerminateJobScheduleOptions ¶
type TerminateJobScheduleOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // If true, the server will terminate the JobSchedule even if the corresponding nodes have not fully processed the termination. // The default value is false. Force *bool // An ETag value associated with the version of the resource known to the client. // The operation will be performed only if the resource's current ETag on the // service exactly matches the value specified by the client. IfMatch *azcore.ETag // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // been modified since the specified time. IfModifiedSince *time.Time // An ETag value associated with the version of the resource known to the client. // The operation will be performed only if the resource's current ETag on the // service does not match the value specified by the client. IfNoneMatch *azcore.ETag // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // not been modified since the specified time. IfUnmodifiedSince *time.Time // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
TerminateJobScheduleOptions contains the optional parameters for the Client.TerminateJobSchedule method.
type TerminateJobScheduleResponse ¶
type TerminateJobScheduleResponse struct { // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The OData ID of the resource to which the request applied. DataServiceID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
TerminateJobScheduleResponse contains the response from method Client.TerminateJobSchedule.
type TerminateTaskOptions ¶
type TerminateTaskOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // An ETag value associated with the version of the resource known to the client. // The operation will be performed only if the resource's current ETag on the // service exactly matches the value specified by the client. IfMatch *azcore.ETag // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // been modified since the specified time. IfModifiedSince *time.Time // An ETag value associated with the version of the resource known to the client. // The operation will be performed only if the resource's current ETag on the // service does not match the value specified by the client. IfNoneMatch *azcore.ETag // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // not been modified since the specified time. IfUnmodifiedSince *time.Time // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
TerminateTaskOptions contains the optional parameters for the Client.TerminateTask method.
type TerminateTaskResponse ¶
type TerminateTaskResponse struct { // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The OData ID of the resource to which the request applied. DataServiceID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
TerminateTaskResponse contains the response from method Client.TerminateTask.
type UEFISettings ¶
type UEFISettings struct { // Specifies whether secure boot should be enabled on the virtual machine. SecureBootEnabled *bool // Specifies whether vTPM should be enabled on the virtual machine. VTPMEnabled *bool }
UEFISettings - Specifies the security settings like secure boot and vTPM used while creating the virtual machine.
func (UEFISettings) MarshalJSON ¶
func (u UEFISettings) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type UEFISettings.
func (*UEFISettings) UnmarshalJSON ¶
func (u *UEFISettings) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type UEFISettings.
type UpdateJobContent ¶
type UpdateJobContent struct { // Whether Tasks in this job can be preempted by other high priority jobs. If the value is set to True, other high priority // jobs submitted to the system will take precedence and will be able requeue tasks from this job. You can update a job's // allowTaskPreemption after it has been created using the update job API. AllowTaskPreemption *bool // The execution constraints for the Job. If omitted, the existing execution constraints are left unchanged. Constraints *JobConstraints // The maximum number of tasks that can be executed in parallel for the job. The value of maxParallelTasks must be -1 or greater // than 0 if specified. If not specified, the default value is -1, which means there's no limit to the number of tasks that // can be run at once. You can update a job's maxParallelTasks after it has been created using the update job API. MaxParallelTasks *int32 // A list of name-value pairs associated with the Job as metadata. If omitted, the existing Job metadata is left unchanged. Metadata []MetadataItem // The network configuration for the Job. NetworkConfiguration *JobNetworkConfiguration // The action the Batch service should take when all Tasks in the Job are in the completed state. If omitted, the completion // behavior is left unchanged. You may not change the value from terminatejob to noaction - that is, once you have engaged // automatic Job termination, you cannot turn it off again. If you try to do this, the request fails with an 'invalid property // value' error response; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). OnAllTasksComplete *OnAllTasksComplete // The Pool on which the Batch service runs the Job's Tasks. You may change the Pool for a Job only when the Job is disabled. // The Patch Job call will fail if you include the poolInfo element and the Job is not disabled. If you specify an autoPoolSpecification // in the poolInfo, only the keepAlive property of the autoPoolSpecification can be updated, and then only if the autoPoolSpecification // has a poolLifetimeOption of Job (other job properties can be updated as normal). If omitted, the Job continues to run on // its current Pool. PoolInfo *PoolInfo // The priority of the Job. Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being // the highest priority. If omitted, the priority of the Job is left unchanged. Priority *int32 }
UpdateJobContent - Parameters for updating an Azure Batch Job.
func (UpdateJobContent) MarshalJSON ¶
func (u UpdateJobContent) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type UpdateJobContent.
func (*UpdateJobContent) UnmarshalJSON ¶
func (u *UpdateJobContent) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type UpdateJobContent.
type UpdateJobOptions ¶
type UpdateJobOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // An ETag value associated with the version of the resource known to the client. // The operation will be performed only if the resource's current ETag on the // service exactly matches the value specified by the client. IfMatch *azcore.ETag // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // been modified since the specified time. IfModifiedSince *time.Time // An ETag value associated with the version of the resource known to the client. // The operation will be performed only if the resource's current ETag on the // service does not match the value specified by the client. IfNoneMatch *azcore.ETag // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // not been modified since the specified time. IfUnmodifiedSince *time.Time // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
UpdateJobOptions contains the optional parameters for the Client.UpdateJob method.
type UpdateJobResponse ¶
type UpdateJobResponse struct { // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The OData ID of the resource to which the request applied. DataServiceID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
UpdateJobResponse contains the response from method Client.UpdateJob.
type UpdateJobScheduleContent ¶
type UpdateJobScheduleContent struct { // The details of the Jobs to be created on this schedule. Updates affect only Jobs that are started after the update has // taken place. Any currently active Job continues with the older specification. JobSpecification *JobSpecification // A list of name-value pairs associated with the Job Schedule as metadata. If you do not specify this element, existing metadata // is left unchanged. Metadata []MetadataItem // The schedule according to which Jobs will be created. All times are fixed respective to UTC and are not impacted by daylight // saving time. If you do not specify this element, the existing schedule is left unchanged. Schedule *JobScheduleConfiguration }
UpdateJobScheduleContent - Parameters for updating an Azure Batch Job Schedule.
func (UpdateJobScheduleContent) MarshalJSON ¶
func (u UpdateJobScheduleContent) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type UpdateJobScheduleContent.
func (*UpdateJobScheduleContent) UnmarshalJSON ¶
func (u *UpdateJobScheduleContent) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type UpdateJobScheduleContent.
type UpdateJobScheduleOptions ¶
type UpdateJobScheduleOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // An ETag value associated with the version of the resource known to the client. // The operation will be performed only if the resource's current ETag on the // service exactly matches the value specified by the client. IfMatch *azcore.ETag // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // been modified since the specified time. IfModifiedSince *time.Time // An ETag value associated with the version of the resource known to the client. // The operation will be performed only if the resource's current ETag on the // service does not match the value specified by the client. IfNoneMatch *azcore.ETag // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // not been modified since the specified time. IfUnmodifiedSince *time.Time // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
UpdateJobScheduleOptions contains the optional parameters for the Client.UpdateJobSchedule method.
type UpdateJobScheduleResponse ¶
type UpdateJobScheduleResponse struct { // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The OData ID of the resource to which the request applied. DataServiceID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
UpdateJobScheduleResponse contains the response from method Client.UpdateJobSchedule.
type UpdateNodeUserContent ¶
type UpdateNodeUserContent struct { // The time at which the Account should expire. If omitted, the default is 1 day from the current time. For Linux Compute // Nodes, the expiryTime has a precision up to a day. ExpiryTime *time.Time // The password of the Account. The password is required for Windows Compute Nodes. For Linux Compute Nodes, the password // can optionally be specified along with the sshPublicKey property. If omitted, any existing password is removed. Password *string // The SSH public key that can be used for remote login to the Compute Node. The public key should be compatible with OpenSSH // encoding and should be base 64 encoded. This property can be specified only for Linux Compute Nodes. If this is specified // for a Windows Compute Node, then the Batch service rejects the request; if you are calling the REST API directly, the HTTP // status code is 400 (Bad Request). If omitted, any existing SSH public key is removed. SSHPublicKey *string }
UpdateNodeUserContent - Parameters for updating a user account for RDP or SSH access on an Azure Batch Compute Node.
func (UpdateNodeUserContent) MarshalJSON ¶
func (u UpdateNodeUserContent) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type UpdateNodeUserContent.
func (*UpdateNodeUserContent) UnmarshalJSON ¶
func (u *UpdateNodeUserContent) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type UpdateNodeUserContent.
type UpdatePoolContent ¶
type UpdatePoolContent struct { // A list of Packages to be installed on each Compute Node in the Pool. Changes to Package references affect all new Nodes // joining the Pool, but do not affect Compute Nodes that are already in the Pool until they are rebooted or reimaged. If // this element is present, it replaces any existing Package references. If you specify an empty collection, then all Package // references are removed from the Pool. If omitted, any existing Package references are left unchanged. ApplicationPackageReferences []ApplicationPackageReference // If this element is present, it replaces any existing Certificate references configured on the Pool. // If omitted, any existing Certificate references are left unchanged. // For Windows Nodes, the Batch service installs the Certificates to the specified Certificate store and location. // For Linux Compute Nodes, the Certificates are stored in a directory inside the Task working directory and an environment // variable AZ_BATCH_CERTIFICATES_DIR is supplied to the Task to query for this location. // For Certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) // and Certificates are placed in that directory. // Warning: This property is deprecated and will be removed after February, 2024. Please use the [Azure KeyVault Extension](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) // instead. CertificateReferences []CertificateReference // The display name for the Pool. The display name need not be unique and can contain any Unicode characters up to a maximum // length of 1024. This field can be updated only when the pool is empty. DisplayName *string // Whether the Pool permits direct communication between Compute Nodes. Enabling inter-node communication limits the maximum // size of the Pool due to deployment restrictions on the Compute Nodes of the Pool. This may result in the Pool not reaching // its desired size. The default value is false.<br /><br />This field can be updated only when the pool is empty. EnableInterNodeCommunication *bool // A list of name-value pairs associated with the Pool as metadata. If this element is present, it replaces any existing metadata // configured on the Pool. If you specify an empty collection, any metadata is removed from the Pool. If omitted, any existing // metadata is left unchanged. Metadata []MetadataItem // Mount storage using specified file system for the entire lifetime of the pool. Mount the storage using Azure fileshare, // NFS, CIFS or Blobfuse based file system.<br /><br />This field can be updated only when the pool is empty. MountConfiguration []MountConfiguration // The network configuration for the Pool. This field can be updated only when the pool is empty. NetworkConfiguration *NetworkConfiguration // The user-specified tags associated with the pool. The user-defined tags to be associated with the Azure Batch Pool. When // specified, these tags are propagated to the backing Azure resources associated with the pool. This property can only be // specified when the Batch account was created with the poolAllocationMode property set to 'UserSubscription'.<br /><br />This // field can be updated only when the pool is empty. ResourceTags map[string]*string // A Task to run on each Compute Node as it joins the Pool. The Task runs when the Compute Node is added to the Pool or when // the Compute Node is restarted. If this element is present, it overwrites any existing StartTask. If omitted, any existing // StartTask is left unchanged. StartTask *StartTask // The desired node communication mode for the pool. If this element is present, it replaces the existing targetNodeCommunicationMode // configured on the Pool. If omitted, any existing metadata is left unchanged. TargetNodeCommunicationMode *NodeCommunicationMode // How Tasks are distributed across Compute Nodes in a Pool. If not specified, the default is spread.<br /><br />This field // can be updated only when the pool is empty. TaskSchedulingPolicy *TaskSchedulingPolicy // The number of task slots that can be used to run concurrent tasks on a single compute node in the pool. The default value // is 1. The maximum value is the smaller of 4 times the number of cores of the vmSize of the pool or 256.<br /><br />This // field can be updated only when the pool is empty. TaskSlotsPerNode *int32 // The upgrade policy for the Pool. Describes an upgrade policy - automatic, manual, or rolling.<br /><br />This field can // be updated only when the pool is empty. UpgradePolicy *UpgradePolicy // The list of user Accounts to be created on each Compute Node in the Pool. This field can be updated only when the pool // is empty. UserAccounts []UserAccount // The size of virtual machines in the Pool. For information about available sizes of virtual machines in Pools, see Choose // a VM size for Compute Nodes in an Azure Batch Pool (https://learn.microsoft.com/azure/batch/batch-pool-vm-sizes).<br /><br // />This field can be updated only when the pool is empty. VMSize *string // The virtual machine configuration for the Pool. This property must be specified.<br /><br />This field can be updated only // when the pool is empty. VirtualMachineConfiguration *VirtualMachineConfiguration }
UpdatePoolContent - Parameters for updating an Azure Batch Pool.
func (UpdatePoolContent) MarshalJSON ¶
func (u UpdatePoolContent) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type UpdatePoolContent.
func (*UpdatePoolContent) UnmarshalJSON ¶
func (u *UpdatePoolContent) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type UpdatePoolContent.
type UpdatePoolOptions ¶
type UpdatePoolOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // An ETag value associated with the version of the resource known to the client. // The operation will be performed only if the resource's current ETag on the // service exactly matches the value specified by the client. IfMatch *azcore.ETag // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // been modified since the specified time. IfModifiedSince *time.Time // An ETag value associated with the version of the resource known to the client. // The operation will be performed only if the resource's current ETag on the // service does not match the value specified by the client. IfNoneMatch *azcore.ETag // A timestamp indicating the last modified time of the resource known to the // client. The operation will be performed only if the resource on the service has // not been modified since the specified time. IfUnmodifiedSince *time.Time // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
UpdatePoolOptions contains the optional parameters for the Client.UpdatePool method.
type UpdatePoolResponse ¶
type UpdatePoolResponse struct { // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The OData ID of the resource to which the request applied. DataServiceID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
UpdatePoolResponse contains the response from method Client.UpdatePool.
type UpgradeMode ¶
type UpgradeMode string
UpgradeMode - UpgradeMode enums
const ( // UpgradeModeAutomatic - TAll virtual machines in the scale set are automatically updated at the same time. UpgradeModeAutomatic UpgradeMode = "automatic" // UpgradeModeManual - You control the application of updates to virtual machines in the scale set. You do this by using the // manualUpgrade action. UpgradeModeManual UpgradeMode = "manual" // UpgradeModeRolling - The existing instances in a scale set are brought down in batches to be upgraded. Once the upgraded // batch is complete, the instances will begin taking traffic again and the next batch will begin. This continues until all // instances brought up-to-date. UpgradeModeRolling UpgradeMode = "rolling" )
func PossibleUpgradeModeValues ¶
func PossibleUpgradeModeValues() []UpgradeMode
PossibleUpgradeModeValues returns the possible values for the UpgradeMode const type.
type UpgradePolicy ¶
type UpgradePolicy struct { // REQUIRED; Specifies the mode of an upgrade to virtual machines in the scale set.<br /><br /> Possible values are:<br /><br // /> **Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade // action.<br /><br /> **Automatic** - All virtual machines in the scale set are automatically updated at the same time.<br // /><br /> **Rolling** - Scale set performs updates in batches with an optional pause time in between. Mode *UpgradeMode // Configuration parameters used for performing automatic OS Upgrade. The configuration parameters used for performing automatic // OS upgrade. AutomaticOsUpgradePolicy *AutomaticOSUpgradePolicy // The configuration parameters used while performing a rolling upgrade. RollingUpgradePolicy *RollingUpgradePolicy }
UpgradePolicy - Describes an upgrade policy - automatic, manual, or rolling.
func (UpgradePolicy) MarshalJSON ¶
func (u UpgradePolicy) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type UpgradePolicy.
func (*UpgradePolicy) UnmarshalJSON ¶
func (u *UpgradePolicy) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type UpgradePolicy.
type UploadNodeLogsContent ¶
type UploadNodeLogsContent struct { // REQUIRED; The URL of the container within Azure Blob Storage to which to upload the Batch Service log file(s). If a user // assigned managed identity is not being used, the URL must include a Shared Access Signature (SAS) granting write permissions // to the container. The SAS duration must allow enough time for the upload to finish. The start time for SAS is optional // and recommended to not be specified. ContainerURL *string // REQUIRED; The start of the time range from which to upload Batch Service log file(s). Any log file containing a log message // in the time range will be uploaded. This means that the operation might retrieve more logs than have been requested since // the entire log file is always uploaded, but the operation should not retrieve fewer logs than have been requested. StartTime *time.Time // The end of the time range from which to upload Batch Service log file(s). Any log file containing a log message in the // time range will be uploaded. This means that the operation might retrieve more logs than have been requested since the // entire log file is always uploaded, but the operation should not retrieve fewer logs than have been requested. If omitted, // the default is to upload all logs available after the startTime. EndTime *time.Time // The reference to the user assigned identity to use to access Azure Blob Storage specified by containerUrl. The identity // must have write access to the Azure Blob Storage container. IdentityReference *NodeIdentityReference }
UploadNodeLogsContent - The Azure Batch service log files upload parameters for a Compute Node.
func (UploadNodeLogsContent) MarshalJSON ¶
func (u UploadNodeLogsContent) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type UploadNodeLogsContent.
func (*UploadNodeLogsContent) UnmarshalJSON ¶
func (u *UploadNodeLogsContent) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type UploadNodeLogsContent.
type UploadNodeLogsOptions ¶
type UploadNodeLogsOptions struct { // The caller-generated request identity, in the form of a GUID with no decoration // such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0. ClientRequestID *string // The time the request was issued. Client libraries typically set this to the // current system clock time; set it explicitly if you are calling the REST API // directly. OCPDate *time.Time // Whether the server should return the client-request-id in the response. ReturnClientRequestID *bool // The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value // is larger than 30, the default will be used instead.". Timeout *int32 }
UploadNodeLogsOptions contains the optional parameters for the Client.UploadNodeLogs method.
type UploadNodeLogsResponse ¶
type UploadNodeLogsResponse struct { // The result of uploading Batch service log files from a specific Compute Node. UploadNodeLogsResult // The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id // parameter was set to true. ClientRequestID *string // The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between // requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match // headers. ETag *azcore.ETag // The time at which the resource was last modified. LastModified *time.Time // A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have // verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, // include the value of this request ID, the approximate time that the request was made, the Batch Account against which the // request was made, and the region that Account resides in. RequestID *string }
UploadNodeLogsResponse contains the response from method Client.UploadNodeLogs.
type UploadNodeLogsResult ¶
type UploadNodeLogsResult struct { // REQUIRED; The number of log files which will be uploaded. NumberOfFilesUploaded *int32 // REQUIRED; The virtual directory within Azure Blob Storage container to which the Batch Service log file(s) will be uploaded. // The virtual directory name is part of the blob name for each log file uploaded, and it is built based poolId, nodeId and // a unique identifier. VirtualDirectoryName *string }
UploadNodeLogsResult - The result of uploading Batch service log files from a specific Compute Node.
func (UploadNodeLogsResult) MarshalJSON ¶
func (u UploadNodeLogsResult) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type UploadNodeLogsResult.
func (*UploadNodeLogsResult) UnmarshalJSON ¶
func (u *UploadNodeLogsResult) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type UploadNodeLogsResult.
type UserAccount ¶
type UserAccount struct { // REQUIRED; The name of the user Account. Names can contain any Unicode characters up to a maximum length of 20. Name *string // REQUIRED; The password for the user Account. Password *string // The elevation level of the user Account. The default value is nonAdmin. ElevationLevel *ElevationLevel // The Linux-specific user configuration for the user Account. This property is ignored if specified on a Windows Pool. If // not specified, the user is created with the default options. LinuxUserConfiguration *LinuxUserConfiguration // The Windows-specific user configuration for the user Account. This property can only be specified if the user is on a Windows // Pool. If not specified and on a Windows Pool, the user is created with the default options. WindowsUserConfiguration *WindowsUserConfiguration }
UserAccount - Properties used to create a user used to execute Tasks on an Azure Batch Compute Node.
func (UserAccount) MarshalJSON ¶
func (u UserAccount) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type UserAccount.
func (*UserAccount) UnmarshalJSON ¶
func (u *UserAccount) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type UserAccount.
type UserAssignedIdentity ¶
type UserAssignedIdentity struct { // REQUIRED; The ARM resource id of the user assigned identity. ResourceID *string // READ-ONLY; The client id of the user assigned identity. ClientID *string // READ-ONLY; The principal id of the user assigned identity. PrincipalID *string }
UserAssignedIdentity - The user assigned Identity
func (UserAssignedIdentity) MarshalJSON ¶
func (u UserAssignedIdentity) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type UserAssignedIdentity.
func (*UserAssignedIdentity) UnmarshalJSON ¶
func (u *UserAssignedIdentity) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type UserAssignedIdentity.
type UserIdentity ¶
type UserIdentity struct { // The auto user under which the Task is run. The userName and autoUser properties are mutually exclusive; you must specify // one but not both. AutoUser *AutoUserSpecification // The name of the user identity under which the Task is run. The userName and autoUser properties are mutually exclusive; // you must specify one but not both. Username *string }
UserIdentity - The definition of the user identity under which the Task is run. Specify either the userName or autoUser property, but not both.
func (UserIdentity) MarshalJSON ¶
func (u UserIdentity) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type UserIdentity.
func (*UserIdentity) UnmarshalJSON ¶
func (u *UserIdentity) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type UserIdentity.
type VMDiskSecurityProfile ¶
type VMDiskSecurityProfile struct { // Specifies the EncryptionType of the managed disk. It is set to VMGuestStateOnly for encryption of just the VMGuestState // blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob. **Note**: It can be set for only // Confidential VMs and is required when using Confidential VMs. SecurityEncryptionType *SecurityEncryptionTypes }
VMDiskSecurityProfile - Specifies the security profile settings for the managed disk. **Note**: It can only be set for Confidential VMs and required when using Confidential VMs.
func (VMDiskSecurityProfile) MarshalJSON ¶
func (v VMDiskSecurityProfile) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type VMDiskSecurityProfile.
func (*VMDiskSecurityProfile) UnmarshalJSON ¶
func (v *VMDiskSecurityProfile) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type VMDiskSecurityProfile.
type VMExtension ¶
type VMExtension struct { // REQUIRED; The name of the virtual machine extension. Name *string // REQUIRED; The name of the extension handler publisher. Publisher *string // REQUIRED; The type of the extension. Type *string // Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, // however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. AutoUpgradeMinorVersion *bool // Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension // available. EnableAutomaticUpgrade *bool // The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. ProtectedSettings map[string]*string // The collection of extension names. Collection of extension names after which this extension needs to be provisioned. ProvisionAfterExtensions []string // JSON formatted public settings for the extension. Settings map[string]*string // The version of script handler. TypeHandlerVersion *string }
VMExtension - The configuration for virtual machine extensions.
func (VMExtension) MarshalJSON ¶
func (v VMExtension) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type VMExtension.
func (*VMExtension) UnmarshalJSON ¶
func (v *VMExtension) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type VMExtension.
type VMExtensionInstanceView ¶
type VMExtensionInstanceView struct { // The name of the vm extension instance view. Name *string // The resource status information. Statuses []InstanceViewStatus // The resource status information. SubStatuses []InstanceViewStatus }
VMExtensionInstanceView - The vm extension instance view.
func (VMExtensionInstanceView) MarshalJSON ¶
func (v VMExtensionInstanceView) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type VMExtensionInstanceView.
func (*VMExtensionInstanceView) UnmarshalJSON ¶
func (v *VMExtensionInstanceView) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type VMExtensionInstanceView.
type VirtualMachineConfiguration ¶
type VirtualMachineConfiguration struct { // REQUIRED; A reference to the Azure Virtual Machines Marketplace Image or the custom Virtual Machine Image to use. ImageReference *ImageReference // REQUIRED; The SKU of the Batch Compute Node agent to be provisioned on Compute Nodes in the Pool. The Batch Compute Node // agent is a program that runs on each Compute Node in the Pool, and provides the command-and-control interface between the // Compute Node and the Batch service. There are different implementations of the Compute Node agent, known as SKUs, for different // operating systems. You must specify a Compute Node agent SKU which matches the selected Image reference. To get the list // of supported Compute Node agent SKUs along with their list of verified Image references, see the 'List supported Compute // Node agent SKUs' operation. NodeAgentSKUID *string // The container configuration for the Pool. If specified, setup is performed on each Compute Node in the Pool to allow Tasks // to run in containers. All regular Tasks and Job manager Tasks run on this Pool must specify the containerSettings property, // and all other Tasks may specify it. ContainerConfiguration *ContainerConfiguration // The configuration for data disks attached to the Compute Nodes in the Pool. This property must be specified if the Compute // Nodes in the Pool need to have empty data disks attached to them. This cannot be updated. Each Compute Node gets its own // disk (the disk is not a file share). Existing disks cannot be attached, each attached disk is empty. When the Compute Node // is removed from the Pool, the disk and all data associated with it is also deleted. The disk is not formatted after being // attached, it must be formatted before use - for more information see https://learn.microsoft.com/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux // and https://learn.microsoft.com/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine. DataDisks []DataDisk // The disk encryption configuration for the pool. If specified, encryption is performed on each node in the pool during node // provisioning. DiskEncryptionConfiguration *DiskEncryptionConfiguration // The virtual machine extension for the pool. If specified, the extensions mentioned in this configuration will be installed // on each node. Extensions []VMExtension // This only applies to Images that contain the Windows operating system, and // should only be used when you hold valid on-premises licenses for the Compute // Nodes which will be deployed. If omitted, no on-premises licensing discount is // applied. Values are: // Windows_Server - The on-premises license is for Windows // Server. // Windows_Client - The on-premises license is for Windows Client. LicenseType *string // The node placement configuration for the pool. This configuration will specify rules on how nodes in the pool will be physically // allocated. NodePlacementConfiguration *NodePlacementConfiguration // Settings for the operating system disk of the Virtual Machine. OSDisk *OSDisk // Specifies the security profile settings for the virtual machine or virtual machine scale set. SecurityProfile *SecurityProfile // Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when // using 'latest' image version. The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} ServiceArtifactReference *ServiceArtifactReference // Windows operating system settings on the virtual machine. This property must not be specified if the imageReference property // specifies a Linux OS Image. WindowsConfiguration *WindowsConfiguration }
VirtualMachineConfiguration - The configuration for Compute Nodes in a Pool based on the Azure Virtual Machines infrastructure.
func (VirtualMachineConfiguration) MarshalJSON ¶
func (v VirtualMachineConfiguration) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type VirtualMachineConfiguration.
func (*VirtualMachineConfiguration) UnmarshalJSON ¶
func (v *VirtualMachineConfiguration) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type VirtualMachineConfiguration.
type VirtualMachineInfo ¶
type VirtualMachineInfo struct { // The reference to the Azure Virtual Machine's Marketplace Image. ImageReference *ImageReference // The resource ID of the Compute Node's current Virtual Machine Scale Set VM. Only defined if the Batch Account was created // with its poolAllocationMode property set to 'UserSubscription'. ScaleSetVMResourceID *string }
VirtualMachineInfo - Info about the current state of the virtual machine.
func (VirtualMachineInfo) MarshalJSON ¶
func (v VirtualMachineInfo) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type VirtualMachineInfo.
func (*VirtualMachineInfo) UnmarshalJSON ¶
func (v *VirtualMachineInfo) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type VirtualMachineInfo.
type WindowsConfiguration ¶
type WindowsConfiguration struct { // Whether automatic updates are enabled on the virtual machine. If omitted, the default value is true. EnableAutomaticUpdates *bool }
WindowsConfiguration - Windows operating system settings to apply to the virtual machine.
func (WindowsConfiguration) MarshalJSON ¶
func (w WindowsConfiguration) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type WindowsConfiguration.
func (*WindowsConfiguration) UnmarshalJSON ¶
func (w *WindowsConfiguration) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type WindowsConfiguration.
type WindowsUserConfiguration ¶
type WindowsUserConfiguration struct { // The login mode for the user. The default is 'batch'. LoginMode *LoginMode }
WindowsUserConfiguration - Properties used to create a user Account on a Windows Compute Node.
func (WindowsUserConfiguration) MarshalJSON ¶
func (w WindowsUserConfiguration) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaller interface for type WindowsUserConfiguration.
func (*WindowsUserConfiguration) UnmarshalJSON ¶
func (w *WindowsUserConfiguration) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaller interface for type WindowsUserConfiguration.