@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 5.56 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Describes the NGroups resource.
*
* Uses Azure REST API version 2025-09-01. In version 2.x of the Azure Native provider, it used API version 2024-09-01-preview.
*
* Other available API versions: 2024-09-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 class NGroup extends pulumi.CustomResource {
/**
* Get an existing NGroup resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): NGroup;
/**
* Returns true if the given object is an instance of NGroup. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is NGroup;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* The Container Group Profiles that could be used in the NGroups resource.
*/
readonly containerGroupProfiles: pulumi.Output<outputs.containerinstance.ContainerGroupProfileStubResponse[] | undefined>;
/**
* The elastic profile.
*/
readonly elasticProfile: pulumi.Output<outputs.containerinstance.ElasticProfileResponse | undefined>;
/**
* The identity of the NGroup, if configured.
*/
readonly identity: pulumi.Output<outputs.containerinstance.NGroupIdentityResponse | undefined>;
/**
* The resource location.
*/
readonly location: pulumi.Output<string | undefined>;
/**
* The resource name.
*/
readonly name: pulumi.Output<string>;
/**
* Provides options w.r.t allocation and management w.r.t certain placement policies. These utilize capabilities provided by the underlying Azure infrastructure. They are typically used for high availability scenarios. E.g., distributing CGs across fault domains.
*/
readonly placementProfile: pulumi.Output<outputs.containerinstance.PlacementProfileResponse | undefined>;
/**
* The provisioning state, which only appears in the response.
*/
readonly provisioningState: pulumi.Output<string>;
/**
* Metadata pertaining to creation and last modification of the resource.
*/
readonly systemData: pulumi.Output<outputs.containerinstance.SystemDataResponse>;
/**
* The resource tags.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* The resource type.
*/
readonly type: pulumi.Output<string>;
/**
* Used by the customer to specify the way to update the Container Groups in NGroup.
*/
readonly updateProfile: pulumi.Output<outputs.containerinstance.UpdateProfileResponse | undefined>;
/**
* The zones for the container group.
*/
readonly zones: pulumi.Output<string[] | undefined>;
/**
* Create a NGroup resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: NGroupArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a NGroup resource.
*/
export interface NGroupArgs {
/**
* The Container Group Profiles that could be used in the NGroups resource.
*/
containerGroupProfiles?: pulumi.Input<pulumi.Input<inputs.containerinstance.ContainerGroupProfileStubArgs>[]>;
/**
* The elastic profile.
*/
elasticProfile?: pulumi.Input<inputs.containerinstance.ElasticProfileArgs>;
/**
* The identity of the NGroup, if configured.
*/
identity?: pulumi.Input<inputs.containerinstance.NGroupIdentityArgs>;
/**
* The resource location.
*/
location?: pulumi.Input<string>;
/**
* The NGroups name.
*/
ngroupsName?: pulumi.Input<string>;
/**
* Provides options w.r.t allocation and management w.r.t certain placement policies. These utilize capabilities provided by the underlying Azure infrastructure. They are typically used for high availability scenarios. E.g., distributing CGs across fault domains.
*/
placementProfile?: pulumi.Input<inputs.containerinstance.PlacementProfileArgs>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
/**
* The resource tags.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Used by the customer to specify the way to update the Container Groups in NGroup.
*/
updateProfile?: pulumi.Input<inputs.containerinstance.UpdateProfileArgs>;
/**
* The zones for the container group.
*/
zones?: pulumi.Input<pulumi.Input<string>[]>;
}