azure.ai.ml.entities.NetworkSettings.yml

### YamlMime:PythonClass
uid: azure.ai.ml.entities.NetworkSettings
name: NetworkSettings
fullName: azure.ai.ml.entities.NetworkSettings
module: azure.ai.ml.entities
inheritances:
- builtins.object
summary: 'Network settings for a compute resource. If the workspace and VNet are in
  different resource groups,

  please provide the full URI for subnet and leave vnet_name as None.'
constructor:
  syntax: 'NetworkSettings(*, vnet_name: str | None = None, subnet: str | None = None,
    **kwargs: Any)'
  parameters:
  - name: vnet_name
    description: The virtual network name.
    isRequired: true
    types:
    - <xref:typing.Optional>[<xref:str>]
  - name: subnet
    description: The subnet name.
    isRequired: true
    types:
    - <xref:typing.Optional>[<xref:str>]
  keywordOnlyParameters:
  - name: vnet_name
    isRequired: true
  - name: subnet
    isRequired: true
examples:
- "Configuring NetworkSettings for an AmlCompute 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 (\n       AmlCompute,\n       IdentityConfiguration,\n       ManagedIdentityConfiguration,\n\
  \       NetworkSettings,\n   )\n\n   aml_compute = AmlCompute(\n       name=\"my-compute\"\
  ,\n       min_instances=0,\n       max_instances=10,\n       idle_time_before_scale_down=100,\n\
  \       network_settings=NetworkSettings(vnet_name=\"my-vnet\", subnet=\"default\"\
  ),\n   )\n\n   ````\n"
attributes:
- uid: azure.ai.ml.entities.NetworkSettings.private_ip_address
  name: private_ip_address
  summary: Private IP address of the compute instance.
  return:
    description: Private IP address.
    types:
    - <xref:str>
- uid: azure.ai.ml.entities.NetworkSettings.public_ip_address
  name: public_ip_address
  summary: Public IP address of the compute instance.
  return:
    description: Public IP address.
    types:
    - <xref:str>