Documentation
¶
Index ¶
- type Account
- func (r *Account) AccountEndpoint() *pulumi.StringOutput
- func (r *Account) ID() *pulumi.IDOutput
- func (r *Account) Location() *pulumi.StringOutput
- func (r *Account) Name() *pulumi.StringOutput
- func (r *Account) PoolAllocationMode() *pulumi.StringOutput
- func (r *Account) PrimaryAccessKey() *pulumi.StringOutput
- func (r *Account) ResourceGroupName() *pulumi.StringOutput
- func (r *Account) SecondaryAccessKey() *pulumi.StringOutput
- func (r *Account) StorageAccountId() *pulumi.StringOutput
- func (r *Account) Tags() *pulumi.MapOutput
- func (r *Account) URN() *pulumi.URNOutput
- type AccountArgs
- type AccountState
- type Certificate
- func (r *Certificate) AccountName() *pulumi.StringOutput
- func (r *Certificate) Certificate() *pulumi.StringOutput
- func (r *Certificate) Format() *pulumi.StringOutput
- func (r *Certificate) ID() *pulumi.IDOutput
- func (r *Certificate) Name() *pulumi.StringOutput
- func (r *Certificate) Password() *pulumi.StringOutput
- func (r *Certificate) PublicData() *pulumi.StringOutput
- func (r *Certificate) ResourceGroupName() *pulumi.StringOutput
- func (r *Certificate) Thumbprint() *pulumi.StringOutput
- func (r *Certificate) ThumbprintAlgorithm() *pulumi.StringOutput
- func (r *Certificate) URN() *pulumi.URNOutput
- type CertificateArgs
- type CertificateState
- type GetAccountArgs
- type GetAccountResult
- type GetCertificateArgs
- type GetCertificateResult
- type GetPoolArgs
- type GetPoolResult
- type Pool
- func (r *Pool) AccountName() *pulumi.StringOutput
- func (r *Pool) AutoScale() *pulumi.Output
- func (r *Pool) Certificates() *pulumi.ArrayOutput
- func (r *Pool) ContainerConfiguration() *pulumi.Output
- func (r *Pool) DisplayName() *pulumi.StringOutput
- func (r *Pool) FixedScale() *pulumi.Output
- func (r *Pool) ID() *pulumi.IDOutput
- func (r *Pool) MaxTasksPerNode() *pulumi.IntOutput
- func (r *Pool) Name() *pulumi.StringOutput
- func (r *Pool) NodeAgentSkuId() *pulumi.StringOutput
- func (r *Pool) ResourceGroupName() *pulumi.StringOutput
- func (r *Pool) StartTask() *pulumi.Output
- func (r *Pool) StopPendingResizeOperation() *pulumi.BoolOutput
- func (r *Pool) StorageImageReference() *pulumi.Output
- func (r *Pool) URN() *pulumi.URNOutput
- func (r *Pool) VmSize() *pulumi.StringOutput
- type PoolArgs
- type PoolState
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Account ¶
type Account struct {
// contains filtered or unexported fields
}
Manages an Azure Batch account.
func GetAccount ¶
func GetAccount(ctx *pulumi.Context, name string, id pulumi.ID, state *AccountState, opts ...pulumi.ResourceOpt) (*Account, error)
GetAccount gets an existing Account resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewAccount ¶
func NewAccount(ctx *pulumi.Context, name string, args *AccountArgs, opts ...pulumi.ResourceOpt) (*Account, error)
NewAccount registers a new resource with the given unique name, arguments, and options.
func (*Account) AccountEndpoint ¶ added in v0.18.0
func (r *Account) AccountEndpoint() *pulumi.StringOutput
The account endpoint used to interact with the Batch service.
func (*Account) Location ¶
func (r *Account) Location() *pulumi.StringOutput
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
func (*Account) Name ¶
func (r *Account) Name() *pulumi.StringOutput
Specifies the name of the Batch account. Changing this forces a new resource to be created.
func (*Account) PoolAllocationMode ¶
func (r *Account) PoolAllocationMode() *pulumi.StringOutput
Specifies the mode to use for pool allocation. Possible values are `BatchService` or `UserSubscription`. Defaults to `BatchService`.
func (*Account) PrimaryAccessKey ¶ added in v0.18.0
func (r *Account) PrimaryAccessKey() *pulumi.StringOutput
The Batch account primary access key.
func (*Account) ResourceGroupName ¶
func (r *Account) ResourceGroupName() *pulumi.StringOutput
The name of the resource group in which to create the Batch account. Changing this forces a new resource to be created.
func (*Account) SecondaryAccessKey ¶ added in v0.18.0
func (r *Account) SecondaryAccessKey() *pulumi.StringOutput
The Batch account secondary access key.
func (*Account) StorageAccountId ¶
func (r *Account) StorageAccountId() *pulumi.StringOutput
Specifies the storage account to use for the Batch account. If not specified, Azure Batch will manage the storage.
type AccountArgs ¶
type AccountArgs struct { // Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created. Location interface{} // Specifies the name of the Batch account. Changing this forces a new resource to be created. Name interface{} // Specifies the mode to use for pool allocation. Possible values are `BatchService` or `UserSubscription`. Defaults to `BatchService`. PoolAllocationMode interface{} // The name of the resource group in which to create the Batch account. Changing this forces a new resource to be created. ResourceGroupName interface{} // Specifies the storage account to use for the Batch account. If not specified, Azure Batch will manage the storage. StorageAccountId interface{} // A mapping of tags to assign to the resource. Tags interface{} }
The set of arguments for constructing a Account resource.
type AccountState ¶
type AccountState struct { // The account endpoint used to interact with the Batch service. AccountEndpoint interface{} // Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created. Location interface{} // Specifies the name of the Batch account. Changing this forces a new resource to be created. Name interface{} // Specifies the mode to use for pool allocation. Possible values are `BatchService` or `UserSubscription`. Defaults to `BatchService`. PoolAllocationMode interface{} // The Batch account primary access key. PrimaryAccessKey interface{} // The name of the resource group in which to create the Batch account. Changing this forces a new resource to be created. ResourceGroupName interface{} // The Batch account secondary access key. SecondaryAccessKey interface{} // Specifies the storage account to use for the Batch account. If not specified, Azure Batch will manage the storage. StorageAccountId interface{} // A mapping of tags to assign to the resource. Tags interface{} }
Input properties used for looking up and filtering Account resources.
type Certificate ¶ added in v0.18.0
type Certificate struct {
// contains filtered or unexported fields
}
Manages a certificate in an Azure Batch account.
func GetCertificate ¶ added in v0.18.0
func GetCertificate(ctx *pulumi.Context, name string, id pulumi.ID, state *CertificateState, opts ...pulumi.ResourceOpt) (*Certificate, error)
GetCertificate gets an existing Certificate resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewCertificate ¶ added in v0.18.0
func NewCertificate(ctx *pulumi.Context, name string, args *CertificateArgs, opts ...pulumi.ResourceOpt) (*Certificate, error)
NewCertificate registers a new resource with the given unique name, arguments, and options.
func (*Certificate) AccountName ¶ added in v0.18.0
func (r *Certificate) AccountName() *pulumi.StringOutput
Specifies the name of the Batch account. Changing this forces a new resource to be created.
func (*Certificate) Certificate ¶ added in v0.18.0
func (r *Certificate) Certificate() *pulumi.StringOutput
The base64-encoded contents of the certificate.
func (*Certificate) Format ¶ added in v0.18.0
func (r *Certificate) Format() *pulumi.StringOutput
The format of the certificate. Possible values are `Cer` or `Pfx`.
func (*Certificate) ID ¶ added in v0.18.0
func (r *Certificate) ID() *pulumi.IDOutput
ID is this resource's unique identifier assigned by its provider.
func (*Certificate) Name ¶ added in v0.18.0
func (r *Certificate) Name() *pulumi.StringOutput
The generated name of the certificate.
func (*Certificate) Password ¶ added in v0.18.0
func (r *Certificate) Password() *pulumi.StringOutput
The password to access the certificate's private key. This must and can only be specified when `format` is `Pfx`.
func (*Certificate) PublicData ¶ added in v0.18.0
func (r *Certificate) PublicData() *pulumi.StringOutput
The public key of the certificate.
func (*Certificate) ResourceGroupName ¶ added in v0.18.0
func (r *Certificate) ResourceGroupName() *pulumi.StringOutput
The name of the resource group in which to create the Batch account. Changing this forces a new resource to be created.
func (*Certificate) Thumbprint ¶ added in v0.18.0
func (r *Certificate) Thumbprint() *pulumi.StringOutput
The thumbprint of the certificate. At this time the only supported value is 'SHA1'.
func (*Certificate) ThumbprintAlgorithm ¶ added in v0.18.0
func (r *Certificate) ThumbprintAlgorithm() *pulumi.StringOutput
func (*Certificate) URN ¶ added in v0.18.0
func (r *Certificate) URN() *pulumi.URNOutput
URN is this resource's unique name assigned by Pulumi.
type CertificateArgs ¶ added in v0.18.0
type CertificateArgs struct { // Specifies the name of the Batch account. Changing this forces a new resource to be created. AccountName interface{} // The base64-encoded contents of the certificate. Certificate interface{} // The format of the certificate. Possible values are `Cer` or `Pfx`. Format interface{} // The password to access the certificate's private key. This must and can only be specified when `format` is `Pfx`. Password interface{} // The name of the resource group in which to create the Batch account. Changing this forces a new resource to be created. ResourceGroupName interface{} // The thumbprint of the certificate. At this time the only supported value is 'SHA1'. Thumbprint interface{} ThumbprintAlgorithm interface{} }
The set of arguments for constructing a Certificate resource.
type CertificateState ¶ added in v0.18.0
type CertificateState struct { // Specifies the name of the Batch account. Changing this forces a new resource to be created. AccountName interface{} // The base64-encoded contents of the certificate. Certificate interface{} // The format of the certificate. Possible values are `Cer` or `Pfx`. Format interface{} // The generated name of the certificate. Name interface{} // The password to access the certificate's private key. This must and can only be specified when `format` is `Pfx`. Password interface{} // The public key of the certificate. PublicData interface{} // The name of the resource group in which to create the Batch account. Changing this forces a new resource to be created. ResourceGroupName interface{} // The thumbprint of the certificate. At this time the only supported value is 'SHA1'. Thumbprint interface{} ThumbprintAlgorithm interface{} }
Input properties used for looking up and filtering Certificate resources.
type GetAccountArgs ¶
type GetAccountArgs struct { // The name of the Batch account. Name interface{} // The Name of the Resource Group where this Batch account exists. ResourceGroupName interface{} }
A collection of arguments for invoking getAccount.
type GetAccountResult ¶
type GetAccountResult struct { // The account endpoint used to interact with the Batch service. AccountEndpoint interface{} // The Azure Region in which this Batch account exists. Location interface{} // The Batch account name. Name interface{} // The pool allocation mode configured for this Batch account. PoolAllocationMode interface{} // The Batch account primary access key. PrimaryAccessKey interface{} ResourceGroupName interface{} // The Batch account secondary access key. SecondaryAccessKey interface{} // The ID of the Storage Account used for this Batch account. StorageAccountId interface{} // A map of tags assigned to the Batch account. Tags interface{} // id is the provider-assigned unique ID for this managed resource. Id interface{} }
A collection of values returned by getAccount.
func LookupAccount ¶
func LookupAccount(ctx *pulumi.Context, args *GetAccountArgs) (*GetAccountResult, error)
Use this data source to access information about an existing Batch Account.
type GetCertificateArgs ¶ added in v0.18.0
type GetCertificateArgs struct { // The name of the Batch account. AccountName interface{} // The name of the Batch certificate. Name interface{} // The Name of the Resource Group where this Batch account exists. ResourceGroupName interface{} }
A collection of arguments for invoking getCertificate.
type GetCertificateResult ¶ added in v0.18.0
type GetCertificateResult struct { AccountName interface{} // The format of the certificate, such as `Cer` or `Pfx`. Format interface{} Name interface{} // The public key of the certificate. PublicData interface{} ResourceGroupName interface{} // The thumbprint of the certificate. Thumbprint interface{} // The algorithm of the certificate thumbprint. ThumbprintAlgorithm interface{} // id is the provider-assigned unique ID for this managed resource. Id interface{} }
A collection of values returned by getCertificate.
func LookupCertificate ¶ added in v0.18.0
func LookupCertificate(ctx *pulumi.Context, args *GetCertificateArgs) (*GetCertificateResult, error)
Use this data source to access information about an existing certificate in a Batch Account.
type GetPoolArgs ¶
type GetPoolArgs struct { AccountName interface{} Certificates interface{} Name interface{} ResourceGroupName interface{} StartTask interface{} }
A collection of arguments for invoking getPool.
type GetPoolResult ¶
type GetPoolResult struct { // The name of the Batch account. AccountName interface{} // A `auto_scale` block that describes the scale settings when using auto scale. AutoScales interface{} // One or more `certificate` blocks that describe the certificates installed on each compute node in the pool. Certificates interface{} // The container configuration used in the pool's VMs. ContainerConfigurations interface{} DisplayName interface{} // A `fixed_scale` block that describes the scale settings when using fixed scale. FixedScales interface{} // The maximum number of tasks that can run concurrently on a single compute node in the pool. MaxTasksPerNode interface{} // The name of the Batch pool. Name interface{} // The Sku of the node agents in the Batch pool. NodeAgentSkuId interface{} ResourceGroupName interface{} // A `start_task` block that describes the start task settings for the Batch pool. StartTask interface{} // The reference of the storage image used by the nodes in the Batch pool. StorageImageReferences interface{} // The size of the VM created in the Batch pool. VmSize interface{} // id is the provider-assigned unique ID for this managed resource. Id interface{} }
A collection of values returned by getPool.
func LookupPool ¶
func LookupPool(ctx *pulumi.Context, args *GetPoolArgs) (*GetPoolResult, error)
Use this data source to access information about an existing Batch pool
type Pool ¶
type Pool struct {
// contains filtered or unexported fields
}
Manages an Azure Batch pool.
func GetPool ¶
func GetPool(ctx *pulumi.Context, name string, id pulumi.ID, state *PoolState, opts ...pulumi.ResourceOpt) (*Pool, error)
GetPool gets an existing Pool resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewPool ¶
func NewPool(ctx *pulumi.Context, name string, args *PoolArgs, opts ...pulumi.ResourceOpt) (*Pool, error)
NewPool registers a new resource with the given unique name, arguments, and options.
func (*Pool) AccountName ¶
func (r *Pool) AccountName() *pulumi.StringOutput
Specifies the name of the Batch account in which the pool will be created. Changing this forces a new resource to be created.
func (*Pool) AutoScale ¶
A `auto_scale` block that describes the scale settings when using auto scale.
func (*Pool) Certificates ¶ added in v0.18.0
func (r *Pool) Certificates() *pulumi.ArrayOutput
One or more `certificate` blocks that describe the certificates to be installed on each compute node in the pool.
func (*Pool) ContainerConfiguration ¶ added in v0.18.3
The container configuration used in the pool's VMs.
func (*Pool) DisplayName ¶
func (r *Pool) DisplayName() *pulumi.StringOutput
Specifies the display name of the Batch pool.
func (*Pool) FixedScale ¶
A `fixed_scale` block that describes the scale settings when using fixed scale.
func (*Pool) MaxTasksPerNode ¶ added in v0.16.8
Specifies the maximum number of tasks that can run concurrently on a single compute node in the pool. Defaults to `1`. Changing this forces a new resource to be created.
func (*Pool) Name ¶
func (r *Pool) Name() *pulumi.StringOutput
Specifies the name of the Batch pool. Changing this forces a new resource to be created.
func (*Pool) NodeAgentSkuId ¶
func (r *Pool) NodeAgentSkuId() *pulumi.StringOutput
Specifies the Sku of the node agents that will be created in the Batch pool.
func (*Pool) ResourceGroupName ¶
func (r *Pool) ResourceGroupName() *pulumi.StringOutput
The name of the resource group in which to create the Batch pool. Changing this forces a new resource to be created.
func (*Pool) StartTask ¶
A `start_task` block that describes the start task settings for the Batch pool.
func (*Pool) StopPendingResizeOperation ¶
func (r *Pool) StopPendingResizeOperation() *pulumi.BoolOutput
func (*Pool) StorageImageReference ¶
A `storage_image_reference` for the virtual machines that will compose the Batch pool.
func (*Pool) VmSize ¶
func (r *Pool) VmSize() *pulumi.StringOutput
Specifies the size of the VM created in the Batch pool.
type PoolArgs ¶
type PoolArgs struct { // Specifies the name of the Batch account in which the pool will be created. Changing this forces a new resource to be created. AccountName interface{} // A `auto_scale` block that describes the scale settings when using auto scale. AutoScale interface{} // One or more `certificate` blocks that describe the certificates to be installed on each compute node in the pool. Certificates interface{} // The container configuration used in the pool's VMs. ContainerConfiguration interface{} // Specifies the display name of the Batch pool. DisplayName interface{} // A `fixed_scale` block that describes the scale settings when using fixed scale. FixedScale interface{} // Specifies the maximum number of tasks that can run concurrently on a single compute node in the pool. Defaults to `1`. Changing this forces a new resource to be created. MaxTasksPerNode interface{} // Specifies the name of the Batch pool. Changing this forces a new resource to be created. Name interface{} // Specifies the Sku of the node agents that will be created in the Batch pool. NodeAgentSkuId interface{} // The name of the resource group in which to create the Batch pool. Changing this forces a new resource to be created. ResourceGroupName interface{} // A `start_task` block that describes the start task settings for the Batch pool. StartTask interface{} StopPendingResizeOperation interface{} // A `storage_image_reference` for the virtual machines that will compose the Batch pool. StorageImageReference interface{} // Specifies the size of the VM created in the Batch pool. VmSize interface{} }
The set of arguments for constructing a Pool resource.
type PoolState ¶
type PoolState struct { // Specifies the name of the Batch account in which the pool will be created. Changing this forces a new resource to be created. AccountName interface{} // A `auto_scale` block that describes the scale settings when using auto scale. AutoScale interface{} // One or more `certificate` blocks that describe the certificates to be installed on each compute node in the pool. Certificates interface{} // The container configuration used in the pool's VMs. ContainerConfiguration interface{} // Specifies the display name of the Batch pool. DisplayName interface{} // A `fixed_scale` block that describes the scale settings when using fixed scale. FixedScale interface{} // Specifies the maximum number of tasks that can run concurrently on a single compute node in the pool. Defaults to `1`. Changing this forces a new resource to be created. MaxTasksPerNode interface{} // Specifies the name of the Batch pool. Changing this forces a new resource to be created. Name interface{} // Specifies the Sku of the node agents that will be created in the Batch pool. NodeAgentSkuId interface{} // The name of the resource group in which to create the Batch pool. Changing this forces a new resource to be created. ResourceGroupName interface{} // A `start_task` block that describes the start task settings for the Batch pool. StartTask interface{} StopPendingResizeOperation interface{} // A `storage_image_reference` for the virtual machines that will compose the Batch pool. StorageImageReference interface{} // Specifies the size of the VM created in the Batch pool. VmSize interface{} }
Input properties used for looking up and filtering Pool resources.