ContainerConfiguration Class

  • java.lang.Object
    • com.azure.ai.agents.models.ContainerConfiguration

Implements

public final class ContainerConfiguration
implements JsonSerializable<ContainerConfiguration>

Container-based deployment configuration for a hosted agent.

Constructor Summary

Constructor Description
ContainerConfiguration(String image)

Creates an instance of ContainerConfiguration class.

Method Summary

Modifier and Type Method and Description
static ContainerConfiguration fromJson(JsonReader jsonReader)

Reads an instance of ContainerConfiguration from the JsonReader.

String getImage()

Get the image property: The container image for the hosted agent.

String getRegistryConnectionId()

Get the registryConnectionId property: The id (or name) of the Foundry project connection that provides the credentials used to authenticate to the private container registry hosting `image`.

ContainerConfiguration setRegistryConnectionId(String registryConnectionId)

Set the registryConnectionId property: The id (or name) of the Foundry project connection that provides the credentials used to authenticate to the private container registry hosting `image`.

JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

Constructor Details

ContainerConfiguration

public ContainerConfiguration(String image)

Creates an instance of ContainerConfiguration class.

Parameters:

image - the image value to set.

Method Details

fromJson

public static ContainerConfiguration fromJson(JsonReader jsonReader)

Reads an instance of ContainerConfiguration from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of ContainerConfiguration if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

getImage

public String getImage()

Get the image property: The container image for the hosted agent.

Returns:

the image value.

getRegistryConnectionId

public String getRegistryConnectionId()

Get the registryConnectionId property: The id (or name) of the Foundry project connection that provides the credentials used to authenticate to the private container registry hosting `image`. The connection abstracts the auth mechanism — for example a managed-identity-federated token exchange, or a username/token secret — so registry credentials are never part of the agent definition. Omit for public images or registries already reachable by the platform's default identity (for example, Azure Container Registry).

Returns:

the registryConnectionId value.

setRegistryConnectionId

public ContainerConfiguration setRegistryConnectionId(String registryConnectionId)

Set the registryConnectionId property: The id (or name) of the Foundry project connection that provides the credentials used to authenticate to the private container registry hosting `image`. The connection abstracts the auth mechanism — for example a managed-identity-federated token exchange, or a username/token secret — so registry credentials are never part of the agent definition. Omit for public images or registries already reachable by the platform's default identity (for example, Azure Container Registry).

Parameters:

registryConnectionId - the registryConnectionId value to set.

Returns:

the ContainerConfiguration object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to