1. Packages
  2. Azure Native
  3. API Docs
  4. containerinstance
  5. getNGroup
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.10.1 published on Friday, Nov 7, 2025 by Pulumi
Schema (JSON)
pulumi/pulumi-azure-native

azure-native.containerinstance.getNGroup

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.10.1 published on Friday, Nov 7, 2025 by Pulumi
Schema (JSON)
pulumi/pulumi-azure-native

    Get the properties of the specified NGroups resource.

    Uses Azure REST API version 2025-09-01.

    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 for details.

    Using getNGroup

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getNGroup(args: GetNGroupArgs, opts?: InvokeOptions): Promise<GetNGroupResult>
function getNGroupOutput(args: GetNGroupOutputArgs, opts?: InvokeOptions): Output<GetNGroupResult>
    def get_n_group(ngroups_name: Optional[str] = None,
                resource_group_name: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetNGroupResult
def get_n_group_output(ngroups_name: Optional[pulumi.Input[str]] = None,
                resource_group_name: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetNGroupResult]
    func LookupNGroup(ctx *Context, args *LookupNGroupArgs, opts ...InvokeOption) (*LookupNGroupResult, error)
func LookupNGroupOutput(ctx *Context, args *LookupNGroupOutputArgs, opts ...InvokeOption) LookupNGroupResultOutput

    > Note: This function is named LookupNGroup in the Go SDK.

    public static class GetNGroup 
{
    public static Task<GetNGroupResult> InvokeAsync(GetNGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetNGroupResult> Invoke(GetNGroupInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetNGroupResult> getNGroup(GetNGroupArgs args, InvokeOptions options)
public static Output<GetNGroupResult> getNGroup(GetNGroupArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:containerinstance:getNGroup
  arguments:
    # arguments dictionary

    The following arguments are supported:

    NgroupsName string
    The NGroups name.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    NgroupsName string
    The NGroups name.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ngroupsName String
    The NGroups name.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    ngroupsName string
    The NGroups name.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    ngroups_name str
    The NGroups name.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    ngroupsName String
    The NGroups name.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getNGroup Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    The resource id.
    Name string
    The resource name.
    ProvisioningState string
    The provisioning state, which only appears in the response.
    SystemData Pulumi.AzureNative.ContainerInstance.Outputs.SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    Type string
    The resource type.
    ContainerGroupProfiles List<Pulumi.AzureNative.ContainerInstance.Outputs.ContainerGroupProfileStubResponse>
    The Container Group Profiles that could be used in the NGroups resource.
    ElasticProfile Pulumi.AzureNative.ContainerInstance.Outputs.ElasticProfileResponse
    The elastic profile.
    Identity Pulumi.AzureNative.ContainerInstance.Outputs.NGroupIdentityResponse
    The identity of the NGroup, if configured.
    Location string
    The resource location.
    PlacementProfile Pulumi.AzureNative.ContainerInstance.Outputs.PlacementProfileResponse
    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.
    Tags Dictionary<string, string>
    The resource tags.
    UpdateProfile Pulumi.AzureNative.ContainerInstance.Outputs.UpdateProfileResponse
    Used by the customer to specify the way to update the Container Groups in NGroup.
    Zones List<string>
    The zones for the container group.
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    The resource id.
    Name string
    The resource name.
    ProvisioningState string
    The provisioning state, which only appears in the response.
    SystemData SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    Type string
    The resource type.
    ContainerGroupProfiles []ContainerGroupProfileStubResponse
    The Container Group Profiles that could be used in the NGroups resource.
    ElasticProfile ElasticProfileResponse
    The elastic profile.
    Identity NGroupIdentityResponse
    The identity of the NGroup, if configured.
    Location string
    The resource location.
    PlacementProfile PlacementProfileResponse
    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.
    Tags map[string]string
    The resource tags.
    UpdateProfile UpdateProfileResponse
    Used by the customer to specify the way to update the Container Groups in NGroup.
    Zones []string
    The zones for the container group.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    The resource id.
    name String
    The resource name.
    provisioningState String
    The provisioning state, which only appears in the response.
    systemData SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    type String
    The resource type.
    containerGroupProfiles List<ContainerGroupProfileStubResponse>
    The Container Group Profiles that could be used in the NGroups resource.
    elasticProfile ElasticProfileResponse
    The elastic profile.
    identity NGroupIdentityResponse
    The identity of the NGroup, if configured.
    location String
    The resource location.
    placementProfile PlacementProfileResponse
    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.
    tags Map<String,String>
    The resource tags.
    updateProfile UpdateProfileResponse
    Used by the customer to specify the way to update the Container Groups in NGroup.
    zones List<String>
    The zones for the container group.
    azureApiVersion string
    The Azure API version of the resource.
    id string
    The resource id.
    name string
    The resource name.
    provisioningState string
    The provisioning state, which only appears in the response.
    systemData SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    type string
    The resource type.
    containerGroupProfiles ContainerGroupProfileStubResponse[]
    The Container Group Profiles that could be used in the NGroups resource.
    elasticProfile ElasticProfileResponse
    The elastic profile.
    identity NGroupIdentityResponse
    The identity of the NGroup, if configured.
    location string
    The resource location.
    placementProfile PlacementProfileResponse
    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.
    tags {[key: string]: string}
    The resource tags.
    updateProfile UpdateProfileResponse
    Used by the customer to specify the way to update the Container Groups in NGroup.
    zones string[]
    The zones for the container group.
    azure_api_version str
    The Azure API version of the resource.
    id str
    The resource id.
    name str
    The resource name.
    provisioning_state str
    The provisioning state, which only appears in the response.
    system_data SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    type str
    The resource type.
    container_group_profiles Sequence[ContainerGroupProfileStubResponse]
    The Container Group Profiles that could be used in the NGroups resource.
    elastic_profile ElasticProfileResponse
    The elastic profile.
    identity NGroupIdentityResponse
    The identity of the NGroup, if configured.
    location str
    The resource location.
    placement_profile PlacementProfileResponse
    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.
    tags Mapping[str, str]
    The resource tags.
    update_profile UpdateProfileResponse
    Used by the customer to specify the way to update the Container Groups in NGroup.
    zones Sequence[str]
    The zones for the container group.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    The resource id.
    name String
    The resource name.
    provisioningState String
    The provisioning state, which only appears in the response.
    systemData Property Map
    Metadata pertaining to creation and last modification of the resource.
    type String
    The resource type.
    containerGroupProfiles List<Property Map>
    The Container Group Profiles that could be used in the NGroups resource.
    elasticProfile Property Map
    The elastic profile.
    identity Property Map
    The identity of the NGroup, if configured.
    location String
    The resource location.
    placementProfile Property Map
    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.
    tags Map<String>
    The resource tags.
    updateProfile Property Map
    Used by the customer to specify the way to update the Container Groups in NGroup.
    zones List<String>
    The zones for the container group.

    Supporting Types

    ApiEntityReferenceResponse

    Id string
    The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...
    Id string
    The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...
    id String
    The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...
    id string
    The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...
    id str
    The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...
    id String
    The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...

    ApplicationGatewayBackendAddressPoolResponse

    Resource string
    The application gateway backend address pool ARM resource Id.
    Resource string
    The application gateway backend address pool ARM resource Id.
    resource String
    The application gateway backend address pool ARM resource Id.
    resource string
    The application gateway backend address pool ARM resource Id.
    resource str
    The application gateway backend address pool ARM resource Id.
    resource String
    The application gateway backend address pool ARM resource Id.

    ApplicationGatewayResponse

    BackendAddressPools List<Pulumi.AzureNative.ContainerInstance.Inputs.ApplicationGatewayBackendAddressPoolResponse>
    List of Application Gateway Backend Address Pools.
    Resource string
    The Application Gateway ARM resource Id.
    BackendAddressPools []ApplicationGatewayBackendAddressPoolResponse
    List of Application Gateway Backend Address Pools.
    Resource string
    The Application Gateway ARM resource Id.
    backendAddressPools List<ApplicationGatewayBackendAddressPoolResponse>
    List of Application Gateway Backend Address Pools.
    resource String
    The Application Gateway ARM resource Id.
    backendAddressPools ApplicationGatewayBackendAddressPoolResponse[]
    List of Application Gateway Backend Address Pools.
    resource string
    The Application Gateway ARM resource Id.
    backend_address_pools Sequence[ApplicationGatewayBackendAddressPoolResponse]
    List of Application Gateway Backend Address Pools.
    resource str
    The Application Gateway ARM resource Id.
    backendAddressPools List<Property Map>
    List of Application Gateway Backend Address Pools.
    resource String
    The Application Gateway ARM resource Id.

    AzureFileVolumeResponse

    ShareName string
    The name of the Azure File share to be mounted as a volume.
    StorageAccountName string
    The name of the storage account that contains the Azure File share.
    ReadOnly bool
    The flag indicating whether the Azure File shared mounted as a volume is read-only.
    StorageAccountKey string
    The storage account access key used to access the Azure File share.
    StorageAccountKeyReference string
    The reference to the storage account access key used to access the Azure File share.
    ShareName string
    The name of the Azure File share to be mounted as a volume.
    StorageAccountName string
    The name of the storage account that contains the Azure File share.
    ReadOnly bool
    The flag indicating whether the Azure File shared mounted as a volume is read-only.
    StorageAccountKey string
    The storage account access key used to access the Azure File share.
    StorageAccountKeyReference string
    The reference to the storage account access key used to access the Azure File share.
    shareName String
    The name of the Azure File share to be mounted as a volume.
    storageAccountName String
    The name of the storage account that contains the Azure File share.
    readOnly Boolean
    The flag indicating whether the Azure File shared mounted as a volume is read-only.
    storageAccountKey String
    The storage account access key used to access the Azure File share.
    storageAccountKeyReference String
    The reference to the storage account access key used to access the Azure File share.
    shareName string
    The name of the Azure File share to be mounted as a volume.
    storageAccountName string
    The name of the storage account that contains the Azure File share.
    readOnly boolean
    The flag indicating whether the Azure File shared mounted as a volume is read-only.
    storageAccountKey string
    The storage account access key used to access the Azure File share.
    storageAccountKeyReference string
    The reference to the storage account access key used to access the Azure File share.
    share_name str
    The name of the Azure File share to be mounted as a volume.
    storage_account_name str
    The name of the storage account that contains the Azure File share.
    read_only bool
    The flag indicating whether the Azure File shared mounted as a volume is read-only.
    storage_account_key str
    The storage account access key used to access the Azure File share.
    storage_account_key_reference str
    The reference to the storage account access key used to access the Azure File share.
    shareName String
    The name of the Azure File share to be mounted as a volume.
    storageAccountName String
    The name of the storage account that contains the Azure File share.
    readOnly Boolean
    The flag indicating whether the Azure File shared mounted as a volume is read-only.
    storageAccountKey String
    The storage account access key used to access the Azure File share.
    storageAccountKeyReference String
    The reference to the storage account access key used to access the Azure File share.

    ContainerGroupProfileStubResponse

    ContainerGroupProperties Pulumi.AzureNative.ContainerInstance.Inputs.NGroupContainerGroupPropertiesResponse
    Container Group properties which can be set while creating or updating the NGroups.
    NetworkProfile Pulumi.AzureNative.ContainerInstance.Inputs.NetworkProfileResponse
    A network profile for network settings of a ContainerGroupProfile.
    Resource Pulumi.AzureNative.ContainerInstance.Inputs.ApiEntityReferenceResponse
    A reference to the container group profile ARM resource hosted in ACI RP.
    Revision int
    The revision of the CG profile is an optional property. If customer does not to provide a revision then NGroups will pickup the latest revision of CGProfile.
    StorageProfile Pulumi.AzureNative.ContainerInstance.Inputs.StorageProfileResponse
    Storage profile for storage related settings of a container group profile.
    ContainerGroupProperties NGroupContainerGroupPropertiesResponse
    Container Group properties which can be set while creating or updating the NGroups.
    NetworkProfile NetworkProfileResponse
    A network profile for network settings of a ContainerGroupProfile.
    Resource ApiEntityReferenceResponse
    A reference to the container group profile ARM resource hosted in ACI RP.
    Revision int
    The revision of the CG profile is an optional property. If customer does not to provide a revision then NGroups will pickup the latest revision of CGProfile.
    StorageProfile StorageProfileResponse
    Storage profile for storage related settings of a container group profile.
    containerGroupProperties NGroupContainerGroupPropertiesResponse
    Container Group properties which can be set while creating or updating the NGroups.
    networkProfile NetworkProfileResponse
    A network profile for network settings of a ContainerGroupProfile.
    resource ApiEntityReferenceResponse
    A reference to the container group profile ARM resource hosted in ACI RP.
    revision Integer
    The revision of the CG profile is an optional property. If customer does not to provide a revision then NGroups will pickup the latest revision of CGProfile.
    storageProfile StorageProfileResponse
    Storage profile for storage related settings of a container group profile.
    containerGroupProperties NGroupContainerGroupPropertiesResponse
    Container Group properties which can be set while creating or updating the NGroups.
    networkProfile NetworkProfileResponse
    A network profile for network settings of a ContainerGroupProfile.
    resource ApiEntityReferenceResponse
    A reference to the container group profile ARM resource hosted in ACI RP.
    revision number
    The revision of the CG profile is an optional property. If customer does not to provide a revision then NGroups will pickup the latest revision of CGProfile.
    storageProfile StorageProfileResponse
    Storage profile for storage related settings of a container group profile.
    container_group_properties NGroupContainerGroupPropertiesResponse
    Container Group properties which can be set while creating or updating the NGroups.
    network_profile NetworkProfileResponse
    A network profile for network settings of a ContainerGroupProfile.
    resource ApiEntityReferenceResponse
    A reference to the container group profile ARM resource hosted in ACI RP.
    revision int
    The revision of the CG profile is an optional property. If customer does not to provide a revision then NGroups will pickup the latest revision of CGProfile.
    storage_profile StorageProfileResponse
    Storage profile for storage related settings of a container group profile.
    containerGroupProperties Property Map
    Container Group properties which can be set while creating or updating the NGroups.
    networkProfile Property Map
    A network profile for network settings of a ContainerGroupProfile.
    resource Property Map
    A reference to the container group profile ARM resource hosted in ACI RP.
    revision Number
    The revision of the CG profile is an optional property. If customer does not to provide a revision then NGroups will pickup the latest revision of CGProfile.
    storageProfile Property Map
    Storage profile for storage related settings of a container group profile.

    ContainerGroupSubnetIdResponse

    Id string
    Resource ID of virtual network and subnet.
    Name string
    Friendly name for the subnet.
    Id string
    Resource ID of virtual network and subnet.
    Name string
    Friendly name for the subnet.
    id String
    Resource ID of virtual network and subnet.
    name String
    Friendly name for the subnet.
    id string
    Resource ID of virtual network and subnet.
    name string
    Friendly name for the subnet.
    id str
    Resource ID of virtual network and subnet.
    name str
    Friendly name for the subnet.
    id String
    Resource ID of virtual network and subnet.
    name String
    Friendly name for the subnet.

    ElasticProfileResponse

    ContainerGroupNamingPolicy Pulumi.AzureNative.ContainerInstance.Inputs.ElasticProfileResponseContainerGroupNamingPolicy
    Container Groups are named on a generic guid based naming scheme/policy. Customer can modify naming policy to add prefix to CG names during scale out operation.
    DesiredCount int
    MaintainDesiredCount bool
    Flag that indicates whether desiredCount should be maintained when customer deletes SPECIFIC container groups (CGs) from the NGroups. In this case, new CGs will be created by NGroup to compensate for the specific deleted ones.
    ContainerGroupNamingPolicy ElasticProfileResponseContainerGroupNamingPolicy
    Container Groups are named on a generic guid based naming scheme/policy. Customer can modify naming policy to add prefix to CG names during scale out operation.
    DesiredCount int
    MaintainDesiredCount bool
    Flag that indicates whether desiredCount should be maintained when customer deletes SPECIFIC container groups (CGs) from the NGroups. In this case, new CGs will be created by NGroup to compensate for the specific deleted ones.
    containerGroupNamingPolicy ElasticProfileResponseContainerGroupNamingPolicy
    Container Groups are named on a generic guid based naming scheme/policy. Customer can modify naming policy to add prefix to CG names during scale out operation.
    desiredCount Integer
    maintainDesiredCount Boolean
    Flag that indicates whether desiredCount should be maintained when customer deletes SPECIFIC container groups (CGs) from the NGroups. In this case, new CGs will be created by NGroup to compensate for the specific deleted ones.
    containerGroupNamingPolicy ElasticProfileResponseContainerGroupNamingPolicy
    Container Groups are named on a generic guid based naming scheme/policy. Customer can modify naming policy to add prefix to CG names during scale out operation.
    desiredCount number
    maintainDesiredCount boolean
    Flag that indicates whether desiredCount should be maintained when customer deletes SPECIFIC container groups (CGs) from the NGroups. In this case, new CGs will be created by NGroup to compensate for the specific deleted ones.
    container_group_naming_policy ElasticProfileResponseContainerGroupNamingPolicy
    Container Groups are named on a generic guid based naming scheme/policy. Customer can modify naming policy to add prefix to CG names during scale out operation.
    desired_count int
    maintain_desired_count bool
    Flag that indicates whether desiredCount should be maintained when customer deletes SPECIFIC container groups (CGs) from the NGroups. In this case, new CGs will be created by NGroup to compensate for the specific deleted ones.
    containerGroupNamingPolicy Property Map
    Container Groups are named on a generic guid based naming scheme/policy. Customer can modify naming policy to add prefix to CG names during scale out operation.
    desiredCount Number
    maintainDesiredCount Boolean
    Flag that indicates whether desiredCount should be maintained when customer deletes SPECIFIC container groups (CGs) from the NGroups. In this case, new CGs will be created by NGroup to compensate for the specific deleted ones.

    ElasticProfileResponseContainerGroupNamingPolicy

    ElasticProfileResponseGuidNamingPolicy

    Prefix string
    The prefix can be used when there are tooling limitations (e.g. on the Azure portal where CGs from multiple NGroups exist in the same RG). The prefix with the suffixed resource name must still follow Azure resource naming guidelines.
    Prefix string
    The prefix can be used when there are tooling limitations (e.g. on the Azure portal where CGs from multiple NGroups exist in the same RG). The prefix with the suffixed resource name must still follow Azure resource naming guidelines.
    prefix String
    The prefix can be used when there are tooling limitations (e.g. on the Azure portal where CGs from multiple NGroups exist in the same RG). The prefix with the suffixed resource name must still follow Azure resource naming guidelines.
    prefix string
    The prefix can be used when there are tooling limitations (e.g. on the Azure portal where CGs from multiple NGroups exist in the same RG). The prefix with the suffixed resource name must still follow Azure resource naming guidelines.
    prefix str
    The prefix can be used when there are tooling limitations (e.g. on the Azure portal where CGs from multiple NGroups exist in the same RG). The prefix with the suffixed resource name must still follow Azure resource naming guidelines.
    prefix String
    The prefix can be used when there are tooling limitations (e.g. on the Azure portal where CGs from multiple NGroups exist in the same RG). The prefix with the suffixed resource name must still follow Azure resource naming guidelines.

    FileShareResponse

    FileShareResponseProperties

    ShareAccessTier string
    Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. Learn more at: https://learn.microsoft.com/en-us/rest/api/storagerp/file-shares/create?tabs=HTTP#shareaccesstier
    ShareAccessType string
    Specifies how Container Groups can access the Azure file share i.e. all CG will share same Azure file share or going to have exclusive file share.
    ShareAccessTier string
    Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. Learn more at: https://learn.microsoft.com/en-us/rest/api/storagerp/file-shares/create?tabs=HTTP#shareaccesstier
    ShareAccessType string
    Specifies how Container Groups can access the Azure file share i.e. all CG will share same Azure file share or going to have exclusive file share.
    shareAccessTier String
    Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. Learn more at: https://learn.microsoft.com/en-us/rest/api/storagerp/file-shares/create?tabs=HTTP#shareaccesstier
    shareAccessType String
    Specifies how Container Groups can access the Azure file share i.e. all CG will share same Azure file share or going to have exclusive file share.
    shareAccessTier string
    Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. Learn more at: https://learn.microsoft.com/en-us/rest/api/storagerp/file-shares/create?tabs=HTTP#shareaccesstier
    shareAccessType string
    Specifies how Container Groups can access the Azure file share i.e. all CG will share same Azure file share or going to have exclusive file share.
    share_access_tier str
    Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. Learn more at: https://learn.microsoft.com/en-us/rest/api/storagerp/file-shares/create?tabs=HTTP#shareaccesstier
    share_access_type str
    Specifies how Container Groups can access the Azure file share i.e. all CG will share same Azure file share or going to have exclusive file share.
    shareAccessTier String
    Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. Learn more at: https://learn.microsoft.com/en-us/rest/api/storagerp/file-shares/create?tabs=HTTP#shareaccesstier
    shareAccessType String
    Specifies how Container Groups can access the Azure file share i.e. all CG will share same Azure file share or going to have exclusive file share.

    LoadBalancerBackendAddressPoolResponse

    Resource string
    The Load Balancer backend address pool ARM resource Id.
    Resource string
    The Load Balancer backend address pool ARM resource Id.
    resource String
    The Load Balancer backend address pool ARM resource Id.
    resource string
    The Load Balancer backend address pool ARM resource Id.
    resource str
    The Load Balancer backend address pool ARM resource Id.
    resource String
    The Load Balancer backend address pool ARM resource Id.

    LoadBalancerResponse

    BackendAddressPools []LoadBalancerBackendAddressPoolResponse
    List of Load Balancer Backend Address Pools.
    backendAddressPools List<LoadBalancerBackendAddressPoolResponse>
    List of Load Balancer Backend Address Pools.
    backendAddressPools LoadBalancerBackendAddressPoolResponse[]
    List of Load Balancer Backend Address Pools.
    backendAddressPools List<Property Map>
    List of Load Balancer Backend Address Pools.

    NGroupCGPropertyContainerResponse

    Name string
    container name
    Properties NGroupCGPropertyContainerResponseProperties
    container properties
    name String
    container name
    properties NGroupCGPropertyContainerResponseProperties
    container properties
    name string
    container name
    properties NGroupCGPropertyContainerResponseProperties
    container properties
    name str
    container name
    properties NGroupCGPropertyContainerResponseProperties
    container properties
    name String
    container name
    properties Property Map
    container properties

    NGroupCGPropertyContainerResponseProperties

    NGroupCGPropertyVolumeResponse

    Name string
    The name of the volume.
    AzureFile AzureFileVolumeResponse
    The Azure File volume.
    name String
    The name of the volume.
    azureFile AzureFileVolumeResponse
    The Azure File volume.
    name string
    The name of the volume.
    azureFile AzureFileVolumeResponse
    The Azure File volume.
    name str
    The name of the volume.
    azure_file AzureFileVolumeResponse
    The Azure File volume.
    name String
    The name of the volume.
    azureFile Property Map
    The Azure File volume.

    NGroupContainerGroupPropertiesResponse

    Containers List<Pulumi.AzureNative.ContainerInstance.Inputs.NGroupCGPropertyContainerResponse>
    Contains information about Container which can be set while creating or updating the NGroups.
    SubnetIds List<Pulumi.AzureNative.ContainerInstance.Inputs.ContainerGroupSubnetIdResponse>
    Contains information about Virtual Network Subnet ARM Resource
    Volumes List<Pulumi.AzureNative.ContainerInstance.Inputs.NGroupCGPropertyVolumeResponse>
    Contains information about the volumes that can be mounted by Containers in the Container Groups.
    Containers []NGroupCGPropertyContainerResponse
    Contains information about Container which can be set while creating or updating the NGroups.
    SubnetIds []ContainerGroupSubnetIdResponse
    Contains information about Virtual Network Subnet ARM Resource
    Volumes []NGroupCGPropertyVolumeResponse
    Contains information about the volumes that can be mounted by Containers in the Container Groups.
    containers List<NGroupCGPropertyContainerResponse>
    Contains information about Container which can be set while creating or updating the NGroups.
    subnetIds List<ContainerGroupSubnetIdResponse>
    Contains information about Virtual Network Subnet ARM Resource
    volumes List<NGroupCGPropertyVolumeResponse>
    Contains information about the volumes that can be mounted by Containers in the Container Groups.
    containers NGroupCGPropertyContainerResponse[]
    Contains information about Container which can be set while creating or updating the NGroups.
    subnetIds ContainerGroupSubnetIdResponse[]
    Contains information about Virtual Network Subnet ARM Resource
    volumes NGroupCGPropertyVolumeResponse[]
    Contains information about the volumes that can be mounted by Containers in the Container Groups.
    containers Sequence[NGroupCGPropertyContainerResponse]
    Contains information about Container which can be set while creating or updating the NGroups.
    subnet_ids Sequence[ContainerGroupSubnetIdResponse]
    Contains information about Virtual Network Subnet ARM Resource
    volumes Sequence[NGroupCGPropertyVolumeResponse]
    Contains information about the volumes that can be mounted by Containers in the Container Groups.
    containers List<Property Map>
    Contains information about Container which can be set while creating or updating the NGroups.
    subnetIds List<Property Map>
    Contains information about Virtual Network Subnet ARM Resource
    volumes List<Property Map>
    Contains information about the volumes that can be mounted by Containers in the Container Groups.

    NGroupIdentityResponse

    PrincipalId string
    The principal id of the NGroup identity. This property will only be provided for a system assigned identity.
    TenantId string
    The tenant id associated with the NGroup. This property will only be provided for a system assigned identity.
    Type string
    The type of identity used for the NGroup. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the NGroup.
    UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.ContainerInstance.Inputs.UserAssignedIdentitiesResponse>
    The list of user identities associated with the NGroup.
    PrincipalId string
    The principal id of the NGroup identity. This property will only be provided for a system assigned identity.
    TenantId string
    The tenant id associated with the NGroup. This property will only be provided for a system assigned identity.
    Type string
    The type of identity used for the NGroup. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the NGroup.
    UserAssignedIdentities map[string]UserAssignedIdentitiesResponse
    The list of user identities associated with the NGroup.
    principalId String
    The principal id of the NGroup identity. This property will only be provided for a system assigned identity.
    tenantId String
    The tenant id associated with the NGroup. This property will only be provided for a system assigned identity.
    type String
    The type of identity used for the NGroup. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the NGroup.
    userAssignedIdentities Map<String,UserAssignedIdentitiesResponse>
    The list of user identities associated with the NGroup.
    principalId string
    The principal id of the NGroup identity. This property will only be provided for a system assigned identity.
    tenantId string
    The tenant id associated with the NGroup. This property will only be provided for a system assigned identity.
    type string
    The type of identity used for the NGroup. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the NGroup.
    userAssignedIdentities {[key: string]: UserAssignedIdentitiesResponse}
    The list of user identities associated with the NGroup.
    principal_id str
    The principal id of the NGroup identity. This property will only be provided for a system assigned identity.
    tenant_id str
    The tenant id associated with the NGroup. This property will only be provided for a system assigned identity.
    type str
    The type of identity used for the NGroup. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the NGroup.
    user_assigned_identities Mapping[str, UserAssignedIdentitiesResponse]
    The list of user identities associated with the NGroup.
    principalId String
    The principal id of the NGroup identity. This property will only be provided for a system assigned identity.
    tenantId String
    The tenant id associated with the NGroup. This property will only be provided for a system assigned identity.
    type String
    The type of identity used for the NGroup. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the NGroup.
    userAssignedIdentities Map<Property Map>
    The list of user identities associated with the NGroup.

    NetworkProfileResponse

    ApplicationGateway Pulumi.AzureNative.ContainerInstance.Inputs.ApplicationGatewayResponse
    Application Gateway the CG profile will use to interact with CGs in a backend pool
    LoadBalancer Pulumi.AzureNative.ContainerInstance.Inputs.LoadBalancerResponse
    LoadBalancer the CG profile will use to interact with CGs in a backend pool
    ApplicationGateway ApplicationGatewayResponse
    Application Gateway the CG profile will use to interact with CGs in a backend pool
    LoadBalancer LoadBalancerResponse
    LoadBalancer the CG profile will use to interact with CGs in a backend pool
    applicationGateway ApplicationGatewayResponse
    Application Gateway the CG profile will use to interact with CGs in a backend pool
    loadBalancer LoadBalancerResponse
    LoadBalancer the CG profile will use to interact with CGs in a backend pool
    applicationGateway ApplicationGatewayResponse
    Application Gateway the CG profile will use to interact with CGs in a backend pool
    loadBalancer LoadBalancerResponse
    LoadBalancer the CG profile will use to interact with CGs in a backend pool
    application_gateway ApplicationGatewayResponse
    Application Gateway the CG profile will use to interact with CGs in a backend pool
    load_balancer LoadBalancerResponse
    LoadBalancer the CG profile will use to interact with CGs in a backend pool
    applicationGateway Property Map
    Application Gateway the CG profile will use to interact with CGs in a backend pool
    loadBalancer Property Map
    LoadBalancer the CG profile will use to interact with CGs in a backend pool

    PlacementProfileResponse

    FaultDomainCount int
    The number of fault domains to be used to spread CGs in the NGroups resource. This can only be specified during NGroup creation and is immutable after that.
    FaultDomainCount int
    The number of fault domains to be used to spread CGs in the NGroups resource. This can only be specified during NGroup creation and is immutable after that.
    faultDomainCount Integer
    The number of fault domains to be used to spread CGs in the NGroups resource. This can only be specified during NGroup creation and is immutable after that.
    faultDomainCount number
    The number of fault domains to be used to spread CGs in the NGroups resource. This can only be specified during NGroup creation and is immutable after that.
    fault_domain_count int
    The number of fault domains to be used to spread CGs in the NGroups resource. This can only be specified during NGroup creation and is immutable after that.
    faultDomainCount Number
    The number of fault domains to be used to spread CGs in the NGroups resource. This can only be specified during NGroup creation and is immutable after that.

    StorageProfileResponse

    SystemDataResponse

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    UpdateProfileResponse

    RollingUpdateProfile UpdateProfileResponseRollingUpdateProfile
    This profile allows the customers to customize the rolling update.
    UpdateMode string
    rollingUpdateProfile UpdateProfileResponseRollingUpdateProfile
    This profile allows the customers to customize the rolling update.
    updateMode String
    rollingUpdateProfile UpdateProfileResponseRollingUpdateProfile
    This profile allows the customers to customize the rolling update.
    updateMode string
    rolling_update_profile UpdateProfileResponseRollingUpdateProfile
    This profile allows the customers to customize the rolling update.
    update_mode str
    rollingUpdateProfile Property Map
    This profile allows the customers to customize the rolling update.
    updateMode String

    UpdateProfileResponseRollingUpdateProfile

    InPlaceUpdate bool
    Default is false. If set to true, the CGs will be updated in-place instead of creating new CG and deleting old ones.
    MaxBatchPercent int
    Maximum percentage of total Container Groups which can be updated simultaneously by rolling update in one batch.
    MaxUnhealthyPercent int
    Maximum percentage of the updated Container Groups which can be in unhealthy state after each batch is updated.
    PauseTimeBetweenBatches string
    The wait time between batches after completing the one batch of the rolling update and starting the next batch. The time duration should be specified in ISO 8601 format for duration.
    InPlaceUpdate bool
    Default is false. If set to true, the CGs will be updated in-place instead of creating new CG and deleting old ones.
    MaxBatchPercent int
    Maximum percentage of total Container Groups which can be updated simultaneously by rolling update in one batch.
    MaxUnhealthyPercent int
    Maximum percentage of the updated Container Groups which can be in unhealthy state after each batch is updated.
    PauseTimeBetweenBatches string
    The wait time between batches after completing the one batch of the rolling update and starting the next batch. The time duration should be specified in ISO 8601 format for duration.
    inPlaceUpdate Boolean
    Default is false. If set to true, the CGs will be updated in-place instead of creating new CG and deleting old ones.
    maxBatchPercent Integer
    Maximum percentage of total Container Groups which can be updated simultaneously by rolling update in one batch.
    maxUnhealthyPercent Integer
    Maximum percentage of the updated Container Groups which can be in unhealthy state after each batch is updated.
    pauseTimeBetweenBatches String
    The wait time between batches after completing the one batch of the rolling update and starting the next batch. The time duration should be specified in ISO 8601 format for duration.
    inPlaceUpdate boolean
    Default is false. If set to true, the CGs will be updated in-place instead of creating new CG and deleting old ones.
    maxBatchPercent number
    Maximum percentage of total Container Groups which can be updated simultaneously by rolling update in one batch.
    maxUnhealthyPercent number
    Maximum percentage of the updated Container Groups which can be in unhealthy state after each batch is updated.
    pauseTimeBetweenBatches string
    The wait time between batches after completing the one batch of the rolling update and starting the next batch. The time duration should be specified in ISO 8601 format for duration.
    in_place_update bool
    Default is false. If set to true, the CGs will be updated in-place instead of creating new CG and deleting old ones.
    max_batch_percent int
    Maximum percentage of total Container Groups which can be updated simultaneously by rolling update in one batch.
    max_unhealthy_percent int
    Maximum percentage of the updated Container Groups which can be in unhealthy state after each batch is updated.
    pause_time_between_batches str
    The wait time between batches after completing the one batch of the rolling update and starting the next batch. The time duration should be specified in ISO 8601 format for duration.
    inPlaceUpdate Boolean
    Default is false. If set to true, the CGs will be updated in-place instead of creating new CG and deleting old ones.
    maxBatchPercent Number
    Maximum percentage of total Container Groups which can be updated simultaneously by rolling update in one batch.
    maxUnhealthyPercent Number
    Maximum percentage of the updated Container Groups which can be in unhealthy state after each batch is updated.
    pauseTimeBetweenBatches String
    The wait time between batches after completing the one batch of the rolling update and starting the next batch. The time duration should be specified in ISO 8601 format for duration.

    UserAssignedIdentitiesResponse

    ClientId string
    The client id of user assigned identity.
    PrincipalId string
    The principal id of user assigned identity.
    ClientId string
    The client id of user assigned identity.
    PrincipalId string
    The principal id of user assigned identity.
    clientId String
    The client id of user assigned identity.
    principalId String
    The principal id of user assigned identity.
    clientId string
    The client id of user assigned identity.
    principalId string
    The principal id of user assigned identity.
    client_id str
    The client id of user assigned identity.
    principal_id str
    The principal id of user assigned identity.
    clientId String
    The client id of user assigned identity.
    principalId String
    The principal id of user assigned identity.

    VolumeMountResponse

    MountPath string
    The path within the container where the volume should be mounted. Must not contain colon (:).
    Name string
    The name of the volume mount.
    ReadOnly bool
    The flag indicating whether the volume mount is read-only.
    MountPath string
    The path within the container where the volume should be mounted. Must not contain colon (:).
    Name string
    The name of the volume mount.
    ReadOnly bool
    The flag indicating whether the volume mount is read-only.
    mountPath String
    The path within the container where the volume should be mounted. Must not contain colon (:).
    name String
    The name of the volume mount.
    readOnly Boolean
    The flag indicating whether the volume mount is read-only.
    mountPath string
    The path within the container where the volume should be mounted. Must not contain colon (:).
    name string
    The name of the volume mount.
    readOnly boolean
    The flag indicating whether the volume mount is read-only.
    mount_path str
    The path within the container where the volume should be mounted. Must not contain colon (:).
    name str
    The name of the volume mount.
    read_only bool
    The flag indicating whether the volume mount is read-only.
    mountPath String
    The path within the container where the volume should be mounted. Must not contain colon (:).
    name String
    The name of the volume mount.
    readOnly Boolean
    The flag indicating whether the volume mount is read-only.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Azure Native v3.10.1 published on Friday, Nov 7, 2025 by Pulumi
    Schema (JSON)
    pulumi/pulumi-azure-native
      Meet Neo: Your AI Platform Teammate