pool

package
v0.20241212.1154051 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 12, 2024 License: MPL-2.0 Imports: 15 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/batch/2024-07-01/pool Documentation

The pool SDK allows for interaction with Azure Resource Manager batch (API Version 2024-07-01).

This readme covers example usages, but further information on using this SDK can be found in the project root.

Import Path

import "github.com/hashicorp/go-azure-sdk/resource-manager/batch/2024-07-01/pool"

Client Initialization

client := pool.NewPoolClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: PoolClient.Create

ctx := context.TODO()
id := pool.NewPoolID("12345678-1234-9876-4563-123456789012", "example-resource-group", "batchAccountName", "poolName")

payload := pool.Pool{
	// ...
}


read, err := client.Create(ctx, id, payload, pool.DefaultCreateOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: PoolClient.Delete

ctx := context.TODO()
id := pool.NewPoolID("12345678-1234-9876-4563-123456789012", "example-resource-group", "batchAccountName", "poolName")

if err := client.DeleteThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: PoolClient.DisableAutoScale

ctx := context.TODO()
id := pool.NewPoolID("12345678-1234-9876-4563-123456789012", "example-resource-group", "batchAccountName", "poolName")

read, err := client.DisableAutoScale(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: PoolClient.Get

ctx := context.TODO()
id := pool.NewPoolID("12345678-1234-9876-4563-123456789012", "example-resource-group", "batchAccountName", "poolName")

read, err := client.Get(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: PoolClient.ListByBatchAccount

ctx := context.TODO()
id := pool.NewBatchAccountID("12345678-1234-9876-4563-123456789012", "example-resource-group", "batchAccountName")

// alternatively `client.ListByBatchAccount(ctx, id, pool.DefaultListByBatchAccountOperationOptions())` can be used to do batched pagination
items, err := client.ListByBatchAccountComplete(ctx, id, pool.DefaultListByBatchAccountOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: PoolClient.StopResize

ctx := context.TODO()
id := pool.NewPoolID("12345678-1234-9876-4563-123456789012", "example-resource-group", "batchAccountName", "poolName")

read, err := client.StopResize(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: PoolClient.Update

ctx := context.TODO()
id := pool.NewPoolID("12345678-1234-9876-4563-123456789012", "example-resource-group", "batchAccountName", "poolName")

payload := pool.Pool{
	// ...
}


read, err := client.Update(ctx, id, payload, pool.DefaultUpdateOperationOptions())
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForAllocationState

func PossibleValuesForAllocationState() []string

func PossibleValuesForAutoUserScope

func PossibleValuesForAutoUserScope() []string

func PossibleValuesForCachingType

func PossibleValuesForCachingType() []string

func PossibleValuesForCertificateStoreLocation

func PossibleValuesForCertificateStoreLocation() []string

func PossibleValuesForCertificateVisibility

func PossibleValuesForCertificateVisibility() []string

func PossibleValuesForComputeNodeDeallocationOption

func PossibleValuesForComputeNodeDeallocationOption() []string

func PossibleValuesForComputeNodeFillType

func PossibleValuesForComputeNodeFillType() []string

func PossibleValuesForContainerHostDataPath

func PossibleValuesForContainerHostDataPath() []string

func PossibleValuesForContainerType

func PossibleValuesForContainerType() []string

func PossibleValuesForContainerWorkingDirectory

func PossibleValuesForContainerWorkingDirectory() []string

func PossibleValuesForDiffDiskPlacement

func PossibleValuesForDiffDiskPlacement() []string

func PossibleValuesForDiskEncryptionTarget

func PossibleValuesForDiskEncryptionTarget() []string

func PossibleValuesForDynamicVNetAssignmentScope

func PossibleValuesForDynamicVNetAssignmentScope() []string

func PossibleValuesForElevationLevel

func PossibleValuesForElevationLevel() []string

func PossibleValuesForIPAddressProvisioningType

func PossibleValuesForIPAddressProvisioningType() []string

func PossibleValuesForInboundEndpointProtocol

func PossibleValuesForInboundEndpointProtocol() []string

func PossibleValuesForInterNodeCommunicationState

func PossibleValuesForInterNodeCommunicationState() []string

func PossibleValuesForLoginMode

func PossibleValuesForLoginMode() []string

func PossibleValuesForNetworkSecurityGroupRuleAccess

func PossibleValuesForNetworkSecurityGroupRuleAccess() []string

func PossibleValuesForNodeCommunicationMode

func PossibleValuesForNodeCommunicationMode() []string

func PossibleValuesForNodePlacementPolicyType

func PossibleValuesForNodePlacementPolicyType() []string

func PossibleValuesForPoolProvisioningState

func PossibleValuesForPoolProvisioningState() []string

func PossibleValuesForSecurityEncryptionTypes

func PossibleValuesForSecurityEncryptionTypes() []string

func PossibleValuesForSecurityTypes

func PossibleValuesForSecurityTypes() []string

func PossibleValuesForStorageAccountType

func PossibleValuesForStorageAccountType() []string

func PossibleValuesForUpgradeMode

func PossibleValuesForUpgradeMode() []string

func ValidateBatchAccountID

func ValidateBatchAccountID(input interface{}, key string) (warnings []string, errors []error)

ValidateBatchAccountID checks that 'input' can be parsed as a Batch Account ID

func ValidatePoolID

func ValidatePoolID(input interface{}, key string) (warnings []string, errors []error)

ValidatePoolID checks that 'input' can be parsed as a Pool ID

Types

type AllocationState

type AllocationState string
const (
	AllocationStateResizing AllocationState = "Resizing"
	AllocationStateSteady   AllocationState = "Steady"
	AllocationStateStopping AllocationState = "Stopping"
)

func (*AllocationState) UnmarshalJSON

func (s *AllocationState) UnmarshalJSON(bytes []byte) error

type ApplicationPackageReference

type ApplicationPackageReference struct {
	Id      string  `json:"id"`
	Version *string `json:"version,omitempty"`
}

type AutoScaleRun

type AutoScaleRun struct {
	Error          *AutoScaleRunError `json:"error,omitempty"`
	EvaluationTime string             `json:"evaluationTime"`
	Results        *string            `json:"results,omitempty"`
}

func (*AutoScaleRun) GetEvaluationTimeAsTime

func (o *AutoScaleRun) GetEvaluationTimeAsTime() (*time.Time, error)

func (*AutoScaleRun) SetEvaluationTimeAsTime

func (o *AutoScaleRun) SetEvaluationTimeAsTime(input time.Time)

type AutoScaleRunError

type AutoScaleRunError struct {
	Code    string               `json:"code"`
	Details *[]AutoScaleRunError `json:"details,omitempty"`
	Message string               `json:"message"`
}

type AutoScaleSettings

type AutoScaleSettings struct {
	EvaluationInterval *string `json:"evaluationInterval,omitempty"`
	Formula            string  `json:"formula"`
}

type AutoUserScope

type AutoUserScope string
const (
	AutoUserScopePool AutoUserScope = "Pool"
	AutoUserScopeTask AutoUserScope = "Task"
)

func (*AutoUserScope) UnmarshalJSON

func (s *AutoUserScope) UnmarshalJSON(bytes []byte) error

type AutoUserSpecification

type AutoUserSpecification struct {
	ElevationLevel *ElevationLevel `json:"elevationLevel,omitempty"`
	Scope          *AutoUserScope  `json:"scope,omitempty"`
}

type AutomaticOSUpgradePolicy

type AutomaticOSUpgradePolicy struct {
	DisableAutomaticRollback *bool `json:"disableAutomaticRollback,omitempty"`
	EnableAutomaticOSUpgrade *bool `json:"enableAutomaticOSUpgrade,omitempty"`
	OsRollingUpgradeDeferral *bool `json:"osRollingUpgradeDeferral,omitempty"`
	UseRollingUpgradePolicy  *bool `json:"useRollingUpgradePolicy,omitempty"`
}

type AzureBlobFileSystemConfiguration

type AzureBlobFileSystemConfiguration struct {
	AccountKey        *string                       `json:"accountKey,omitempty"`
	AccountName       string                        `json:"accountName"`
	BlobfuseOptions   *string                       `json:"blobfuseOptions,omitempty"`
	ContainerName     string                        `json:"containerName"`
	IdentityReference *ComputeNodeIdentityReference `json:"identityReference,omitempty"`
	RelativeMountPath string                        `json:"relativeMountPath"`
	SasKey            *string                       `json:"sasKey,omitempty"`
}

type AzureFileShareConfiguration

type AzureFileShareConfiguration struct {
	AccountKey        string  `json:"accountKey"`
	AccountName       string  `json:"accountName"`
	AzureFileURL      string  `json:"azureFileUrl"`
	MountOptions      *string `json:"mountOptions,omitempty"`
	RelativeMountPath string  `json:"relativeMountPath"`
}

type BatchAccountId

type BatchAccountId struct {
	SubscriptionId    string
	ResourceGroupName string
	BatchAccountName  string
}

BatchAccountId is a struct representing the Resource ID for a Batch Account

func NewBatchAccountID

func NewBatchAccountID(subscriptionId string, resourceGroupName string, batchAccountName string) BatchAccountId

NewBatchAccountID returns a new BatchAccountId struct

func ParseBatchAccountID

func ParseBatchAccountID(input string) (*BatchAccountId, error)

ParseBatchAccountID parses 'input' into a BatchAccountId

func ParseBatchAccountIDInsensitively

func ParseBatchAccountIDInsensitively(input string) (*BatchAccountId, error)

ParseBatchAccountIDInsensitively parses 'input' case-insensitively into a BatchAccountId note: this method should only be used for API response data and not user input

func (*BatchAccountId) FromParseResult

func (id *BatchAccountId) FromParseResult(input resourceids.ParseResult) error

func (BatchAccountId) ID

func (id BatchAccountId) ID() string

ID returns the formatted Batch Account ID

func (BatchAccountId) Segments

func (id BatchAccountId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Batch Account ID

func (BatchAccountId) String

func (id BatchAccountId) String() string

String returns a human-readable description of this Batch Account ID

type CIFSMountConfiguration

type CIFSMountConfiguration struct {
	MountOptions      *string `json:"mountOptions,omitempty"`
	Password          string  `json:"password"`
	RelativeMountPath string  `json:"relativeMountPath"`
	Source            string  `json:"source"`
	UserName          string  `json:"userName"`
}

type CachingType

type CachingType string
const (
	CachingTypeNone      CachingType = "None"
	CachingTypeReadOnly  CachingType = "ReadOnly"
	CachingTypeReadWrite CachingType = "ReadWrite"
)

func (*CachingType) UnmarshalJSON

func (s *CachingType) UnmarshalJSON(bytes []byte) error

type CertificateReference

type CertificateReference struct {
	Id            string                    `json:"id"`
	StoreLocation *CertificateStoreLocation `json:"storeLocation,omitempty"`
	StoreName     *string                   `json:"storeName,omitempty"`
	Visibility    *[]CertificateVisibility  `json:"visibility,omitempty"`
}

type CertificateStoreLocation

type CertificateStoreLocation string
const (
	CertificateStoreLocationCurrentUser  CertificateStoreLocation = "CurrentUser"
	CertificateStoreLocationLocalMachine CertificateStoreLocation = "LocalMachine"
)

func (*CertificateStoreLocation) UnmarshalJSON

func (s *CertificateStoreLocation) UnmarshalJSON(bytes []byte) error

type CertificateVisibility

type CertificateVisibility string
const (
	CertificateVisibilityRemoteUser CertificateVisibility = "RemoteUser"
	CertificateVisibilityStartTask  CertificateVisibility = "StartTask"
	CertificateVisibilityTask       CertificateVisibility = "Task"
)

func (*CertificateVisibility) UnmarshalJSON

func (s *CertificateVisibility) UnmarshalJSON(bytes []byte) error

type ComputeNodeDeallocationOption

type ComputeNodeDeallocationOption string
const (
	ComputeNodeDeallocationOptionRequeue        ComputeNodeDeallocationOption = "Requeue"
	ComputeNodeDeallocationOptionRetainedData   ComputeNodeDeallocationOption = "RetainedData"
	ComputeNodeDeallocationOptionTaskCompletion ComputeNodeDeallocationOption = "TaskCompletion"
	ComputeNodeDeallocationOptionTerminate      ComputeNodeDeallocationOption = "Terminate"
)

func (*ComputeNodeDeallocationOption) UnmarshalJSON

func (s *ComputeNodeDeallocationOption) UnmarshalJSON(bytes []byte) error

type ComputeNodeFillType

type ComputeNodeFillType string
const (
	ComputeNodeFillTypePack   ComputeNodeFillType = "Pack"
	ComputeNodeFillTypeSpread ComputeNodeFillType = "Spread"
)

func (*ComputeNodeFillType) UnmarshalJSON

func (s *ComputeNodeFillType) UnmarshalJSON(bytes []byte) error

type ComputeNodeIdentityReference

type ComputeNodeIdentityReference struct {
	ResourceId *string `json:"resourceId,omitempty"`
}

type ContainerConfiguration

type ContainerConfiguration struct {
	ContainerImageNames *[]string            `json:"containerImageNames,omitempty"`
	ContainerRegistries *[]ContainerRegistry `json:"containerRegistries,omitempty"`
	Type                ContainerType        `json:"type"`
}

type ContainerHostBatchBindMountEntry

type ContainerHostBatchBindMountEntry struct {
	IsReadOnly *bool                  `json:"isReadOnly,omitempty"`
	Source     *ContainerHostDataPath `json:"source,omitempty"`
}

type ContainerHostDataPath

type ContainerHostDataPath string
const (
	ContainerHostDataPathApplications ContainerHostDataPath = "Applications"
	ContainerHostDataPathJobPrep      ContainerHostDataPath = "JobPrep"
	ContainerHostDataPathShared       ContainerHostDataPath = "Shared"
	ContainerHostDataPathStartup      ContainerHostDataPath = "Startup"
	ContainerHostDataPathTask         ContainerHostDataPath = "Task"
	ContainerHostDataPathVfsMounts    ContainerHostDataPath = "VfsMounts"
)

func (*ContainerHostDataPath) UnmarshalJSON

func (s *ContainerHostDataPath) UnmarshalJSON(bytes []byte) error

type ContainerRegistry

type ContainerRegistry struct {
	IdentityReference *ComputeNodeIdentityReference `json:"identityReference,omitempty"`
	Password          *string                       `json:"password,omitempty"`
	RegistryServer    *string                       `json:"registryServer,omitempty"`
	Username          *string                       `json:"username,omitempty"`
}

type ContainerType

type ContainerType string
const (
	ContainerTypeCriCompatible    ContainerType = "CriCompatible"
	ContainerTypeDockerCompatible ContainerType = "DockerCompatible"
)

func (*ContainerType) UnmarshalJSON

func (s *ContainerType) UnmarshalJSON(bytes []byte) error

type ContainerWorkingDirectory

type ContainerWorkingDirectory string
const (
	ContainerWorkingDirectoryContainerImageDefault ContainerWorkingDirectory = "ContainerImageDefault"
	ContainerWorkingDirectoryTaskWorkingDirectory  ContainerWorkingDirectory = "TaskWorkingDirectory"
)

func (*ContainerWorkingDirectory) UnmarshalJSON

func (s *ContainerWorkingDirectory) UnmarshalJSON(bytes []byte) error

type CreateOperationOptions

type CreateOperationOptions struct {
	IfMatch     *string
	IfNoneMatch *string
}

func DefaultCreateOperationOptions

func DefaultCreateOperationOptions() CreateOperationOptions

func (CreateOperationOptions) ToHeaders

func (o CreateOperationOptions) ToHeaders() *client.Headers

func (CreateOperationOptions) ToOData

func (o CreateOperationOptions) ToOData() *odata.Query

func (CreateOperationOptions) ToQuery

type CreateOperationResponse

type CreateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Pool
}

type DataDisk

type DataDisk struct {
	Caching            *CachingType        `json:"caching,omitempty"`
	DiskSizeGB         int64               `json:"diskSizeGB"`
	Lun                int64               `json:"lun"`
	StorageAccountType *StorageAccountType `json:"storageAccountType,omitempty"`
}

type DeleteOperationResponse

type DeleteOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type DeploymentConfiguration

type DeploymentConfiguration struct {
	VirtualMachineConfiguration *VirtualMachineConfiguration `json:"virtualMachineConfiguration,omitempty"`
}

type DiffDiskPlacement

type DiffDiskPlacement string
const (
	DiffDiskPlacementCacheDisk DiffDiskPlacement = "CacheDisk"
)

func (*DiffDiskPlacement) UnmarshalJSON

func (s *DiffDiskPlacement) UnmarshalJSON(bytes []byte) error

type DiffDiskSettings

type DiffDiskSettings struct {
	Placement *DiffDiskPlacement `json:"placement,omitempty"`
}

type DisableAutoScaleOperationResponse

type DisableAutoScaleOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Pool
}

type DiskEncryptionConfiguration

type DiskEncryptionConfiguration struct {
	Targets *[]DiskEncryptionTarget `json:"targets,omitempty"`
}

type DiskEncryptionTarget

type DiskEncryptionTarget string
const (
	DiskEncryptionTargetOsDisk        DiskEncryptionTarget = "OsDisk"
	DiskEncryptionTargetTemporaryDisk DiskEncryptionTarget = "TemporaryDisk"
)

func (*DiskEncryptionTarget) UnmarshalJSON

func (s *DiskEncryptionTarget) UnmarshalJSON(bytes []byte) error

type DynamicVNetAssignmentScope

type DynamicVNetAssignmentScope string
const (
	DynamicVNetAssignmentScopeJob  DynamicVNetAssignmentScope = "job"
	DynamicVNetAssignmentScopeNone DynamicVNetAssignmentScope = "none"
)

func (*DynamicVNetAssignmentScope) UnmarshalJSON

func (s *DynamicVNetAssignmentScope) UnmarshalJSON(bytes []byte) error

type ElevationLevel

type ElevationLevel string
const (
	ElevationLevelAdmin    ElevationLevel = "Admin"
	ElevationLevelNonAdmin ElevationLevel = "NonAdmin"
)

func (*ElevationLevel) UnmarshalJSON

func (s *ElevationLevel) UnmarshalJSON(bytes []byte) error

type EnvironmentSetting

type EnvironmentSetting struct {
	Name  string  `json:"name"`
	Value *string `json:"value,omitempty"`
}

type FixedScaleSettings

type FixedScaleSettings struct {
	NodeDeallocationOption *ComputeNodeDeallocationOption `json:"nodeDeallocationOption,omitempty"`
	ResizeTimeout          *string                        `json:"resizeTimeout,omitempty"`
	TargetDedicatedNodes   *int64                         `json:"targetDedicatedNodes,omitempty"`
	TargetLowPriorityNodes *int64                         `json:"targetLowPriorityNodes,omitempty"`
}

type GetOperationResponse

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Pool
}

type IPAddressProvisioningType

type IPAddressProvisioningType string
const (
	IPAddressProvisioningTypeBatchManaged        IPAddressProvisioningType = "BatchManaged"
	IPAddressProvisioningTypeNoPublicIPAddresses IPAddressProvisioningType = "NoPublicIPAddresses"
	IPAddressProvisioningTypeUserManaged         IPAddressProvisioningType = "UserManaged"
)

func (*IPAddressProvisioningType) UnmarshalJSON

func (s *IPAddressProvisioningType) UnmarshalJSON(bytes []byte) error

type ImageReference

type ImageReference struct {
	CommunityGalleryImageId *string `json:"communityGalleryImageId,omitempty"`
	Id                      *string `json:"id,omitempty"`
	Offer                   *string `json:"offer,omitempty"`
	Publisher               *string `json:"publisher,omitempty"`
	SharedGalleryImageId    *string `json:"sharedGalleryImageId,omitempty"`
	Sku                     *string `json:"sku,omitempty"`
	Version                 *string `json:"version,omitempty"`
}

type InboundEndpointProtocol

type InboundEndpointProtocol string
const (
	InboundEndpointProtocolTCP InboundEndpointProtocol = "TCP"
	InboundEndpointProtocolUDP InboundEndpointProtocol = "UDP"
)

func (*InboundEndpointProtocol) UnmarshalJSON

func (s *InboundEndpointProtocol) UnmarshalJSON(bytes []byte) error

type InboundNatPool

type InboundNatPool struct {
	BackendPort               int64                       `json:"backendPort"`
	FrontendPortRangeEnd      int64                       `json:"frontendPortRangeEnd"`
	FrontendPortRangeStart    int64                       `json:"frontendPortRangeStart"`
	Name                      string                      `json:"name"`
	NetworkSecurityGroupRules *[]NetworkSecurityGroupRule `json:"networkSecurityGroupRules,omitempty"`
	Protocol                  InboundEndpointProtocol     `json:"protocol"`
}

type InterNodeCommunicationState

type InterNodeCommunicationState string
const (
	InterNodeCommunicationStateDisabled InterNodeCommunicationState = "Disabled"
	InterNodeCommunicationStateEnabled  InterNodeCommunicationState = "Enabled"
)

func (*InterNodeCommunicationState) UnmarshalJSON

func (s *InterNodeCommunicationState) UnmarshalJSON(bytes []byte) error

type LinuxUserConfiguration

type LinuxUserConfiguration struct {
	Gid           *int64  `json:"gid,omitempty"`
	SshPrivateKey *string `json:"sshPrivateKey,omitempty"`
	Uid           *int64  `json:"uid,omitempty"`
}

type ListByBatchAccountCompleteResult

type ListByBatchAccountCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []Pool
}

type ListByBatchAccountCustomPager

type ListByBatchAccountCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListByBatchAccountCustomPager) NextPageLink() *odata.Link

type ListByBatchAccountOperationOptions

type ListByBatchAccountOperationOptions struct {
	Filter     *string
	Maxresults *int64
	Select     *string
}

func DefaultListByBatchAccountOperationOptions

func DefaultListByBatchAccountOperationOptions() ListByBatchAccountOperationOptions

func (ListByBatchAccountOperationOptions) ToHeaders

func (ListByBatchAccountOperationOptions) ToOData

func (ListByBatchAccountOperationOptions) ToQuery

type ListByBatchAccountOperationResponse

type ListByBatchAccountOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]Pool
}

type LoginMode

type LoginMode string
const (
	LoginModeBatch       LoginMode = "Batch"
	LoginModeInteractive LoginMode = "Interactive"
)

func (*LoginMode) UnmarshalJSON

func (s *LoginMode) UnmarshalJSON(bytes []byte) error

type ManagedDisk

type ManagedDisk struct {
	SecurityProfile    *VMDiskSecurityProfile `json:"securityProfile,omitempty"`
	StorageAccountType *StorageAccountType    `json:"storageAccountType,omitempty"`
}

type MetadataItem

type MetadataItem struct {
	Name  string `json:"name"`
	Value string `json:"value"`
}

type MountConfiguration

type MountConfiguration struct {
	AzureBlobFileSystemConfiguration *AzureBlobFileSystemConfiguration `json:"azureBlobFileSystemConfiguration,omitempty"`
	AzureFileShareConfiguration      *AzureFileShareConfiguration      `json:"azureFileShareConfiguration,omitempty"`
	CifsMountConfiguration           *CIFSMountConfiguration           `json:"cifsMountConfiguration,omitempty"`
	NfsMountConfiguration            *NFSMountConfiguration            `json:"nfsMountConfiguration,omitempty"`
}

type NFSMountConfiguration

type NFSMountConfiguration struct {
	MountOptions      *string `json:"mountOptions,omitempty"`
	RelativeMountPath string  `json:"relativeMountPath"`
	Source            string  `json:"source"`
}

type NetworkConfiguration

type NetworkConfiguration struct {
	DynamicVnetAssignmentScope   *DynamicVNetAssignmentScope   `json:"dynamicVnetAssignmentScope,omitempty"`
	EnableAcceleratedNetworking  *bool                         `json:"enableAcceleratedNetworking,omitempty"`
	EndpointConfiguration        *PoolEndpointConfiguration    `json:"endpointConfiguration,omitempty"`
	PublicIPAddressConfiguration *PublicIPAddressConfiguration `json:"publicIPAddressConfiguration,omitempty"`
	SubnetId                     *string                       `json:"subnetId,omitempty"`
}

type NetworkSecurityGroupRule

type NetworkSecurityGroupRule struct {
	Access              NetworkSecurityGroupRuleAccess `json:"access"`
	Priority            int64                          `json:"priority"`
	SourceAddressPrefix string                         `json:"sourceAddressPrefix"`
	SourcePortRanges    *[]string                      `json:"sourcePortRanges,omitempty"`
}

type NetworkSecurityGroupRuleAccess

type NetworkSecurityGroupRuleAccess string
const (
	NetworkSecurityGroupRuleAccessAllow NetworkSecurityGroupRuleAccess = "Allow"
	NetworkSecurityGroupRuleAccessDeny  NetworkSecurityGroupRuleAccess = "Deny"
)

func (*NetworkSecurityGroupRuleAccess) UnmarshalJSON

func (s *NetworkSecurityGroupRuleAccess) UnmarshalJSON(bytes []byte) error

type NodeCommunicationMode

type NodeCommunicationMode string
const (
	NodeCommunicationModeClassic    NodeCommunicationMode = "Classic"
	NodeCommunicationModeDefault    NodeCommunicationMode = "Default"
	NodeCommunicationModeSimplified NodeCommunicationMode = "Simplified"
)

func (*NodeCommunicationMode) UnmarshalJSON

func (s *NodeCommunicationMode) UnmarshalJSON(bytes []byte) error

type NodePlacementConfiguration

type NodePlacementConfiguration struct {
	Policy *NodePlacementPolicyType `json:"policy,omitempty"`
}

type NodePlacementPolicyType

type NodePlacementPolicyType string
const (
	NodePlacementPolicyTypeRegional NodePlacementPolicyType = "Regional"
	NodePlacementPolicyTypeZonal    NodePlacementPolicyType = "Zonal"
)

func (*NodePlacementPolicyType) UnmarshalJSON

func (s *NodePlacementPolicyType) UnmarshalJSON(bytes []byte) error

type OSDisk

type OSDisk struct {
	Caching                 *CachingType      `json:"caching,omitempty"`
	DiskSizeGB              *int64            `json:"diskSizeGB,omitempty"`
	EphemeralOSDiskSettings *DiffDiskSettings `json:"ephemeralOSDiskSettings,omitempty"`
	ManagedDisk             *ManagedDisk      `json:"managedDisk,omitempty"`
	WriteAcceleratorEnabled *bool             `json:"writeAcceleratorEnabled,omitempty"`
}

type Pool

type Pool struct {
	Etag       *string                   `json:"etag,omitempty"`
	Id         *string                   `json:"id,omitempty"`
	Identity   *identity.UserAssignedMap `json:"identity,omitempty"`
	Name       *string                   `json:"name,omitempty"`
	Properties *PoolProperties           `json:"properties,omitempty"`
	Tags       *map[string]string        `json:"tags,omitempty"`
	Type       *string                   `json:"type,omitempty"`
}

type PoolClient

type PoolClient struct {
	Client *resourcemanager.Client
}

func NewPoolClientWithBaseURI

func NewPoolClientWithBaseURI(sdkApi sdkEnv.Api) (*PoolClient, error)

func (PoolClient) Create

func (c PoolClient) Create(ctx context.Context, id PoolId, input Pool, options CreateOperationOptions) (result CreateOperationResponse, err error)

Create ...

func (PoolClient) Delete

func (c PoolClient) Delete(ctx context.Context, id PoolId) (result DeleteOperationResponse, err error)

Delete ...

func (PoolClient) DeleteThenPoll

func (c PoolClient) DeleteThenPoll(ctx context.Context, id PoolId) error

DeleteThenPoll performs Delete then polls until it's completed

func (PoolClient) DisableAutoScale

func (c PoolClient) DisableAutoScale(ctx context.Context, id PoolId) (result DisableAutoScaleOperationResponse, err error)

DisableAutoScale ...

func (PoolClient) Get

func (c PoolClient) Get(ctx context.Context, id PoolId) (result GetOperationResponse, err error)

Get ...

func (PoolClient) ListByBatchAccount

ListByBatchAccount ...

func (PoolClient) ListByBatchAccountComplete

ListByBatchAccountComplete retrieves all the results into a single object

func (PoolClient) ListByBatchAccountCompleteMatchingPredicate

func (c PoolClient) ListByBatchAccountCompleteMatchingPredicate(ctx context.Context, id BatchAccountId, options ListByBatchAccountOperationOptions, predicate PoolOperationPredicate) (result ListByBatchAccountCompleteResult, err error)

ListByBatchAccountCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (PoolClient) StopResize

func (c PoolClient) StopResize(ctx context.Context, id PoolId) (result StopResizeOperationResponse, err error)

StopResize ...

func (PoolClient) Update

func (c PoolClient) Update(ctx context.Context, id PoolId, input Pool, options UpdateOperationOptions) (result UpdateOperationResponse, err error)

Update ...

type PoolEndpointConfiguration

type PoolEndpointConfiguration struct {
	InboundNatPools []InboundNatPool `json:"inboundNatPools"`
}

type PoolId

type PoolId struct {
	SubscriptionId    string
	ResourceGroupName string
	BatchAccountName  string
	PoolName          string
}

PoolId is a struct representing the Resource ID for a Pool

func NewPoolID

func NewPoolID(subscriptionId string, resourceGroupName string, batchAccountName string, poolName string) PoolId

NewPoolID returns a new PoolId struct

func ParsePoolID

func ParsePoolID(input string) (*PoolId, error)

ParsePoolID parses 'input' into a PoolId

func ParsePoolIDInsensitively

func ParsePoolIDInsensitively(input string) (*PoolId, error)

ParsePoolIDInsensitively parses 'input' case-insensitively into a PoolId note: this method should only be used for API response data and not user input

func (*PoolId) FromParseResult

func (id *PoolId) FromParseResult(input resourceids.ParseResult) error

func (PoolId) ID

func (id PoolId) ID() string

ID returns the formatted Pool ID

func (PoolId) Segments

func (id PoolId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Pool ID

func (PoolId) String

func (id PoolId) String() string

String returns a human-readable description of this Pool ID

type PoolOperationPredicate

type PoolOperationPredicate struct {
	Etag *string
	Id   *string
	Name *string
	Type *string
}

func (PoolOperationPredicate) Matches

func (p PoolOperationPredicate) Matches(input Pool) bool

type PoolProperties

type PoolProperties struct {
	AllocationState                 *AllocationState               `json:"allocationState,omitempty"`
	AllocationStateTransitionTime   *string                        `json:"allocationStateTransitionTime,omitempty"`
	ApplicationLicenses             *[]string                      `json:"applicationLicenses,omitempty"`
	ApplicationPackages             *[]ApplicationPackageReference `json:"applicationPackages,omitempty"`
	AutoScaleRun                    *AutoScaleRun                  `json:"autoScaleRun,omitempty"`
	Certificates                    *[]CertificateReference        `json:"certificates,omitempty"`
	CreationTime                    *string                        `json:"creationTime,omitempty"`
	CurrentDedicatedNodes           *int64                         `json:"currentDedicatedNodes,omitempty"`
	CurrentLowPriorityNodes         *int64                         `json:"currentLowPriorityNodes,omitempty"`
	CurrentNodeCommunicationMode    *NodeCommunicationMode         `json:"currentNodeCommunicationMode,omitempty"`
	DeploymentConfiguration         *DeploymentConfiguration       `json:"deploymentConfiguration,omitempty"`
	DisplayName                     *string                        `json:"displayName,omitempty"`
	InterNodeCommunication          *InterNodeCommunicationState   `json:"interNodeCommunication,omitempty"`
	LastModified                    *string                        `json:"lastModified,omitempty"`
	Metadata                        *[]MetadataItem                `json:"metadata,omitempty"`
	MountConfiguration              *[]MountConfiguration          `json:"mountConfiguration,omitempty"`
	NetworkConfiguration            *NetworkConfiguration          `json:"networkConfiguration,omitempty"`
	ProvisioningState               *PoolProvisioningState         `json:"provisioningState,omitempty"`
	ProvisioningStateTransitionTime *string                        `json:"provisioningStateTransitionTime,omitempty"`
	ResizeOperationStatus           *ResizeOperationStatus         `json:"resizeOperationStatus,omitempty"`
	ResourceTags                    *map[string]string             `json:"resourceTags,omitempty"`
	ScaleSettings                   *ScaleSettings                 `json:"scaleSettings,omitempty"`
	StartTask                       *StartTask                     `json:"startTask,omitempty"`
	TargetNodeCommunicationMode     *NodeCommunicationMode         `json:"targetNodeCommunicationMode,omitempty"`
	TaskSchedulingPolicy            *TaskSchedulingPolicy          `json:"taskSchedulingPolicy,omitempty"`
	TaskSlotsPerNode                *int64                         `json:"taskSlotsPerNode,omitempty"`
	UpgradePolicy                   *UpgradePolicy                 `json:"upgradePolicy,omitempty"`
	UserAccounts                    *[]UserAccount                 `json:"userAccounts,omitempty"`
	VMSize                          *string                        `json:"vmSize,omitempty"`
}

func (*PoolProperties) GetAllocationStateTransitionTimeAsTime

func (o *PoolProperties) GetAllocationStateTransitionTimeAsTime() (*time.Time, error)

func (*PoolProperties) GetCreationTimeAsTime

func (o *PoolProperties) GetCreationTimeAsTime() (*time.Time, error)

func (*PoolProperties) GetLastModifiedAsTime

func (o *PoolProperties) GetLastModifiedAsTime() (*time.Time, error)

func (*PoolProperties) GetProvisioningStateTransitionTimeAsTime

func (o *PoolProperties) GetProvisioningStateTransitionTimeAsTime() (*time.Time, error)

func (*PoolProperties) SetAllocationStateTransitionTimeAsTime

func (o *PoolProperties) SetAllocationStateTransitionTimeAsTime(input time.Time)

func (*PoolProperties) SetCreationTimeAsTime

func (o *PoolProperties) SetCreationTimeAsTime(input time.Time)

func (*PoolProperties) SetLastModifiedAsTime

func (o *PoolProperties) SetLastModifiedAsTime(input time.Time)

func (*PoolProperties) SetProvisioningStateTransitionTimeAsTime

func (o *PoolProperties) SetProvisioningStateTransitionTimeAsTime(input time.Time)

type PoolProvisioningState

type PoolProvisioningState string
const (
	PoolProvisioningStateDeleting  PoolProvisioningState = "Deleting"
	PoolProvisioningStateSucceeded PoolProvisioningState = "Succeeded"
)

func (*PoolProvisioningState) UnmarshalJSON

func (s *PoolProvisioningState) UnmarshalJSON(bytes []byte) error

type PublicIPAddressConfiguration

type PublicIPAddressConfiguration struct {
	IPAddressIds *[]string                  `json:"ipAddressIds,omitempty"`
	Provision    *IPAddressProvisioningType `json:"provision,omitempty"`
}

type ResizeError

type ResizeError struct {
	Code    string         `json:"code"`
	Details *[]ResizeError `json:"details,omitempty"`
	Message string         `json:"message"`
}

type ResizeOperationStatus

type ResizeOperationStatus struct {
	Errors                 *[]ResizeError                 `json:"errors,omitempty"`
	NodeDeallocationOption *ComputeNodeDeallocationOption `json:"nodeDeallocationOption,omitempty"`
	ResizeTimeout          *string                        `json:"resizeTimeout,omitempty"`
	StartTime              *string                        `json:"startTime,omitempty"`
	TargetDedicatedNodes   *int64                         `json:"targetDedicatedNodes,omitempty"`
	TargetLowPriorityNodes *int64                         `json:"targetLowPriorityNodes,omitempty"`
}

func (*ResizeOperationStatus) GetStartTimeAsTime

func (o *ResizeOperationStatus) GetStartTimeAsTime() (*time.Time, error)

func (*ResizeOperationStatus) SetStartTimeAsTime

func (o *ResizeOperationStatus) SetStartTimeAsTime(input time.Time)

type ResourceFile

type ResourceFile struct {
	AutoStorageContainerName *string                       `json:"autoStorageContainerName,omitempty"`
	BlobPrefix               *string                       `json:"blobPrefix,omitempty"`
	FileMode                 *string                       `json:"fileMode,omitempty"`
	FilePath                 *string                       `json:"filePath,omitempty"`
	HTTPURL                  *string                       `json:"httpUrl,omitempty"`
	IdentityReference        *ComputeNodeIdentityReference `json:"identityReference,omitempty"`
	StorageContainerURL      *string                       `json:"storageContainerUrl,omitempty"`
}

type RollingUpgradePolicy

type RollingUpgradePolicy struct {
	EnableCrossZoneUpgrade                *bool   `json:"enableCrossZoneUpgrade,omitempty"`
	MaxBatchInstancePercent               *int64  `json:"maxBatchInstancePercent,omitempty"`
	MaxUnhealthyInstancePercent           *int64  `json:"maxUnhealthyInstancePercent,omitempty"`
	MaxUnhealthyUpgradedInstancePercent   *int64  `json:"maxUnhealthyUpgradedInstancePercent,omitempty"`
	PauseTimeBetweenBatches               *string `json:"pauseTimeBetweenBatches,omitempty"`
	PrioritizeUnhealthyInstances          *bool   `json:"prioritizeUnhealthyInstances,omitempty"`
	RollbackFailedInstancesOnPolicyBreach *bool   `json:"rollbackFailedInstancesOnPolicyBreach,omitempty"`
}

type ScaleSettings

type ScaleSettings struct {
	AutoScale  *AutoScaleSettings  `json:"autoScale,omitempty"`
	FixedScale *FixedScaleSettings `json:"fixedScale,omitempty"`
}

type SecurityEncryptionTypes

type SecurityEncryptionTypes string
const (
	SecurityEncryptionTypesNonPersistedTPM  SecurityEncryptionTypes = "NonPersistedTPM"
	SecurityEncryptionTypesVMGuestStateOnly SecurityEncryptionTypes = "VMGuestStateOnly"
)

func (*SecurityEncryptionTypes) UnmarshalJSON

func (s *SecurityEncryptionTypes) UnmarshalJSON(bytes []byte) error

type SecurityProfile

type SecurityProfile struct {
	EncryptionAtHost *bool          `json:"encryptionAtHost,omitempty"`
	SecurityType     *SecurityTypes `json:"securityType,omitempty"`
	UefiSettings     *UefiSettings  `json:"uefiSettings,omitempty"`
}

type SecurityTypes

type SecurityTypes string
const (
	SecurityTypesConfidentialVM SecurityTypes = "confidentialVM"
	SecurityTypesTrustedLaunch  SecurityTypes = "trustedLaunch"
)

func (*SecurityTypes) UnmarshalJSON

func (s *SecurityTypes) UnmarshalJSON(bytes []byte) error

type ServiceArtifactReference

type ServiceArtifactReference struct {
	Id string `json:"id"`
}

type StartTask

type StartTask struct {
	CommandLine         *string                `json:"commandLine,omitempty"`
	ContainerSettings   *TaskContainerSettings `json:"containerSettings,omitempty"`
	EnvironmentSettings *[]EnvironmentSetting  `json:"environmentSettings,omitempty"`
	MaxTaskRetryCount   *int64                 `json:"maxTaskRetryCount,omitempty"`
	ResourceFiles       *[]ResourceFile        `json:"resourceFiles,omitempty"`
	UserIdentity        *UserIdentity          `json:"userIdentity,omitempty"`
	WaitForSuccess      *bool                  `json:"waitForSuccess,omitempty"`
}

type StopResizeOperationResponse

type StopResizeOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Pool
}

type StorageAccountType

type StorageAccountType string
const (
	StorageAccountTypePremiumLRS     StorageAccountType = "Premium_LRS"
	StorageAccountTypeStandardLRS    StorageAccountType = "Standard_LRS"
	StorageAccountTypeStandardSSDLRS StorageAccountType = "StandardSSD_LRS"
)

func (*StorageAccountType) UnmarshalJSON

func (s *StorageAccountType) UnmarshalJSON(bytes []byte) error

type TaskContainerSettings

type TaskContainerSettings struct {
	ContainerHostBatchBindMounts *[]ContainerHostBatchBindMountEntry `json:"containerHostBatchBindMounts,omitempty"`
	ContainerRunOptions          *string                             `json:"containerRunOptions,omitempty"`
	ImageName                    string                              `json:"imageName"`
	Registry                     *ContainerRegistry                  `json:"registry,omitempty"`
	WorkingDirectory             *ContainerWorkingDirectory          `json:"workingDirectory,omitempty"`
}

type TaskSchedulingPolicy

type TaskSchedulingPolicy struct {
	NodeFillType ComputeNodeFillType `json:"nodeFillType"`
}

type UefiSettings

type UefiSettings struct {
	SecureBootEnabled *bool `json:"secureBootEnabled,omitempty"`
	VTpmEnabled       *bool `json:"vTpmEnabled,omitempty"`
}

type UpdateOperationOptions

type UpdateOperationOptions struct {
	IfMatch *string
}

func DefaultUpdateOperationOptions

func DefaultUpdateOperationOptions() UpdateOperationOptions

func (UpdateOperationOptions) ToHeaders

func (o UpdateOperationOptions) ToHeaders() *client.Headers

func (UpdateOperationOptions) ToOData

func (o UpdateOperationOptions) ToOData() *odata.Query

func (UpdateOperationOptions) ToQuery

type UpdateOperationResponse

type UpdateOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Pool
}

type UpgradeMode

type UpgradeMode string
const (
	UpgradeModeAutomatic UpgradeMode = "automatic"
	UpgradeModeManual    UpgradeMode = "manual"
	UpgradeModeRolling   UpgradeMode = "rolling"
)

func (*UpgradeMode) UnmarshalJSON

func (s *UpgradeMode) UnmarshalJSON(bytes []byte) error

type UpgradePolicy

type UpgradePolicy struct {
	AutomaticOSUpgradePolicy *AutomaticOSUpgradePolicy `json:"automaticOSUpgradePolicy,omitempty"`
	Mode                     UpgradeMode               `json:"mode"`
	RollingUpgradePolicy     *RollingUpgradePolicy     `json:"rollingUpgradePolicy,omitempty"`
}

type UserAccount

type UserAccount struct {
	ElevationLevel           *ElevationLevel           `json:"elevationLevel,omitempty"`
	LinuxUserConfiguration   *LinuxUserConfiguration   `json:"linuxUserConfiguration,omitempty"`
	Name                     string                    `json:"name"`
	Password                 string                    `json:"password"`
	WindowsUserConfiguration *WindowsUserConfiguration `json:"windowsUserConfiguration,omitempty"`
}

type UserIdentity

type UserIdentity struct {
	AutoUser *AutoUserSpecification `json:"autoUser,omitempty"`
	UserName *string                `json:"userName,omitempty"`
}

type VMDiskSecurityProfile

type VMDiskSecurityProfile struct {
	SecurityEncryptionType *SecurityEncryptionTypes `json:"securityEncryptionType,omitempty"`
}

type VirtualMachineConfiguration

type VirtualMachineConfiguration struct {
	ContainerConfiguration      *ContainerConfiguration      `json:"containerConfiguration,omitempty"`
	DataDisks                   *[]DataDisk                  `json:"dataDisks,omitempty"`
	DiskEncryptionConfiguration *DiskEncryptionConfiguration `json:"diskEncryptionConfiguration,omitempty"`
	Extensions                  *[]VmExtension               `json:"extensions,omitempty"`
	ImageReference              ImageReference               `json:"imageReference"`
	LicenseType                 *string                      `json:"licenseType,omitempty"`
	NodeAgentSkuId              string                       `json:"nodeAgentSkuId"`
	NodePlacementConfiguration  *NodePlacementConfiguration  `json:"nodePlacementConfiguration,omitempty"`
	OsDisk                      *OSDisk                      `json:"osDisk,omitempty"`
	SecurityProfile             *SecurityProfile             `json:"securityProfile,omitempty"`
	ServiceArtifactReference    *ServiceArtifactReference    `json:"serviceArtifactReference,omitempty"`
	WindowsConfiguration        *WindowsConfiguration        `json:"windowsConfiguration,omitempty"`
}

type VmExtension

type VmExtension struct {
	AutoUpgradeMinorVersion  *bool        `json:"autoUpgradeMinorVersion,omitempty"`
	EnableAutomaticUpgrade   *bool        `json:"enableAutomaticUpgrade,omitempty"`
	Name                     string       `json:"name"`
	ProtectedSettings        *interface{} `json:"protectedSettings,omitempty"`
	ProvisionAfterExtensions *[]string    `json:"provisionAfterExtensions,omitempty"`
	Publisher                string       `json:"publisher"`
	Settings                 *interface{} `json:"settings,omitempty"`
	Type                     string       `json:"type"`
	TypeHandlerVersion       *string      `json:"typeHandlerVersion,omitempty"`
}

type WindowsConfiguration

type WindowsConfiguration struct {
	EnableAutomaticUpdates *bool `json:"enableAutomaticUpdates,omitempty"`
}

type WindowsUserConfiguration

type WindowsUserConfiguration struct {
	LoginMode *LoginMode `json:"loginMode,omitempty"`
}

Source Files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL