@azure/arm-containerinstance package
Classes
ContainerInstanceManagementClient |
Interfaces
AzureFileVolume |
The properties of the Azure File volume. Azure File shares are mounted as volumes. |
CachedImages |
The cached image and OS type. |
CachedImagesListResult |
The response containing cached images. |
Capabilities |
The regional capabilities. |
CapabilitiesCapabilities |
The supported capabilities. |
CapabilitiesListResult |
The response containing list of 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 |
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. |
ContainerGroupListResult |
The container group list response that contains the container group properties. |
ContainerGroupProperties |
The container group properties |
ContainerGroupPropertiesInstanceView |
The instance view of the container group. Only valid in response. |
ContainerGroupSubnetId |
Container group subnet information. |
ContainerGroups |
Interface representing a ContainerGroups. |
ContainerGroupsCreateOrUpdateOptionalParams |
Optional parameters. |
ContainerGroupsDeleteOptionalParams |
Optional parameters. |
ContainerGroupsGetOptionalParams |
Optional parameters. |
ContainerGroupsGetOutboundNetworkDependenciesEndpointsOptionalParams |
Optional parameters. |
ContainerGroupsListByResourceGroupNextOptionalParams |
Optional parameters. |
ContainerGroupsListByResourceGroupOptionalParams |
Optional parameters. |
ContainerGroupsListNextOptionalParams |
Optional parameters. |
ContainerGroupsListOptionalParams |
Optional parameters. |
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. |
ContainerPort |
The port exposed on the container instance. |
ContainerProbe |
The container probe, for liveness or readiness |
ContainerPropertiesInstanceView |
The instance view of the container instance. Only valid in response. |
ContainerState |
The container instance state. |
Containers |
Interface representing a Containers. |
ContainersAttachOptionalParams |
Optional parameters. |
ContainersExecuteCommandOptionalParams |
Optional parameters. |
ContainersListLogsOptionalParams |
Optional parameters. |
DeploymentExtensionSpec |
Extension sidecars to be added to the deployment. |
DnsConfiguration |
DNS configuration for the container group. |
EncryptionProperties |
The container group encryption properties. |
EnvironmentVariable |
The environment variable to set within the container instance. |
Event |
A container group or container instance event. |
GitRepoVolume |
Represents a volume that is populated with the contents of a git repository |
GpuResource |
The GPU resource. |
HttpHeader |
The HTTP header. |
ImageRegistryCredential |
Image registry credential. |
InitContainerDefinition |
The init container definition. |
InitContainerPropertiesDefinitionInstanceView |
The instance view of the init container. Only valid in response. |
IpAddress |
IP address for the container group. |
Location |
Interface representing a Location. |
LocationListCachedImagesNextOptionalParams |
Optional parameters. |
LocationListCachedImagesOptionalParams |
Optional parameters. |
LocationListCapabilitiesNextOptionalParams |
Optional parameters. |
LocationListCapabilitiesOptionalParams |
Optional parameters. |
LocationListUsageOptionalParams |
Optional parameters. |
LogAnalytics |
Container group log analytics information. |
Logs |
The logs. |
Operation |
An operation for Azure Container Instance service. |
OperationDisplay |
The display information of the operation. |
OperationListResult |
The operation list response that contains all operations for Azure Container Instance service. |
Operations |
Interface representing a Operations. |
OperationsListNextOptionalParams |
Optional parameters. |
OperationsListOptionalParams |
Optional parameters. |
Port |
The port exposed on the container group. |
Resource |
The Resource model definition. |
ResourceLimits |
The resource limits. |
ResourceRequests |
The resource requests. |
ResourceRequirements |
The resource requirements. |
SecurityContextCapabilitiesDefinition |
The capabilities to add or drop from a container. |
SecurityContextDefinition |
The security context for the container. |
SubnetServiceAssociationLink |
Interface representing a SubnetServiceAssociationLink. |
SubnetServiceAssociationLinkDeleteOptionalParams |
Optional parameters. |
Usage |
A single usage result |
UsageListResult |
The response containing the usage data |
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}'. |
Volume |
The properties of the volume. |
VolumeMount |
The properties of the volume mount. |
Type Aliases
ContainerGroupIpAddressType |
Defines values for ContainerGroupIpAddressType. Known values supported by the servicePublic |
ContainerGroupNetworkProtocol |
Defines values for ContainerGroupNetworkProtocol. Known values supported by the serviceTCP |
ContainerGroupPriority |
Defines values for ContainerGroupPriority. Known values supported by the serviceRegular |
ContainerGroupRestartPolicy |
Defines values for ContainerGroupRestartPolicy. Known values supported by the serviceAlways |
ContainerGroupSku |
Defines values for ContainerGroupSku. Known values supported by the serviceStandard |
ContainerGroupsCreateOrUpdateResponse |
Contains response data for the createOrUpdate operation. |
ContainerGroupsDeleteResponse |
Contains response data for the delete operation. |
ContainerGroupsGetOutboundNetworkDependenciesEndpointsResponse |
Contains response data for the getOutboundNetworkDependenciesEndpoints operation. |
ContainerGroupsGetResponse |
Contains response data for the get operation. |
ContainerGroupsListByResourceGroupNextResponse |
Contains response data for the listByResourceGroupNext operation. |
ContainerGroupsListByResourceGroupResponse |
Contains response data for the listByResourceGroup operation. |
ContainerGroupsListNextResponse |
Contains response data for the listNext operation. |
ContainerGroupsListResponse |
Contains response data for the list operation. |
ContainerGroupsUpdateResponse |
Contains response data for the update operation. |
ContainerInstanceOperationsOrigin |
Defines values for ContainerInstanceOperationsOrigin. Known values supported by the serviceUser |
ContainerNetworkProtocol |
Defines values for ContainerNetworkProtocol. Known values supported by the serviceTCP |
ContainersAttachResponse |
Contains response data for the attach operation. |
ContainersExecuteCommandResponse |
Contains response data for the executeCommand operation. |
ContainersListLogsResponse |
Contains response data for the listLogs operation. |
DnsNameLabelReusePolicy |
Defines values for DnsNameLabelReusePolicy. Known values supported by the serviceUnsecure |
GpuSku |
Defines values for GpuSku. Known values supported by the serviceK80 |
LocationListCachedImagesNextResponse |
Contains response data for the listCachedImagesNext operation. |
LocationListCachedImagesResponse |
Contains response data for the listCachedImages operation. |
LocationListCapabilitiesNextResponse |
Contains response data for the listCapabilitiesNext operation. |
LocationListCapabilitiesResponse |
Contains response data for the listCapabilities operation. |
LocationListUsageResponse |
Contains response data for the listUsage operation. |
LogAnalyticsLogType |
Defines values for LogAnalyticsLogType. Known values supported by the serviceContainerInsights |
OperatingSystemTypes |
Defines values for OperatingSystemTypes. Known values supported by the serviceWindows |
OperationsListNextResponse |
Contains response data for the listNext operation. |
OperationsListResponse |
Contains response data for the list operation. |
ResourceIdentityType |
Defines values for ResourceIdentityType. |
Scheme |
Defines values for Scheme. Known values supported by the servicehttp |
Enums
Functions
get |
Given the last |
Function Details
getContinuationToken(unknown)
Given the last .value
produced by the byPage
iterator,
returns a continuation token that can be used to begin paging from
that point later.
function getContinuationToken(page: unknown): string | undefined
Parameters
- page
-
unknown
An object from accessing value
on the IteratorResult from a byPage
iterator.
Returns
string | undefined
The continuation token that can be passed into byPage() during future calls.