Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. resources
  5. getResource
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.3.0 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.resources.getResource

Explore with Pulumi AI

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.3.0 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-azure-native

    Gets a resource.

    Uses Azure REST API version 2024-03-01.

    Other available API versions: 2020-10-01, 2021-01-01, 2021-04-01, 2022-09-01, 2023-07-01, 2024-07-01, 2024-11-01, 2025-03-01, 2025-04-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native resources [ApiVersion]. See the version guide for details.

    Using getResource

    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 getResource(args: GetResourceArgs, opts?: InvokeOptions): Promise<GetResourceResult>
function getResourceOutput(args: GetResourceOutputArgs, opts?: InvokeOptions): Output<GetResourceResult>
    def get_resource(api_version: Optional[str] = None,
                 parent_resource_path: Optional[str] = None,
                 resource_group_name: Optional[str] = None,
                 resource_name: Optional[str] = None,
                 resource_provider_namespace: Optional[str] = None,
                 resource_type: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetResourceResult
def get_resource_output(api_version: Optional[pulumi.Input[str]] = None,
                 parent_resource_path: Optional[pulumi.Input[str]] = None,
                 resource_group_name: Optional[pulumi.Input[str]] = None,
                 resource_name: Optional[pulumi.Input[str]] = None,
                 resource_provider_namespace: Optional[pulumi.Input[str]] = None,
                 resource_type: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetResourceResult]
    func LookupResource(ctx *Context, args *LookupResourceArgs, opts ...InvokeOption) (*LookupResourceResult, error)
func LookupResourceOutput(ctx *Context, args *LookupResourceOutputArgs, opts ...InvokeOption) LookupResourceResultOutput

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

    public static class GetResource 
{
    public static Task<GetResourceResult> InvokeAsync(GetResourceArgs args, InvokeOptions? opts = null)
    public static Output<GetResourceResult> Invoke(GetResourceInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetResourceResult> getResource(GetResourceArgs args, InvokeOptions options)
public static Output<GetResourceResult> getResource(GetResourceArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:resources:getResource
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ApiVersion string
    The API version to use for the operation.
    ParentResourcePath string
    The parent resource identity.
    ResourceGroupName string
    The name of the resource group containing the resource to get. The name is case insensitive.
    ResourceName string
    The name of the resource to get.
    ResourceProviderNamespace string
    The namespace of the resource provider.
    ResourceType string
    The resource type of the resource.
    ApiVersion string
    The API version to use for the operation.
    ParentResourcePath string
    The parent resource identity.
    ResourceGroupName string
    The name of the resource group containing the resource to get. The name is case insensitive.
    ResourceName string
    The name of the resource to get.
    ResourceProviderNamespace string
    The namespace of the resource provider.
    ResourceType string
    The resource type of the resource.
    apiVersion String
    The API version to use for the operation.
    parentResourcePath String
    The parent resource identity.
    resourceGroupName String
    The name of the resource group containing the resource to get. The name is case insensitive.
    resourceName String
    The name of the resource to get.
    resourceProviderNamespace String
    The namespace of the resource provider.
    resourceType String
    The resource type of the resource.
    apiVersion string
    The API version to use for the operation.
    parentResourcePath string
    The parent resource identity.
    resourceGroupName string
    The name of the resource group containing the resource to get. The name is case insensitive.
    resourceName string
    The name of the resource to get.
    resourceProviderNamespace string
    The namespace of the resource provider.
    resourceType string
    The resource type of the resource.
    api_version str
    The API version to use for the operation.
    parent_resource_path str
    The parent resource identity.
    resource_group_name str
    The name of the resource group containing the resource to get. The name is case insensitive.
    resource_name str
    The name of the resource to get.
    resource_provider_namespace str
    The namespace of the resource provider.
    resource_type str
    The resource type of the resource.
    apiVersion String
    The API version to use for the operation.
    parentResourcePath String
    The parent resource identity.
    resourceGroupName String
    The name of the resource group containing the resource to get. The name is case insensitive.
    resourceName String
    The name of the resource to get.
    resourceProviderNamespace String
    The namespace of the resource provider.
    resourceType String
    The resource type of the resource.

    getResource Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Resource ID
    Name string
    Resource name
    Properties object
    The resource properties.
    Type string
    Resource type
    ExtendedLocation Pulumi.AzureNative.Resources.Outputs.ExtendedLocationResponse
    Resource extended location.
    Identity Pulumi.AzureNative.Resources.Outputs.IdentityResponse
    The identity of the resource.
    Kind string
    The kind of the resource.
    Location string
    Resource location
    ManagedBy string
    ID of the resource that manages this resource.
    Plan Pulumi.AzureNative.Resources.Outputs.PlanResponse
    The plan of the resource.
    Sku Pulumi.AzureNative.Resources.Outputs.SkuResponse
    The SKU of the resource.
    Tags Dictionary<string, string>
    Resource tags
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Resource ID
    Name string
    Resource name
    Properties interface{}
    The resource properties.
    Type string
    Resource type
    ExtendedLocation ExtendedLocationResponse
    Resource extended location.
    Identity IdentityResponse
    The identity of the resource.
    Kind string
    The kind of the resource.
    Location string
    Resource location
    ManagedBy string
    ID of the resource that manages this resource.
    Plan PlanResponse
    The plan of the resource.
    Sku SkuResponse
    The SKU of the resource.
    Tags map[string]string
    Resource tags
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Resource ID
    name String
    Resource name
    properties Object
    The resource properties.
    type String
    Resource type
    extendedLocation ExtendedLocationResponse
    Resource extended location.
    identity IdentityResponse
    The identity of the resource.
    kind String
    The kind of the resource.
    location String
    Resource location
    managedBy String
    ID of the resource that manages this resource.
    plan PlanResponse
    The plan of the resource.
    sku SkuResponse
    The SKU of the resource.
    tags Map<String,String>
    Resource tags
    azureApiVersion string
    The Azure API version of the resource.
    id string
    Resource ID
    name string
    Resource name
    properties any
    The resource properties.
    type string
    Resource type
    extendedLocation ExtendedLocationResponse
    Resource extended location.
    identity IdentityResponse
    The identity of the resource.
    kind string
    The kind of the resource.
    location string
    Resource location
    managedBy string
    ID of the resource that manages this resource.
    plan PlanResponse
    The plan of the resource.
    sku SkuResponse
    The SKU of the resource.
    tags {[key: string]: string}
    Resource tags
    azure_api_version str
    The Azure API version of the resource.
    id str
    Resource ID
    name str
    Resource name
    properties Any
    The resource properties.
    type str
    Resource type
    extended_location ExtendedLocationResponse
    Resource extended location.
    identity IdentityResponse
    The identity of the resource.
    kind str
    The kind of the resource.
    location str
    Resource location
    managed_by str
    ID of the resource that manages this resource.
    plan PlanResponse
    The plan of the resource.
    sku SkuResponse
    The SKU of the resource.
    tags Mapping[str, str]
    Resource tags
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Resource ID
    name String
    Resource name
    properties Any
    The resource properties.
    type String
    Resource type
    extendedLocation Property Map
    Resource extended location.
    identity Property Map
    The identity of the resource.
    kind String
    The kind of the resource.
    location String
    Resource location
    managedBy String
    ID of the resource that manages this resource.
    plan Property Map
    The plan of the resource.
    sku Property Map
    The SKU of the resource.
    tags Map<String>
    Resource tags

    Supporting Types

    ExtendedLocationResponse

    Name string
    The extended location name.
    Type string
    The extended location type.
    Name string
    The extended location name.
    Type string
    The extended location type.
    name String
    The extended location name.
    type String
    The extended location type.
    name string
    The extended location name.
    type string
    The extended location type.
    name str
    The extended location name.
    type str
    The extended location type.
    name String
    The extended location name.
    type String
    The extended location type.

    IdentityResponse

    PrincipalId string
    The principal ID of resource identity.
    TenantId string
    The tenant ID of resource.
    Type string
    The identity type.
    UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.Resources.Inputs.IdentityResponseUserAssignedIdentities>
    The list of user identities associated with the resource. 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 resource identity.
    TenantId string
    The tenant ID of resource.
    Type string
    The identity type.
    UserAssignedIdentities map[string]IdentityResponseUserAssignedIdentities
    The list of user identities associated with the resource. 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 resource identity.
    tenantId String
    The tenant ID of resource.
    type String
    The identity type.
    userAssignedIdentities Map<String,IdentityResponseUserAssignedIdentities>
    The list of user identities associated with the resource. 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 resource identity.
    tenantId string
    The tenant ID of resource.
    type string
    The identity type.
    userAssignedIdentities {[key: string]: IdentityResponseUserAssignedIdentities}
    The list of user identities associated with the resource. 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 resource identity.
    tenant_id str
    The tenant ID of resource.
    type str
    The identity type.
    user_assigned_identities Mapping[str, IdentityResponseUserAssignedIdentities]
    The list of user identities associated with the resource. 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 resource identity.
    tenantId String
    The tenant ID of resource.
    type String
    The identity type.
    userAssignedIdentities Map<Property Map>
    The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

    IdentityResponseUserAssignedIdentities

    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.

    PlanResponse

    Name string
    The plan ID.
    Product string
    The offer ID.
    PromotionCode string
    The promotion code.
    Publisher string
    The publisher ID.
    Version string
    The plan's version.
    Name string
    The plan ID.
    Product string
    The offer ID.
    PromotionCode string
    The promotion code.
    Publisher string
    The publisher ID.
    Version string
    The plan's version.
    name String
    The plan ID.
    product String
    The offer ID.
    promotionCode String
    The promotion code.
    publisher String
    The publisher ID.
    version String
    The plan's version.
    name string
    The plan ID.
    product string
    The offer ID.
    promotionCode string
    The promotion code.
    publisher string
    The publisher ID.
    version string
    The plan's version.
    name str
    The plan ID.
    product str
    The offer ID.
    promotion_code str
    The promotion code.
    publisher str
    The publisher ID.
    version str
    The plan's version.
    name String
    The plan ID.
    product String
    The offer ID.
    promotionCode String
    The promotion code.
    publisher String
    The publisher ID.
    version String
    The plan's version.

    SkuResponse

    Capacity int
    The SKU capacity.
    Family string
    The SKU family.
    Model string
    The SKU model.
    Name string
    The SKU name.
    Size string
    The SKU size.
    Tier string
    The SKU tier.
    Capacity int
    The SKU capacity.
    Family string
    The SKU family.
    Model string
    The SKU model.
    Name string
    The SKU name.
    Size string
    The SKU size.
    Tier string
    The SKU tier.
    capacity Integer
    The SKU capacity.
    family String
    The SKU family.
    model String
    The SKU model.
    name String
    The SKU name.
    size String
    The SKU size.
    tier String
    The SKU tier.
    capacity number
    The SKU capacity.
    family string
    The SKU family.
    model string
    The SKU model.
    name string
    The SKU name.
    size string
    The SKU size.
    tier string
    The SKU tier.
    capacity int
    The SKU capacity.
    family str
    The SKU family.
    model str
    The SKU model.
    name str
    The SKU name.
    size str
    The SKU size.
    tier str
    The SKU tier.
    capacity Number
    The SKU capacity.
    family String
    The SKU family.
    model String
    The SKU model.
    name String
    The SKU name.
    size String
    The SKU size.
    tier String
    The SKU tier.

    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.3.0 published on Monday, Apr 28, 2025 by Pulumi
    pulumi/pulumi-azure-native