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.76.0 published on Friday, Dec 6, 2024 by Pulumi
azure-native.containerinstance.getNGroup
Explore with Pulumi AI
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.76.0 published on Friday, Dec 6, 2024 by Pulumi
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:
- Ngroups
Name string - The N Groups name.
- Resource
Group stringName - The name of the resource group.
- Ngroups
Name string - The N Groups name.
- Resource
Group stringName - The name of the resource group.
- ngroups
Name String - The N Groups name.
- resource
Group StringName - The name of the resource group.
- ngroups
Name string - The N Groups name.
- resource
Group stringName - The name of the resource group.
- ngroups_
name str - The N Groups name.
- resource_
group_ strname - The name of the resource group.
- ngroups
Name String - The N Groups name.
- resource
Group StringName - The name of the resource group.
getNGroup Result
The following output properties are available:
- Id string
- The resource id.
- Name string
- The resource name.
- Provisioning
State string - The provisioning state, which only appears in the response.
- System
Data Pulumi.Azure Native. Container Instance. Outputs. System Data Response - Metadata pertaining to creation and last modification of the resource.
- Type string
- The resource type.
- Container
Group List<Pulumi.Profiles Azure Native. Container Instance. Outputs. Container Group Profile Stub Response> - The Container Group Profiles that could be used in a nGroup.
- Elastic
Profile Pulumi.Azure Native. Container Instance. Outputs. Elastic Profile Response - The elastic profile.
- Identity
Pulumi.
Azure Native. Container Instance. Outputs. NGroup Identity Response - The identity of the nGroup, if configured.
- Location string
- The resource location.
- 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.
- Provisioning
State string - The provisioning state, which only appears in the response.
- System
Data SystemData Response - Metadata pertaining to creation and last modification of the resource.
- Type string
- The resource type.
- Container
Group []ContainerProfiles Group Profile Stub Response - The Container Group Profiles that could be used in a nGroup.
- Elastic
Profile ElasticProfile Response - The elastic profile.
- Identity
NGroup
Identity Response - The identity of the nGroup, if configured.
- Location string
- The resource location.
- map[string]string
- The resource tags.
- Zones []string
- The zones for the container group.
- id String
- The resource id.
- name String
- The resource name.
- provisioning
State String - The provisioning state, which only appears in the response.
- system
Data SystemData Response - Metadata pertaining to creation and last modification of the resource.
- type String
- The resource type.
- container
Group List<ContainerProfiles Group Profile Stub Response> - The Container Group Profiles that could be used in a nGroup.
- elastic
Profile ElasticProfile Response - The elastic profile.
- identity
NGroup
Identity Response - The identity of the nGroup, if configured.
- location String
- The resource location.
- 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.
- provisioning
State string - The provisioning state, which only appears in the response.
- system
Data SystemData Response - Metadata pertaining to creation and last modification of the resource.
- type string
- The resource type.
- container
Group ContainerProfiles Group Profile Stub Response[] - The Container Group Profiles that could be used in a nGroup.
- elastic
Profile ElasticProfile Response - The elastic profile.
- identity
NGroup
Identity Response - The identity of the nGroup, if configured.
- location string
- The resource location.
- {[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 SystemData Response - Metadata pertaining to creation and last modification of the resource.
- type str
- The resource type.
- container_
group_ Sequence[Containerprofiles Group Profile Stub Response] - The Container Group Profiles that could be used in a nGroup.
- elastic_
profile ElasticProfile Response - The elastic profile.
- identity
NGroup
Identity Response - The identity of the nGroup, if configured.
- location str
- The resource location.
- 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.
- provisioning
State String - The provisioning state, which only appears in the response.
- system
Data Property Map - Metadata pertaining to creation and last modification of the resource.
- type String
- The resource type.
- container
Group List<Property Map>Profiles - The Container Group Profiles that could be used in a nGroup.
- elastic
Profile Property Map - The elastic profile.
- identity Property Map
- The identity of the nGroup, if configured.
- location String
- The resource location.
- 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
Pulumi.
Azure Native. Container Instance. Inputs. Api Entity Reference Response - The API entity reference.
- Resource
Api
Entity Reference Response - The API entity reference.
- resource
Api
Entity Reference Response - The API entity reference.
- resource
Api
Entity Reference Response - The API entity reference.
- resource
Api
Entity Reference Response - The API entity reference.
- resource Property Map
- The API entity reference.
ElasticProfileResponse
- Desired
Count int
- Desired
Count int
- desired
Count Integer
- desired
Count number
- desired_
count int
- desired
Count Number
NGroupIdentityResponse
- Principal
Id string - The principal id of the nGroup identity. This property will only be provided for a system assigned identity.
- Tenant
Id 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.
- User
Assigned Dictionary<string, Pulumi.Identities Azure Native. Container Instance. Inputs. User Assigned Identity Response> - 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 string - The principal id of the nGroup identity. This property will only be provided for a system assigned identity.
- Tenant
Id 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.
- User
Assigned map[string]UserIdentities Assigned Identity Response - 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 String - The principal id of the nGroup identity. This property will only be provided for a system assigned identity.
- tenant
Id 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.
- user
Assigned Map<String,UserIdentities Assigned Identity Response> - 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 string - The principal id of the nGroup identity. This property will only be provided for a system assigned identity.
- tenant
Id 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.
- user
Assigned {[key: string]: UserIdentities Assigned Identity Response} - 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_ Mapping[str, Useridentities Assigned Identity Response] - 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 String - The principal id of the nGroup identity. This property will only be provided for a system assigned identity.
- tenant
Id 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.
- user
Assigned Map<Property Map>Identities - 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
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - 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_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
UserAssignedIdentityResponse
- Client
Id string - The client ID of the assigned identity.
- Principal
Id string - The principal ID of the assigned identity.
- Client
Id string - The client ID of the assigned identity.
- Principal
Id string - The principal ID of the assigned identity.
- client
Id String - The client ID of the assigned identity.
- principal
Id String - The principal ID of the assigned identity.
- client
Id string - The client ID of the assigned identity.
- principal
Id 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.
- client
Id String - The client ID of the assigned identity.
- principal
Id String - The principal ID of the assigned identity.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0
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.76.0 published on Friday, Dec 6, 2024 by Pulumi