Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v1
  3. API Docs
  4. resources
  5. Resource
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

azure-native.resources.Resource

Explore with Pulumi AI

azure-native-v1 logo
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

    Resource information. API Version: 2019-05-01.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:resources:Resource myresource1 /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}

    Create Resource Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Resource(name: string, args: ResourceArgs, opts?: CustomResourceOptions);
    @overload
def Resource(resource_name: str,
             args: ResourceArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Resource(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             parent_resource_path: Optional[str] = None,
             resource_type: Optional[str] = None,
             resource_provider_namespace: Optional[str] = None,
             resource_group_name: Optional[str] = None,
             managed_by: Optional[str] = None,
             plan: Optional[PlanArgs] = None,
             properties: Optional[Any] = None,
             identity: Optional[IdentityArgs] = None,
             resource_name_: Optional[str] = None,
             location: Optional[str] = None,
             kind: Optional[str] = None,
             sku: Optional[SkuArgs] = None,
             tags: Optional[Mapping[str, str]] = None)
    func NewResource(ctx *Context, name string, args ResourceArgs, opts ...ResourceOption) (*Resource, error)
    public Resource(string name, ResourceArgs args, CustomResourceOptions? opts = null)
    public Resource(String name, ResourceArgs args)
public Resource(String name, ResourceArgs args, CustomResourceOptions options)

    type: azure-native:resources:Resource
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ResourceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ResourceArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ResourceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ResourceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ResourceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var resourceResource = new AzureNative.Resources.Resource("resourceResource", new()
{
    ParentResourcePath = "string",
    ResourceType = "string",
    ResourceProviderNamespace = "string",
    ResourceGroupName = "string",
    ManagedBy = "string",
    Plan = 
    {
        { "name", "string" },
        { "product", "string" },
        { "promotionCode", "string" },
        { "publisher", "string" },
        { "version", "string" },
    },
    Properties = "any",
    Identity = 
    {
        { "type", "SystemAssigned" },
        { "userAssignedIdentities", 
        {
            { "string", "any" },
        } },
    },
    ResourceName = "string",
    Location = "string",
    Kind = "string",
    Sku = 
    {
        { "capacity", 0 },
        { "family", "string" },
        { "model", "string" },
        { "name", "string" },
        { "size", "string" },
        { "tier", "string" },
    },
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := resources.NewResource(ctx, "resourceResource", &resources.ResourceArgs{
	ParentResourcePath:        "string",
	ResourceType:              "string",
	ResourceProviderNamespace: "string",
	ResourceGroupName:         "string",
	ManagedBy:                 "string",
	Plan: map[string]interface{}{
		"name":          "string",
		"product":       "string",
		"promotionCode": "string",
		"publisher":     "string",
		"version":       "string",
	},
	Properties: "any",
	Identity: map[string]interface{}{
		"type": "SystemAssigned",
		"userAssignedIdentities": map[string]interface{}{
			"string": "any",
		},
	},
	ResourceName: "string",
	Location:     "string",
	Kind:         "string",
	Sku: map[string]interface{}{
		"capacity": 0,
		"family":   "string",
		"model":    "string",
		"name":     "string",
		"size":     "string",
		"tier":     "string",
	},
	Tags: map[string]interface{}{
		"string": "string",
	},
})

    var resourceResource = new Resource("resourceResource", ResourceArgs.builder()
    .parentResourcePath("string")
    .resourceType("string")
    .resourceProviderNamespace("string")
    .resourceGroupName("string")
    .managedBy("string")
    .plan(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .properties("any")
    .identity(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .resourceName("string")
    .location("string")
    .kind("string")
    .sku(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .tags(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .build());

    resource_resource = azure_native.resources.Resource("resourceResource",
    parent_resource_path=string,
    resource_type=string,
    resource_provider_namespace=string,
    resource_group_name=string,
    managed_by=string,
    plan={
        name: string,
        product: string,
        promotionCode: string,
        publisher: string,
        version: string,
    },
    properties=any,
    identity={
        type: SystemAssigned,
        userAssignedIdentities: {
            string: any,
        },
    },
    resource_name_=string,
    location=string,
    kind=string,
    sku={
        capacity: 0,
        family: string,
        model: string,
        name: string,
        size: string,
        tier: string,
    },
    tags={
        string: string,
    })

    const resourceResource = new azure_native.resources.Resource("resourceResource", {
    parentResourcePath: "string",
    resourceType: "string",
    resourceProviderNamespace: "string",
    resourceGroupName: "string",
    managedBy: "string",
    plan: {
        name: "string",
        product: "string",
        promotionCode: "string",
        publisher: "string",
        version: "string",
    },
    properties: "any",
    identity: {
        type: "SystemAssigned",
        userAssignedIdentities: {
            string: "any",
        },
    },
    resourceName: "string",
    location: "string",
    kind: "string",
    sku: {
        capacity: 0,
        family: "string",
        model: "string",
        name: "string",
        size: "string",
        tier: "string",
    },
    tags: {
        string: "string",
    },
});

    type: azure-native:resources:Resource
properties:
    identity:
        type: SystemAssigned
        userAssignedIdentities:
            string: any
    kind: string
    location: string
    managedBy: string
    parentResourcePath: string
    plan:
        name: string
        product: string
        promotionCode: string
        publisher: string
        version: string
    properties: any
    resourceGroupName: string
    resourceName: string
    resourceProviderNamespace: string
    resourceType: string
    sku:
        capacity: 0
        family: string
        model: string
        name: string
        size: string
        tier: string
    tags:
        string: string

    Resource Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Resource resource accepts the following input properties:

    ParentResourcePath string
    The parent resource identity.
    ResourceGroupName string
    The name of the resource group for the resource. The name is case insensitive.
    ResourceProviderNamespace string
    The namespace of the resource provider.
    ResourceType string
    The resource type of the resource to create.
    Identity Pulumi.AzureNative.Resources.Inputs.Identity
    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.Inputs.Plan
    The plan of the resource.
    Properties object
    The resource properties.
    ResourceName string
    The name of the resource to create.
    Sku Pulumi.AzureNative.Resources.Inputs.Sku
    The SKU of the resource.
    Tags Dictionary<string, string>
    Resource tags
    ParentResourcePath string
    The parent resource identity.
    ResourceGroupName string
    The name of the resource group for the resource. The name is case insensitive.
    ResourceProviderNamespace string
    The namespace of the resource provider.
    ResourceType string
    The resource type of the resource to create.
    Identity IdentityArgs
    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 PlanArgs
    The plan of the resource.
    Properties interface{}
    The resource properties.
    ResourceName string
    The name of the resource to create.
    Sku SkuArgs
    The SKU of the resource.
    Tags map[string]string
    Resource tags
    parentResourcePath String
    The parent resource identity.
    resourceGroupName String
    The name of the resource group for the resource. The name is case insensitive.
    resourceProviderNamespace String
    The namespace of the resource provider.
    resourceType String
    The resource type of the resource to create.
    identity Identity
    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 Plan
    The plan of the resource.
    properties Object
    The resource properties.
    resourceName String
    The name of the resource to create.
    sku Sku
    The SKU of the resource.
    tags Map<String,String>
    Resource tags
    parentResourcePath string
    The parent resource identity.
    resourceGroupName string
    The name of the resource group for the resource. The name is case insensitive.
    resourceProviderNamespace string
    The namespace of the resource provider.
    resourceType string
    The resource type of the resource to create.
    identity Identity
    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 Plan
    The plan of the resource.
    properties any
    The resource properties.
    resourceName string
    The name of the resource to create.
    sku Sku
    The SKU of the resource.
    tags {[key: string]: string}
    Resource tags
    parent_resource_path str
    The parent resource identity.
    resource_group_name str
    The name of the resource group for the resource. The name is case insensitive.
    resource_provider_namespace str
    The namespace of the resource provider.
    resource_type str
    The resource type of the resource to create.
    identity IdentityArgs
    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 PlanArgs
    The plan of the resource.
    properties Any
    The resource properties.
    resource_name str
    The name of the resource to create.
    sku SkuArgs
    The SKU of the resource.
    tags Mapping[str, str]
    Resource tags
    parentResourcePath String
    The parent resource identity.
    resourceGroupName String
    The name of the resource group for the resource. The name is case insensitive.
    resourceProviderNamespace String
    The namespace of the resource provider.
    resourceType String
    The resource type of the resource to create.
    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.
    properties Any
    The resource properties.
    resourceName String
    The name of the resource to create.
    sku Property Map
    The SKU of the resource.
    tags Map<String>
    Resource tags

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Resource resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Resource name
    Type string
    Resource type
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Resource name
    Type string
    Resource type
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Resource name
    type String
    Resource type
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Resource name
    type string
    Resource type
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    Resource name
    type str
    Resource type
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Resource name
    type String
    Resource type

    Supporting Types

    Identity, IdentityArgs

    Type Pulumi.AzureNative.Resources.ResourceIdentityType
    The identity type.
    UserAssignedIdentities Dictionary<string, object>
    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}'.
    Type ResourceIdentityType
    The identity type.
    UserAssignedIdentities map[string]interface{}
    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}'.
    type ResourceIdentityType
    The identity type.
    userAssignedIdentities Map<String,Object>
    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}'.
    type ResourceIdentityType
    The identity type.
    userAssignedIdentities {[key: string]: any}
    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}'.
    type ResourceIdentityType
    The identity type.
    user_assigned_identities Mapping[str, Any]
    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}'.
    type "SystemAssigned" | "UserAssigned" | "SystemAssigned, UserAssigned" | "None"
    The identity type.
    userAssignedIdentities Map<Any>
    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}'.

    IdentityResponse, IdentityResponseArgs

    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, IdentityResponseUserAssignedIdentitiesArgs

    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.

    Plan, PlanArgs

    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.

    PlanResponse, PlanResponseArgs

    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.

    ResourceIdentityType, ResourceIdentityTypeArgs

    SystemAssigned
    SystemAssigned
    UserAssigned
    UserAssigned
    SystemAssigned_UserAssigned
    SystemAssigned, UserAssigned
    None
    None
    ResourceIdentityTypeSystemAssigned
    SystemAssigned
    ResourceIdentityTypeUserAssigned
    UserAssigned
    ResourceIdentityType_SystemAssigned_UserAssigned
    SystemAssigned, UserAssigned
    ResourceIdentityTypeNone
    None
    SystemAssigned
    SystemAssigned
    UserAssigned
    UserAssigned
    SystemAssigned_UserAssigned
    SystemAssigned, UserAssigned
    None
    None
    SystemAssigned
    SystemAssigned
    UserAssigned
    UserAssigned
    SystemAssigned_UserAssigned
    SystemAssigned, UserAssigned
    None
    None
    SYSTEM_ASSIGNED
    SystemAssigned
    USER_ASSIGNED
    UserAssigned
    SYSTEM_ASSIGNED_USER_ASSIGNED
    SystemAssigned, UserAssigned
    NONE
    None
    "SystemAssigned"
    SystemAssigned
    "UserAssigned"
    UserAssigned
    "SystemAssigned, UserAssigned"
    SystemAssigned, UserAssigned
    "None"
    None

    Sku, SkuArgs

    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.

    SkuResponse, SkuResponseArgs

    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-v1 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native-v1 logo
    These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
    Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
    pulumi/pulumi-azure-native