BatchAccountResource Class

Definition

Namespace:: Azure.ResourceManager.Batch

Assembly:: Azure.ResourceManager.Batch.dll

Package:: Azure.ResourceManager.Batch v1.7.0

Package:: Azure.ResourceManager.Batch v1.3.0-beta.1

Source:: BatchAccountResource.cs

Source:: BatchAccountResource.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

A class representing a BatchAccount along with the instance operations that can be performed on it. If you have a ResourceIdentifier you can construct a BatchAccountResource from an instance of ArmClient using the GetResource method. Otherwise you can get one from its parent resource ResourceGroupResource using the GetBatchAccounts method.

public class BatchAccountResource : Azure.ResourceManager.ArmResource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Batch.BatchAccountData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Batch.BatchAccountData>

public class BatchAccountResource : Azure.ResourceManager.ArmResource

type BatchAccountResource = class
    inherit ArmResource
    interface IJsonModel<BatchAccountData>
    interface IPersistableModel<BatchAccountData>

type BatchAccountResource = class
    inherit ArmResource

Public Class BatchAccountResource
Inherits ArmResource
Implements IJsonModel(Of BatchAccountData), IPersistableModel(Of BatchAccountData)

Public Class BatchAccountResource
Inherits ArmResource

Inheritance: Object

ArmResource
BatchAccountResource

Implements: IJsonModel<BatchAccountData> IPersistableModel<BatchAccountData> IPersistableModel<T>

Constructors

Name	Description
BatchAccountResource()	Initializes a new instance of BatchAccountResource for mocking.

Fields

Name	Description
ResourceType	Gets the resource type for the operations.

Properties

Name	Description
Client	Gets the ArmClient this resource client was created from. (Inherited from ArmResource)
Data	Gets the data representing this Feature.
Diagnostics	Gets the diagnostic options for this resource client. (Inherited from ArmResource)
Endpoint	Gets the base uri for this resource client. (Inherited from ArmResource)
HasData	Gets whether or not the current instance has data.
Id	Gets the resource identifier. (Inherited from ArmResource)
Pipeline	Gets the pipeline for this resource client. (Inherited from ArmResource)

Methods

Name	Description
AddTag(String, String, CancellationToken)	Add a tag to the current resource.
AddTagAsync(String, String, CancellationToken)	Add a tag to the current resource.
CanUseTagResource(CancellationToken)	Checks to see if the TagResource API is deployed in the current environment. (Inherited from ArmResource)
CanUseTagResourceAsync(CancellationToken)	Checks to see if the TagResource API is deployed in the current environment. (Inherited from ArmResource)
CreateResourceIdentifier(String, String, String)	Generate the resource identifier for this resource.
Delete(WaitUntil, CancellationToken)	Deletes the specified Batch account. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}. Operation Id. : BatchAccounts_Delete. Default Api Version. : 2025-06-01. Resource. : BatchAccountResource.
DeleteAsync(WaitUntil, CancellationToken)	Deletes the specified Batch account. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}. Operation Id. : BatchAccounts_Delete. Default Api Version. : 2025-06-01. Resource. : BatchAccountResource.
Get(CancellationToken)	Gets information about the specified Batch account. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}. Operation Id. : BatchAccounts_Get. Default Api Version. : 2025-06-01. Resource. : BatchAccountResource.
GetAsync(CancellationToken)	Gets information about the specified Batch account. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}. Operation Id. : BatchAccounts_Get. Default Api Version. : 2025-06-01. Resource. : BatchAccountResource.
GetAvailableLocations(CancellationToken)	Lists all available geo-locations. (Inherited from ArmResource)
GetAvailableLocationsAsync(CancellationToken)	Lists all available geo-locations. (Inherited from ArmResource)
GetBatchAccountDetector(String, CancellationToken)	Gets information about the given detector for a given Batch account.
GetBatchAccountDetectorAsync(String, CancellationToken)	Gets information about the given detector for a given Batch account.
GetBatchAccountDetectors()	Gets a collection of BatchAccountDetectors in the BatchAccountResource.
GetBatchAccountPool(String, CancellationToken)	Gets information about the specified pool.
GetBatchAccountPoolAsync(String, CancellationToken)	Gets information about the specified pool.
GetBatchAccountPools()	Gets a collection of BatchAccountPools in the BatchAccountResource.
GetBatchApplication(String, CancellationToken)	Gets information about the specified application.
GetBatchApplicationAsync(String, CancellationToken)	Gets information about the specified application.
GetBatchApplications()	Gets a collection of BatchApplications in the BatchAccountResource.
GetBatchPrivateEndpointConnection(String, CancellationToken)	Gets information about the specified private endpoint connection.
GetBatchPrivateEndpointConnectionAsync(String, CancellationToken)	Gets information about the specified private endpoint connection.
GetBatchPrivateEndpointConnections()	Gets a collection of BatchPrivateEndpointConnections in the BatchAccountResource.
GetBatchPrivateLinkResource(String, CancellationToken)	Gets information about the specified private link resource.
GetBatchPrivateLinkResourceAsync(String, CancellationToken)	Gets information about the specified private link resource.
GetBatchPrivateLinkResources()	Gets a collection of BatchPrivateLinkResources in the BatchAccountResource.
GetKeys(CancellationToken)	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, getting the keys will fail. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/listKeys. Operation Id. : BatchAccounts_GetKeys. Default Api Version. : 2025-06-01. Resource. : BatchAccountResource.
GetKeysAsync(CancellationToken)	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, getting the keys will fail. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/listKeys. Operation Id. : BatchAccounts_GetKeys. Default Api Version. : 2025-06-01. Resource. : BatchAccountResource.
GetManagementLock(String, CancellationToken)	Get a management lock by scope. Request Path: /{scope}/providers/Microsoft.Authorization/locks/{lockName} Operation Id: ManagementLocks_GetByScope Default Api Version: 2020-05-01 Resource: ManagementLockResource (Inherited from ArmResource)
GetManagementLockAsync(String, CancellationToken)	Get a management lock by scope. Request Path: /{scope}/providers/Microsoft.Authorization/locks/{lockName} Operation Id: ManagementLocks_GetByScope Default Api Version: 2020-05-01 Resource: ManagementLockResource (Inherited from ArmResource)
GetManagementLocks()	Gets a collection of ManagementLockResources in the ArmResource. (Inherited from ArmResource)
GetNetworkSecurityPerimeterConfiguration(String, CancellationToken)	Gets information about the specified NSP configuration.
GetNetworkSecurityPerimeterConfigurationAsync(String, CancellationToken)	Gets information about the specified NSP configuration.
GetNetworkSecurityPerimeterConfigurations()	Gets a collection of NetworkSecurityPerimeterConfigurations in the BatchAccountResource.
GetOutboundNetworkDependenciesEndpoints(CancellationToken)	Lists the endpoints that a Batch Compute Node under this Batch Account may call as part of Batch service administration. If you are deploying a Pool inside of a virtual network that you specify, you must make sure your network allows outbound access to these endpoints. Failure to allow access to these endpoints may cause Batch to mark the affected nodes as unusable. For more information about creating a pool inside of a virtual network, see https://learn.microsoft.com/azure/batch/batch-virtual-network. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/outboundNetworkDependenciesEndpoints. Operation Id. : BatchAccounts_ListOutboundNetworkDependenciesEndpoints. Default Api Version. : 2025-06-01. Resource. : BatchAccountResource.
GetOutboundNetworkDependenciesEndpointsAsync(CancellationToken)	Lists the endpoints that a Batch Compute Node under this Batch Account may call as part of Batch service administration. If you are deploying a Pool inside of a virtual network that you specify, you must make sure your network allows outbound access to these endpoints. Failure to allow access to these endpoints may cause Batch to mark the affected nodes as unusable. For more information about creating a pool inside of a virtual network, see https://learn.microsoft.com/azure/batch/batch-virtual-network. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/outboundNetworkDependenciesEndpoints. Operation Id. : BatchAccounts_ListOutboundNetworkDependenciesEndpoints. Default Api Version. : 2025-06-01. Resource. : BatchAccountResource.
GetPolicyAssignment(String, CancellationToken)	This operation retrieves a single policy assignment, given its name and the scope it was created at. Request Path: /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName} Operation Id: PolicyAssignments_Get Default Api Version: 2022-06-01 Resource: PolicyAssignmentResource (Inherited from ArmResource)
GetPolicyAssignmentAsync(String, CancellationToken)	This operation retrieves a single policy assignment, given its name and the scope it was created at. Request Path: /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName} Operation Id: PolicyAssignments_Get Default Api Version: 2022-06-01 Resource: PolicyAssignmentResource (Inherited from ArmResource)
GetPolicyAssignments()	Gets a collection of PolicyAssignmentResources in the ArmResource. (Inherited from ArmResource)
GetTagResource()	Gets an object representing a TagResource along with the instance operations that can be performed on it in the ArmResource. (Inherited from ArmResource)
RegenerateKey(BatchAccountRegenerateKeyContent, CancellationToken)	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. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/regenerateKeys. Operation Id. : BatchAccounts_RegenerateKey. Default Api Version. : 2025-06-01. Resource. : BatchAccountResource.
RegenerateKeyAsync(BatchAccountRegenerateKeyContent, CancellationToken)	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. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/regenerateKeys. Operation Id. : BatchAccounts_RegenerateKey. Default Api Version. : 2025-06-01. Resource. : BatchAccountResource.
RemoveTag(String, CancellationToken)	Removes a tag by key from the resource.
RemoveTagAsync(String, CancellationToken)	Removes a tag by key from the resource.
SetTags(IDictionary<String,String>, CancellationToken)	Replace the tags on the resource with the given set.
SetTagsAsync(IDictionary<String,String>, CancellationToken)	Replace the tags on the resource with the given set.
SynchronizeAutoStorageKeys(CancellationToken)	Synchronizes access keys for the auto-storage account configured for the specified Batch account, only if storage key authentication is being used. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/syncAutoStorageKeys. Operation Id. : BatchAccounts_SynchronizeAutoStorageKeys. Default Api Version. : 2025-06-01. Resource. : BatchAccountResource.
SynchronizeAutoStorageKeysAsync(CancellationToken)	Synchronizes access keys for the auto-storage account configured for the specified Batch account, only if storage key authentication is being used. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/syncAutoStorageKeys. Operation Id. : BatchAccounts_SynchronizeAutoStorageKeys. Default Api Version. : 2025-06-01. Resource. : BatchAccountResource.
TryGetApiVersion(ResourceType, String)	Gets the api version override if it has been set for the current client options. (Inherited from ArmResource)
Update(BatchAccountPatch, CancellationToken)	Updates the properties of an existing Batch account. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}. Operation Id. : BatchAccounts_Update. Default Api Version. : 2025-06-01. Resource. : BatchAccountResource.
UpdateAsync(BatchAccountPatch, CancellationToken)	Updates the properties of an existing Batch account. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}. Operation Id. : BatchAccounts_Update. Default Api Version. : 2025-06-01. Resource. : BatchAccountResource.

Explicit Interface Implementations

Name	Description
IJsonModel<BatchAccountData>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<BatchAccountData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<BatchAccountData>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<BatchAccountData>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<BatchAccountData>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.

Extension Methods

Name	Description
GetAuthorizationRoleDefinition(ArmResource, ResourceIdentifier, CancellationToken)	Gets the role definition identified by `roleDefinitionId` at this resource scope.
GetAuthorizationRoleDefinitionAsync(ArmResource, ResourceIdentifier, CancellationToken)	Gets the role definition identified by `roleDefinitionId` at this resource scope.
GetAuthorizationRoleDefinitions(ArmResource)	Gets a collection of AuthorizationRoleDefinitionCollection objects within the specified scope.
GetDenyAssignment(ArmResource, String, CancellationToken)	Get the specified deny assignment.
GetDenyAssignmentAsync(ArmResource, String, CancellationToken)	Get the specified deny assignment.
GetDenyAssignments(ArmResource)	Gets a collection of DenyAssignmentCollection objects within the specified scope.
GetLinkerResource(ArmResource, String, CancellationToken)	Returns Linker resource for a given name. Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName} Operation Id: Linker_Get Default Api Version: 2022-05-01 Resource: LinkerResource <item>MockingTo mock this method, please mock GetLinkerResource(String, CancellationToken) instead.</item>
GetLinkerResourceAsync(ArmResource, String, CancellationToken)	Returns Linker resource for a given name. Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName} Operation Id: Linker_Get Default Api Version: 2022-05-01 Resource: LinkerResource <item>MockingTo mock this method, please mock GetLinkerResourceAsync(String, CancellationToken) instead.</item>
GetLinkerResources(ArmResource)	Gets a collection of LinkerResources in the ArmResource. <item>MockingTo mock this method, please mock GetLinkerResources() instead.</item>
GetRoleAssignment(ArmResource, String, String, CancellationToken)	Get a role assignment by scope and name.
GetRoleAssignmentAsync(ArmResource, String, String, CancellationToken)	Get a role assignment by scope and name.
GetRoleAssignments(ArmResource)	Gets a collection of RoleAssignmentCollection objects within the specified scope.
GetRoleAssignmentSchedule(ArmResource, String, CancellationToken)	Get the specified role assignment schedule for a resource scope.
GetRoleAssignmentScheduleAsync(ArmResource, String, CancellationToken)	Get the specified role assignment schedule for a resource scope.
GetRoleAssignmentScheduleInstance(ArmResource, String, CancellationToken)	Gets the specified role assignment schedule instance.
GetRoleAssignmentScheduleInstanceAsync(ArmResource, String, CancellationToken)	Gets the specified role assignment schedule instance.
GetRoleAssignmentScheduleInstances(ArmResource)	Gets a collection of RoleAssignmentScheduleInstanceCollection objects within the specified scope.
GetRoleAssignmentScheduleRequest(ArmResource, String, CancellationToken)	Get the specified role assignment schedule request.
GetRoleAssignmentScheduleRequestAsync(ArmResource, String, CancellationToken)	Get the specified role assignment schedule request.
GetRoleAssignmentScheduleRequests(ArmResource)	Gets a collection of RoleAssignmentScheduleRequestCollection objects within the specified scope.
GetRoleAssignmentSchedules(ArmResource)	Gets a collection of RoleAssignmentScheduleCollection objects within the specified scope.
GetRoleEligibilitySchedule(ArmResource, String, CancellationToken)	Get the specified role eligibility schedule for a resource scope.
GetRoleEligibilityScheduleAsync(ArmResource, String, CancellationToken)	Get the specified role eligibility schedule for a resource scope.
GetRoleEligibilityScheduleInstance(ArmResource, String, CancellationToken)	Gets the specified role eligibility schedule instance.
GetRoleEligibilityScheduleInstanceAsync(ArmResource, String, CancellationToken)	Gets the specified role eligibility schedule instance.
GetRoleEligibilityScheduleInstances(ArmResource)	Gets a collection of RoleEligibilityScheduleInstanceCollection objects within the specified scope.
GetRoleEligibilityScheduleRequest(ArmResource, String, CancellationToken)	Get the specified role eligibility schedule request.
GetRoleEligibilityScheduleRequestAsync(ArmResource, String, CancellationToken)	Get the specified role eligibility schedule request.
GetRoleEligibilityScheduleRequests(ArmResource)	Gets a collection of RoleEligibilityScheduleRequestCollection objects within the specified scope.
GetRoleEligibilitySchedules(ArmResource)	Gets a collection of RoleEligibilityScheduleCollection objects within the specified scope.
GetRoleManagementPolicies(ArmResource)	Gets a collection of RoleManagementPolicyCollection objects within the specified scope.
GetRoleManagementPolicy(ArmResource, String, CancellationToken)	Get the specified role management policy for a resource scope.
GetRoleManagementPolicyAssignment(ArmResource, String, CancellationToken)	Get the specified role management policy assignment for a resource scope.
GetRoleManagementPolicyAssignmentAsync(ArmResource, String, CancellationToken)	Get the specified role management policy assignment for a resource scope.
GetRoleManagementPolicyAssignments(ArmResource)	Gets a collection of RoleManagementPolicyAssignmentCollection objects within the specified scope.
GetRoleManagementPolicyAsync(ArmResource, String, CancellationToken)	Get the specified role management policy for a resource scope.
GetSystemAssignedIdentity(ArmResource)	Gets an object representing a SystemAssignedIdentityResource along with the instance operations that can be performed on it in the ArmResource scope.

Applies to

Comentarios

¿Le ha resultado útil esta página?