azure.ai.ml.entities.KubernetesCompute.yml

### YamlMime:PythonClass
uid: azure.ai.ml.entities.KubernetesCompute
name: KubernetesCompute
fullName: azure.ai.ml.entities.KubernetesCompute
module: azure.ai.ml.entities
inheritances:
- azure.ai.ml.entities._compute.compute.Compute
summary: Kubernetes Compute resource.
constructor:
  syntax: 'KubernetesCompute(*, namespace: str = ''default'', properties: Dict[str,
    Any] | None = None, identity: IdentityConfiguration | None = None, **kwargs: Any)'
  parameters:
  - name: namespace
    description: The namespace of the KubernetesCompute. Defaults to "default".
    isRequired: true
    types:
    - <xref:typing.Optional>[<xref:str>]
  - name: properties
    description: The properties of the Kubernetes compute resource.
    isRequired: true
    types:
    - <xref:typing.Optional>[<xref:typing.Dict>]
  - name: identity
    description: The identities that are associated with the compute cluster.
    isRequired: true
    types:
    - <xref:azure.ai.ml.entities.IdentityConfiguration>
  keywordOnlyParameters:
  - name: namespace
    defaultValue: default
  - name: properties
    isRequired: true
  - name: identity
    isRequired: true
examples:
- "Creating a KubernetesCompute object.<!--[!code-python[Main](les\\ml_samples_compute.py\
  \ )]-->\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\": [], \"dupnames\"\
  : [], \"backrefs\": [], \"source\": \"C:\\\\hostedtoolcache\\\\windows\\\\Python\\\
  \\3.11.9\\\\x64\\\\Lib\\\\site-packages\\\\py2docfx\\\\dist_temp\\\\8\\\\azure-ai-ml-1.16.1\\\
  \\samples\\\\ml_samples_compute.py\", \"xml:space\": \"preserve\", \"force\": false,\
  \ \"language\": \"python\", \"highlight_args\": {\"linenostart\": 1}, \"linenos\"\
  : false} -->\n\n````python\n\n   from azure.ai.ml.entities import KubernetesCompute\n\
  \n   k8s_compute = KubernetesCompute(\n       identity=IdentityConfiguration(\n\
  \           type=\"UserAssigned\",\n           user_assigned_identities=[\n    \
  \           ManagedIdentityConfiguration(\n                   resource_id=\"/subscriptions/1234567-abcd-ef12-1234-12345/resourcegroups/our_rg_eastus/providers/Microsoft.ManagedIdentity/userAssignedIdentities/our-agent-aks\"\
  \n               )\n           ],\n       ),\n   )\n\n   ````\n"
methods:
- uid: azure.ai.ml.entities.KubernetesCompute.dump
  name: dump
  summary: Dump the compute content into a file in yaml format.
  signature: 'dump(dest: str | PathLike | IO, **kwargs: Any) -> None'
  parameters:
  - name: dest
    description: 'The destination to receive this compute''s content.

      Must be either a path to a local file, or an already-open file stream.

      If dest is a file path, a new file will be created,

      and an exception is raised if the file exists.

      If dest is an open file, the file will be written to directly,

      and an exception will be raised if the file is not writable.''.'
    isRequired: true
    types:
    - <xref:typing.Union>[<xref:PathLike>, <xref:str>, <xref:typing.IO>[<xref:typing.AnyStr>]]
attributes:
- uid: azure.ai.ml.entities.KubernetesCompute.base_path
  name: base_path
  summary: The base path of the resource.
  return:
    description: The base path of the resource.
    types:
    - <xref:str>
- uid: azure.ai.ml.entities.KubernetesCompute.created_on
  name: created_on
  summary: The compute resource creation timestamp.
  return:
    description: The compute resource creation timestamp.
    types:
    - <xref:typing.Optional>[<xref:str>]
- uid: azure.ai.ml.entities.KubernetesCompute.creation_context
  name: creation_context
  summary: The creation context of the resource.
  return:
    description: The creation metadata for the resource.
    types:
    - <xref:typing.Optional>[<xref:azure.ai.ml.entities.SystemData>]
- uid: azure.ai.ml.entities.KubernetesCompute.id
  name: id
  summary: The resource ID.
  return:
    description: The global ID of the resource, an Azure Resource Manager (ARM) ID.
    types:
    - <xref:typing.Optional>[<xref:str>]
- uid: azure.ai.ml.entities.KubernetesCompute.provisioning_errors
  name: provisioning_errors
  summary: The compute resource provisioning errors.
  return:
    description: The compute resource provisioning errors.
    types:
    - <xref:typing.Optional>[<xref:str>]
- uid: azure.ai.ml.entities.KubernetesCompute.provisioning_state
  name: provisioning_state
  summary: The compute resource's provisioning state.
  return:
    description: The compute resource's provisioning state.
    types:
    - <xref:typing.Optional>[<xref:str>]
- uid: azure.ai.ml.entities.KubernetesCompute.type
  name: type
  summary: The compute type.
  return:
    description: The compute type.
    types:
    - <xref:typing.Optional>[<xref:str>]