accounts

Creates, updates, deletes, gets or lists a accounts resource.

Overview

Name	accounts
Type	Resource
Id	azure.batch.accounts

Fields

vw_accounts

Name	Datatype	Description
id	text	The ID of the resource.
name	text	The name of the resource.
accountName	text	field from the properties object
account_endpoint	text	field from the properties object
active_job_and_job_schedule_quota	text	field from the properties object
allowed_authentication_modes	text	field from the properties object
auto_storage	text	field from the properties object
dedicated_core_quota	text	field from the properties object
dedicated_core_quota_per_vm_family	text	field from the properties object
dedicated_core_quota_per_vm_family_enforced	text	field from the properties object
encryption	text	field from the properties object
identity	text	The identity of the Batch account, if configured. This is used when the user specifies 'Microsoft.KeyVault' as their Batch account encryption configuration or when ManagedIdentity is selected as the auto-storage authentication mode.
key_vault_reference	text	field from the properties object
location	text	The location of the resource.
low_priority_core_quota	text	field from the properties object
network_profile	text	field from the properties object
node_management_endpoint	text	field from the properties object
pool_allocation_mode	text	field from the properties object
pool_quota	text	field from the properties object
private_endpoint_connections	text	field from the properties object
provisioning_state	text	field from the properties object
public_network_access	text	field from the properties object
resourceGroupName	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	The tags of the resource.
type	text	The type of the resource.

accounts

Name	Datatype	Description
id	string	The ID of the resource.
name	string	The name of the resource.
identity	object	The identity of the Batch account, if configured. This is used when the user specifies 'Microsoft.KeyVault' as their Batch account encryption configuration or when ManagedIdentity is selected as the auto-storage authentication mode.
location	string	The location of the resource.
properties	object	Account specific properties.
tags	object	The tags of the resource.
type	string	The type of the resource.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	accountName, resourceGroupName, subscriptionId	Gets information about the specified Batch account.
list	SELECT	subscriptionId	Gets information about the Batch accounts associated with the subscription.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	Gets information about the Batch accounts associated with the specified resource group.
create	INSERT	accountName, resourceGroupName, subscriptionId, data__location	Creates a new Batch account with the specified parameters. Existing accounts cannot be updated with this API and should instead be updated with the Update Batch Account API.
delete	DELETE	accountName, resourceGroupName, subscriptionId	Deletes the specified Batch account.
update	UPDATE	accountName, resourceGroupName, subscriptionId	Updates the properties of an existing Batch account.
regenerate_key	EXEC	accountName, resourceGroupName, subscriptionId, data__keyName	This operation applies only to Batch accounts with allowedAuthenticationModes containing 'SharedKey'. If the Batch account doesn't contain 'SharedKey' in its allowedAuthenticationMode, clients cannot use shared keys to authenticate, and must use another allowedAuthenticationModes instead. In this case, regenerating the keys will fail.
synchronize_auto_storage_keys	EXEC	accountName, resourceGroupName, subscriptionId	Synchronizes access keys for the auto-storage account configured for the specified Batch account, only if storage key authentication is being used.

SELECT examples

Gets information about the Batch accounts associated with the subscription.

vw_accounts

SELECT
id,
name,
accountName,
account_endpoint,
active_job_and_job_schedule_quota,
allowed_authentication_modes,
auto_storage,
dedicated_core_quota,
dedicated_core_quota_per_vm_family,
dedicated_core_quota_per_vm_family_enforced,
encryption,
identity,
key_vault_reference,
location,
low_priority_core_quota,
network_profile,
node_management_endpoint,
pool_allocation_mode,
pool_quota,
private_endpoint_connections,
provisioning_state,
public_network_access,
resourceGroupName,
subscriptionId,
tags,
type
FROM azure.batch.vw_accounts
WHERE subscriptionId = '{{ subscriptionId }}';

accounts

SELECT
id,
name,
identity,
location,
properties,
tags,
type
FROM azure.batch.accounts
WHERE subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new accounts resource.

All Properties

/*+ create */
INSERT INTO azure.batch.accounts (
accountName,
resourceGroupName,
subscriptionId,
data__location,
location,
tags,
properties,
identity
)
SELECT 
'{{ accountName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ data__location }}',
'{{ location }}',
'{{ tags }}',
'{{ properties }}',
'{{ identity }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: location
      value: string
    - name: tags
      value: object
    - name: properties
      value:
        - name: autoStorage
          value:
            - name: storageAccountId
              value: string
            - name: authenticationMode
              value: string
            - name: nodeIdentityReference
              value:
                - name: resourceId
                  value: string
        - name: poolAllocationMode
          value: []
        - name: keyVaultReference
          value:
            - name: id
              value: string
            - name: url
              value: string
        - name: publicNetworkAccess
          value: []
        - name: networkProfile
          value:
            - name: accountAccess
              value:
                - name: defaultAction
                  value: string
                - name: ipRules
                  value:
                    - - name: action
                        value: string
                      - name: value
                        value: string
        - name: encryption
          value:
            - name: keySource
              value: string
            - name: keyVaultProperties
              value:
                - name: keyIdentifier
                  value: string
        - name: allowedAuthenticationModes
          value:
            - []
    - name: identity
      value:
        - name: principalId
          value: string
        - name: tenantId
          value: string
        - name: type
          value: string
        - name: userAssignedIdentities
          value: object

UPDATE example

Updates a accounts resource.

/*+ update */
UPDATE azure.batch.accounts
SET 
tags = '{{ tags }}',
properties = '{{ properties }}',
identity = '{{ identity }}'
WHERE 
accountName = '{{ accountName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified accounts resource.

/*+ delete */
DELETE FROM azure.batch.accounts
WHERE accountName = '{{ accountName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';