@azure/arm-containerinstance package
Interfaces
| ApiEntityReference |
The API entity reference. |
| ApplicationGateway |
Application Gateway the CG profile will use to interact with CGs in a backend pool |
| ApplicationGatewayBackendAddressPool |
NGroups application gateway backend address pool |
| ArmResource |
Common fields that are returned in the response for all Azure Resource Manager resources |
| AzureFileVolume |
The properties of the Azure File volume. Azure File shares are mounted as volumes. |
| CGProfileCreateOrUpdateOptionalParams |
Optional parameters. |
| CGProfileDeleteOptionalParams |
Optional parameters. |
| CGProfileGetByRevisionNumberOptionalParams |
Optional parameters. |
| CGProfileGetOptionalParams |
Optional parameters. |
| CGProfileListAllRevisionsOptionalParams |
Optional parameters. |
| CGProfileOperations |
Interface representing a CGProfile operations. |
| CGProfileUpdateOptionalParams |
Optional parameters. |
| CGProfilesListByResourceGroupOptionalParams |
Optional parameters. |
| CGProfilesListBySubscriptionOptionalParams |
Optional parameters. |
| CGProfilesOperations |
Interface representing a CGProfiles operations. |
| CachedImages |
The cached image and OS type. |
| Capabilities |
The regional capabilities. |
| CapabilitiesCapabilities |
The supported capabilities. |
| CloudError |
An error response from the Container Instance service. |
| CloudErrorBody |
An error response from the Container Instance service. |
| ConfidentialComputeProperties |
The properties for confidential container group |
| ConfigMap |
The container config map. |
| Container |
A container instance. |
| ContainerAttachResponse |
The information for the output stream from container attach. |
| ContainerExec |
The container execution command, for liveness or readiness probe |
| ContainerExecRequest |
The container exec request. |
| ContainerExecRequestTerminalSize |
The size of the terminal. |
| ContainerExecResponse |
The information for the container exec command. |
| ContainerGroup |
A container group. |
| ContainerGroupDiagnostics |
Container group diagnostic information. |
| ContainerGroupIdentity |
Identity for the container group. |
| ContainerGroupProfile |
A container group profile object |
| ContainerGroupProfilePatch |
Properties of container group profile that need to be patched |
| ContainerGroupProfileProperties |
The container group profile properties |
| ContainerGroupProfileReferenceDefinition |
The container group profile reference. |
| ContainerGroupProfileStub |
The object that contains a reference to a Container Group Profile and it's other related properties. |
| ContainerGroupProperties |
The container group properties |
| ContainerGroupPropertiesInstanceView |
The instance view of the container group. Only valid in response. |
| ContainerGroupSubnetId |
Container group subnet information. |
| ContainerGroupsCreateOrUpdateOptionalParams |
Optional parameters. |
| ContainerGroupsDeleteOptionalParams |
Optional parameters. |
| ContainerGroupsGetOptionalParams |
Optional parameters. |
| ContainerGroupsGetOutboundNetworkDependenciesEndpointsOptionalParams |
Optional parameters. |
| ContainerGroupsListByResourceGroupOptionalParams |
Optional parameters. |
| ContainerGroupsListOptionalParams |
Optional parameters. |
| ContainerGroupsOperations |
Interface representing a ContainerGroups operations. |
| ContainerGroupsRestartOptionalParams |
Optional parameters. |
| ContainerGroupsStartOptionalParams |
Optional parameters. |
| ContainerGroupsStopOptionalParams |
Optional parameters. |
| ContainerGroupsUpdateOptionalParams |
Optional parameters. |
| ContainerHttpGet |
The container Http Get settings, for liveness or readiness probe |
| ContainerInstanceManagementClientOptionalParams |
Optional parameters for the client. |
| ContainerPort |
The port exposed on the container instance. |
| ContainerProbe |
The container probe, for liveness or readiness |
| ContainerProperties |
The container instance properties. |
| ContainerPropertiesInstanceView |
The instance view of the container instance. Only valid in response. |
| ContainerState |
The container instance state. |
| ContainersAttachOptionalParams |
Optional parameters. |
| ContainersExecuteCommandOptionalParams |
Optional parameters. |
| ContainersListLogsOptionalParams |
Optional parameters. |
| ContainersOperations |
Interface representing a Containers operations. |
| DeploymentExtensionSpec |
Extension sidecars to be added to the deployment. |
| DeploymentExtensionSpecProperties |
Extension specific properties |
| DnsConfiguration |
DNS configuration for the container group. |
| ElasticProfile |
Describes the elastic profile of the NGroup |
| ElasticProfileContainerGroupNamingPolicy |
Container Groups are named on a generic guid based naming scheme/policy. Customer can modify naming policy to add prefix to CG names during scale out operation. |
| ElasticProfileContainerGroupNamingPolicyGuidNamingPolicy |
model interface ElasticProfileContainerGroupNamingPolicyGuidNamingPolicy |
| EncryptionProperties |
The container group encryption properties. |
| EnvironmentVariable |
The environment variable to set within the container instance. |
| ErrorAdditionalInfo |
The resource management error additional info. |
| ErrorDetail |
The error detail. |
| ErrorResponse |
Common error response for all Azure Resource Manager APIs to return error details for failed operations. |
| Event |
A container group or container instance event. |
| FileShare |
File shares that can be mounted on container groups. |
| FileShareProperties |
model interface FileShareProperties |
| GitRepoVolume |
Represents a volume that is populated with the contents of a git repository |
| GpuResource |
The GPU resource. |
| HttpHeader |
The HTTP header. |
| IdentityAccessControl |
The access control for an identity |
| IdentityAcls |
The access control levels of the identities. |
| ImageRegistryCredential |
Image registry credential. |
| InitContainerDefinition |
The init container definition. |
| InitContainerPropertiesDefinition |
The init container definition properties. |
| InitContainerPropertiesDefinitionInstanceView |
The instance view of the init container. Only valid in response. |
| IpAddress |
IP address for the container group. |
| LoadBalancer |
LoadBalancer the CG profile will use to interact with CGs in a backend pool |
| LoadBalancerBackendAddressPool |
NGroups load balancer backend address pool |
| LocationListCachedImagesOptionalParams |
Optional parameters. |
| LocationListCapabilitiesOptionalParams |
Optional parameters. |
| LocationListUsageOptionalParams |
Optional parameters. |
| LocationOperations |
Interface representing a Location operations. |
| LogAnalytics |
Container group log analytics information. |
| Logs |
The logs. |
| ManagedServiceIdentity |
Managed service identity (system assigned and/or user assigned identities) |
| NGroup |
Describes the NGroups resource. |
| NGroupCGPropertyContainer |
Container properties that can be provided with NGroups object. |
| NGroupCGPropertyContainerProperties |
container properties |
| NGroupCGPropertyVolume |
Contains information about the volumes that can be mounted by Containers in the Container Groups. |
| NGroupContainerGroupProperties |
Container Group properties which can be set while creating or updating the NGroups. |
| NGroupIdentity |
Identity for the NGroup. |
| NGroupPatch |
Describes the NGroups resource. |
| NGroupProperties |
Describes the properties of the NGroups resource. |
| NGroupsCreateOrUpdateOptionalParams |
Optional parameters. |
| NGroupsDeleteOptionalParams |
Optional parameters. |
| NGroupsGetOptionalParams |
Optional parameters. |
| NGroupsListByResourceGroupOptionalParams |
Optional parameters. |
| NGroupsListOptionalParams |
Optional parameters. |
| NGroupsOperations |
Interface representing a NGroups operations. |
| NGroupsRestartOptionalParams |
Optional parameters. |
| NGroupsStartOptionalParams |
Optional parameters. |
| NGroupsStopOptionalParams |
Optional parameters. |
| NGroupsUpdateOptionalParams |
Optional parameters. |
| NetworkProfile |
A network profile for network settings of a ContainerGroupProfile. Used to manage load balancer and application gateway backend pools, specifically updating the IP addresses of CGs within the backend pool. |
| Operation |
An operation for Azure Container Instance service. |
| OperationDisplay |
The display information of the operation. |
| OperationsListOptionalParams |
Optional parameters. |
| OperationsOperations |
Interface representing a Operations operations. |
| PageSettings |
Options for the byPage method |
| PagedAsyncIterableIterator |
An interface that allows async iterable iteration both to completion and by page. |
| PlacementProfile |
Provides options w.r.t allocation and management w.r.t certain placement policies. These utilize capabilities provided by the underlying Azure infrastructure. They are typically used for high availability scenarios. E.g., distributing CGs across fault domains. |
| Port |
The port exposed on the container group. |
| ProxyResource |
The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location |
| Resource |
The Resource model definition. |
| ResourceLimits |
The resource limits. |
| ResourceRequests |
The resource requests. |
| ResourceRequirements |
The resource requirements. |
| RestorePollerOptions | |
| SandboxGroup |
A SandboxGroup tracked resource. |
| SandboxGroupAccessToken |
The result of getting an access token for a SandboxGroup. |
| SandboxGroupNetworkProfile |
The network profile for a SandboxGroup. |
| SandboxGroupProperties |
Properties of a SandboxGroup. |
| SandboxGroupTagsUpdate |
The type used for updating a SandboxGroup resource. |
| SandboxGroupsConnectOptionalParams |
Optional parameters. |
| SandboxGroupsCreateOrUpdateOptionalParams |
Optional parameters. |
| SandboxGroupsDeleteOptionalParams |
Optional parameters. |
| SandboxGroupsGetOptionalParams |
Optional parameters. |
| SandboxGroupsListByResourceGroupOptionalParams |
Optional parameters. |
| SandboxGroupsListBySubscriptionOptionalParams |
Optional parameters. |
| SandboxGroupsOperations |
Interface representing a SandboxGroups operations. |
| SandboxGroupsUpdateOptionalParams |
Optional parameters. |
| SecretReference |
A secret reference |
| SecurityContextCapabilitiesDefinition |
The capabilities to add or drop from a container. |
| SecurityContextDefinition |
The security context for the container. |
| SimplePollerLike |
A simple poller that can be used to poll a long running operation. |
| StandbyPoolProfileDefinition |
The standby pool profile reference. |
| StorageProfile |
Storage profile for storage related settings of a container group profile. |
| SubnetReference |
A reference to a subnet resource. |
| SubnetServiceAssociationLinkDeleteOptionalParams |
Optional parameters. |
| SubnetServiceAssociationLinkOperations |
Interface representing a SubnetServiceAssociationLink operations. |
| SystemData |
Metadata pertaining to creation and last modification of the resource. |
| TrackedResource |
The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location' |
| UpdateProfile |
Used by the customer to specify the way to update the Container Groups in NGroup. |
| UpdateProfileRollingUpdateProfile |
This profile allows the customers to customize the rolling update. |
| Usage |
A single usage result |
| UsageName |
The name object of the resource |
| UserAssignedIdentities |
The list of user identities associated with the container group. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. |
| UserAssignedIdentity |
User assigned identity properties |
| Volume |
The properties of the volume. |
| VolumeMount |
The properties of the volume mount. |
Type Aliases
| AzureFileShareAccessTier |
Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. Learn more at: https://learn.microsoft.com/en-us/rest/api/storagerp/file-shares/create?tabs=HTTP#shareaccesstier |
| AzureFileShareAccessType |
Specifies how Container Groups can access the Azure file share i.e. all CG will share same Azure file share or going to have exclusive file share. |
| AzureSupportedClouds |
The supported values for cloud setting as a string literal type |
| ContainerGroupIpAddressType |
Specifies if the IP is exposed to the public internet or private VNET. Known values supported by the servicePublic: Public |
| ContainerGroupNetworkProtocol |
The protocol associated with the port. Known values supported by the serviceTCP: TCP |
| ContainerGroupPriority |
The priority of the container group. Known values supported by the serviceRegular: Regular |
| ContainerGroupRestartPolicy |
Restart policy for all containers within the container group.
Known values supported by the serviceAlways: Always |
| ContainerGroupSku |
The container group SKU. Known values supported by the serviceNotSpecified: NotSpecified |
| ContainerGroupsGetOutboundNetworkDependenciesEndpointsResponse | |
| ContainerInstanceOperationsOrigin |
The intended executor of the operation. Known values supported by the serviceUser: User |
| ContainerNetworkProtocol |
The protocol associated with the port. Known values supported by the serviceTCP: TCP |
| ContinuablePage |
An interface that describes a page of results. |
| CreatedByType |
The kind of entity that created the resource. Known values supported by the serviceUser: The entity was created by a user. |
| DnsNameLabelReusePolicy |
The value representing the security enum. The 'Unsecure' value is the default value if not selected and means the object's domain name label is not secured against subdomain takeover. The 'TenantReuse' value is the default value if selected and means the object's domain name label can be reused within the same tenant. The 'SubscriptionReuse' value means the object's domain name label can be reused within the same subscription. The 'ResourceGroupReuse' value means the object's domain name label can be reused within the same resource group. The 'NoReuse' value means the object's domain name label cannot be reused within the same resource group, subscription, or tenant. Known values supported by the serviceUnsecure: Unsecure |
| GpuSku |
The SKU of the GPU resource. Known values supported by the serviceK80: K80 |
| IdentityAccessLevel |
The access level of an identity. Known values supported by the serviceAll: All |
| LogAnalyticsLogType |
The log type to be used. Known values supported by the serviceContainerInsights: ContainerInsights |
| ManagedServiceIdentityType |
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). Known values supported by the serviceNone: No managed identity. |
| NGroupProvisioningState |
The provisioning state, which only appears in the response. Known values supported by the serviceCreating: Creating |
| NGroupUpdateMode |
Type of NGroupUpdateMode |
| OperatingSystemTypes |
The operating system type required by the containers in the container group. Known values supported by the serviceWindows: Windows |
| ResourceIdentityType |
The type of identity used for the container group. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the container group. |
| SandboxGroupProvisioningState |
The provisioning state of a SandboxGroup resource. Known values supported by the serviceSucceeded: Resource has been created. |
| Scheme |
The scheme. Known values supported by the servicehttp: http |
Enums
| AzureClouds |
An enum to describe Azure Cloud environments. |
| KnownContainerGroupIpAddressType |
Specifies if the IP is exposed to the public internet or private VNET. |
| KnownContainerGroupNetworkProtocol |
The protocol associated with the port. |
| KnownContainerGroupPriority |
The priority of the container group. |
| KnownContainerGroupRestartPolicy |
Restart policy for all containers within the container group.
|
| KnownContainerGroupSku |
The container group SKU. |
| KnownContainerInstanceOperationsOrigin |
The intended executor of the operation. |
| KnownContainerNetworkProtocol |
The protocol associated with the port. |
| KnownCreatedByType |
The kind of entity that created the resource. |
| KnownDnsNameLabelReusePolicy |
The value representing the security enum. The 'Unsecure' value is the default value if not selected and means the object's domain name label is not secured against subdomain takeover. The 'TenantReuse' value is the default value if selected and means the object's domain name label can be reused within the same tenant. The 'SubscriptionReuse' value means the object's domain name label can be reused within the same subscription. The 'ResourceGroupReuse' value means the object's domain name label can be reused within the same resource group. The 'NoReuse' value means the object's domain name label cannot be reused within the same resource group, subscription, or tenant. |
| KnownGpuSku |
The SKU of the GPU resource. |
| KnownIdentityAccessLevel |
The access level of an identity. |
| KnownLogAnalyticsLogType |
The log type to be used. |
| KnownManagedServiceIdentityType |
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). |
| KnownNGroupProvisioningState |
The provisioning state, which only appears in the response. |
| KnownNGroupUpdateMode |
Known values of NGroupUpdateMode that the service accepts. |
| KnownOperatingSystemTypes |
The operating system type required by the containers in the container group. |
| KnownSandboxGroupProvisioningState |
The provisioning state of a SandboxGroup resource. |
| KnownScheme |
The scheme. |
| KnownVersions |
The available API versions. |
Functions
| is |
Typeguard for RestError |
| restore |
Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope. |
Variables
| Rest |
A custom error type for failed pipeline requests. |
Function Details
isRestError(unknown)
Typeguard for RestError
function isRestError(e: unknown): e is RestError
Parameters
- e
-
unknown
Something caught by a catch clause.
Returns
e is RestError
restorePoller<TResponse, TResult>(ContainerInstanceManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.
function restorePoller<TResponse, TResult>(client: ContainerInstanceManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>
Parameters
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
Returns
PollerLike<OperationState<TResult>, TResult>
Variable Details
RestError
A custom error type for failed pipeline requests.
RestError: RestErrorConstructor