azure.ai.ml.entities.ManagedOnlineEndpoint.yml

### YamlMime:PythonClass
uid: azure.ai.ml.entities.ManagedOnlineEndpoint
name: ManagedOnlineEndpoint
fullName: azure.ai.ml.entities.ManagedOnlineEndpoint
module: azure.ai.ml.entities
inheritances:
- azure.ai.ml.entities._endpoint.online_endpoint.OnlineEndpoint
summary: 'Managed Online endpoint entity.


  Managed Online endpoint entity.


  Constructor for Managed Online endpoint entity.'
constructor:
  syntax: 'ManagedOnlineEndpoint(*, name: str | None = None, tags: Dict[str, Any]
    | None = None, properties: Dict[str, Any] | None = None, auth_mode: str = ''key'',
    description: str | None = None, location: str | None = None, traffic: Dict[str,
    int] | None = None, mirror_traffic: Dict[str, int] | None = None, identity: IdentityConfiguration
    | None = None, kind: str | None = None, public_network_access: str | None = None,
    **kwargs: Any)'
  keywordOnlyParameters:
  - name: name
    description: Name of the resource, defaults to None
    types:
    - <xref:typing.Optional>[<xref:str>]
  - name: tags
    description: Tag dictionary. Tags can be added, removed, and updated, defaults
      to None
    types:
    - <xref:typing.Optional>[<xref:typing.Dict>[<xref:str>, <xref:typing.Any>]]
  - name: properties
    description: The asset property dictionary, defaults to None
    types:
    - <xref:typing.Optional>[<xref:typing.Dict>[<xref:str>, <xref:typing.Any>]]
  - name: auth_mode
    description: 'Possible values include: "aml_token", "key", defaults to KEY'
    defaultValue: key
  - name: description
    description: Description of the inference endpoint, defaults to None
    types:
    - <xref:typing.Optional>[<xref:str>]
  - name: location
    description: Location of the resource, defaults to None
    types:
    - <xref:typing.Optional>[<xref:str>]
  - name: traffic
    description: Traffic rules on how the traffic will be routed across deployments,
      defaults to None
    types:
    - <xref:typing.Optional>[<xref:typing.Dict>[<xref:str>, <xref:int>]]
  - name: mirror_traffic
    description: Duplicated live traffic used to inference a single deployment, defaults
      to None
    types:
    - <xref:typing.Optional>[<xref:typing.Dict>[<xref:str>, <xref:int>]]
  - name: identity
    description: Identity Configuration, defaults to SystemAssigned
    types:
    - <xref:typing.Optional>[<xref:azure.ai.ml.entities.IdentityConfiguration>]
  - name: kind
    description: 'Kind of the resource, we have two kinds: K8s and Managed online
      endpoints, defaults to None.'
    types:
    - <xref:typing.Optional>[<xref:str>]
  - name: public_network_access
    description: 'Whether to allow public endpoint connectivity, defaults to None

      Allowed values are: "enabled", "disabled"'
  - name: name
    description: Name of the resource, defaults to None
    types:
    - <xref:typing.Optional>[<xref:str>]
  - name: tags
    description: Tag dictionary. Tags can be added, removed, and updated, defaults
      to None
    types:
    - <xref:typing.Optional>[<xref:typing.Dict>[<xref:str>, <xref:typing.Any>]]
  - name: properties
    description: The asset property dictionary, defaults to None
    types:
    - <xref:typing.Optional>[<xref:typing.Dict>[<xref:str>, <xref:typing.Any>]]
  - name: auth_mode
    description: 'Possible values include: "aml_token", "key", defaults to KEY'
  - name: description
    description: Description of the inference endpoint, defaults to None
    types:
    - <xref:typing.Optional>[<xref:str>]
  - name: location
    description: Location of the resource, defaults to None
    types:
    - <xref:typing.Optional>[<xref:str>]
  - name: traffic
    description: Traffic rules on how the traffic will be routed across deployments,
      defaults to None
    types:
    - <xref:typing.Optional>[<xref:typing.Dict>[<xref:str>, <xref:int>]]
  - name: mirror_traffic
    description: Duplicated live traffic used to inference a single deployment, defaults
      to None
    types:
    - <xref:typing.Optional>[<xref:typing.Dict>[<xref:str>, <xref:int>]]
  - name: identity
    description: Identity Configuration, defaults to SystemAssigned
    types:
    - <xref:typing.Optional>[<xref:azure.ai.ml.entities.IdentityConfiguration>]
  - name: kind
    description: 'Kind of the resource, we have two kinds: K8s and Managed online
      endpoints, defaults to None.'
  - name: public_network_access
    description: 'Whether to allow public endpoint connectivity, defaults to None.

      Allowed values are: "enabled", "disabled"'
methods:
- uid: azure.ai.ml.entities.ManagedOnlineEndpoint.dump
  name: dump
  signature: 'dump(dest: str | PathLike | IO | None = None, **kwargs: Any) -> Dict[str,
    Any]'
  parameters:
  - name: dest
    defaultValue: None
attributes:
- uid: azure.ai.ml.entities.ManagedOnlineEndpoint.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.ManagedOnlineEndpoint.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.ManagedOnlineEndpoint.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.ManagedOnlineEndpoint.openapi_uri
  name: openapi_uri
  summary: URI to check the open api definition of the endpoint.
  return:
    description: The open API URI
    types:
    - <xref:typing.Optional>[<xref:str>]
- uid: azure.ai.ml.entities.ManagedOnlineEndpoint.provisioning_state
  name: provisioning_state
  summary: Endpoint provisioning state, readonly.
  return:
    description: Endpoint provisioning state.
    types:
    - <xref:typing.Optional>[<xref:str>]
- uid: azure.ai.ml.entities.ManagedOnlineEndpoint.scoring_uri
  name: scoring_uri
  summary: URI to use to perform a prediction, readonly.
  return:
    description: The scoring URI
    types:
    - <xref:typing.Optional>[<xref:str>]