EnvironmentOperations Clase

EnvironmentOperations.

No debe crear una instancia de esta clase directamente. En su lugar, debe crear una instancia de MLClient que le cree instancias y la adjunte como un atributo.

Herencia

azure.ai.ml._scope_dependent_operations._ScopeDependentOperations

EnvironmentOperations

Constructor

EnvironmentOperations(operation_scope: OperationScope, operation_config: OperationConfig, service_client: AzureMachineLearningWorkspaces | AzureMachineLearningWorkspaces, all_operations: OperationsContainer, **kwargs: Any)

Parámetros

operation_scope

<xref:azure.ai.ml._scope_dependent_operations.OperationScope>

Requerido

Variables de ámbito para las clases de operaciones de un objeto MLClient.

operation_config

<xref:azure.ai.ml._scope_dependent_operations.OperationConfig>

Requerido

Configuración común para las clases de operaciones de un objeto MLClient.

service_client

Union[ <xref:azure.ai.ml._restclient.v2023_04_01_preview._azure_machine_learning_workspaces.AzureMachineLearningWorkspaces>, <xref:azure.ai.ml._restclient.v2021_10_01_dataplanepreview._azure_machine_learning_workspaces. AzureMachineLearningWorkspaces>]

Requerido

Cliente de servicio para permitir que los usuarios finales funcionen en recursos del área de trabajo de Azure Machine Learning (ServiceClient042023Preview o ServiceClient102021Dataplane).

all_operations

<xref:azure.ai.ml._scope_dependent_operations.OperationsContainer>

Requerido

Todas las clases de operaciones de un objeto MLClient.

Métodos

archive	Archivar un entorno o una versión del entorno.
create_or_update	Devuelve el recurso de entorno creado o actualizado.
get	Devuelve el recurso de entorno especificado.
list	Enumere todos los recursos de entorno en el área de trabajo.
restore	Restaure una versión de entorno archivado.
share	Nota Se trata de un método experimental y puede cambiar en cualquier momento. Consulte https://aka.ms/azuremlexperimental para más información. Comparta un recurso de entorno desde el área de trabajo al registro.

archive

Archivar un entorno o una versión del entorno.

archive(name: str, version: str | None = None, label: str | None = None, **kwargs) -> None

Parámetros

name

str

Requerido

Nombre del entorno.

version

str

Requerido

Versión del entorno.

label

str

Requerido

Etiqueta del entorno. (mutuamente excluyente con la versión)

Ejemplos

Ejemplo de archivo.

   ml_client.environments.archive("create-environment", "2.0")

create_or_update

Devuelve el recurso de entorno creado o actualizado.

create_or_update(environment: Environment) -> Environment

Parámetros

environment

<xref:azure.ai.ml.entities._assets.Environment>

Requerido

Environment (objeto)

Devoluciones

Objeto Environment creado o actualizado

Tipo de valor devuelto

Environment

Excepciones

ValidationException

Se genera si environment no se puede validar correctamente. Los detalles se proporcionarán en el mensaje de error.

EmptyDirectoryError

Se genera si la ruta de acceso local proporcionada apunta a un directorio vacío.

Ejemplos

Crear entorno.

   from azure.ai.ml.entities import BuildContext, Environment

   env_docker_context = Environment(
       build=BuildContext(
           path="./sdk/ml/azure-ai-ml/tests/test_configs/environment/environment_files",
           dockerfile_path="DockerfileNonDefault",
       ),
       name="create-environment",
       version="2.0",
       description="Environment created from a Docker context.",
   )
   ml_client.environments.create_or_update(env_docker_context)

get

Devuelve el recurso de entorno especificado.

get(name: str, version: str | None = None, label: str | None = None) -> Environment

Parámetros

name

str

Requerido

Nombre del entorno.

version

str

Requerido

Versión del entorno.

label

str

Requerido

Etiqueta del entorno. (mutuamente excluyente con la versión)

Devoluciones

Environment (objeto)

Tipo de valor devuelto

Environment

Excepciones

ValidationException

Se genera si environment no se puede validar correctamente. Los detalles se proporcionarán en el mensaje de error.

Ejemplos

Obtenga un ejemplo.

   ml_client.environments.get("create-environment", "2.0")

list

Enumere todos los recursos de entorno en el área de trabajo.

list(name: str | None = None, *, list_view_type: ListViewType = ListViewType.ACTIVE_ONLY) -> Iterable[Environment]

Parámetros

name

Optional[str]

Requerido

Nombre del entorno.

list_view_type

Tipo de vista para incluir o excluir (por ejemplo) entornos archivados. Valor predeterminado: ACTIVE_ONLY.

Devoluciones

Iterador como la instancia de objetos Environment.

Tipo de valor devuelto

ItemPaged[Environment]

Ejemplos

Ejemplo de lista.

   ml_client.environments.list()

restore

Restaure una versión de entorno archivado.

restore(name: str, version: str | None = None, label: str | None = None, **kwargs) -> None

Parámetros

name

str

Requerido

Nombre del entorno.

version

str

Requerido

Versión del entorno.

label

str

Requerido

Etiqueta del entorno. (mutuamente excluyente con la versión)

Ejemplos

Ejemplo de restauración.

   ml_client.environments.restore("create-environment", "2.0")

share

Nota

Se trata de un método experimental y puede cambiar en cualquier momento. Consulte https://aka.ms/azuremlexperimental para más información.

Comparta un recurso de entorno desde el área de trabajo al registro.

share(name: str, version: str, *, share_with_name: str, share_with_version: str, registry_name: str) -> Environment

Parámetros

name

str

Requerido

Nombre del recurso de entorno.

version

str

Requerido

Versión del recurso de entorno.

share_with_name

str

Nombre del recurso de entorno con el que se va a compartir.

share_with_version

str

Versión del recurso de entorno con la que se va a compartir.

registry_name

str

Nombre del registro de destino.

Devoluciones

Objeto de recurso de entorno.

Tipo de valor devuelto

Environment