IContainerGroup Interface

Definition

An immutable client-side representation of an Azure Container Group.

public interface IContainerGroup : Microsoft.Azure.Management.ResourceManager.Fluent.Core.IBeta, Microsoft.Azure.Management.ResourceManager.Fluent.Core.IGroupableResource<Microsoft.Azure.Management.ContainerInstance.Fluent.IContainerInstanceManager,Microsoft.Azure.Management.ContainerInstance.Fluent.Models.ContainerGroupInner>, Microsoft.Azure.Management.ResourceManager.Fluent.Core.IHasInner<Microsoft.Azure.Management.ContainerInstance.Fluent.Models.ContainerGroupInner>, Microsoft.Azure.Management.ResourceManager.Fluent.Core.IHasManager<Microsoft.Azure.Management.ContainerInstance.Fluent.IContainerInstanceManager>, Microsoft.Azure.Management.ResourceManager.Fluent.Core.ResourceActions.IRefreshable<Microsoft.Azure.Management.ContainerInstance.Fluent.IContainerGroup>, Microsoft.Azure.Management.ResourceManager.Fluent.Core.ResourceActions.IUpdatable<Microsoft.Azure.Management.ContainerInstance.Fluent.ContainerGroup.Update.IUpdate>
type IContainerGroup = interface
    interface IBeta
    interface IGroupableResource<IContainerInstanceManager, ContainerGroupInner>
    interface IResource
    interface IIndexable
    interface IHasId
    interface IHasName
    interface IHasResourceGroup
    interface IHasManager<IContainerInstanceManager>
    interface IHasInner<ContainerGroupInner>
    interface IRefreshable<IContainerGroup>
    interface IUpdatable<IUpdate>
Public Interface IContainerGroup
Implements IBeta, IGroupableResource(Of IContainerInstanceManager, ContainerGroupInner), IHasInner(Of ContainerGroupInner), IHasManager(Of IContainerInstanceManager), IRefreshable(Of IContainerGroup), IUpdatable(Of IUpdate)
Implements

Properties

Containers

Gets the container instances in this container group.

DnsConfig

Gets the DNS configuration for the container group.

DnsPrefix

Gets the DNS prefix which was specified at creation time.

Events

Gets the container group events.

ExternalPorts

Gets all the ports publicly exposed for this container group.

ExternalTcpPorts

Gets the TCP ports publicly exposed for this container group.

ExternalUdpPorts

Gets the UDP ports publicly exposed for this container group.

Fqdn

Gets the FQDN for the container group.

Id

Gets the resource id string

(Inherited from IHasId)
ImageRegistryServers

Gets the Docker image registry servers by which the container group is created from.

Inner (Inherited from IHasInner<T>)
IPAddress

Gets the IP address.

IsIPAddressPrivate

Gets true if IP address is private.

IsIPAddressPublic

Gets true if IP address is public.

IsManagedServiceIdentityEnabled

Gets whether managed service identity is enabled for the container group.

Key (Inherited from IIndexable)
LogAnalytics

Gets the log analytics information of the container group.

ManagedServiceIdentityType

Gets whether managed service identity is system assigned, user assigned, both, or neither.

Manager

Gets the manager client type of this resource type.

(Inherited from IHasManager<ManagerT>)
Name

Gets the name of the resource

(Inherited from IHasName)
NetworkProfileId

Gets the id of the network profile for the container group.

OSType

Gets the base level OS type required by the containers in the group.

ProvisioningState

Gets the provisioningState of the container group.

Region (Inherited from IResource)
RegionName (Inherited from IResource)
ResourceGroupName (Inherited from IHasResourceGroup)
RestartPolicy

Gets the container group restart policy.

State

Gets the state of the container group; only valid in response.

SystemAssignedManagedServiceIdentityPrincipalId

Gets the principal id of the system assigned managed service identity. Null if managed service identity is not configured.

SystemAssignedManagedServiceIdentityTenantId

Gets the tenant id of the system assigned managed service identity. Null if managed service identity is not configured.

Tags (Inherited from IResource)
Type (Inherited from IResource)
UserAssignedManagedServiceIdentityIds

Gets the ids of the user assigned managed service identities. Returns an empty set if no MSIs are set.

Volumes

Gets the volumes for this container group.

Methods

ExecuteCommand(String, String, Int32, Int32)

Starts the exec command for a specific container instance.

ExecuteCommandAsync(String, String, Int32, Int32, CancellationToken)

Starts the exec command for a specific container instance within the container group.

GetLogContent(String)

Get the log content for the specified container instance within the container group.

GetLogContent(String, Int32)

Get the log content for the specified container instance within the container group.

GetLogContentAsync(String, CancellationToken)

Get the log content for the specified container instance within the container group.

GetLogContentAsync(String, Int32, CancellationToken)

Get the log content for the specified container instance within the container group.

Refresh()

Refreshes the resource to sync with Azure.

(Inherited from IRefreshable<T>)
RefreshAsync(CancellationToken)

Refreshes the resource to sync with Azure.

(Inherited from IRefreshable<T>)
Restart()

Restarts all containers in a container group in place. If container image has updates, new image will be downloaded.

RestartAsync(CancellationToken)

Restarts all containers in a container group in place asynchronously. If container image has updates, new image will be downloaded.

Stop()

Stops all containers in a container group. Compute resources will be de-allocated and billing will stop.

StopAsync(CancellationToken)

Stops all containers in a container group asynchronously. Compute resources will be de-allocated and billing will stop.

Update() (Inherited from IUpdatable<T>)

Applies to