@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 6.23 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* 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.
*
* Uses Azure REST API version 2024-05-01-preview.
*
* Other available API versions: 2023-05-01, 2024-09-01-preview, 2024-10-01-preview, 2024-11-01-preview. 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 getContainerGroup(args: GetContainerGroupArgs, opts?: pulumi.InvokeOptions): Promise<GetContainerGroupResult>;
export interface GetContainerGroupArgs {
/**
* The name of the container group.
*/
containerGroupName: string;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: string;
}
/**
* A container group.
*/
export interface GetContainerGroupResult {
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: string;
/**
* The properties for confidential container group
*/
readonly confidentialComputeProperties?: outputs.containerinstance.ConfidentialComputePropertiesResponse;
/**
* The reference container group profile properties.
*/
readonly containerGroupProfile?: outputs.containerinstance.ContainerGroupProfileReferenceDefinitionResponse;
/**
* The containers within the container group.
*/
readonly containers: outputs.containerinstance.ContainerResponse[];
/**
* The diagnostic information for a container group.
*/
readonly diagnostics?: outputs.containerinstance.ContainerGroupDiagnosticsResponse;
/**
* The DNS config information for a container group.
*/
readonly dnsConfig?: outputs.containerinstance.DnsConfigurationResponse;
/**
* 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 identity of the container group, if configured.
*/
readonly identity?: outputs.containerinstance.ContainerGroupIdentityResponse;
/**
* 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 instance view of the container group. Only valid in response.
*/
readonly instanceView: outputs.containerinstance.ContainerGroupPropertiesResponseInstanceView;
/**
* The IP address type of the container group.
*/
readonly ipAddress?: outputs.containerinstance.IpAddressResponse;
/**
* The flag indicating whether the container group is created by standby pool.
*/
readonly isCreatedFromStandbyPool: boolean;
/**
* 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;
/**
* The provisioning state of the container group. This only appears in the response.
*/
readonly provisioningState: string;
/**
* Restart policy for all containers within the container group.
* - `Always` Always restart
* - `OnFailure` Restart on failure
* - `Never` Never restart
*/
readonly restartPolicy?: string;
/**
* The SKU for a container group.
*/
readonly sku?: string;
/**
* The reference standby pool profile properties.
*/
readonly standbyPoolProfile?: outputs.containerinstance.StandbyPoolProfileDefinitionResponse;
/**
* The subnet resource IDs for a container group.
*/
readonly subnetIds?: outputs.containerinstance.ContainerGroupSubnetIdResponse[];
/**
* The resource tags.
*/
readonly tags?: {
[key: string]: string;
};
/**
* The resource type.
*/
readonly type: string;
/**
* 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[];
}
/**
* 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.
*
* Uses Azure REST API version 2024-05-01-preview.
*
* Other available API versions: 2023-05-01, 2024-09-01-preview, 2024-10-01-preview, 2024-11-01-preview. 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 getContainerGroupOutput(args: GetContainerGroupOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetContainerGroupResult>;
export interface GetContainerGroupOutputArgs {
/**
* The name of the container group.
*/
containerGroupName: pulumi.Input<string>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
}