@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 5.26 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Get the properties of the specified container group profile.
*
* Uses Azure REST API version 2024-11-01-preview.
*
* Other available API versions: 2025-09-01. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native containerinstance [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getCGProfile(args: GetCGProfileArgs, opts?: pulumi.InvokeOptions): Promise<GetCGProfileResult>;
export interface GetCGProfileArgs {
/**
* ContainerGroupProfile name.
*/
containerGroupProfileName: string;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: string;
}
/**
* A container group profile object
*/
export interface GetCGProfileResult {
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: string;
/**
* The properties for confidential container group
*/
readonly confidentialComputeProperties?: outputs.containerinstance.ConfidentialComputePropertiesResponse;
/**
* The containers within the container group.
*/
readonly containers: outputs.containerinstance.ContainerResponse[];
/**
* The diagnostic information for a container group.
*/
readonly diagnostics?: outputs.containerinstance.ContainerGroupDiagnosticsResponse;
/**
* The encryption properties for a container group.
*/
readonly encryptionProperties?: outputs.containerinstance.EncryptionPropertiesResponse;
/**
* extensions used by virtual kubelet
*/
readonly extensions?: outputs.containerinstance.DeploymentExtensionSpecResponse[];
/**
* The resource id.
*/
readonly id: string;
/**
* The image registry credentials by which the container group is created from.
*/
readonly imageRegistryCredentials?: outputs.containerinstance.ImageRegistryCredentialResponse[];
/**
* The init containers for a container group.
*/
readonly initContainers?: outputs.containerinstance.InitContainerDefinitionResponse[];
/**
* The IP address type of the container group.
*/
readonly ipAddress?: outputs.containerinstance.IpAddressResponse;
/**
* The resource location.
*/
readonly location?: string;
/**
* The resource name.
*/
readonly name: string;
/**
* The operating system type required by the containers in the container group.
*/
readonly osType: string;
/**
* The priority of the container group.
*/
readonly priority?: string;
/**
* Registered revisions are calculated at request time based off the records in the table logs.
*/
readonly registeredRevisions: number[];
/**
* Restart policy for all containers within the container group.
* - `Always` Always restart
* - `OnFailure` Restart on failure
* - `Never` Never restart
*/
readonly restartPolicy?: string;
/**
* Container group profile current revision number
*/
readonly revision: number;
/**
* The container security properties.
*/
readonly securityContext?: outputs.containerinstance.SecurityContextDefinitionResponse;
/**
* Shutdown grace period for containers in a container group.
*/
readonly shutdownGracePeriod?: string;
/**
* The SKU for a container group.
*/
readonly sku?: string;
/**
* Metadata pertaining to creation and last modification of the resource.
*/
readonly systemData: outputs.containerinstance.SystemDataResponse;
/**
* The resource tags.
*/
readonly tags?: {
[key: string]: string;
};
/**
* Post completion time to live for containers of a CG
*/
readonly timeToLive?: string;
/**
* The resource type.
*/
readonly type: string;
/**
* Gets or sets Krypton use property.
*/
readonly useKrypton?: boolean;
/**
* The list of volumes that can be mounted by containers in this container group.
*/
readonly volumes?: outputs.containerinstance.VolumeResponse[];
/**
* The zones for the container group.
*/
readonly zones?: string[];
}
/**
* Get the properties of the specified container group profile.
*
* Uses Azure REST API version 2024-11-01-preview.
*
* Other available API versions: 2025-09-01. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native containerinstance [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getCGProfileOutput(args: GetCGProfileOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetCGProfileResult>;
export interface GetCGProfileOutputArgs {
/**
* ContainerGroupProfile name.
*/
containerGroupProfileName: pulumi.Input<string>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
}