@azure/arm-containerinstance 9.1.1-alpha.20241024.1 → 9.2.0-beta.1

package/types/arm-containerinstance.d.ts

@@ -117,12 +117,20 @@ export declare interface ConfidentialComputeProperties {
     ccePolicy?: string;
 }
 
+/** The container config map. */
+export declare interface ConfigMap {
+    /** The key value pairs dictionary in the config map. */
+    keyValuePairs?: {
+        [propertyName: string]: string;
+    };
+}
+
 /** A container instance. */
 export declare interface Container {
     /** The user-provided name of the container instance. */
     name: string;
     /** The name of the image used to create the container instance. */
-    image: string;
+    image?: string;
     /** The commands to execute within the container instance in exec form. */
     command?: string[];
     /** The exposed ports on the container instance. */
@@ -135,7 +143,7 @@ export declare interface Container {
      */
     readonly instanceView?: ContainerPropertiesInstanceView;
     /** The resource requirements of the container instance. */
-    resources: ResourceRequirements;
+    resources?: ResourceRequirements;
     /** The volume mounts available to the container instance. */
     volumeMounts?: VolumeMount[];
     /** The liveness probe. */
@@ -144,6 +152,8 @@ export declare interface Container {
     readinessProbe?: ContainerProbe;
     /** The container security properties. */
     securityContext?: SecurityContextDefinition;
+    /** The config map. */
+    configMap?: ConfigMap;
 }
 
 /** The information for the output stream from container attach. */
@@ -252,6 +262,227 @@ export declare type ContainerGroupNetworkProtocol = string;
  */
 export declare type ContainerGroupPriority = string;
 
+/** A container group profile. */
+export declare interface ContainerGroupProfile extends Resource, ContainerGroupProfileProperties {
+}
+
+/** Optional parameters. */
+export declare interface ContainerGroupProfileGetByRevisionNumberOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the getByRevisionNumber operation. */
+export declare type ContainerGroupProfileGetByRevisionNumberResponse = ContainerGroupProfile;
+
+/** Optional parameters. */
+export declare interface ContainerGroupProfileListAllRevisionsNextOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the listAllRevisionsNext operation. */
+export declare type ContainerGroupProfileListAllRevisionsNextResponse = ContainerGroupProfileListResult;
+
+/** Optional parameters. */
+export declare interface ContainerGroupProfileListAllRevisionsOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the listAllRevisions operation. */
+export declare type ContainerGroupProfileListAllRevisionsResponse = ContainerGroupProfileListResult;
+
+/** The container group profile list response that contains the container group profile properties. */
+export declare interface ContainerGroupProfileListResult {
+    /** The list of container group profiles. */
+    value?: ContainerGroupProfile[];
+    /** The URI to fetch the next page of container group profiles. */
+    nextLink?: string;
+}
+
+/** Interface representing a ContainerGroupProfileOperations. */
+export declare interface ContainerGroupProfileOperations {
+    /**
+     * Get a list of all the revisions of the specified container group profile in the given subscription
+     * and resource group. This operation returns properties of each revision of the specified container
+     * group profile including containers, image registry credentials, restart policy, IP address type, OS
+     * type volumes, revision number, etc.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param containerGroupProfileName The name of the container group profile.
+     * @param options The options parameters.
+     */
+    listAllRevisions(resourceGroupName: string, containerGroupProfileName: string, options?: ContainerGroupProfileListAllRevisionsOptionalParams): PagedAsyncIterableIterator<ContainerGroupProfile>;
+    /**
+     * Gets the properties of the specified revision of the container group profile in the given
+     * subscription and resource group. The operation returns the properties of container group profile
+     * including containers, image registry credentials, restart policy, IP address type, OS type, volumes,
+     * current revision number, etc.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param containerGroupProfileName The name of the container group profile.
+     * @param revisionNumber The revision number of the container group profile.
+     * @param options The options parameters.
+     */
+    getByRevisionNumber(resourceGroupName: string, containerGroupProfileName: string, revisionNumber: string, options?: ContainerGroupProfileGetByRevisionNumberOptionalParams): Promise<ContainerGroupProfileGetByRevisionNumberResponse>;
+}
+
+/** Properties of container group profile that need to be patched */
+export declare interface ContainerGroupProfilePatch {
+    /** Resource tags. */
+    tags?: {
+        [propertyName: string]: string;
+    };
+}
+
+/** The container group profile properties */
+export declare interface ContainerGroupProfileProperties {
+    /** The containers within the container group. */
+    containers: Container[];
+    /** The image registry credentials by which the container group is created from. */
+    imageRegistryCredentials?: ImageRegistryCredential[];
+    /**
+     * Restart policy for all containers within the container group.
+     * - `Always` Always restart
+     * - `OnFailure` Restart on failure
+     * - `Never` Never restart
+     *
+     */
+    restartPolicy?: ContainerGroupRestartPolicy;
+    /** The IP address type of the container group. */
+    ipAddress?: IpAddress;
+    /** The operating system type required by the containers in the container group. */
+    osType: OperatingSystemTypes;
+    /** The list of volumes that can be mounted by containers in this container group. */
+    volumes?: Volume[];
+    /** The diagnostic information for a container group. */
+    diagnostics?: ContainerGroupDiagnostics;
+    /** The SKU for a container group. */
+    sku?: ContainerGroupSku;
+    /** The encryption properties for a container group. */
+    encryptionProperties?: EncryptionProperties;
+    /** The init containers for a container group. */
+    initContainers?: InitContainerDefinition[];
+    /** extensions used by virtual kubelet */
+    extensions?: DeploymentExtensionSpec[];
+    /** The properties for confidential container group */
+    confidentialComputeProperties?: ConfidentialComputeProperties;
+    /** The priority of the container group. */
+    priority?: ContainerGroupPriority;
+    /**
+     * The container group profile current revision number. This only appears in the response.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly revision?: number;
+}
+
+/** The container group profile reference. */
+export declare interface ContainerGroupProfileReferenceDefinition {
+    /** The container group profile reference id.This will be an ARM resource id in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroupProfiles/{containerGroupProfileName}'. */
+    id?: string;
+    /** The container group profile reference revision. */
+    revision?: number;
+}
+
+/** Interface representing a ContainerGroupProfiles. */
+export declare interface ContainerGroupProfiles {
+    /**
+     * Get a list of container group profiles in the specified subscription. This operation returns
+     * properties of each container group profile including containers, image registry credentials, restart
+     * policy, IP address type, OS type,volumes,current revision number, etc.
+     * @param options The options parameters.
+     */
+    list(options?: ContainerGroupProfilesListOptionalParams): PagedAsyncIterableIterator<ContainerGroupProfile>;
+    /**
+     * Get a list of container group profiles in a specified subscription and resource group. This
+     * operation returns properties of each container group profile including containers, image registry
+     * credentials, restart policy, IP address type, OS type volumes, current revision number, etc.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param options The options parameters.
+     */
+    listByResourceGroup(resourceGroupName: string, options?: ContainerGroupProfilesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ContainerGroupProfile>;
+    /**
+     * Gets the properties of the specified container group profile in the specified subscription and
+     * resource group. The operation returns the properties of container group profile including
+     * containers, image registry credentials, restart policy, IP address type, OS type, volumes, current
+     * revision number, etc.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param containerGroupProfileName The name of the container group profile.
+     * @param options The options parameters.
+     */
+    get(resourceGroupName: string, containerGroupProfileName: string, options?: ContainerGroupProfilesGetOptionalParams): Promise<ContainerGroupProfilesGetResponse>;
+    /**
+     * Create or update container group profiles with specified configurations.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param containerGroupProfileName The name of the container group profile.
+     * @param containerGroupProfile The properties of the container group profile to be created or updated.
+     * @param options The options parameters.
+     */
+    createOrUpdate(resourceGroupName: string, containerGroupProfileName: string, containerGroupProfile: ContainerGroupProfile, options?: ContainerGroupProfilesCreateOrUpdateOptionalParams): Promise<ContainerGroupProfilesCreateOrUpdateResponse>;
+    /**
+     * Patches container group profile with specified properties.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param containerGroupProfileName The name of the container group profile.
+     * @param properties The container group profile properties that need to be updated.
+     * @param options The options parameters.
+     */
+    patch(resourceGroupName: string, containerGroupProfileName: string, properties: ContainerGroupProfilePatch, options?: ContainerGroupProfilesPatchOptionalParams): Promise<ContainerGroupProfilesPatchResponse>;
+    /**
+     * Delete the specified container group profile in the specified subscription and resource group. The
+     * operation does not delete other resources provided by the user, such as volumes.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
+     * @param containerGroupProfileName The name of the container group profile.
+     * @param options The options parameters.
+     */
+    delete(resourceGroupName: string, containerGroupProfileName: string, options?: ContainerGroupProfilesDeleteOptionalParams): Promise<void>;
+}
+
+/** Optional parameters. */
+export declare interface ContainerGroupProfilesCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the createOrUpdate operation. */
+export declare type ContainerGroupProfilesCreateOrUpdateResponse = ContainerGroupProfile;
+
+/** Optional parameters. */
+export declare interface ContainerGroupProfilesDeleteOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Optional parameters. */
+export declare interface ContainerGroupProfilesGetOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the get operation. */
+export declare type ContainerGroupProfilesGetResponse = ContainerGroupProfile;
+
+/** Optional parameters. */
+export declare interface ContainerGroupProfilesListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the listByResourceGroupNext operation. */
+export declare type ContainerGroupProfilesListByResourceGroupNextResponse = ContainerGroupProfileListResult;
+
+/** Optional parameters. */
+export declare interface ContainerGroupProfilesListByResourceGroupOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the listByResourceGroup operation. */
+export declare type ContainerGroupProfilesListByResourceGroupResponse = ContainerGroupProfileListResult;
+
+/** Optional parameters. */
+export declare interface ContainerGroupProfilesListNextOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the listNext operation. */
+export declare type ContainerGroupProfilesListNextResponse = ContainerGroupProfileListResult;
+
+/** Optional parameters. */
+export declare interface ContainerGroupProfilesListOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the list operation. */
+export declare type ContainerGroupProfilesListResponse = ContainerGroupProfileListResult;
+
+/** Optional parameters. */
+export declare interface ContainerGroupProfilesPatchOptionalParams extends coreClient.OperationOptions {
+}
+
+/** Contains response data for the patch operation. */
+export declare type ContainerGroupProfilesPatchResponse = ContainerGroupProfile;
+
 /** The container group properties */
 export declare interface ContainerGroupProperties {
     /** The identity of the container group, if configured. */
@@ -276,7 +507,7 @@ export declare interface ContainerGroupProperties {
     /** The IP address type of the container group. */
     ipAddress?: IpAddress;
     /** The operating system type required by the containers in the container group. */
-    osType: OperatingSystemTypes;
+    osType?: OperatingSystemTypes;
     /** The list of volumes that can be mounted by containers in this container group. */
     volumes?: Volume[];
     /**
@@ -302,6 +533,15 @@ export declare interface ContainerGroupProperties {
     confidentialComputeProperties?: ConfidentialComputeProperties;
     /** The priority of the container group. */
     priority?: ContainerGroupPriority;
+    /** The reference container group profile properties. */
+    containerGroupProfile?: ContainerGroupProfileReferenceDefinition;
+    /** The reference standby pool profile properties. */
+    standbyPoolProfile?: StandbyPoolProfileDefinition;
+    /**
+     * The flag indicating whether the container group is created by standby pool.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly isCreatedFromStandbyPool?: boolean;
 }
 
 /** The instance view of the container group. Only valid in response. */
@@ -342,7 +582,7 @@ export declare interface ContainerGroups {
      * Get a list of container groups in a specified subscription and resource group. This operation
      * returns properties of each container group including containers, image registry credentials, restart
      * policy, IP address type, OS type, state, and volumes.
-     * @param resourceGroupName The name of the resource group.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
      * @param options The options parameters.
      */
     listByResourceGroup(resourceGroupName: string, options?: ContainerGroupsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ContainerGroup>;
@@ -350,14 +590,14 @@ export declare interface ContainerGroups {
      * 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.
-     * @param resourceGroupName The name of the resource group.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
      * @param containerGroupName The name of the container group.
      * @param options The options parameters.
      */
     get(resourceGroupName: string, containerGroupName: string, options?: ContainerGroupsGetOptionalParams): Promise<ContainerGroupsGetResponse>;
     /**
      * Create or update container groups with specified configurations.
-     * @param resourceGroupName The name of the resource group.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
      * @param containerGroupName The name of the container group.
      * @param containerGroup The properties of the container group to be created or updated.
      * @param options The options parameters.
@@ -365,7 +605,7 @@ export declare interface ContainerGroups {
     beginCreateOrUpdate(resourceGroupName: string, containerGroupName: string, containerGroup: ContainerGroup, options?: ContainerGroupsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ContainerGroupsCreateOrUpdateResponse>, ContainerGroupsCreateOrUpdateResponse>>;
     /**
      * Create or update container groups with specified configurations.
-     * @param resourceGroupName The name of the resource group.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
      * @param containerGroupName The name of the container group.
      * @param containerGroup The properties of the container group to be created or updated.
      * @param options The options parameters.
@@ -373,7 +613,7 @@ export declare interface ContainerGroups {
     beginCreateOrUpdateAndWait(resourceGroupName: string, containerGroupName: string, containerGroup: ContainerGroup, options?: ContainerGroupsCreateOrUpdateOptionalParams): Promise<ContainerGroupsCreateOrUpdateResponse>;
     /**
      * Updates container group tags with specified values.
-     * @param resourceGroupName The name of the resource group.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
      * @param containerGroupName The name of the container group.
      * @param resource The container group resource with just the tags to be updated.
      * @param options The options parameters.
@@ -382,7 +622,7 @@ export declare interface ContainerGroups {
     /**
      * 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.
-     * @param resourceGroupName The name of the resource group.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
      * @param containerGroupName The name of the container group.
      * @param options The options parameters.
      */
@@ -390,7 +630,7 @@ export declare interface ContainerGroups {
     /**
      * 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.
-     * @param resourceGroupName The name of the resource group.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
      * @param containerGroupName The name of the container group.
      * @param options The options parameters.
      */
@@ -398,7 +638,7 @@ export declare interface ContainerGroups {
     /**
      * Restarts all containers in a container group in place. If container image has updates, new image
      * will be downloaded.
-     * @param resourceGroupName The name of the resource group.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
      * @param containerGroupName The name of the container group.
      * @param options The options parameters.
      */
@@ -406,7 +646,7 @@ export declare interface ContainerGroups {
     /**
      * Restarts all containers in a container group in place. If container image has updates, new image
      * will be downloaded.
-     * @param resourceGroupName The name of the resource group.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
      * @param containerGroupName The name of the container group.
      * @param options The options parameters.
      */
@@ -414,7 +654,7 @@ export declare interface ContainerGroups {
     /**
      * Stops all containers in a container group. Compute resources will be deallocated and billing will
      * stop.
-     * @param resourceGroupName The name of the resource group.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
      * @param containerGroupName The name of the container group.
      * @param options The options parameters.
      */
@@ -422,7 +662,7 @@ export declare interface ContainerGroups {
     /**
      * Starts all containers in a container group. Compute resources will be allocated and billing will
      * start.
-     * @param resourceGroupName The name of the resource group.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
      * @param containerGroupName The name of the container group.
      * @param options The options parameters.
      */
@@ -430,7 +670,7 @@ export declare interface ContainerGroups {
     /**
      * Starts all containers in a container group. Compute resources will be allocated and billing will
      * start.
-     * @param resourceGroupName The name of the resource group.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
      * @param containerGroupName The name of the container group.
      * @param options The options parameters.
      */
@@ -438,7 +678,7 @@ export declare interface ContainerGroups {
     /**
      * 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.
-     * @param resourceGroupName The name of the resource group.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
      * @param containerGroupName The name of the container group.
      * @param options The options parameters.
      */
@@ -577,8 +817,7 @@ export declare class ContainerInstanceManagementClient extends coreClient.Servic
     /**
      * Initializes a new instance of the ContainerInstanceManagementClient class.
      * @param credentials Subscription credentials which uniquely identify client subscription.
-     * @param subscriptionId Subscription credentials which uniquely identify Microsoft Azure subscription.
-     *                       The subscription ID forms part of the URI for every service call.
+     * @param subscriptionId The ID of the target subscription. The value must be an UUID.
      * @param options The parameter options
      */
     constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: ContainerInstanceManagementClientOptionalParams);
@@ -589,6 +828,8 @@ export declare class ContainerInstanceManagementClient extends coreClient.Servic
     location: Location_2;
     containers: Containers;
     subnetServiceAssociationLink: SubnetServiceAssociationLink;
+    containerGroupProfiles: ContainerGroupProfiles;
+    containerGroupProfileOperations: ContainerGroupProfileOperations;
 }
 
 /** Optional parameters. */
@@ -675,7 +916,7 @@ export declare interface ContainerPropertiesInstanceView {
 export declare interface Containers {
     /**
      * Get the logs for a specified container instance in a specified resource group and container group.
-     * @param resourceGroupName The name of the resource group.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
      * @param containerGroupName The name of the container group.
      * @param containerName The name of the container instance.
      * @param options The options parameters.
@@ -684,7 +925,7 @@ export declare interface Containers {
     /**
      * Executes a command for a specific container instance in a specified resource group and container
      * group.
-     * @param resourceGroupName The name of the resource group.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
      * @param containerGroupName The name of the container group.
      * @param containerName The name of the container instance.
      * @param containerExecRequest The request for the exec command.
@@ -694,7 +935,7 @@ export declare interface Containers {
     /**
      * Attach to the output stream of a specific container instance in a specified resource group and
      * container group.
-     * @param resourceGroupName The name of the resource group.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
      * @param containerGroupName The name of the container group.
      * @param containerName The name of the container instance.
      * @param options The options parameters.
@@ -1086,19 +1327,19 @@ export declare enum KnownScheme {
 declare interface Location_2 {
     /**
      * Get the usage for a subscription
-     * @param location The identifier for the physical azure location.
+     * @param location The name of the Azure region.
      * @param options The options parameters.
      */
     listUsage(location: string, options?: LocationListUsageOptionalParams): PagedAsyncIterableIterator<Usage>;
     /**
      * Get the list of cached images on specific OS type for a subscription in a region.
-     * @param location The identifier for the physical azure location.
+     * @param location The name of the Azure region.
      * @param options The options parameters.
      */
     listCachedImages(location: string, options?: LocationListCachedImagesOptionalParams): PagedAsyncIterableIterator<CachedImages>;
     /**
      * Get the list of CPU/memory/GPU capabilities of a region.
-     * @param location The identifier for the physical azure location.
+     * @param location The name of the Azure region.
      * @param options The options parameters.
      */
     listCapabilities(location: string, options?: LocationListCapabilitiesOptionalParams): PagedAsyncIterableIterator<Capabilities>;
@@ -1337,12 +1578,20 @@ export declare interface SecurityContextDefinition {
     seccompProfile?: string;
 }
 
+/** The standby pool profile reference. */
+export declare interface StandbyPoolProfileDefinition {
+    /** The standby pool profile reference id.This will be an ARM resource id in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StandbyPool/standbyContainerGroupPools/{standbyPoolName}'. */
+    id?: string;
+    /** The flag to determine whether ACI should fail the create request if the container group can not be obtained from standby pool. */
+    failContainerGroupCreateOnReuseFailure?: boolean;
+}
+
 /** Interface representing a SubnetServiceAssociationLink. */
 export declare interface SubnetServiceAssociationLink {
     /**
      * Delete container group virtual network association links. The operation does not delete other
      * resources provided by the user.
-     * @param resourceGroupName The name of the resource group.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
      * @param virtualNetworkName The name of the virtual network.
      * @param subnetName The name of the subnet.
      * @param options The options parameters.
@@ -1351,7 +1600,7 @@ export declare interface SubnetServiceAssociationLink {
     /**
      * Delete container group virtual network association links. The operation does not delete other
      * resources provided by the user.
-     * @param resourceGroupName The name of the resource group.
+     * @param resourceGroupName The name of the resource group. The name is case insensitive.
      * @param virtualNetworkName The name of the virtual network.
      * @param subnetName The name of the subnet.
      * @param options The options parameters.