Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. containerinstance
  5. getNGroup
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
pulumi/pulumi-azure-native

azure-native.containerinstance.getNGroup

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
pulumi/pulumi-azure-native

    Get the properties of the specified n group. Azure REST API version: 2024-09-01-preview.

    Other available API versions: 2024-11-01-preview.

    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)
// Output-based functions aren't available in Java yet

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

    The following arguments are supported:

    NgroupsName string
    The N Groups name.
    ResourceGroupName string
    The name of the resource group.
    NgroupsName string
    The N Groups name.
    ResourceGroupName string
    The name of the resource group.
    ngroupsName String
    The N Groups name.
    resourceGroupName String
    The name of the resource group.
    ngroupsName string
    The N Groups name.
    resourceGroupName string
    The name of the resource group.
    ngroups_name str
    The N Groups name.
    resource_group_name str
    The name of the resource group.
    ngroupsName String
    The N Groups name.
    resourceGroupName String
    The name of the resource group.

    getNGroup Result

    The following output properties are available:

    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 a nGroup.
    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.
    Tags Dictionary<string, string>
    The resource tags.
    Zones List<string>
    The zones for the container group.
    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 a nGroup.
    ElasticProfile ElasticProfileResponse
    The elastic profile.
    Identity NGroupIdentityResponse
    The identity of the nGroup, if configured.
    Location string
    The resource location.
    Tags map[string]string
    The resource tags.
    Zones []string
    The zones for the container group.
    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 a nGroup.
    elasticProfile ElasticProfileResponse
    The elastic profile.
    identity NGroupIdentityResponse
    The identity of the nGroup, if configured.
    location String
    The resource location.
    tags Map<String,String>
    The resource tags.
    zones List<String>
    The zones for the container group.
    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 a nGroup.
    elasticProfile ElasticProfileResponse
    The elastic profile.
    identity NGroupIdentityResponse
    The identity of the nGroup, if configured.
    location string
    The resource location.
    tags {[key: string]: string}
    The resource tags.
    zones string[]
    The zones for the container group.
    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 a nGroup.
    elastic_profile ElasticProfileResponse
    The elastic profile.
    identity NGroupIdentityResponse
    The identity of the nGroup, if configured.
    location str
    The resource location.
    tags Mapping[str, str]
    The resource tags.
    zones Sequence[str]
    The zones for the container group.
    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 a nGroup.
    elasticProfile Property Map
    The elastic profile.
    identity Property Map
    The identity of the nGroup, if configured.
    location String
    The resource location.
    tags Map<String>
    The resource tags.
    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}/...

    ContainerGroupProfileStubResponse

    Resource ApiEntityReferenceResponse
    The API entity reference.
    resource ApiEntityReferenceResponse
    The API entity reference.
    resource ApiEntityReferenceResponse
    The API entity reference.
    resource ApiEntityReferenceResponse
    The API entity reference.
    resource Property Map
    The API entity reference.

    ElasticProfileResponse

    desiredCount Integer

    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 container scale set. 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.UserAssignedIdentityResponse>
    The list of user identities associated with the container scale set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
    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 container scale set. 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]UserAssignedIdentityResponse
    The list of user identities associated with the container scale set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
    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 container scale set. 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,UserAssignedIdentityResponse>
    The list of user identities associated with the container scale set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
    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 container scale set. 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]: UserAssignedIdentityResponse}
    The list of user identities associated with the container scale set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
    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 container scale set. 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, UserAssignedIdentityResponse]
    The list of user identities associated with the container scale set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
    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 container scale set. 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 container scale set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

    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.

    UserAssignedIdentityResponse

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

    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 v1 docs if using the v1 version of this package.
    Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi
    pulumi/pulumi-azure-native