pulumi-azure-native 2.57.1__py3-none-any.whl → 2.58.0__py3-none-any.whl

pulumi_azure_native/batch/v20240701/get_batch_account.py

@@ -0,0 +1,364 @@
+# coding=utf-8
+# *** WARNING: this file was generated by pulumi-language-python. ***
+# *** Do not edit by hand unless you're certain you know what you are doing! ***
+
+import copy
+import warnings
+import sys
+import pulumi
+import pulumi.runtime
+from typing import Any, Mapping, Optional, Sequence, Union, overload
+if sys.version_info >= (3, 11):
+    from typing import NotRequired, TypedDict, TypeAlias
+else:
+    from typing_extensions import NotRequired, TypedDict, TypeAlias
+from ... import _utilities
+from . import outputs
+
+__all__ = [
+    'GetBatchAccountResult',
+    'AwaitableGetBatchAccountResult',
+    'get_batch_account',
+    'get_batch_account_output',
+]
+
+@pulumi.output_type
+class GetBatchAccountResult:
+    """
+    Contains information about an Azure Batch account.
+    """
+    def __init__(__self__, account_endpoint=None, active_job_and_job_schedule_quota=None, allowed_authentication_modes=None, auto_storage=None, dedicated_core_quota=None, dedicated_core_quota_per_vm_family=None, dedicated_core_quota_per_vm_family_enforced=None, encryption=None, id=None, identity=None, key_vault_reference=None, location=None, low_priority_core_quota=None, name=None, network_profile=None, node_management_endpoint=None, pool_allocation_mode=None, pool_quota=None, private_endpoint_connections=None, provisioning_state=None, public_network_access=None, tags=None, type=None):
+        if account_endpoint and not isinstance(account_endpoint, str):
+            raise TypeError("Expected argument 'account_endpoint' to be a str")
+        pulumi.set(__self__, "account_endpoint", account_endpoint)
+        if active_job_and_job_schedule_quota and not isinstance(active_job_and_job_schedule_quota, int):
+            raise TypeError("Expected argument 'active_job_and_job_schedule_quota' to be a int")
+        pulumi.set(__self__, "active_job_and_job_schedule_quota", active_job_and_job_schedule_quota)
+        if allowed_authentication_modes and not isinstance(allowed_authentication_modes, list):
+            raise TypeError("Expected argument 'allowed_authentication_modes' to be a list")
+        pulumi.set(__self__, "allowed_authentication_modes", allowed_authentication_modes)
+        if auto_storage and not isinstance(auto_storage, dict):
+            raise TypeError("Expected argument 'auto_storage' to be a dict")
+        pulumi.set(__self__, "auto_storage", auto_storage)
+        if dedicated_core_quota and not isinstance(dedicated_core_quota, int):
+            raise TypeError("Expected argument 'dedicated_core_quota' to be a int")
+        pulumi.set(__self__, "dedicated_core_quota", dedicated_core_quota)
+        if dedicated_core_quota_per_vm_family and not isinstance(dedicated_core_quota_per_vm_family, list):
+            raise TypeError("Expected argument 'dedicated_core_quota_per_vm_family' to be a list")
+        pulumi.set(__self__, "dedicated_core_quota_per_vm_family", dedicated_core_quota_per_vm_family)
+        if dedicated_core_quota_per_vm_family_enforced and not isinstance(dedicated_core_quota_per_vm_family_enforced, bool):
+            raise TypeError("Expected argument 'dedicated_core_quota_per_vm_family_enforced' to be a bool")
+        pulumi.set(__self__, "dedicated_core_quota_per_vm_family_enforced", dedicated_core_quota_per_vm_family_enforced)
+        if encryption and not isinstance(encryption, dict):
+            raise TypeError("Expected argument 'encryption' to be a dict")
+        pulumi.set(__self__, "encryption", encryption)
+        if id and not isinstance(id, str):
+            raise TypeError("Expected argument 'id' to be a str")
+        pulumi.set(__self__, "id", id)
+        if identity and not isinstance(identity, dict):
+            raise TypeError("Expected argument 'identity' to be a dict")
+        pulumi.set(__self__, "identity", identity)
+        if key_vault_reference and not isinstance(key_vault_reference, dict):
+            raise TypeError("Expected argument 'key_vault_reference' to be a dict")
+        pulumi.set(__self__, "key_vault_reference", key_vault_reference)
+        if location and not isinstance(location, str):
+            raise TypeError("Expected argument 'location' to be a str")
+        pulumi.set(__self__, "location", location)
+        if low_priority_core_quota and not isinstance(low_priority_core_quota, int):
+            raise TypeError("Expected argument 'low_priority_core_quota' to be a int")
+        pulumi.set(__self__, "low_priority_core_quota", low_priority_core_quota)
+        if name and not isinstance(name, str):
+            raise TypeError("Expected argument 'name' to be a str")
+        pulumi.set(__self__, "name", name)
+        if network_profile and not isinstance(network_profile, dict):
+            raise TypeError("Expected argument 'network_profile' to be a dict")
+        pulumi.set(__self__, "network_profile", network_profile)
+        if node_management_endpoint and not isinstance(node_management_endpoint, str):
+            raise TypeError("Expected argument 'node_management_endpoint' to be a str")
+        pulumi.set(__self__, "node_management_endpoint", node_management_endpoint)
+        if pool_allocation_mode and not isinstance(pool_allocation_mode, str):
+            raise TypeError("Expected argument 'pool_allocation_mode' to be a str")
+        pulumi.set(__self__, "pool_allocation_mode", pool_allocation_mode)
+        if pool_quota and not isinstance(pool_quota, int):
+            raise TypeError("Expected argument 'pool_quota' to be a int")
+        pulumi.set(__self__, "pool_quota", pool_quota)
+        if private_endpoint_connections and not isinstance(private_endpoint_connections, list):
+            raise TypeError("Expected argument 'private_endpoint_connections' to be a list")
+        pulumi.set(__self__, "private_endpoint_connections", private_endpoint_connections)
+        if provisioning_state and not isinstance(provisioning_state, str):
+            raise TypeError("Expected argument 'provisioning_state' to be a str")
+        pulumi.set(__self__, "provisioning_state", provisioning_state)
+        if public_network_access and not isinstance(public_network_access, str):
+            raise TypeError("Expected argument 'public_network_access' to be a str")
+        pulumi.set(__self__, "public_network_access", public_network_access)
+        if tags and not isinstance(tags, dict):
+            raise TypeError("Expected argument 'tags' to be a dict")
+        pulumi.set(__self__, "tags", tags)
+        if type and not isinstance(type, str):
+            raise TypeError("Expected argument 'type' to be a str")
+        pulumi.set(__self__, "type", type)
+
+    @property
+    @pulumi.getter(name="accountEndpoint")
+    def account_endpoint(self) -> str:
+        """
+        The account endpoint used to interact with the Batch service.
+        """
+        return pulumi.get(self, "account_endpoint")
+
+    @property
+    @pulumi.getter(name="activeJobAndJobScheduleQuota")
+    def active_job_and_job_schedule_quota(self) -> int:
+        return pulumi.get(self, "active_job_and_job_schedule_quota")
+
+    @property
+    @pulumi.getter(name="allowedAuthenticationModes")
+    def allowed_authentication_modes(self) -> Sequence[str]:
+        """
+        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.
+        """
+        return pulumi.get(self, "allowed_authentication_modes")
+
+    @property
+    @pulumi.getter(name="autoStorage")
+    def auto_storage(self) -> 'outputs.AutoStoragePropertiesResponse':
+        """
+        Contains information about the auto-storage account associated with a Batch account.
+        """
+        return pulumi.get(self, "auto_storage")
+
+    @property
+    @pulumi.getter(name="dedicatedCoreQuota")
+    def dedicated_core_quota(self) -> int:
+        """
+        For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.
+        """
+        return pulumi.get(self, "dedicated_core_quota")
+
+    @property
+    @pulumi.getter(name="dedicatedCoreQuotaPerVMFamily")
+    def dedicated_core_quota_per_vm_family(self) -> Sequence['outputs.VirtualMachineFamilyCoreQuotaResponse']:
+        """
+        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.
+        """
+        return pulumi.get(self, "dedicated_core_quota_per_vm_family")
+
+    @property
+    @pulumi.getter(name="dedicatedCoreQuotaPerVMFamilyEnforced")
+    def dedicated_core_quota_per_vm_family_enforced(self) -> bool:
+        """
+        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.
+        """
+        return pulumi.get(self, "dedicated_core_quota_per_vm_family_enforced")
+
+    @property
+    @pulumi.getter
+    def encryption(self) -> 'outputs.EncryptionPropertiesResponse':
+        """
+        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.
+        """
+        return pulumi.get(self, "encryption")
+
+    @property
+    @pulumi.getter
+    def id(self) -> str:
+        """
+        The ID of the resource.
+        """
+        return pulumi.get(self, "id")
+
+    @property
+    @pulumi.getter
+    def identity(self) -> Optional['outputs.BatchAccountIdentityResponse']:
+        """
+        The identity of the Batch account.
+        """
+        return pulumi.get(self, "identity")
+
+    @property
+    @pulumi.getter(name="keyVaultReference")
+    def key_vault_reference(self) -> 'outputs.KeyVaultReferenceResponse':
+        """
+        Identifies the Azure key vault associated with a Batch account.
+        """
+        return pulumi.get(self, "key_vault_reference")
+
+    @property
+    @pulumi.getter
+    def location(self) -> str:
+        """
+        The location of the resource.
+        """
+        return pulumi.get(self, "location")
+
+    @property
+    @pulumi.getter(name="lowPriorityCoreQuota")
+    def low_priority_core_quota(self) -> int:
+        """
+        For accounts with PoolAllocationMode set to UserSubscription, quota is managed on the subscription so this value is not returned.
+        """
+        return pulumi.get(self, "low_priority_core_quota")
+
+    @property
+    @pulumi.getter
+    def name(self) -> str:
+        """
+        The name of the resource.
+        """
+        return pulumi.get(self, "name")
+
+    @property
+    @pulumi.getter(name="networkProfile")
+    def network_profile(self) -> Optional['outputs.NetworkProfileResponse']:
+        """
+        The network profile only takes effect when publicNetworkAccess is enabled.
+        """
+        return pulumi.get(self, "network_profile")
+
+    @property
+    @pulumi.getter(name="nodeManagementEndpoint")
+    def node_management_endpoint(self) -> str:
+        """
+        The endpoint used by compute node to connect to the Batch node management service.
+        """
+        return pulumi.get(self, "node_management_endpoint")
+
+    @property
+    @pulumi.getter(name="poolAllocationMode")
+    def pool_allocation_mode(self) -> str:
+        """
+        The allocation mode for creating pools in the Batch account.
+        """
+        return pulumi.get(self, "pool_allocation_mode")
+
+    @property
+    @pulumi.getter(name="poolQuota")
+    def pool_quota(self) -> int:
+        return pulumi.get(self, "pool_quota")
+
+    @property
+    @pulumi.getter(name="privateEndpointConnections")
+    def private_endpoint_connections(self) -> Sequence['outputs.PrivateEndpointConnectionResponse']:
+        """
+        List of private endpoint connections associated with the Batch account
+        """
+        return pulumi.get(self, "private_endpoint_connections")
+
+    @property
+    @pulumi.getter(name="provisioningState")
+    def provisioning_state(self) -> str:
+        """
+        The provisioned state of the resource
+        """
+        return pulumi.get(self, "provisioning_state")
+
+    @property
+    @pulumi.getter(name="publicNetworkAccess")
+    def public_network_access(self) -> Optional[str]:
+        """
+        If not specified, the default value is 'enabled'.
+        """
+        return pulumi.get(self, "public_network_access")
+
+    @property
+    @pulumi.getter
+    def tags(self) -> Mapping[str, str]:
+        """
+        The tags of the resource.
+        """
+        return pulumi.get(self, "tags")
+
+    @property
+    @pulumi.getter
+    def type(self) -> str:
+        """
+        The type of the resource.
+        """
+        return pulumi.get(self, "type")
+
+
+class AwaitableGetBatchAccountResult(GetBatchAccountResult):
+    # pylint: disable=using-constant-test
+    def __await__(self):
+        if False:
+            yield self
+        return GetBatchAccountResult(
+            account_endpoint=self.account_endpoint,
+            active_job_and_job_schedule_quota=self.active_job_and_job_schedule_quota,
+            allowed_authentication_modes=self.allowed_authentication_modes,
+            auto_storage=self.auto_storage,
+            dedicated_core_quota=self.dedicated_core_quota,
+            dedicated_core_quota_per_vm_family=self.dedicated_core_quota_per_vm_family,
+            dedicated_core_quota_per_vm_family_enforced=self.dedicated_core_quota_per_vm_family_enforced,
+            encryption=self.encryption,
+            id=self.id,
+            identity=self.identity,
+            key_vault_reference=self.key_vault_reference,
+            location=self.location,
+            low_priority_core_quota=self.low_priority_core_quota,
+            name=self.name,
+            network_profile=self.network_profile,
+            node_management_endpoint=self.node_management_endpoint,
+            pool_allocation_mode=self.pool_allocation_mode,
+            pool_quota=self.pool_quota,
+            private_endpoint_connections=self.private_endpoint_connections,
+            provisioning_state=self.provisioning_state,
+            public_network_access=self.public_network_access,
+            tags=self.tags,
+            type=self.type)
+
+
+def get_batch_account(account_name: Optional[str] = None,
+                      resource_group_name: Optional[str] = None,
+                      opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetBatchAccountResult:
+    """
+    Gets information about the specified Batch account.
+
+
+    :param str account_name: The name of the Batch account.
+    :param str resource_group_name: The name of the resource group that contains the Batch account.
+    """
+    __args__ = dict()
+    __args__['accountName'] = account_name
+    __args__['resourceGroupName'] = resource_group_name
+    opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke('azure-native:batch/v20240701:getBatchAccount', __args__, opts=opts, typ=GetBatchAccountResult).value
+
+    return AwaitableGetBatchAccountResult(
+        account_endpoint=pulumi.get(__ret__, 'account_endpoint'),
+        active_job_and_job_schedule_quota=pulumi.get(__ret__, 'active_job_and_job_schedule_quota'),
+        allowed_authentication_modes=pulumi.get(__ret__, 'allowed_authentication_modes'),
+        auto_storage=pulumi.get(__ret__, 'auto_storage'),
+        dedicated_core_quota=pulumi.get(__ret__, 'dedicated_core_quota'),
+        dedicated_core_quota_per_vm_family=pulumi.get(__ret__, 'dedicated_core_quota_per_vm_family'),
+        dedicated_core_quota_per_vm_family_enforced=pulumi.get(__ret__, 'dedicated_core_quota_per_vm_family_enforced'),
+        encryption=pulumi.get(__ret__, 'encryption'),
+        id=pulumi.get(__ret__, 'id'),
+        identity=pulumi.get(__ret__, 'identity'),
+        key_vault_reference=pulumi.get(__ret__, 'key_vault_reference'),
+        location=pulumi.get(__ret__, 'location'),
+        low_priority_core_quota=pulumi.get(__ret__, 'low_priority_core_quota'),
+        name=pulumi.get(__ret__, 'name'),
+        network_profile=pulumi.get(__ret__, 'network_profile'),
+        node_management_endpoint=pulumi.get(__ret__, 'node_management_endpoint'),
+        pool_allocation_mode=pulumi.get(__ret__, 'pool_allocation_mode'),
+        pool_quota=pulumi.get(__ret__, 'pool_quota'),
+        private_endpoint_connections=pulumi.get(__ret__, 'private_endpoint_connections'),
+        provisioning_state=pulumi.get(__ret__, 'provisioning_state'),
+        public_network_access=pulumi.get(__ret__, 'public_network_access'),
+        tags=pulumi.get(__ret__, 'tags'),
+        type=pulumi.get(__ret__, 'type'))
+
+
+@_utilities.lift_output_func(get_batch_account)
+def get_batch_account_output(account_name: Optional[pulumi.Input[str]] = None,
+                             resource_group_name: Optional[pulumi.Input[str]] = None,
+                             opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetBatchAccountResult]:
+    """
+    Gets information about the specified Batch account.
+
+
+    :param str account_name: The name of the Batch account.
+    :param str resource_group_name: The name of the resource group that contains the Batch account.
+    """
+    ...