ContainerGroupResource Class
Definition
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 GetContainerGroupResource method. Otherwise you can get one from its parent resource ResourceGroupResource using the GetContainerGroup 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
- Implements
Constructors
ContainerGroupResource() |
Initializes a new instance of the ContainerGroupResource class for mocking. |
Fields
ResourceType |
Gets the resource type for the operations. |
Properties
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
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.
|
AttachContainerAsync(String, CancellationToken) |
Attach to the output stream of a specific container instance in a specified resource group and container group.
|
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 of a ContainerGroupResource instance. |
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.
|
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.
|
ExecuteContainerCommand(String, ContainerExecContent, CancellationToken) |
Executes a command for a specific container instance in a specified resource group and container group.
|
ExecuteContainerCommandAsync(String, ContainerExecContent, CancellationToken) |
Executes a command for a specific container instance in a specified resource group and container group.
|
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.
|
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.
|
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.
|
GetContainerLogsAsync(String, Nullable<Int32>, Nullable<Boolean>, CancellationToken) |
Get the logs for a specified container instance in a specified resource group and container group.
|
GetManagementLock(String, CancellationToken) |
Get a management lock by scope.
|
GetManagementLockAsync(String, CancellationToken) |
Get a management lock by scope.
|
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.
|
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.
|
GetPolicyAssignment(String, CancellationToken) |
This operation retrieves a single policy assignment, given its name and the scope it was created at.
|
GetPolicyAssignmentAsync(String, CancellationToken) |
This operation retrieves a single policy assignment, given its name and the scope it was created at.
|
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.
|
RestartAsync(WaitUntil, CancellationToken) |
Restarts all containers in a container group in place. If container image has updates, new image will be downloaded.
|
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.
|
StartAsync(WaitUntil, CancellationToken) |
Starts all containers in a container group. Compute resources will be allocated and billing will start.
|
Stop(CancellationToken) |
Stops all containers in a container group. Compute resources will be deallocated and billing will stop.
|
StopAsync(CancellationToken) |
Stops all containers in a container group. Compute resources will be deallocated and billing will stop.
|
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.
|
UpdateAsync(ContainerGroupPatch, CancellationToken) |
Updates container group tags with specified values.
|
Explicit Interface Implementations
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
GetAuthorizationRoleDefinition(ArmResource, ResourceIdentifier, CancellationToken) |
Get role definition by name (GUID).
|
GetAuthorizationRoleDefinitionAsync(ArmResource, ResourceIdentifier, CancellationToken) |
Get role definition by name (GUID).
|
GetAuthorizationRoleDefinitions(ArmResource) |
Gets a collection of AuthorizationRoleDefinitionResources in the ArmResource. MockingTo mock this method, please mock GetAuthorizationRoleDefinitions() instead. |
GetDenyAssignment(ArmResource, String, CancellationToken) |
Get the specified deny assignment.
|
GetDenyAssignmentAsync(ArmResource, String, CancellationToken) |
Get the specified deny assignment.
|
GetDenyAssignments(ArmResource) |
Gets a collection of DenyAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetDenyAssignments() instead. |
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 RoleAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignments() instead. |
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 RoleAssignmentScheduleInstanceResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentScheduleInstances() instead. |
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 RoleAssignmentScheduleRequestResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentScheduleRequests() instead. |
GetRoleAssignmentSchedules(ArmResource) |
Gets a collection of RoleAssignmentScheduleResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentSchedules() instead. |
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 RoleEligibilityScheduleInstanceResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilityScheduleInstances() instead. |
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 RoleEligibilityScheduleRequestResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilityScheduleRequests() instead. |
GetRoleEligibilitySchedules(ArmResource) |
Gets a collection of RoleEligibilityScheduleResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilitySchedules() instead. |
GetRoleManagementPolicies(ArmResource) |
Gets a collection of RoleManagementPolicyResources in the ArmResource. MockingTo mock this method, please mock GetRoleManagementPolicies() instead. |
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 RoleManagementPolicyAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetRoleManagementPolicyAssignments() instead. |
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. MockingTo mock this method, please mock GetSystemAssignedIdentity() instead. |
GetLinkerResource(ArmResource, String, CancellationToken) |
Returns Linker resource for a given name.
|
GetLinkerResourceAsync(ArmResource, String, CancellationToken) |
Returns Linker resource for a given name.
|
GetLinkerResources(ArmResource) |
Gets a collection of LinkerResources in the ArmResource. MockingTo mock this method, please mock GetLinkerResources() instead. |