EnvironmentOperations Klasse

EnvironmentOperations.

Sie sollten diese Klasse nicht direkt instanziieren. Stattdessen sollten Sie eine MLClient-instance erstellen, die ihn für Sie instanziiert und als Attribut anfügen.

Vererbung

azure.ai.ml._scope_dependent_operations._ScopeDependentOperations

EnvironmentOperations

Konstruktor

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

Parameter

operation_scope

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

Erforderlich

Bereichsvariablen für die Vorgangsklassen eines MLClient-Objekts.

operation_config

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

Erforderlich

Allgemeine Konfiguration für Betriebsklassen eines MLClient-Objekts.

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>]

Erforderlich

Dienstclient, damit Endbenutzer mit Azure Machine Learning-Arbeitsbereichsressourcen arbeiten können (ServiceClient042023Preview oder ServiceClient102021Dataplane).

all_operations

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

Erforderlich

Alle Vorgangsklassen eines MLClient-Objekts.

Methoden

archive	Archivieren sie eine Umgebung oder eine Umgebungsversion.
create_or_update	Gibt ein erstelltes oder aktualisiertes Umgebungsobjekt zurück.
get	Gibt das angegebene Umgebungsobjekt zurück.
list	Listet alle Umgebungsressourcen im Arbeitsbereich auf.
restore	Stellen Sie eine archivierte Umgebungsversion wieder her.
share	Hinweis Dies ist eine experimentelle Methode, die sich jederzeit ändern kann. Unter https://aka.ms/azuremlexperimental finden Sie weitere Informationen. Freigeben eines Umgebungsobjekts vom Arbeitsbereich für die Registrierung.

archive

Archivieren sie eine Umgebung oder eine Umgebungsversion.

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

Parameter

name

str

Erforderlich

Der Name der Umgebung.

version

str

Erforderlich

Die Version der Umgebung.

label

str

Erforderlich

Bezeichnung der Umgebung. (sich gegenseitig mit Version ausschließen)

Beispiele

Archivbeispiel.

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

create_or_update

Gibt ein erstelltes oder aktualisiertes Umgebungsobjekt zurück.

create_or_update(environment: Environment) -> Environment

Parameter

environment

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

Erforderlich

Environment-Objekt

Gibt zurück

Erstelltes oder aktualisiertes Environment-Objekt

Rückgabetyp

Environment

Ausnahmen

ValidationException

Wird ausgelöst, wenn die Umgebung nicht erfolgreich überprüft werden kann. Details werden in der Fehlermeldung angegeben.

EmptyDirectoryError

Wird ausgelöst, wenn der angegebene lokale Pfad auf ein leeres Verzeichnis verweist.

Beispiele

Erstellen Sie eine Umgebung.

   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

Gibt das angegebene Umgebungsobjekt zurück.

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

Parameter

name

str

Erforderlich

Der Name der Umgebung.

version

str

Erforderlich

Die Version der Umgebung.

label

str

Erforderlich

Bezeichnung der Umgebung. (sich gegenseitig mit Version ausschließen)

Gibt zurück

Environment-Objekt

Rückgabetyp

Environment

Ausnahmen

ValidationException

Wird ausgelöst, wenn die Umgebung nicht erfolgreich überprüft werden kann. Details werden in der Fehlermeldung angegeben.

Beispiele

Beispiel abrufen.

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

list

Listet alle Umgebungsressourcen im Arbeitsbereich auf.

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

Parameter

name

Optional[str]

Erforderlich

Der Name der Umgebung.

list_view_type

Ansichtstyp für das Einschließen/Ausschließen (z. B.) archivierter Umgebungen. Standard: ACTIVE_ONLY.

Gibt zurück

Ein Iterator wie instance von Environment-Objekten.

Rückgabetyp

ItemPaged[Environment]

Beispiele

Listenbeispiel.

   ml_client.environments.list()

restore

Stellen Sie eine archivierte Umgebungsversion wieder her.

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

Parameter

name

str

Erforderlich

Der Name der Umgebung.

version

str

Erforderlich

Die Version der Umgebung.

label

str

Erforderlich

Bezeichnung der Umgebung. (sich gegenseitig mit Version ausschließen)

Beispiele

Beispiel für die Wiederherstellung.

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

share

Hinweis

Dies ist eine experimentelle Methode, die sich jederzeit ändern kann. Unter https://aka.ms/azuremlexperimental finden Sie weitere Informationen.

Freigeben eines Umgebungsobjekts vom Arbeitsbereich für die Registrierung.

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

Parameter

name

str

Erforderlich

Name des Umgebungsobjekts.

version

str

Erforderlich

Version des Umgebungsobjekts.

share_with_name

str

Name des Umgebungsobjekts, für das freigegeben werden soll.

share_with_version

str

Version des Umgebungsobjekts, mit dem freigegeben werden soll.

registry_name

str

Name der Zielregistrierung.

Gibt zurück

Umgebungsobjekt.

Rückgabetyp

Environment