@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 8.56 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* Contains information about an Azure Batch account.
*
* Uses Azure REST API version 2024-07-01. In version 2.x of the Azure Native provider, it used API version 2023-05-01.
*
* Other available API versions: 2023-05-01, 2023-11-01, 2024-02-01. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native batch [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare class BatchAccount extends pulumi.CustomResource {
/**
* Get an existing BatchAccount resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): BatchAccount;
/**
* Returns true if the given object is an instance of BatchAccount. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is BatchAccount;
/**
* The account endpoint used to interact with the Batch service.
*/
readonly accountEndpoint: pulumi.Output<string>;
readonly activeJobAndJobScheduleQuota: pulumi.Output<number>;
/**
* List of allowed authentication modes for the Batch account that can be used to authenticate with the data plane. This does not affect authentication with the control plane.
*/
readonly allowedAuthenticationModes: pulumi.Output<string[]>;
/**
* Contains information about the auto-storage account associated with a Batch account.
*/
readonly autoStorage: pulumi.Output<outputs.batch.AutoStoragePropertiesResponse>;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.
*/
readonly dedicatedCoreQuota: pulumi.Output<number>;
/**
* A list of the dedicated core quota per Virtual Machine family for the Batch account. For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.
*/
readonly dedicatedCoreQuotaPerVMFamily: pulumi.Output<outputs.batch.VirtualMachineFamilyCoreQuotaResponse[]>;
/**
* If this flag is true, dedicated core quota is enforced via both the dedicatedCoreQuotaPerVMFamily and dedicatedCoreQuota properties on the account. If this flag is false, dedicated core quota is enforced only via the dedicatedCoreQuota property on the account and does not consider Virtual Machine family.
*/
readonly dedicatedCoreQuotaPerVMFamilyEnforced: pulumi.Output<boolean>;
/**
* Configures how customer data is encrypted inside the Batch account. By default, accounts are encrypted using a Microsoft managed key. For additional control, a customer-managed key can be used instead.
*/
readonly encryption: pulumi.Output<outputs.batch.EncryptionPropertiesResponse>;
/**
* The identity of the Batch account.
*/
readonly identity: pulumi.Output<outputs.batch.BatchAccountIdentityResponse | undefined>;
/**
* Identifies the Azure key vault associated with a Batch account.
*/
readonly keyVaultReference: pulumi.Output<outputs.batch.KeyVaultReferenceResponse>;
/**
* The location of the resource.
*/
readonly location: pulumi.Output<string>;
/**
* For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.
*/
readonly lowPriorityCoreQuota: pulumi.Output<number>;
/**
* The name of the resource.
*/
readonly name: pulumi.Output<string>;
/**
* The network profile only takes effect when publicNetworkAccess is enabled.
*/
readonly networkProfile: pulumi.Output<outputs.batch.NetworkProfileResponse | undefined>;
/**
* The endpoint used by compute node to connect to the Batch node management service.
*/
readonly nodeManagementEndpoint: pulumi.Output<string>;
/**
* The allocation mode for creating pools in the Batch account.
*/
readonly poolAllocationMode: pulumi.Output<string>;
readonly poolQuota: pulumi.Output<number>;
/**
* List of private endpoint connections associated with the Batch account
*/
readonly privateEndpointConnections: pulumi.Output<outputs.batch.PrivateEndpointConnectionResponse[]>;
/**
* The provisioned state of the resource
*/
readonly provisioningState: pulumi.Output<string>;
/**
* If not specified, the default value is 'enabled'.
*/
readonly publicNetworkAccess: pulumi.Output<string | undefined>;
/**
* The tags of the resource.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
}>;
/**
* The type of the resource.
*/
readonly type: pulumi.Output<string>;
/**
* Create a BatchAccount resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: BatchAccountArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a BatchAccount resource.
*/
export interface BatchAccountArgs {
/**
* A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/.
*/
accountName?: pulumi.Input<string>;
/**
* List of allowed authentication modes for the Batch account that can be used to authenticate with the data plane. This does not affect authentication with the control plane.
*/
allowedAuthenticationModes?: pulumi.Input<pulumi.Input<enums.batch.AuthenticationMode>[]>;
/**
* The properties related to the auto-storage account.
*/
autoStorage?: pulumi.Input<inputs.batch.AutoStorageBasePropertiesArgs>;
/**
* Configures how customer data is encrypted inside the Batch account. By default, accounts are encrypted using a Microsoft managed key. For additional control, a customer-managed key can be used instead.
*/
encryption?: pulumi.Input<inputs.batch.EncryptionPropertiesArgs>;
/**
* The identity of the Batch account.
*/
identity?: pulumi.Input<inputs.batch.BatchAccountIdentityArgs>;
/**
* A reference to the Azure key vault associated with the Batch account.
*/
keyVaultReference?: pulumi.Input<inputs.batch.KeyVaultReferenceArgs>;
/**
* The region in which to create the account.
*/
location?: pulumi.Input<string>;
/**
* The network profile only takes effect when publicNetworkAccess is enabled.
*/
networkProfile?: pulumi.Input<inputs.batch.NetworkProfileArgs>;
/**
* The pool allocation mode also affects how clients may authenticate to the Batch Service API. If the mode is BatchService, clients may authenticate using access keys or Microsoft Entra ID. If the mode is UserSubscription, clients must use Microsoft Entra ID. The default is BatchService.
*/
poolAllocationMode?: pulumi.Input<enums.batch.PoolAllocationMode>;
/**
* If not specified, the default value is 'enabled'.
*/
publicNetworkAccess?: pulumi.Input<enums.batch.PublicNetworkAccessType>;
/**
* The name of the resource group that contains the Batch account.
*/
resourceGroupName: pulumi.Input<string>;
/**
* The user-specified tags associated with the account.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}