ContainerGroupResource Class

Definition

Namespace:: Azure.ResourceManager.ContainerInstance

Assembly:: Azure.ResourceManager.ContainerInstance.dll

Package:: Azure.ResourceManager.ContainerInstance v1.3.1

Package:: Azure.ResourceManager.ContainerInstance v1.3.0-beta.4

Source:: ContainerGroupResource.cs

Source:: ContainerGroupResource.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

A class representing a ContainerGroup along with the instance operations that can be performed on it. If you have a ResourceIdentifier you can construct a ContainerGroupResource from an instance of ArmClient using the GetResource method. Otherwise you can get one from its parent resource ResourceGroupResource using the GetContainerGroups method.

public class ContainerGroupResource : Azure.ResourceManager.ArmResource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.ContainerInstance.ContainerGroupData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.ContainerInstance.ContainerGroupData>

type ContainerGroupResource = class
    inherit ArmResource
    interface IJsonModel<ContainerGroupData>
    interface IPersistableModel<ContainerGroupData>

Public Class ContainerGroupResource
Inherits ArmResource
Implements IJsonModel(Of ContainerGroupData), IPersistableModel(Of ContainerGroupData)

Inheritance: Object

ArmResource
ContainerGroupResource

Implements: IJsonModel<ContainerGroupData> IPersistableModel<ContainerGroupData> IPersistableModel<T>

Constructors

Name	Description
ContainerGroupResource()	Initializes a new instance of ContainerGroupResource for mocking.

Fields

Name	Description
ResourceType	Gets the resource type for the operations.

Properties

Name	Description
Client	Gets the ArmClient this resource client was created from. (Inherited from ArmResource)
Data	Gets the data representing this Feature.
Diagnostics	Gets the diagnostic options for this resource client. (Inherited from ArmResource)
Endpoint	Gets the base uri for this resource client. (Inherited from ArmResource)
HasData	Gets whether or not the current instance has data.
Id	Gets the resource identifier. (Inherited from ArmResource)
Pipeline	Gets the pipeline for this resource client. (Inherited from ArmResource)

Methods

Name	Description
AddTag(String, String, CancellationToken)	Add a tag to the current resource.
AddTagAsync(String, String, CancellationToken)	Add a tag to the current resource.
AttachContainer(String, CancellationToken)	Attach to the output stream of a specific container instance in a specified resource group and container group. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/containers/{containerName}/attach. Operation Id. : ContainerGroups_Attach. Default Api Version. : 2025-09-01. Resource. : ContainerGroupResource.
AttachContainerAsync(String, CancellationToken)	Attach to the output stream of a specific container instance in a specified resource group and container group. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/containers/{containerName}/attach. Operation Id. : ContainerGroups_Attach. Default Api Version. : 2025-09-01. Resource. : ContainerGroupResource.
CanUseTagResource(CancellationToken)	Checks to see if the TagResource API is deployed in the current environment. (Inherited from ArmResource)
CanUseTagResourceAsync(CancellationToken)	Checks to see if the TagResource API is deployed in the current environment. (Inherited from ArmResource)
CreateResourceIdentifier(String, String, String)	Generate the resource identifier for this resource.
Delete(WaitUntil, CancellationToken)	Delete the specified container group in the specified subscription and resource group. The operation does not delete other resources provided by the user, such as volumes. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}. Operation Id. : ContainerGroups_Delete. Default Api Version. : 2025-09-01. Resource. : ContainerGroupResource.
DeleteAsync(WaitUntil, CancellationToken)	Delete the specified container group in the specified subscription and resource group. The operation does not delete other resources provided by the user, such as volumes. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}. Operation Id. : ContainerGroups_Delete. Default Api Version. : 2025-09-01. Resource. : ContainerGroupResource.
ExecuteContainerCommand(String, ContainerExecContent, CancellationToken)	Executes a command for a specific container instance in a specified resource group and container group. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/containers/{containerName}/exec. Operation Id. : ContainerGroups_ExecuteCommand. Default Api Version. : 2025-09-01. Resource. : ContainerGroupResource.
ExecuteContainerCommandAsync(String, ContainerExecContent, CancellationToken)	Executes a command for a specific container instance in a specified resource group and container group. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/containers/{containerName}/exec. Operation Id. : ContainerGroups_ExecuteCommand. Default Api Version. : 2025-09-01. Resource. : ContainerGroupResource.
Get(CancellationToken)	Gets the properties of the specified container group in the specified subscription and resource group. The operation returns the properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}. Operation Id. : ContainerGroups_Get. Default Api Version. : 2025-09-01. Resource. : ContainerGroupResource.
GetAsync(CancellationToken)	Gets the properties of the specified container group in the specified subscription and resource group. The operation returns the properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}. Operation Id. : ContainerGroups_Get. Default Api Version. : 2025-09-01. Resource. : ContainerGroupResource.
GetAvailableLocations(CancellationToken)	Lists all available geo-locations. (Inherited from ArmResource)
GetAvailableLocationsAsync(CancellationToken)	Lists all available geo-locations. (Inherited from ArmResource)
GetContainerLogs(String, Nullable<Int32>, Nullable<Boolean>, CancellationToken)	Get the logs for a specified container instance in a specified resource group and container group. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/containers/{containerName}/logs. Operation Id. : ContainerGroups_ListLogs. Default Api Version. : 2025-09-01. Resource. : ContainerGroupResource.
GetContainerLogsAsync(String, Nullable<Int32>, Nullable<Boolean>, CancellationToken)	Get the logs for a specified container instance in a specified resource group and container group. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/containers/{containerName}/logs. Operation Id. : ContainerGroups_ListLogs. Default Api Version. : 2025-09-01. Resource. : ContainerGroupResource.
GetManagementLock(String, CancellationToken)	Get a management lock by scope. Request Path: /{scope}/providers/Microsoft.Authorization/locks/{lockName} Operation Id: ManagementLocks_GetByScope Default Api Version: 2020-05-01 Resource: ManagementLockResource (Inherited from ArmResource)
GetManagementLockAsync(String, CancellationToken)	Get a management lock by scope. Request Path: /{scope}/providers/Microsoft.Authorization/locks/{lockName} Operation Id: ManagementLocks_GetByScope Default Api Version: 2020-05-01 Resource: ManagementLockResource (Inherited from ArmResource)
GetManagementLocks()	Gets a collection of ManagementLockResources in the ArmResource. (Inherited from ArmResource)
GetOutboundNetworkDependenciesEndpoints(CancellationToken)	Gets all the network dependencies for this container group to allow complete control of network setting and configuration. For container groups, this will always be an empty list. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/outboundNetworkDependenciesEndpoints. Operation Id. : ContainerGroups_GetOutboundNetworkDependenciesEndpoints. Default Api Version. : 2025-09-01. Resource. : ContainerGroupResource.
GetOutboundNetworkDependenciesEndpointsAsync(CancellationToken)	Gets all the network dependencies for this container group to allow complete control of network setting and configuration. For container groups, this will always be an empty list. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/outboundNetworkDependenciesEndpoints. Operation Id. : ContainerGroups_GetOutboundNetworkDependenciesEndpoints. Default Api Version. : 2025-09-01. Resource. : ContainerGroupResource.
GetPolicyAssignment(String, CancellationToken)	This operation retrieves a single policy assignment, given its name and the scope it was created at. Request Path: /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName} Operation Id: PolicyAssignments_Get Default Api Version: 2022-06-01 Resource: PolicyAssignmentResource (Inherited from ArmResource)
GetPolicyAssignmentAsync(String, CancellationToken)	This operation retrieves a single policy assignment, given its name and the scope it was created at. Request Path: /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName} Operation Id: PolicyAssignments_Get Default Api Version: 2022-06-01 Resource: PolicyAssignmentResource (Inherited from ArmResource)
GetPolicyAssignments()	Gets a collection of PolicyAssignmentResources in the ArmResource. (Inherited from ArmResource)
GetTagResource()	Gets an object representing a TagResource along with the instance operations that can be performed on it in the ArmResource. (Inherited from ArmResource)
RemoveTag(String, CancellationToken)	Removes a tag by key from the resource.
RemoveTagAsync(String, CancellationToken)	Removes a tag by key from the resource.
Restart(WaitUntil, CancellationToken)	Restarts all containers in a container group in place. If container image has updates, new image will be downloaded. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/restart. Operation Id. : ContainerGroups_Restart. Default Api Version. : 2025-09-01. Resource. : ContainerGroupResource.
RestartAsync(WaitUntil, CancellationToken)	Restarts all containers in a container group in place. If container image has updates, new image will be downloaded. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/restart. Operation Id. : ContainerGroups_Restart. Default Api Version. : 2025-09-01. Resource. : ContainerGroupResource.
SetTags(IDictionary<String,String>, CancellationToken)	Replace the tags on the resource with the given set.
SetTagsAsync(IDictionary<String,String>, CancellationToken)	Replace the tags on the resource with the given set.
Start(WaitUntil, CancellationToken)	Starts all containers in a container group. Compute resources will be allocated and billing will start. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/start. Operation Id. : ContainerGroups_Start. Default Api Version. : 2025-09-01. Resource. : ContainerGroupResource.
StartAsync(WaitUntil, CancellationToken)	Starts all containers in a container group. Compute resources will be allocated and billing will start. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/start. Operation Id. : ContainerGroups_Start. Default Api Version. : 2025-09-01. Resource. : ContainerGroupResource.
Stop(CancellationToken)	Stops all containers in a container group. Compute resources will be deallocated and billing will stop. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/stop. Operation Id. : ContainerGroups_Stop. Default Api Version. : 2025-09-01. Resource. : ContainerGroupResource.
StopAsync(CancellationToken)	Stops all containers in a container group. Compute resources will be deallocated and billing will stop. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/stop. Operation Id. : ContainerGroups_Stop. Default Api Version. : 2025-09-01. Resource. : ContainerGroupResource.
TryGetApiVersion(ResourceType, String)	Gets the api version override if it has been set for the current client options. (Inherited from ArmResource)
Update(ContainerGroupPatch, CancellationToken)	Updates container group tags with specified values. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}. Operation Id. : ContainerGroups_Update. Default Api Version. : 2025-09-01. Resource. : ContainerGroupResource.
UpdateAsync(ContainerGroupPatch, CancellationToken)	Updates container group tags with specified values. Request Path. : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}. Operation Id. : ContainerGroups_Update. Default Api Version. : 2025-09-01. Resource. : ContainerGroupResource.

Explicit Interface Implementations

Name	Description
IJsonModel<ContainerGroupData>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<ContainerGroupData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<ContainerGroupData>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<ContainerGroupData>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<ContainerGroupData>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.

Extension Methods

Name	Description
GetAuthorizationRoleDefinition(ArmResource, ResourceIdentifier, CancellationToken)	Gets the role definition identified by `roleDefinitionId` at this resource scope.
GetAuthorizationRoleDefinitionAsync(ArmResource, ResourceIdentifier, CancellationToken)	Gets the role definition identified by `roleDefinitionId` at this resource scope.
GetAuthorizationRoleDefinitions(ArmResource)	Gets a collection of AuthorizationRoleDefinitionCollection objects within the specified scope.
GetDenyAssignment(ArmResource, String, CancellationToken)	Get the specified deny assignment.
GetDenyAssignmentAsync(ArmResource, String, CancellationToken)	Get the specified deny assignment.
GetDenyAssignments(ArmResource)	Gets a collection of DenyAssignmentCollection objects within the specified scope.
GetLinkerResource(ArmResource, String, CancellationToken)	Returns Linker resource for a given name. Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName} Operation Id: Linker_Get Default Api Version: 2022-05-01 Resource: LinkerResource <item>MockingTo mock this method, please mock GetLinkerResource(String, CancellationToken) instead.</item>
GetLinkerResourceAsync(ArmResource, String, CancellationToken)	Returns Linker resource for a given name. Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName} Operation Id: Linker_Get Default Api Version: 2022-05-01 Resource: LinkerResource <item>MockingTo mock this method, please mock GetLinkerResourceAsync(String, CancellationToken) instead.</item>
GetLinkerResources(ArmResource)	Gets a collection of LinkerResources in the ArmResource. <item>MockingTo mock this method, please mock GetLinkerResources() instead.</item>
GetRoleAssignment(ArmResource, String, String, CancellationToken)	Get a role assignment by scope and name.
GetRoleAssignmentAsync(ArmResource, String, String, CancellationToken)	Get a role assignment by scope and name.
GetRoleAssignments(ArmResource)	Gets a collection of RoleAssignmentCollection objects within the specified scope.
GetRoleAssignmentSchedule(ArmResource, String, CancellationToken)	Get the specified role assignment schedule for a resource scope.
GetRoleAssignmentScheduleAsync(ArmResource, String, CancellationToken)	Get the specified role assignment schedule for a resource scope.
GetRoleAssignmentScheduleInstance(ArmResource, String, CancellationToken)	Gets the specified role assignment schedule instance.
GetRoleAssignmentScheduleInstanceAsync(ArmResource, String, CancellationToken)	Gets the specified role assignment schedule instance.
GetRoleAssignmentScheduleInstances(ArmResource)	Gets a collection of RoleAssignmentScheduleInstanceCollection objects within the specified scope.
GetRoleAssignmentScheduleRequest(ArmResource, String, CancellationToken)	Get the specified role assignment schedule request.
GetRoleAssignmentScheduleRequestAsync(ArmResource, String, CancellationToken)	Get the specified role assignment schedule request.
GetRoleAssignmentScheduleRequests(ArmResource)	Gets a collection of RoleAssignmentScheduleRequestCollection objects within the specified scope.
GetRoleAssignmentSchedules(ArmResource)	Gets a collection of RoleAssignmentScheduleCollection objects within the specified scope.
GetRoleEligibilitySchedule(ArmResource, String, CancellationToken)	Get the specified role eligibility schedule for a resource scope.
GetRoleEligibilityScheduleAsync(ArmResource, String, CancellationToken)	Get the specified role eligibility schedule for a resource scope.
GetRoleEligibilityScheduleInstance(ArmResource, String, CancellationToken)	Gets the specified role eligibility schedule instance.
GetRoleEligibilityScheduleInstanceAsync(ArmResource, String, CancellationToken)	Gets the specified role eligibility schedule instance.
GetRoleEligibilityScheduleInstances(ArmResource)	Gets a collection of RoleEligibilityScheduleInstanceCollection objects within the specified scope.
GetRoleEligibilityScheduleRequest(ArmResource, String, CancellationToken)	Get the specified role eligibility schedule request.
GetRoleEligibilityScheduleRequestAsync(ArmResource, String, CancellationToken)	Get the specified role eligibility schedule request.
GetRoleEligibilityScheduleRequests(ArmResource)	Gets a collection of RoleEligibilityScheduleRequestCollection objects within the specified scope.
GetRoleEligibilitySchedules(ArmResource)	Gets a collection of RoleEligibilityScheduleCollection objects within the specified scope.
GetRoleManagementPolicies(ArmResource)	Gets a collection of RoleManagementPolicyCollection objects within the specified scope.
GetRoleManagementPolicy(ArmResource, String, CancellationToken)	Get the specified role management policy for a resource scope.
GetRoleManagementPolicyAssignment(ArmResource, String, CancellationToken)	Get the specified role management policy assignment for a resource scope.
GetRoleManagementPolicyAssignmentAsync(ArmResource, String, CancellationToken)	Get the specified role management policy assignment for a resource scope.
GetRoleManagementPolicyAssignments(ArmResource)	Gets a collection of RoleManagementPolicyAssignmentCollection objects within the specified scope.
GetRoleManagementPolicyAsync(ArmResource, String, CancellationToken)	Get the specified role management policy for a resource scope.
GetSystemAssignedIdentity(ArmResource)	Gets an object representing a SystemAssignedIdentityResource along with the instance operations that can be performed on it in the ArmResource scope.

Applies to

Feedback

Was this page helpful?