mirror of
https://github.com/hanzoai/azure-sdk-for-js.git
synced 2026-10-30 19:51:51 +00:00
4201b08be2
Configurations: 'specification/containerinstance/resource-manager/Microsoft.ContainerInstance/ContainerInstance/tspconfig.yaml', API Version: 2026-06-01-preview, SDK Release Type: beta, and CommitSHA: '1b4778de3e8c7709823e0f95bbd8c29bedeb5bdb' in SpecRepo: 'https://github.com/Azure/azure-rest-api-specs' Pipeline run: https://dev.azure.com/azure-sdk/internal/_build/results?buildId=6410514 Refer to https://eng.ms/docs/products/azure-developer-experience/develop/sdk-release/sdk-release-prerequisites to prepare for SDK release. ### Packages impacted by this PR `@azure/arm-containerinstance` ### Issues associated with this PR ### Describe the problem that is addressed by this PR Auto-generated SDK update for `@azure/arm-containerinstance` from TypeSpec/emitter, targeting API version `2026-06-01-preview` (beta release). The branch has been updated with the latest changes from the `main` branch. ### What are the possible designs available to address the problem? If there are more than one possible design, why was the one in this PR chosen? Auto-generated via SDK generation pipeline (build ID: 6410514). ### Are there test cases added in this PR? _(If not, why?)_ No. This is an auto-generated SDK PR. ### Provide a list of related PRs _(if any)_ ### Command used to generate this PR:**_(Applicable only to SDK release request PRs)_ Pipeline run: https://dev.azure.com/azure-sdk/internal/_build/results?buildId=6410514 ### Checklists - [ ] Added impacted package name to the issue description - [ ] Does this PR needs any fixes in the SDK Generator?** _(If so, create an Issue in the [Autorest/typescript](https://github.com/Azure/autorest.typescript) repository and link it here)_ - [ ] Added a changelog (if necessary) --------- Co-authored-by: Jiao Di (MSFT) <[email protected]> Co-authored-by: copilot-swe-agent[bot] <[email protected]> Co-authored-by: jeremymeng <[email protected]> Co-authored-by: Jeremy Meng <[email protected]>
44 KiB
44 KiB
API Report File for "@azure/arm-containerinstance"
Do not edit this file. It is a report generated by API Extractor.
import type { AbortSignalLike } from '@azure/abort-controller';
import type { CancelOnProgress } from '@azure/core-lro';
import type { ClientOptions } from '@azure-rest/core-client';
import { isRestError } from '@azure/core-rest-pipeline';
import type { OperationOptions } from '@azure-rest/core-client';
import type { OperationState } from '@azure/core-lro';
import type { PathUncheckedResponse } from '@azure-rest/core-client';
import type { Pipeline } from '@azure/core-rest-pipeline';
import type { PollerLike } from '@azure/core-lro';
import { RestError } from '@azure/core-rest-pipeline';
import type { TokenCredential } from '@azure/core-auth';
// @public
export interface ApiEntityReference {
id?: string;
}
// @public
export interface ApplicationGateway {
backendAddressPools?: ApplicationGatewayBackendAddressPool[];
resource?: string;
}
// @public
export interface ApplicationGatewayBackendAddressPool {
resource?: string;
}
// @public
export interface ArmResource {
readonly id?: string;
readonly name?: string;
readonly systemData?: SystemData;
readonly type?: string;
}
// @public
export enum AzureClouds {
AZURE_CHINA_CLOUD = "AZURE_CHINA_CLOUD",
AZURE_PUBLIC_CLOUD = "AZURE_PUBLIC_CLOUD",
AZURE_US_GOVERNMENT = "AZURE_US_GOVERNMENT"
}
// @public
export type AzureFileShareAccessTier = "Cool" | "Hot" | "Premium" | "TransactionOptimized";
// @public
export type AzureFileShareAccessType = "Shared" | "Exclusive";
// @public
export interface AzureFileVolume {
readOnly?: boolean;
shareName: string;
storageAccountKey?: string;
storageAccountKeyReference?: string;
storageAccountName: string;
}
// @public
export type AzureSupportedClouds = `${AzureClouds}`;
// @public
export interface CachedImages {
image: string;
osType: string;
}
// @public
export interface Capabilities {
readonly capabilities?: CapabilitiesCapabilities;
readonly gpu?: string;
readonly ipAddressType?: string;
readonly location?: string;
readonly osType?: string;
readonly resourceType?: string;
}
// @public
export interface CapabilitiesCapabilities {
readonly maxCpu?: number;
readonly maxGpuCount?: number;
readonly maxMemoryInGB?: number;
}
// @public
export interface CGProfileCreateOrUpdateOptionalParams extends OperationOptions {
}
// @public
export interface CGProfileDeleteOptionalParams extends OperationOptions {
}
// @public
export interface CGProfileGetByRevisionNumberOptionalParams extends OperationOptions {
}
// @public
export interface CGProfileGetOptionalParams extends OperationOptions {
}
// @public
export interface CGProfileListAllRevisionsOptionalParams extends OperationOptions {
}
// @public
export interface CGProfileOperations {
createOrUpdate: (resourceGroupName: string, containerGroupProfileName: string, containerGroupProfile: ContainerGroupProfile, options?: CGProfileCreateOrUpdateOptionalParams) => Promise<ContainerGroupProfile>;
delete: (resourceGroupName: string, containerGroupProfileName: string, options?: CGProfileDeleteOptionalParams) => Promise<void>;
get: (resourceGroupName: string, containerGroupProfileName: string, options?: CGProfileGetOptionalParams) => Promise<ContainerGroupProfile>;
getByRevisionNumber: (resourceGroupName: string, containerGroupProfileName: string, revisionNumber: string, options?: CGProfileGetByRevisionNumberOptionalParams) => Promise<ContainerGroupProfile>;
listAllRevisions: (resourceGroupName: string, containerGroupProfileName: string, options?: CGProfileListAllRevisionsOptionalParams) => PagedAsyncIterableIterator<ContainerGroupProfile>;
update: (resourceGroupName: string, containerGroupProfileName: string, properties: ContainerGroupProfilePatch, options?: CGProfileUpdateOptionalParams) => Promise<ContainerGroupProfile>;
}
// @public
export interface CGProfilesListByResourceGroupOptionalParams extends OperationOptions {
}
// @public
export interface CGProfilesListBySubscriptionOptionalParams extends OperationOptions {
}
// @public
export interface CGProfilesOperations {
listByResourceGroup: (resourceGroupName: string, options?: CGProfilesListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<ContainerGroupProfile>;
listBySubscription: (options?: CGProfilesListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<ContainerGroupProfile>;
}
// @public
export interface CGProfileUpdateOptionalParams extends OperationOptions {
}
// @public
export interface CloudError {
error?: CloudErrorBody;
}
// @public
export interface CloudErrorBody {
code?: string;
details?: CloudErrorBody[];
message?: string;
target?: string;
}
// @public
export interface ConfidentialComputeProperties {
ccePolicy?: string;
}
// @public
export interface ConfigMap {
keyValuePairs?: Record<string, string>;
}
// @public
export interface Container {
command?: string[];
configMap?: ConfigMap;
environmentVariables?: EnvironmentVariable[];
image?: string;
readonly instanceView?: ContainerPropertiesInstanceView;
livenessProbe?: ContainerProbe;
name: string;
ports?: ContainerPort[];
readinessProbe?: ContainerProbe;
resources?: ResourceRequirements;
securityContext?: SecurityContextDefinition;
volumeMounts?: VolumeMount[];
}
// @public
export interface ContainerAttachResponse {
password?: string;
webSocketUri?: string;
}
// @public
export interface ContainerExec {
command?: string[];
}
// @public
export interface ContainerExecRequest {
command?: string;
terminalSize?: ContainerExecRequestTerminalSize;
}
// @public
export interface ContainerExecRequestTerminalSize {
cols?: number;
rows?: number;
}
// @public
export interface ContainerExecResponse {
password?: string;
webSocketUri?: string;
}
// @public
export interface ContainerGroup extends ProxyResource {
confidentialComputeProperties?: ConfidentialComputeProperties;
containerGroupProfile?: ContainerGroupProfileReferenceDefinition;
containers: Container[];
diagnostics?: ContainerGroupDiagnostics;
dnsConfig?: DnsConfiguration;
encryptionProperties?: EncryptionProperties;
extensions?: DeploymentExtensionSpec[];
identity?: ContainerGroupIdentity;
identityAcls?: IdentityAcls;
imageRegistryCredentials?: ImageRegistryCredential[];
initContainers?: InitContainerDefinition[];
readonly instanceView?: ContainerGroupPropertiesInstanceView;
ipAddress?: IpAddress;
readonly isCreatedFromStandbyPool?: boolean;
location?: string;
osType?: OperatingSystemTypes;
priority?: ContainerGroupPriority;
readonly provisioningState?: string;
restartPolicy?: ContainerGroupRestartPolicy;
secretReferences?: SecretReference[];
sku?: ContainerGroupSku;
standbyPoolProfile?: StandbyPoolProfileDefinition;
subnetIds?: ContainerGroupSubnetId[];
tags?: Record<string, string>;
volumes?: Volume[];
zones?: string[];
}
// @public
export interface ContainerGroupDiagnostics {
logAnalytics?: LogAnalytics;
}
// @public
export interface ContainerGroupIdentity {
readonly principalId?: string;
readonly tenantId?: string;
type?: ResourceIdentityType;
userAssignedIdentities?: Record<string, UserAssignedIdentities>;
}
// @public
export type ContainerGroupIpAddressType = string;
// @public
export type ContainerGroupNetworkProtocol = string;
// @public
export type ContainerGroupPriority = string;
// @public
export interface ContainerGroupProfile extends ProxyResource {
confidentialComputeProperties?: ConfidentialComputeProperties;
containers?: Container[];
diagnostics?: ContainerGroupDiagnostics;
encryptionProperties?: EncryptionProperties;
extensions?: DeploymentExtensionSpec[];
imageRegistryCredentials?: ImageRegistryCredential[];
initContainers?: InitContainerDefinition[];
ipAddress?: IpAddress;
location?: string;
osType?: OperatingSystemTypes;
priority?: ContainerGroupPriority;
readonly registeredRevisions?: number[];
restartPolicy?: ContainerGroupRestartPolicy;
readonly revision?: number;
securityContext?: SecurityContextDefinition;
shutdownGracePeriod?: Date;
sku?: ContainerGroupSku;
tags?: Record<string, string>;
timeToLive?: Date;
useKrypton?: boolean;
volumes?: Volume[];
zones?: string[];
}
// @public
export interface ContainerGroupProfilePatch {
tags?: Record<string, string>;
}
// @public
export interface ContainerGroupProfileProperties {
confidentialComputeProperties?: ConfidentialComputeProperties;
containers: Container[];
diagnostics?: ContainerGroupDiagnostics;
encryptionProperties?: EncryptionProperties;
extensions?: DeploymentExtensionSpec[];
imageRegistryCredentials?: ImageRegistryCredential[];
initContainers?: InitContainerDefinition[];
ipAddress?: IpAddress;
osType: OperatingSystemTypes;
priority?: ContainerGroupPriority;
readonly registeredRevisions?: number[];
restartPolicy?: ContainerGroupRestartPolicy;
readonly revision?: number;
securityContext?: SecurityContextDefinition;
shutdownGracePeriod?: Date;
sku?: ContainerGroupSku;
timeToLive?: Date;
useKrypton?: boolean;
volumes?: Volume[];
}
// @public
export interface ContainerGroupProfileReferenceDefinition {
id?: string;
revision?: number;
}
// @public
export interface ContainerGroupProfileStub {
containerGroupProperties?: NGroupContainerGroupProperties;
networkProfile?: NetworkProfile;
resource?: ApiEntityReference;
revision?: number;
storageProfile?: StorageProfile;
}
// @public
export interface ContainerGroupProperties {
confidentialComputeProperties?: ConfidentialComputeProperties;
containerGroupProfile?: ContainerGroupProfileReferenceDefinition;
containers: Container[];
diagnostics?: ContainerGroupDiagnostics;
dnsConfig?: DnsConfiguration;
encryptionProperties?: EncryptionProperties;
extensions?: DeploymentExtensionSpec[];
identityAcls?: IdentityAcls;
imageRegistryCredentials?: ImageRegistryCredential[];
initContainers?: InitContainerDefinition[];
readonly instanceView?: ContainerGroupPropertiesInstanceView;
ipAddress?: IpAddress;
readonly isCreatedFromStandbyPool?: boolean;
osType?: OperatingSystemTypes;
priority?: ContainerGroupPriority;
readonly provisioningState?: string;
restartPolicy?: ContainerGroupRestartPolicy;
secretReferences?: SecretReference[];
sku?: ContainerGroupSku;
standbyPoolProfile?: StandbyPoolProfileDefinition;
subnetIds?: ContainerGroupSubnetId[];
volumes?: Volume[];
}
// @public
export interface ContainerGroupPropertiesInstanceView {
readonly events?: Event_2[];
readonly state?: string;
}
// @public
export type ContainerGroupRestartPolicy = string;
// @public
export interface ContainerGroupsCreateOrUpdateOptionalParams extends OperationOptions {
updateIntervalInMs?: number;
}
// @public
export interface ContainerGroupsDeleteOptionalParams extends OperationOptions {
updateIntervalInMs?: number;
}
// @public
export interface ContainerGroupsGetOptionalParams extends OperationOptions {
}
// @public
export interface ContainerGroupsGetOutboundNetworkDependenciesEndpointsOptionalParams extends OperationOptions {
}
// @public (undocumented)
export type ContainerGroupsGetOutboundNetworkDependenciesEndpointsResponse = {
body: string[];
};
// @public
export type ContainerGroupSku = string;
// @public
export interface ContainerGroupsListByResourceGroupOptionalParams extends OperationOptions {
}
// @public
export interface ContainerGroupsListOptionalParams extends OperationOptions {
}
// @public
export interface ContainerGroupsOperations {
// @deprecated (undocumented)
beginCreateOrUpdate: (resourceGroupName: string, containerGroupName: string, containerGroup: ContainerGroup, options?: ContainerGroupsCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<ContainerGroup>, ContainerGroup>>;
// @deprecated (undocumented)
beginCreateOrUpdateAndWait: (resourceGroupName: string, containerGroupName: string, containerGroup: ContainerGroup, options?: ContainerGroupsCreateOrUpdateOptionalParams) => Promise<ContainerGroup>;
// @deprecated (undocumented)
beginDelete: (resourceGroupName: string, containerGroupName: string, options?: ContainerGroupsDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<ContainerGroup>, ContainerGroup>>;
// @deprecated (undocumented)
beginDeleteAndWait: (resourceGroupName: string, containerGroupName: string, options?: ContainerGroupsDeleteOptionalParams) => Promise<ContainerGroup>;
// @deprecated (undocumented)
beginRestart: (resourceGroupName: string, containerGroupName: string, options?: ContainerGroupsRestartOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>;
// @deprecated (undocumented)
beginRestartAndWait: (resourceGroupName: string, containerGroupName: string, options?: ContainerGroupsRestartOptionalParams) => Promise<void>;
// @deprecated (undocumented)
beginStart: (resourceGroupName: string, containerGroupName: string, options?: ContainerGroupsStartOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>;
// @deprecated (undocumented)
beginStartAndWait: (resourceGroupName: string, containerGroupName: string, options?: ContainerGroupsStartOptionalParams) => Promise<void>;
createOrUpdate: (resourceGroupName: string, containerGroupName: string, containerGroup: ContainerGroup, options?: ContainerGroupsCreateOrUpdateOptionalParams) => PollerLike<OperationState<ContainerGroup>, ContainerGroup>;
delete: (resourceGroupName: string, containerGroupName: string, options?: ContainerGroupsDeleteOptionalParams) => PollerLike<OperationState<ContainerGroup>, ContainerGroup>;
get: (resourceGroupName: string, containerGroupName: string, options?: ContainerGroupsGetOptionalParams) => Promise<ContainerGroup>;
getOutboundNetworkDependenciesEndpoints: (resourceGroupName: string, containerGroupName: string, options?: ContainerGroupsGetOutboundNetworkDependenciesEndpointsOptionalParams) => Promise<ContainerGroupsGetOutboundNetworkDependenciesEndpointsResponse>;
list: (options?: ContainerGroupsListOptionalParams) => PagedAsyncIterableIterator<ContainerGroup>;
listByResourceGroup: (resourceGroupName: string, options?: ContainerGroupsListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<ContainerGroup>;
restart: (resourceGroupName: string, containerGroupName: string, options?: ContainerGroupsRestartOptionalParams) => PollerLike<OperationState<void>, void>;
start: (resourceGroupName: string, containerGroupName: string, options?: ContainerGroupsStartOptionalParams) => PollerLike<OperationState<void>, void>;
stop: (resourceGroupName: string, containerGroupName: string, options?: ContainerGroupsStopOptionalParams) => Promise<void>;
update: (resourceGroupName: string, containerGroupName: string, resource: Resource, options?: ContainerGroupsUpdateOptionalParams) => Promise<ContainerGroup>;
}
// @public
export interface ContainerGroupsRestartOptionalParams extends OperationOptions {
updateIntervalInMs?: number;
}
// @public
export interface ContainerGroupsStartOptionalParams extends OperationOptions {
updateIntervalInMs?: number;
}
// @public
export interface ContainerGroupsStopOptionalParams extends OperationOptions {
}
// @public
export interface ContainerGroupSubnetId {
id: string;
name?: string;
}
// @public
export interface ContainerGroupsUpdateOptionalParams extends OperationOptions {
}
// @public
export interface ContainerHttpGet {
httpHeaders?: HttpHeader[];
path?: string;
port: number;
scheme?: Scheme;
}
// @public (undocumented)
export class ContainerInstanceManagementClient {
constructor(credential: TokenCredential, options?: ContainerInstanceManagementClientOptionalParams);
constructor(credential: TokenCredential, subscriptionId: string, options?: ContainerInstanceManagementClientOptionalParams);
readonly cgProfile: CGProfileOperations;
readonly cgProfiles: CGProfilesOperations;
readonly containerGroups: ContainerGroupsOperations;
readonly containers: ContainersOperations;
readonly location: LocationOperations;
readonly nGroups: NGroupsOperations;
readonly operations: OperationsOperations;
readonly pipeline: Pipeline;
readonly sandboxGroups: SandboxGroupsOperations;
readonly subnetServiceAssociationLink: SubnetServiceAssociationLinkOperations;
}
// @public
export interface ContainerInstanceManagementClientOptionalParams extends ClientOptions {
apiVersion?: string;
cloudSetting?: AzureSupportedClouds;
}
// @public
export type ContainerInstanceOperationsOrigin = string;
// @public
export type ContainerNetworkProtocol = string;
// @public
export interface ContainerPort {
port: number;
protocol?: ContainerNetworkProtocol;
}
// @public
export interface ContainerProbe {
exec?: ContainerExec;
failureThreshold?: number;
httpGet?: ContainerHttpGet;
initialDelaySeconds?: number;
periodSeconds?: number;
successThreshold?: number;
timeoutSeconds?: number;
}
// @public
export interface ContainerProperties {
command?: string[];
configMap?: ConfigMap;
environmentVariables?: EnvironmentVariable[];
image?: string;
readonly instanceView?: ContainerPropertiesInstanceView;
livenessProbe?: ContainerProbe;
ports?: ContainerPort[];
readinessProbe?: ContainerProbe;
resources?: ResourceRequirements;
securityContext?: SecurityContextDefinition;
volumeMounts?: VolumeMount[];
}
// @public
export interface ContainerPropertiesInstanceView {
readonly currentState?: ContainerState;
readonly events?: Event_2[];
readonly previousState?: ContainerState;
readonly restartCount?: number;
}
// @public
export interface ContainersAttachOptionalParams extends OperationOptions {
}
// @public
export interface ContainersExecuteCommandOptionalParams extends OperationOptions {
}
// @public
export interface ContainersListLogsOptionalParams extends OperationOptions {
tail?: number;
timestamps?: boolean;
}
// @public
export interface ContainersOperations {
attach: (resourceGroupName: string, containerGroupName: string, containerName: string, options?: ContainersAttachOptionalParams) => Promise<ContainerAttachResponse>;
executeCommand: (resourceGroupName: string, containerGroupName: string, containerName: string, containerExecRequest: ContainerExecRequest, options?: ContainersExecuteCommandOptionalParams) => Promise<ContainerExecResponse>;
listLogs: (resourceGroupName: string, containerGroupName: string, containerName: string, options?: ContainersListLogsOptionalParams) => Promise<Logs>;
}
// @public
export interface ContainerState {
readonly detailStatus?: string;
readonly exitCode?: number;
readonly finishTime?: Date;
readonly startTime?: Date;
readonly state?: string;
}
// @public
export type ContinuablePage<TElement, TPage = TElement[]> = TPage & {
continuationToken?: string;
};
// @public
export type CreatedByType = string;
// @public
export interface DeploymentExtensionSpec {
extensionType?: string;
name: string;
protectedSettings?: any;
settings?: any;
version?: string;
}
// @public
export interface DeploymentExtensionSpecProperties {
extensionType: string;
protectedSettings?: any;
settings?: any;
version: string;
}
// @public
export interface DnsConfiguration {
nameServers: string[];
options?: string;
searchDomains?: string;
}
// @public
export type DnsNameLabelReusePolicy = string;
// @public
export interface ElasticProfile {
containerGroupNamingPolicy?: ElasticProfileContainerGroupNamingPolicy;
// (undocumented)
desiredCount?: number;
maintainDesiredCount?: boolean;
}
// @public
export interface ElasticProfileContainerGroupNamingPolicy {
// (undocumented)
guidNamingPolicy?: ElasticProfileContainerGroupNamingPolicyGuidNamingPolicy;
}
// @public
export interface ElasticProfileContainerGroupNamingPolicyGuidNamingPolicy {
prefix?: string;
}
// @public
export interface EncryptionProperties {
identity?: string;
keyName: string;
keyVersion: string;
vaultBaseUrl: string;
}
// @public
export interface EnvironmentVariable {
name: string;
secureValue?: string;
secureValueReference?: string;
value?: string;
}
// @public
export interface ErrorAdditionalInfo {
readonly info?: any;
readonly type?: string;
}
// @public
export interface ErrorDetail {
readonly additionalInfo?: ErrorAdditionalInfo[];
readonly code?: string;
readonly details?: ErrorDetail[];
readonly message?: string;
readonly target?: string;
}
// @public
export interface ErrorResponse {
error?: ErrorDetail;
}
// @public
interface Event_2 {
readonly count?: number;
readonly firstTimestamp?: Date;
readonly lastTimestamp?: Date;
readonly message?: string;
readonly name?: string;
readonly type?: string;
}
export { Event_2 as Event }
// @public
export interface FileShare {
// (undocumented)
name?: string;
// (undocumented)
properties?: FileShareProperties;
// (undocumented)
resourceGroupName?: string;
// (undocumented)
storageAccountName?: string;
}
// @public
export interface FileShareProperties {
shareAccessTier?: AzureFileShareAccessTier;
shareAccessType?: AzureFileShareAccessType;
}
// @public
export interface GitRepoVolume {
directory?: string;
repository: string;
revision?: string;
}
// @public
export interface GpuResource {
count: number;
sku: GpuSku;
}
// @public
export type GpuSku = string;
// @public
export interface HttpHeader {
name?: string;
value?: string;
}
// @public
export interface IdentityAccessControl {
access?: IdentityAccessLevel;
identity?: string;
}
// @public
export type IdentityAccessLevel = string;
// @public
export interface IdentityAcls {
acls?: IdentityAccessControl[];
defaultAccess?: IdentityAccessLevel;
}
// @public
export interface ImageRegistryCredential {
identity?: string;
identityUrl?: string;
password?: string;
passwordReference?: string;
server: string;
username?: string;
}
// @public
export interface InitContainerDefinition {
command?: string[];
environmentVariables?: EnvironmentVariable[];
image?: string;
readonly instanceView?: InitContainerPropertiesDefinitionInstanceView;
name: string;
securityContext?: SecurityContextDefinition;
volumeMounts?: VolumeMount[];
}
// @public
export interface InitContainerPropertiesDefinition {
command?: string[];
environmentVariables?: EnvironmentVariable[];
image?: string;
readonly instanceView?: InitContainerPropertiesDefinitionInstanceView;
securityContext?: SecurityContextDefinition;
volumeMounts?: VolumeMount[];
}
// @public
export interface InitContainerPropertiesDefinitionInstanceView {
readonly currentState?: ContainerState;
readonly events?: Event_2[];
readonly previousState?: ContainerState;
readonly restartCount?: number;
}
// @public
export interface IpAddress {
autoGeneratedDomainNameLabelScope?: DnsNameLabelReusePolicy;
dnsNameLabel?: string;
readonly fqdn?: string;
ip?: string;
ports: Port[];
type: ContainerGroupIpAddressType;
}
export { isRestError }
// @public
export enum KnownContainerGroupIpAddressType {
Private = "Private",
Public = "Public"
}
// @public
export enum KnownContainerGroupNetworkProtocol {
TCP = "TCP",
UDP = "UDP"
}
// @public
export enum KnownContainerGroupPriority {
Regular = "Regular",
Spot = "Spot"
}
// @public
export enum KnownContainerGroupRestartPolicy {
Always = "Always",
Never = "Never",
OnFailure = "OnFailure"
}
// @public
export enum KnownContainerGroupSku {
Confidential = "Confidential",
Dedicated = "Dedicated",
NotSpecified = "NotSpecified",
Standard = "Standard"
}
// @public
export enum KnownContainerInstanceOperationsOrigin {
System = "System",
User = "User"
}
// @public
export enum KnownContainerNetworkProtocol {
TCP = "TCP",
UDP = "UDP"
}
// @public
export enum KnownCreatedByType {
Application = "Application",
Key = "Key",
ManagedIdentity = "ManagedIdentity",
User = "User"
}
// @public
export enum KnownDnsNameLabelReusePolicy {
Noreuse = "Noreuse",
ResourceGroupReuse = "ResourceGroupReuse",
SubscriptionReuse = "SubscriptionReuse",
TenantReuse = "TenantReuse",
Unsecure = "Unsecure"
}
// @public
export enum KnownGpuSku {
K80 = "K80",
P100 = "P100",
V100 = "V100"
}
// @public
export enum KnownIdentityAccessLevel {
All = "All",
System = "System",
User = "User"
}
// @public
export enum KnownLogAnalyticsLogType {
ContainerInsights = "ContainerInsights",
ContainerInstanceLogs = "ContainerInstanceLogs"
}
// @public
export enum KnownManagedServiceIdentityType {
None = "None",
SystemAssigned = "SystemAssigned",
SystemAssignedUserAssigned = "SystemAssigned,UserAssigned",
UserAssigned = "UserAssigned"
}
// @public
export enum KnownNGroupProvisioningState {
Canceled = "Canceled",
Creating = "Creating",
Deleting = "Deleting",
Failed = "Failed",
Migrating = "Migrating",
Succeeded = "Succeeded",
Updating = "Updating"
}
// @public
export enum KnownNGroupUpdateMode {
Manual = "Manual",
Rolling = "Rolling"
}
// @public
export enum KnownOperatingSystemTypes {
Linux = "Linux",
Windows = "Windows"
}
// @public
export enum KnownSandboxGroupProvisioningState {
Accepted = "Accepted",
Canceled = "Canceled",
Deleting = "Deleting",
Failed = "Failed",
Succeeded = "Succeeded",
Updating = "Updating"
}
// @public
export enum KnownScheme {
Http = "http",
Https = "https"
}
// @public
export enum KnownVersions {
V20250901 = "2025-09-01",
V20260601Preview = "2026-06-01-preview"
}
// @public
export interface LoadBalancer {
backendAddressPools?: LoadBalancerBackendAddressPool[];
}
// @public
export interface LoadBalancerBackendAddressPool {
resource?: string;
}
// @public
export interface LocationListCachedImagesOptionalParams extends OperationOptions {
}
// @public
export interface LocationListCapabilitiesOptionalParams extends OperationOptions {
}
// @public
export interface LocationListUsageOptionalParams extends OperationOptions {
}
// @public
export interface LocationOperations {
listCachedImages: (location: string, options?: LocationListCachedImagesOptionalParams) => PagedAsyncIterableIterator<CachedImages>;
listCapabilities: (location: string, options?: LocationListCapabilitiesOptionalParams) => PagedAsyncIterableIterator<Capabilities>;
listUsage: (location: string, options?: LocationListUsageOptionalParams) => PagedAsyncIterableIterator<Usage>;
}
// @public
export interface LogAnalytics {
logType?: LogAnalyticsLogType;
metadata?: Record<string, string>;
workspaceId: string;
workspaceKey: string;
workspaceResourceId?: string;
}
// @public
export type LogAnalyticsLogType = string;
// @public
export interface Logs {
content?: string;
}
// @public
export interface ManagedServiceIdentity {
readonly principalId?: string;
readonly tenantId?: string;
type: ManagedServiceIdentityType;
userAssignedIdentities?: Record<string, UserAssignedIdentity>;
}
// @public
export type ManagedServiceIdentityType = string;
// @public
export interface NetworkProfile {
applicationGateway?: ApplicationGateway;
loadBalancer?: LoadBalancer;
}
// @public
export interface NGroup extends ProxyResource {
containerGroupProfiles?: ContainerGroupProfileStub[];
elasticProfile?: ElasticProfile;
identity?: NGroupIdentity;
location?: string;
placementProfile?: PlacementProfile;
readonly provisioningState?: NGroupProvisioningState;
tags?: Record<string, string>;
updateProfile?: UpdateProfile;
zones?: string[];
}
// @public
export interface NGroupCGPropertyContainer {
name?: string;
properties?: NGroupCGPropertyContainerProperties;
}
// @public
export interface NGroupCGPropertyContainerProperties {
// (undocumented)
volumeMounts?: VolumeMount[];
}
// @public
export interface NGroupCGPropertyVolume {
azureFile?: AzureFileVolume;
name: string;
}
// @public
export interface NGroupContainerGroupProperties {
containers?: NGroupCGPropertyContainer[];
subnetIds?: ContainerGroupSubnetId[];
volumes?: NGroupCGPropertyVolume[];
}
// @public
export interface NGroupIdentity {
readonly principalId?: string;
readonly tenantId?: string;
type?: ResourceIdentityType;
userAssignedIdentities?: Record<string, UserAssignedIdentities>;
}
// @public
export interface NGroupPatch {
containerGroupProfiles?: ContainerGroupProfileStub[];
elasticProfile?: ElasticProfile;
identity?: NGroupIdentity;
placementProfile?: PlacementProfile;
readonly provisioningState?: NGroupProvisioningState;
readonly systemData?: SystemData;
tags?: Record<string, string>;
updateProfile?: UpdateProfile;
zones?: string[];
}
// @public
export interface NGroupProperties {
containerGroupProfiles?: ContainerGroupProfileStub[];
elasticProfile?: ElasticProfile;
placementProfile?: PlacementProfile;
readonly provisioningState?: NGroupProvisioningState;
updateProfile?: UpdateProfile;
}
// @public
export type NGroupProvisioningState = string;
// @public
export interface NGroupsCreateOrUpdateOptionalParams extends OperationOptions {
updateIntervalInMs?: number;
}
// @public
export interface NGroupsDeleteOptionalParams extends OperationOptions {
updateIntervalInMs?: number;
}
// @public
export interface NGroupsGetOptionalParams extends OperationOptions {
}
// @public
export interface NGroupsListByResourceGroupOptionalParams extends OperationOptions {
}
// @public
export interface NGroupsListOptionalParams extends OperationOptions {
}
// @public
export interface NGroupsOperations {
// @deprecated (undocumented)
beginCreateOrUpdate: (resourceGroupName: string, ngroupsName: string, nGroup: NGroup, options?: NGroupsCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<NGroup>, NGroup>>;
// @deprecated (undocumented)
beginCreateOrUpdateAndWait: (resourceGroupName: string, ngroupsName: string, nGroup: NGroup, options?: NGroupsCreateOrUpdateOptionalParams) => Promise<NGroup>;
// @deprecated (undocumented)
beginDelete: (resourceGroupName: string, ngroupsName: string, options?: NGroupsDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>;
// @deprecated (undocumented)
beginDeleteAndWait: (resourceGroupName: string, ngroupsName: string, options?: NGroupsDeleteOptionalParams) => Promise<void>;
// @deprecated (undocumented)
beginRestart: (resourceGroupName: string, ngroupsName: string, options?: NGroupsRestartOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>;
// @deprecated (undocumented)
beginRestartAndWait: (resourceGroupName: string, ngroupsName: string, options?: NGroupsRestartOptionalParams) => Promise<void>;
// @deprecated (undocumented)
beginStart: (resourceGroupName: string, ngroupsName: string, options?: NGroupsStartOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>;
// @deprecated (undocumented)
beginStartAndWait: (resourceGroupName: string, ngroupsName: string, options?: NGroupsStartOptionalParams) => Promise<void>;
// @deprecated (undocumented)
beginUpdate: (resourceGroupName: string, ngroupsName: string, nGroup: NGroupPatch, options?: NGroupsUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<NGroup>, NGroup>>;
// @deprecated (undocumented)
beginUpdateAndWait: (resourceGroupName: string, ngroupsName: string, nGroup: NGroupPatch, options?: NGroupsUpdateOptionalParams) => Promise<NGroup>;
createOrUpdate: (resourceGroupName: string, ngroupsName: string, nGroup: NGroup, options?: NGroupsCreateOrUpdateOptionalParams) => PollerLike<OperationState<NGroup>, NGroup>;
delete: (resourceGroupName: string, ngroupsName: string, options?: NGroupsDeleteOptionalParams) => PollerLike<OperationState<void>, void>;
get: (resourceGroupName: string, ngroupsName: string, options?: NGroupsGetOptionalParams) => Promise<NGroup>;
list: (options?: NGroupsListOptionalParams) => PagedAsyncIterableIterator<NGroup>;
listByResourceGroup: (resourceGroupName: string, options?: NGroupsListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<NGroup>;
restart: (resourceGroupName: string, ngroupsName: string, options?: NGroupsRestartOptionalParams) => PollerLike<OperationState<void>, void>;
start: (resourceGroupName: string, ngroupsName: string, options?: NGroupsStartOptionalParams) => PollerLike<OperationState<void>, void>;
stop: (resourceGroupName: string, ngroupsName: string, options?: NGroupsStopOptionalParams) => Promise<void>;
update: (resourceGroupName: string, ngroupsName: string, nGroup: NGroupPatch, options?: NGroupsUpdateOptionalParams) => PollerLike<OperationState<NGroup>, NGroup>;
}
// @public
export interface NGroupsRestartOptionalParams extends OperationOptions {
updateIntervalInMs?: number;
}
// @public
export interface NGroupsStartOptionalParams extends OperationOptions {
updateIntervalInMs?: number;
}
// @public
export interface NGroupsStopOptionalParams extends OperationOptions {
}
// @public
export interface NGroupsUpdateOptionalParams extends OperationOptions {
updateIntervalInMs?: number;
}
// @public
export type NGroupUpdateMode = string;
// @public
export type OperatingSystemTypes = string;
// @public
export interface Operation {
display: OperationDisplay;
name: string;
origin?: ContainerInstanceOperationsOrigin;
properties?: any;
}
// @public
export interface OperationDisplay {
description?: string;
operation?: string;
provider?: string;
resource?: string;
}
// @public
export interface OperationsListOptionalParams extends OperationOptions {
}
// @public
export interface OperationsOperations {
list: (options?: OperationsListOptionalParams) => PagedAsyncIterableIterator<Operation>;
}
// @public
export interface PagedAsyncIterableIterator<TElement, TPage = TElement[], TPageSettings extends PageSettings = PageSettings> {
[Symbol.asyncIterator](): PagedAsyncIterableIterator<TElement, TPage, TPageSettings>;
byPage: (settings?: TPageSettings) => AsyncIterableIterator<ContinuablePage<TElement, TPage>>;
next(): Promise<IteratorResult<TElement>>;
}
// @public
export interface PageSettings {
continuationToken?: string;
}
// @public
export interface PlacementProfile {
faultDomainCount?: number;
}
// @public
export interface Port {
port: number;
protocol?: ContainerGroupNetworkProtocol;
}
// @public
export interface ProxyResource extends ArmResource {
}
// @public
export interface Resource {
readonly id?: string;
location?: string;
readonly name?: string;
tags?: Record<string, string>;
readonly type?: string;
zones?: string[];
}
// @public
export type ResourceIdentityType = "SystemAssigned" | "UserAssigned" | "SystemAssigned, UserAssigned" | "None";
// @public
export interface ResourceLimits {
cpu?: number;
gpu?: GpuResource;
memoryInGB?: number;
}
// @public
export interface ResourceRequests {
cpu: number;
gpu?: GpuResource;
memoryInGB: number;
}
// @public
export interface ResourceRequirements {
limits?: ResourceLimits;
requests: ResourceRequests;
}
export { RestError }
// @public
export function restorePoller<TResponse extends PathUncheckedResponse, TResult>(client: ContainerInstanceManagementClient, serializedState: string, sourceOperation: (...args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult>): PollerLike<OperationState<TResult>, TResult>;
// @public (undocumented)
export interface RestorePollerOptions<TResult, TResponse extends PathUncheckedResponse = PathUncheckedResponse> extends OperationOptions {
abortSignal?: AbortSignalLike;
processResponseBody?: (result: TResponse) => Promise<TResult>;
updateIntervalInMs?: number;
}
// @public
export interface SandboxGroup extends TrackedResource {
identity?: ManagedServiceIdentity;
properties?: SandboxGroupProperties;
}
// @public
export interface SandboxGroupAccessToken {
accessToken: string;
endpoint: string;
notAfter: Date;
}
// @public
export interface SandboxGroupNetworkProfile {
subnets?: SubnetReference[];
}
// @public
export interface SandboxGroupProperties {
readonly managementResourceGroupId?: string;
networkProfile?: SandboxGroupNetworkProfile;
readonly provisioningState?: SandboxGroupProvisioningState;
}
// @public
export type SandboxGroupProvisioningState = string;
// @public
export interface SandboxGroupsConnectOptionalParams extends OperationOptions {
}
// @public
export interface SandboxGroupsCreateOrUpdateOptionalParams extends OperationOptions {
updateIntervalInMs?: number;
}
// @public
export interface SandboxGroupsDeleteOptionalParams extends OperationOptions {
updateIntervalInMs?: number;
}
// @public
export interface SandboxGroupsGetOptionalParams extends OperationOptions {
}
// @public
export interface SandboxGroupsListByResourceGroupOptionalParams extends OperationOptions {
}
// @public
export interface SandboxGroupsListBySubscriptionOptionalParams extends OperationOptions {
}
// @public
export interface SandboxGroupsOperations {
// @deprecated (undocumented)
beginCreateOrUpdate: (resourceGroupName: string, sandboxGroupName: string, resource: SandboxGroup, options?: SandboxGroupsCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<SandboxGroup>, SandboxGroup>>;
// @deprecated (undocumented)
beginCreateOrUpdateAndWait: (resourceGroupName: string, sandboxGroupName: string, resource: SandboxGroup, options?: SandboxGroupsCreateOrUpdateOptionalParams) => Promise<SandboxGroup>;
// @deprecated (undocumented)
beginDelete: (resourceGroupName: string, sandboxGroupName: string, options?: SandboxGroupsDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>;
// @deprecated (undocumented)
beginDeleteAndWait: (resourceGroupName: string, sandboxGroupName: string, options?: SandboxGroupsDeleteOptionalParams) => Promise<void>;
// @deprecated (undocumented)
beginUpdate: (resourceGroupName: string, sandboxGroupName: string, properties: SandboxGroupTagsUpdate, options?: SandboxGroupsUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<SandboxGroup>, SandboxGroup>>;
// @deprecated (undocumented)
beginUpdateAndWait: (resourceGroupName: string, sandboxGroupName: string, properties: SandboxGroupTagsUpdate, options?: SandboxGroupsUpdateOptionalParams) => Promise<SandboxGroup>;
connect: (resourceGroupName: string, sandboxGroupName: string, options?: SandboxGroupsConnectOptionalParams) => Promise<SandboxGroupAccessToken>;
createOrUpdate: (resourceGroupName: string, sandboxGroupName: string, resource: SandboxGroup, options?: SandboxGroupsCreateOrUpdateOptionalParams) => PollerLike<OperationState<SandboxGroup>, SandboxGroup>;
delete: (resourceGroupName: string, sandboxGroupName: string, options?: SandboxGroupsDeleteOptionalParams) => PollerLike<OperationState<void>, void>;
get: (resourceGroupName: string, sandboxGroupName: string, options?: SandboxGroupsGetOptionalParams) => Promise<SandboxGroup>;
listByResourceGroup: (resourceGroupName: string, options?: SandboxGroupsListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<SandboxGroup>;
listBySubscription: (options?: SandboxGroupsListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<SandboxGroup>;
update: (resourceGroupName: string, sandboxGroupName: string, properties: SandboxGroupTagsUpdate, options?: SandboxGroupsUpdateOptionalParams) => PollerLike<OperationState<SandboxGroup>, SandboxGroup>;
}
// @public
export interface SandboxGroupsUpdateOptionalParams extends OperationOptions {
updateIntervalInMs?: number;
}
// @public
export interface SandboxGroupTagsUpdate {
identity?: ManagedServiceIdentity;
tags?: Record<string, string>;
}
// @public
export type Scheme = string;
// @public
export interface SecretReference {
identity: string;
name: string;
secretReferenceUri: string;
}
// @public
export interface SecurityContextCapabilitiesDefinition {
add?: string[];
drop?: string[];
}
// @public
export interface SecurityContextDefinition {
allowPrivilegeEscalation?: boolean;
capabilities?: SecurityContextCapabilitiesDefinition;
privileged?: boolean;
runAsGroup?: number;
runAsUser?: number;
seccompProfile?: string;
}
// @public
export interface SimplePollerLike<TState extends OperationState<TResult>, TResult> {
getOperationState(): TState;
getResult(): TResult | undefined;
isDone(): boolean;
// @deprecated
isStopped(): boolean;
onProgress(callback: (state: TState) => void): CancelOnProgress;
poll(options?: {
abortSignal?: AbortSignalLike;
}): Promise<TState>;
pollUntilDone(pollOptions?: {
abortSignal?: AbortSignalLike;
}): Promise<TResult>;
serialize(): Promise<string>;
// @deprecated
stopPolling(): void;
submitted(): Promise<void>;
// @deprecated
toString(): string;
}
// @public
export interface StandbyPoolProfileDefinition {
failContainerGroupCreateOnReuseFailure?: boolean;
id?: string;
}
// @public
export interface StorageProfile {
// (undocumented)
fileShares?: FileShare[];
}
// @public
export interface SubnetReference {
id: string;
}
// @public
export interface SubnetServiceAssociationLinkDeleteOptionalParams extends OperationOptions {
updateIntervalInMs?: number;
}
// @public
export interface SubnetServiceAssociationLinkOperations {
// @deprecated (undocumented)
beginDelete: (resourceGroupName: string, virtualNetworkName: string, subnetName: string, options?: SubnetServiceAssociationLinkDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>;
// @deprecated (undocumented)
beginDeleteAndWait: (resourceGroupName: string, virtualNetworkName: string, subnetName: string, options?: SubnetServiceAssociationLinkDeleteOptionalParams) => Promise<void>;
delete: (resourceGroupName: string, virtualNetworkName: string, subnetName: string, options?: SubnetServiceAssociationLinkDeleteOptionalParams) => PollerLike<OperationState<void>, void>;
}
// @public
export interface SystemData {
createdAt?: Date;
createdBy?: string;
createdByType?: CreatedByType;
lastModifiedAt?: Date;
lastModifiedBy?: string;
lastModifiedByType?: CreatedByType;
}
// @public
export interface TrackedResource extends ArmResource {
location: string;
tags?: Record<string, string>;
}
// @public
export interface UpdateProfile {
rollingUpdateProfile?: UpdateProfileRollingUpdateProfile;
// (undocumented)
updateMode?: NGroupUpdateMode;
}
// @public
export interface UpdateProfileRollingUpdateProfile {
inPlaceUpdate?: boolean;
maxBatchPercent?: number;
maxUnhealthyPercent?: number;
pauseTimeBetweenBatches?: string;
}
// @public
export interface Usage {
readonly currentValue?: number;
readonly id?: string;
readonly limit?: number;
readonly name?: UsageName;
readonly unit?: string;
}
// @public
export interface UsageName {
readonly localizedValue?: string;
readonly value?: string;
}
// @public
export interface UserAssignedIdentities {
readonly clientId?: string;
readonly principalId?: string;
}
// @public
export interface UserAssignedIdentity {
readonly clientId?: string;
readonly principalId?: string;
}
// @public
export interface Volume {
azureFile?: AzureFileVolume;
emptyDir?: any;
gitRepo?: GitRepoVolume;
name: string;
secret?: Record<string, string>;
secretReference?: Record<string, string>;
}
// @public
export interface VolumeMount {
mountPath: string;
name: string;
readOnly?: boolean;
}
// (No @packageDocumentation comment for this package)