azapi.getResource

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.

Type string

It is in a format like <resource-type>@<api-version>. <resource-type> is the Azure resource type, for example, Microsoft.Storage/storageAccounts. <api-version> is version of the API used to manage this azure resource.

Identity ediri.Azapi.Inputs.GetResourceIdentity

An identity block as defined below, which contains the Managed Service Identity information for this azure resource.

Name string

Specifies the name of the azure resource.

ParentId string

The ID of the azure resource in which this resource is created. It supports different kinds of deployment scope for top level resources:

• resource group scope: parent_id should be the ID of a resource group, it's recommended to manage a resource group by azurerm_resource_group.
• management group scope: parent_id should be the ID of a management group, it's recommended to manage a management group by azurerm_management_group.
• extension scope: parent_id should be the ID of the resource you're adding the extension to.
• subscription scope: parent_id should be like /subscriptions/00000000-0000-0000-0000-000000000000
• tenant scope: parent_id should be /

For child level resources, the parent_id should be the ID of its parent resource, for example, subnet resource's parent_id is the ID of the vnet.

For type Microsoft.Resources/resourceGroups, the parent_id could be omitted, it defaults to subscription ID specified in provider or the default subscription(You could check the default subscription by azure cli command: az account show).

ResourceId string

The ID of an existing azure source.

Note: Configuring name and parent_id is an alternative way to configure resource_id.

ResponseExportValues List<string>

A list of path that needs to be exported from response body. Setting it to ["*"] will export the full response body. Here's an example. If it sets to ["properties.loginServer", "properties.policies.quarantinePolicy.status"], it will set the following json to computed property output.

{
"properties" : {
"loginServer" : "registry1.azurecr.io"
"policies" : {
"quarantinePolicy" = {
"status" = "disabled"
}
}
}
}

Type string

It is in a format like <resource-type>@<api-version>. <resource-type> is the Azure resource type, for example, Microsoft.Storage/storageAccounts. <api-version> is version of the API used to manage this azure resource.

Identity GetResourceIdentity

An identity block as defined below, which contains the Managed Service Identity information for this azure resource.

Name string

Specifies the name of the azure resource.

ParentId string

The ID of the azure resource in which this resource is created. It supports different kinds of deployment scope for top level resources:

• resource group scope: parent_id should be the ID of a resource group, it's recommended to manage a resource group by azurerm_resource_group.
• management group scope: parent_id should be the ID of a management group, it's recommended to manage a management group by azurerm_management_group.
• extension scope: parent_id should be the ID of the resource you're adding the extension to.
• subscription scope: parent_id should be like /subscriptions/00000000-0000-0000-0000-000000000000
• tenant scope: parent_id should be /

For child level resources, the parent_id should be the ID of its parent resource, for example, subnet resource's parent_id is the ID of the vnet.

For type Microsoft.Resources/resourceGroups, the parent_id could be omitted, it defaults to subscription ID specified in provider or the default subscription(You could check the default subscription by azure cli command: az account show).

ResourceId string

The ID of an existing azure source.

Note: Configuring name and parent_id is an alternative way to configure resource_id.

ResponseExportValues []string

A list of path that needs to be exported from response body. Setting it to ["*"] will export the full response body. Here's an example. If it sets to ["properties.loginServer", "properties.policies.quarantinePolicy.status"], it will set the following json to computed property output.

{
"properties" : {
"loginServer" : "registry1.azurecr.io"
"policies" : {
"quarantinePolicy" = {
"status" = "disabled"
}
}
}
}

type String

It is in a format like <resource-type>@<api-version>. <resource-type> is the Azure resource type, for example, Microsoft.Storage/storageAccounts. <api-version> is version of the API used to manage this azure resource.

identity GetResourceIdentity

An identity block as defined below, which contains the Managed Service Identity information for this azure resource.

name String

Specifies the name of the azure resource.

parentId String

The ID of the azure resource in which this resource is created. It supports different kinds of deployment scope for top level resources:

• resource group scope: parent_id should be the ID of a resource group, it's recommended to manage a resource group by azurerm_resource_group.
• management group scope: parent_id should be the ID of a management group, it's recommended to manage a management group by azurerm_management_group.
• extension scope: parent_id should be the ID of the resource you're adding the extension to.
• subscription scope: parent_id should be like /subscriptions/00000000-0000-0000-0000-000000000000
• tenant scope: parent_id should be /

For child level resources, the parent_id should be the ID of its parent resource, for example, subnet resource's parent_id is the ID of the vnet.

For type Microsoft.Resources/resourceGroups, the parent_id could be omitted, it defaults to subscription ID specified in provider or the default subscription(You could check the default subscription by azure cli command: az account show).

resourceId String

The ID of an existing azure source.

Note: Configuring name and parent_id is an alternative way to configure resource_id.

responseExportValues List<String>

A list of path that needs to be exported from response body. Setting it to ["*"] will export the full response body. Here's an example. If it sets to ["properties.loginServer", "properties.policies.quarantinePolicy.status"], it will set the following json to computed property output.

{
"properties" : {
"loginServer" : "registry1.azurecr.io"
"policies" : {
"quarantinePolicy" = {
"status" = "disabled"
}
}
}
}

type string

It is in a format like <resource-type>@<api-version>. <resource-type> is the Azure resource type, for example, Microsoft.Storage/storageAccounts. <api-version> is version of the API used to manage this azure resource.

identity GetResourceIdentity

An identity block as defined below, which contains the Managed Service Identity information for this azure resource.

name string

Specifies the name of the azure resource.

parentId string

The ID of the azure resource in which this resource is created. It supports different kinds of deployment scope for top level resources:

• resource group scope: parent_id should be the ID of a resource group, it's recommended to manage a resource group by azurerm_resource_group.
• management group scope: parent_id should be the ID of a management group, it's recommended to manage a management group by azurerm_management_group.
• extension scope: parent_id should be the ID of the resource you're adding the extension to.
• subscription scope: parent_id should be like /subscriptions/00000000-0000-0000-0000-000000000000
• tenant scope: parent_id should be /

For child level resources, the parent_id should be the ID of its parent resource, for example, subnet resource's parent_id is the ID of the vnet.

For type Microsoft.Resources/resourceGroups, the parent_id could be omitted, it defaults to subscription ID specified in provider or the default subscription(You could check the default subscription by azure cli command: az account show).

resourceId string

The ID of an existing azure source.

Note: Configuring name and parent_id is an alternative way to configure resource_id.

responseExportValues string[]

A list of path that needs to be exported from response body. Setting it to ["*"] will export the full response body. Here's an example. If it sets to ["properties.loginServer", "properties.policies.quarantinePolicy.status"], it will set the following json to computed property output.

{
"properties" : {
"loginServer" : "registry1.azurecr.io"
"policies" : {
"quarantinePolicy" = {
"status" = "disabled"
}
}
}
}

type str

It is in a format like <resource-type>@<api-version>. <resource-type> is the Azure resource type, for example, Microsoft.Storage/storageAccounts. <api-version> is version of the API used to manage this azure resource.

identity GetResourceIdentity

An identity block as defined below, which contains the Managed Service Identity information for this azure resource.

name str

Specifies the name of the azure resource.

parent_id str

The ID of the azure resource in which this resource is created. It supports different kinds of deployment scope for top level resources:

• resource group scope: parent_id should be the ID of a resource group, it's recommended to manage a resource group by azurerm_resource_group.
• management group scope: parent_id should be the ID of a management group, it's recommended to manage a management group by azurerm_management_group.
• extension scope: parent_id should be the ID of the resource you're adding the extension to.
• subscription scope: parent_id should be like /subscriptions/00000000-0000-0000-0000-000000000000
• tenant scope: parent_id should be /

For child level resources, the parent_id should be the ID of its parent resource, for example, subnet resource's parent_id is the ID of the vnet.

For type Microsoft.Resources/resourceGroups, the parent_id could be omitted, it defaults to subscription ID specified in provider or the default subscription(You could check the default subscription by azure cli command: az account show).

resource_id str

The ID of an existing azure source.

Note: Configuring name and parent_id is an alternative way to configure resource_id.

response_export_values Sequence[str]

A list of path that needs to be exported from response body. Setting it to ["*"] will export the full response body. Here's an example. If it sets to ["properties.loginServer", "properties.policies.quarantinePolicy.status"], it will set the following json to computed property output.

{
"properties" : {
"loginServer" : "registry1.azurecr.io"
"policies" : {
"quarantinePolicy" = {
"status" = "disabled"
}
}
}
}

type String

It is in a format like <resource-type>@<api-version>. <resource-type> is the Azure resource type, for example, Microsoft.Storage/storageAccounts. <api-version> is version of the API used to manage this azure resource.

identity Property Map

An identity block as defined below, which contains the Managed Service Identity information for this azure resource.

name String

Specifies the name of the azure resource.

parentId String

The ID of the azure resource in which this resource is created. It supports different kinds of deployment scope for top level resources:

• resource group scope: parent_id should be the ID of a resource group, it's recommended to manage a resource group by azurerm_resource_group.
• management group scope: parent_id should be the ID of a management group, it's recommended to manage a management group by azurerm_management_group.
• extension scope: parent_id should be the ID of the resource you're adding the extension to.
• subscription scope: parent_id should be like /subscriptions/00000000-0000-0000-0000-000000000000
• tenant scope: parent_id should be /

For child level resources, the parent_id should be the ID of its parent resource, for example, subnet resource's parent_id is the ID of the vnet.

For type Microsoft.Resources/resourceGroups, the parent_id could be omitted, it defaults to subscription ID specified in provider or the default subscription(You could check the default subscription by azure cli command: az account show).

resourceId String

The ID of an existing azure source.

Note: Configuring name and parent_id is an alternative way to configure resource_id.

responseExportValues List<String>

A list of path that needs to be exported from response body. Setting it to ["*"] will export the full response body. Here's an example. If it sets to ["properties.loginServer", "properties.policies.quarantinePolicy.status"], it will set the following json to computed property output.

{
"properties" : {
"loginServer" : "registry1.azurecr.io"
"policies" : {
"quarantinePolicy" = {
"status" = "disabled"
}
}
}
}

Id string

The provider-assigned unique ID for this managed resource.

Identity ediri.Azapi.Outputs.GetResourceIdentity

An identity block as defined below, which contains the Managed Service Identity information for this azure resource.

Location string

The Azure Region where the azure resource should exist.

Output string

The output json containing the properties specified in response_export_values. Here're some examples to decode json and extract the value.

// it will output "registry1.azurecr.io"
output "login_server" {
value = jsondecode(azapi_resource.example.output).properties.loginServer
}

ParentId string

Tags Dictionary<string, string>

A mapping of tags which should be assigned to the azure resource.

Type string

The Type of Identity which should be used for this azure resource. Possible values are SystemAssigned, UserAssigned and SystemAssigned,UserAssigned.

Name string

ResourceId string

ResponseExportValues List<string>

Id string

The provider-assigned unique ID for this managed resource.

Identity GetResourceIdentity

An identity block as defined below, which contains the Managed Service Identity information for this azure resource.

Location string

The Azure Region where the azure resource should exist.

Output string

The output json containing the properties specified in response_export_values. Here're some examples to decode json and extract the value.

// it will output "registry1.azurecr.io"
output "login_server" {
value = jsondecode(azapi_resource.example.output).properties.loginServer
}

ParentId string

Tags map[string]string

A mapping of tags which should be assigned to the azure resource.

Type string

The Type of Identity which should be used for this azure resource. Possible values are SystemAssigned, UserAssigned and SystemAssigned,UserAssigned.

Name string

ResourceId string

ResponseExportValues []string

id String

The provider-assigned unique ID for this managed resource.

identity GetResourceIdentity

An identity block as defined below, which contains the Managed Service Identity information for this azure resource.

location String

The Azure Region where the azure resource should exist.

output String

The output json containing the properties specified in response_export_values. Here're some examples to decode json and extract the value.

// it will output "registry1.azurecr.io"
output "login_server" {
value = jsondecode(azapi_resource.example.output).properties.loginServer
}

parentId String

tags Map<String,String>

A mapping of tags which should be assigned to the azure resource.

type String

The Type of Identity which should be used for this azure resource. Possible values are SystemAssigned, UserAssigned and SystemAssigned,UserAssigned.

name String

resourceId String

responseExportValues List<String>

id string

The provider-assigned unique ID for this managed resource.

identity GetResourceIdentity

An identity block as defined below, which contains the Managed Service Identity information for this azure resource.

location string

The Azure Region where the azure resource should exist.

output string

The output json containing the properties specified in response_export_values. Here're some examples to decode json and extract the value.

// it will output "registry1.azurecr.io"
output "login_server" {
value = jsondecode(azapi_resource.example.output).properties.loginServer
}

parentId string

tags {[key: string]: string}

A mapping of tags which should be assigned to the azure resource.

type string

The Type of Identity which should be used for this azure resource. Possible values are SystemAssigned, UserAssigned and SystemAssigned,UserAssigned.

name string

resourceId string

responseExportValues string[]

id str

The provider-assigned unique ID for this managed resource.

identity GetResourceIdentity

An identity block as defined below, which contains the Managed Service Identity information for this azure resource.

location str

The Azure Region where the azure resource should exist.

output str

The output json containing the properties specified in response_export_values. Here're some examples to decode json and extract the value.

// it will output "registry1.azurecr.io"
output "login_server" {
value = jsondecode(azapi_resource.example.output).properties.loginServer
}

parent_id str

tags Mapping[str, str]

A mapping of tags which should be assigned to the azure resource.

type str

The Type of Identity which should be used for this azure resource. Possible values are SystemAssigned, UserAssigned and SystemAssigned,UserAssigned.

name str

resource_id str

response_export_values Sequence[str]

id String

The provider-assigned unique ID for this managed resource.

identity Property Map

An identity block as defined below, which contains the Managed Service Identity information for this azure resource.

location String

The Azure Region where the azure resource should exist.

output String

The output json containing the properties specified in response_export_values. Here're some examples to decode json and extract the value.

// it will output "registry1.azurecr.io"
output "login_server" {
value = jsondecode(azapi_resource.example.output).properties.loginServer
}

parentId String

tags Map<String>

A mapping of tags which should be assigned to the azure resource.

type String

The Type of Identity which should be used for this azure resource. Possible values are SystemAssigned, UserAssigned and SystemAssigned,UserAssigned.

name String

resourceId String

responseExportValues List<String>

IdentityIds List<string>

A list of User Managed Identity ID's which should be assigned to the azure resource.

PrincipalId string

The Principal ID for the Service Principal associated with the Managed Service Identity of this azure resource.

TenantId string

The Tenant ID for the Service Principal associated with the Managed Service Identity of this azure resource.

Type string

It is in a format like <resource-type>@<api-version>. <resource-type> is the Azure resource type, for example, Microsoft.Storage/storageAccounts. <api-version> is version of the API used to manage this azure resource.

IdentityIds []string

A list of User Managed Identity ID's which should be assigned to the azure resource.

PrincipalId string

The Principal ID for the Service Principal associated with the Managed Service Identity of this azure resource.

TenantId string

The Tenant ID for the Service Principal associated with the Managed Service Identity of this azure resource.

Type string

It is in a format like <resource-type>@<api-version>. <resource-type> is the Azure resource type, for example, Microsoft.Storage/storageAccounts. <api-version> is version of the API used to manage this azure resource.

identityIds List<String>

A list of User Managed Identity ID's which should be assigned to the azure resource.

principalId String

The Principal ID for the Service Principal associated with the Managed Service Identity of this azure resource.

tenantId String

The Tenant ID for the Service Principal associated with the Managed Service Identity of this azure resource.

type String

It is in a format like <resource-type>@<api-version>. <resource-type> is the Azure resource type, for example, Microsoft.Storage/storageAccounts. <api-version> is version of the API used to manage this azure resource.

identityIds string[]

A list of User Managed Identity ID's which should be assigned to the azure resource.

principalId string

The Principal ID for the Service Principal associated with the Managed Service Identity of this azure resource.

tenantId string

The Tenant ID for the Service Principal associated with the Managed Service Identity of this azure resource.

type string

It is in a format like <resource-type>@<api-version>. <resource-type> is the Azure resource type, for example, Microsoft.Storage/storageAccounts. <api-version> is version of the API used to manage this azure resource.

identity_ids Sequence[str]

A list of User Managed Identity ID's which should be assigned to the azure resource.

principal_id str

The Principal ID for the Service Principal associated with the Managed Service Identity of this azure resource.

tenant_id str

The Tenant ID for the Service Principal associated with the Managed Service Identity of this azure resource.

type str

It is in a format like <resource-type>@<api-version>. <resource-type> is the Azure resource type, for example, Microsoft.Storage/storageAccounts. <api-version> is version of the API used to manage this azure resource.

identityIds List<String>

A list of User Managed Identity ID's which should be assigned to the azure resource.

principalId String

The Principal ID for the Service Principal associated with the Managed Service Identity of this azure resource.

tenantId String

The Tenant ID for the Service Principal associated with the Managed Service Identity of this azure resource.

type String

It is in a format like <resource-type>@<api-version>. <resource-type> is the Azure resource type, for example, Microsoft.Storage/storageAccounts. <api-version> is version of the API used to manage this azure resource.