Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Terraform
  4. API Docs
  5. state
  6. getAzureRMReference
Viewing docs for Terraform v6.1.0
published on Monday, Jul 20, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-terraform

terraform.state.getAzureRMReference

terraform logo
Viewing docs for Terraform v6.1.0
published on Monday, Jul 20, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-terraform

    Access state stored in an Azure Blob Storage container.

    Using getAzureRMReference

    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 getAzureRMReference(args: GetAzureRMReferenceArgs, opts?: InvokeOptions): Promise<GetAzureRMReferenceResult>
function getAzureRMReferenceOutput(args: GetAzureRMReferenceOutputArgs, opts?: InvokeOptions): Output<GetAzureRMReferenceResult>
    def get_azure_rm_reference(access_key: Optional[str] = None,
                           client_certificate_password: Optional[str] = None,
                           client_certificate_path: Optional[str] = None,
                           client_id: Optional[str] = None,
                           client_secret: Optional[str] = None,
                           container_name: Optional[str] = None,
                           endpoint: Optional[str] = None,
                           environment: Optional[str] = None,
                           key: Optional[str] = None,
                           metadata_host: Optional[str] = None,
                           msi_endpoint: Optional[str] = None,
                           oidc_request_token: Optional[str] = None,
                           oidc_request_url: Optional[str] = None,
                           oidc_token: Optional[str] = None,
                           oidc_token_file_path: Optional[str] = None,
                           resource_group_name: Optional[str] = None,
                           sas_token: Optional[str] = None,
                           storage_account_name: Optional[str] = None,
                           subscription_id: Optional[str] = None,
                           tenant_id: Optional[str] = None,
                           use_azuread_auth: Optional[bool] = None,
                           use_msi: Optional[bool] = None,
                           use_oidc: Optional[bool] = None,
                           workspace: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetAzureRMReferenceResult
def get_azure_rm_reference_output(access_key: pulumi.Input[Optional[str]] = None,
                           client_certificate_password: pulumi.Input[Optional[str]] = None,
                           client_certificate_path: pulumi.Input[Optional[str]] = None,
                           client_id: pulumi.Input[Optional[str]] = None,
                           client_secret: pulumi.Input[Optional[str]] = None,
                           container_name: pulumi.Input[Optional[str]] = None,
                           endpoint: pulumi.Input[Optional[str]] = None,
                           environment: pulumi.Input[Optional[str]] = None,
                           key: pulumi.Input[Optional[str]] = None,
                           metadata_host: pulumi.Input[Optional[str]] = None,
                           msi_endpoint: pulumi.Input[Optional[str]] = None,
                           oidc_request_token: pulumi.Input[Optional[str]] = None,
                           oidc_request_url: pulumi.Input[Optional[str]] = None,
                           oidc_token: pulumi.Input[Optional[str]] = None,
                           oidc_token_file_path: pulumi.Input[Optional[str]] = None,
                           resource_group_name: pulumi.Input[Optional[str]] = None,
                           sas_token: pulumi.Input[Optional[str]] = None,
                           storage_account_name: pulumi.Input[Optional[str]] = None,
                           subscription_id: pulumi.Input[Optional[str]] = None,
                           tenant_id: pulumi.Input[Optional[str]] = None,
                           use_azuread_auth: pulumi.Input[Optional[bool]] = None,
                           use_msi: pulumi.Input[Optional[bool]] = None,
                           use_oidc: pulumi.Input[Optional[bool]] = None,
                           workspace: pulumi.Input[Optional[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetAzureRMReferenceResult]
    func GetAzureRMReference(ctx *Context, args *GetAzureRMReferenceArgs, opts ...InvokeOption) (*GetAzureRMReferenceResult, error)
func GetAzureRMReferenceOutput(ctx *Context, args *GetAzureRMReferenceOutputArgs, opts ...InvokeOption) GetAzureRMReferenceResultOutput

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

    public static class GetAzureRMReference 
{
    public static Task<GetAzureRMReferenceResult> InvokeAsync(GetAzureRMReferenceArgs args, InvokeOptions? opts = null)
    public static Output<GetAzureRMReferenceResult> Invoke(GetAzureRMReferenceInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetAzureRMReferenceResult> getAzureRMReference(GetAzureRMReferenceArgs args, InvokeOptions options)
public static Output<GetAzureRMReferenceResult> getAzureRMReference(GetAzureRMReferenceArgs args, InvokeOptions options)

    fn::invoke:
  function: terraform:state:getAzureRMReference
  arguments:
    # arguments dictionary
    data "terraform_state_get_azure_r_m_reference" "name" {
    # arguments
}

    The following arguments are supported:

    ContainerName string
    The name of the storage container within the storage account.
    Key string
    The name of the blob holding the Terraform state file inside the storage container.
    StorageAccountName string
    The name of the storage account.
    AccessKey string
    The access key of the storage account. Falls back to the ARM_ACCESS_KEY environment variable when unset.
    ClientCertificatePassword string
    The password for the client certificate specified in clientCertificatePath. Falls back to the ARM_CLIENT_CERTIFICATE_PASSWORD environment variable when unset.
    ClientCertificatePath string
    The path to the PFX file used as the client certificate for service principal authentication. Falls back to the ARM_CLIENT_CERTIFICATE_PATH environment variable when unset.
    ClientId string
    The client ID to authenticate as. Falls back to the ARM_CLIENT_ID environment variable when unset.
    ClientSecret string
    The client secret used for service principal authentication. Falls back to the ARM_CLIENT_SECRET environment variable when unset.
    Endpoint string
    A custom endpoint for the Azure Resource Manager API. Falls back to the ARM_ENDPOINT environment variable when unset.
    Environment string
    The Azure cloud environment to use: public (default), china, german, stack or usgovernment. Falls back to the ARM_ENVIRONMENT environment variable when unset.
    MetadataHost string
    The hostname of the Azure metadata service used to obtain the cloud environment. Falls back to the ARM_METADATA_HOST environment variable when unset.
    MsiEndpoint string
    The endpoint of the Managed Service Identity. Falls back to the ARM_MSI_ENDPOINT environment variable when unset.
    OidcRequestToken string
    The bearer token for requests to the oidcRequestUrl URL. Falls back to the ARM_OIDC_REQUEST_TOKEN or ACTIONS_ID_TOKEN_REQUEST_TOKEN environment variables when unset.
    OidcRequestUrl string
    The URL of the OIDC provider to request an ID token from, e.g. in GitHub Actions. Requires oidcRequestToken. Falls back to the ARM_OIDC_REQUEST_URL or ACTIONS_ID_TOKEN_REQUEST_URL environment variables when unset.
    OidcToken string
    A JWT token for OIDC authentication. Conflicts with oidcRequestToken. Falls back to the ARM_OIDC_TOKEN environment variable when unset.
    OidcTokenFilePath string
    The path to a file containing a JWT token for OIDC authentication. Conflicts with oidcRequestToken. Falls back to the ARM_OIDC_TOKEN_FILE_PATH environment variable when unset.
    ResourceGroupName string
    The name of the resource group holding the storage account. Required when using AzureAD authentication against the Azure Resource Manager API to look up the storage access key.
    SasToken string
    A SAS token for accessing the storage container. Falls back to the ARM_SAS_TOKEN environment variable when unset.
    SubscriptionId string
    The subscription ID holding the storage account. Falls back to the ARM_SUBSCRIPTION_ID environment variable when unset.
    TenantId string
    The tenant ID to authenticate against. Falls back to the ARM_TENANT_ID environment variable when unset.
    UseAzureadAuth bool
    Whether to authenticate against the storage container with AzureAD instead of an access key. Falls back to the ARM_USE_AZUREAD environment variable when unset.
    UseMsi bool
    Whether to authenticate using Managed Service Identity. Falls back to the ARM_USE_MSI environment variable when unset.
    UseOidc bool
    Whether to authenticate using OIDC. Falls back to the ARM_USE_OIDC environment variable when unset.
    Workspace string
    The Terraform workspace to read state from.
    ContainerName string
    The name of the storage container within the storage account.
    Key string
    The name of the blob holding the Terraform state file inside the storage container.
    StorageAccountName string
    The name of the storage account.
    AccessKey string
    The access key of the storage account. Falls back to the ARM_ACCESS_KEY environment variable when unset.
    ClientCertificatePassword string
    The password for the client certificate specified in clientCertificatePath. Falls back to the ARM_CLIENT_CERTIFICATE_PASSWORD environment variable when unset.
    ClientCertificatePath string
    The path to the PFX file used as the client certificate for service principal authentication. Falls back to the ARM_CLIENT_CERTIFICATE_PATH environment variable when unset.
    ClientId string
    The client ID to authenticate as. Falls back to the ARM_CLIENT_ID environment variable when unset.
    ClientSecret string
    The client secret used for service principal authentication. Falls back to the ARM_CLIENT_SECRET environment variable when unset.
    Endpoint string
    A custom endpoint for the Azure Resource Manager API. Falls back to the ARM_ENDPOINT environment variable when unset.
    Environment string
    The Azure cloud environment to use: public (default), china, german, stack or usgovernment. Falls back to the ARM_ENVIRONMENT environment variable when unset.
    MetadataHost string
    The hostname of the Azure metadata service used to obtain the cloud environment. Falls back to the ARM_METADATA_HOST environment variable when unset.
    MsiEndpoint string
    The endpoint of the Managed Service Identity. Falls back to the ARM_MSI_ENDPOINT environment variable when unset.
    OidcRequestToken string
    The bearer token for requests to the oidcRequestUrl URL. Falls back to the ARM_OIDC_REQUEST_TOKEN or ACTIONS_ID_TOKEN_REQUEST_TOKEN environment variables when unset.
    OidcRequestUrl string
    The URL of the OIDC provider to request an ID token from, e.g. in GitHub Actions. Requires oidcRequestToken. Falls back to the ARM_OIDC_REQUEST_URL or ACTIONS_ID_TOKEN_REQUEST_URL environment variables when unset.
    OidcToken string
    A JWT token for OIDC authentication. Conflicts with oidcRequestToken. Falls back to the ARM_OIDC_TOKEN environment variable when unset.
    OidcTokenFilePath string
    The path to a file containing a JWT token for OIDC authentication. Conflicts with oidcRequestToken. Falls back to the ARM_OIDC_TOKEN_FILE_PATH environment variable when unset.
    ResourceGroupName string
    The name of the resource group holding the storage account. Required when using AzureAD authentication against the Azure Resource Manager API to look up the storage access key.
    SasToken string
    A SAS token for accessing the storage container. Falls back to the ARM_SAS_TOKEN environment variable when unset.
    SubscriptionId string
    The subscription ID holding the storage account. Falls back to the ARM_SUBSCRIPTION_ID environment variable when unset.
    TenantId string
    The tenant ID to authenticate against. Falls back to the ARM_TENANT_ID environment variable when unset.
    UseAzureadAuth bool
    Whether to authenticate against the storage container with AzureAD instead of an access key. Falls back to the ARM_USE_AZUREAD environment variable when unset.
    UseMsi bool
    Whether to authenticate using Managed Service Identity. Falls back to the ARM_USE_MSI environment variable when unset.
    UseOidc bool
    Whether to authenticate using OIDC. Falls back to the ARM_USE_OIDC environment variable when unset.
    Workspace string
    The Terraform workspace to read state from.
    container_name string
    The name of the storage container within the storage account.
    key string
    The name of the blob holding the Terraform state file inside the storage container.
    storage_account_name string
    The name of the storage account.
    access_key string
    The access key of the storage account. Falls back to the ARM_ACCESS_KEY environment variable when unset.
    client_certificate_password string
    The password for the client certificate specified in clientCertificatePath. Falls back to the ARM_CLIENT_CERTIFICATE_PASSWORD environment variable when unset.
    client_certificate_path string
    The path to the PFX file used as the client certificate for service principal authentication. Falls back to the ARM_CLIENT_CERTIFICATE_PATH environment variable when unset.
    client_id string
    The client ID to authenticate as. Falls back to the ARM_CLIENT_ID environment variable when unset.
    client_secret string
    The client secret used for service principal authentication. Falls back to the ARM_CLIENT_SECRET environment variable when unset.
    endpoint string
    A custom endpoint for the Azure Resource Manager API. Falls back to the ARM_ENDPOINT environment variable when unset.
    environment string
    The Azure cloud environment to use: public (default), china, german, stack or usgovernment. Falls back to the ARM_ENVIRONMENT environment variable when unset.
    metadata_host string
    The hostname of the Azure metadata service used to obtain the cloud environment. Falls back to the ARM_METADATA_HOST environment variable when unset.
    msi_endpoint string
    The endpoint of the Managed Service Identity. Falls back to the ARM_MSI_ENDPOINT environment variable when unset.
    oidc_request_token string
    The bearer token for requests to the oidcRequestUrl URL. Falls back to the ARM_OIDC_REQUEST_TOKEN or ACTIONS_ID_TOKEN_REQUEST_TOKEN environment variables when unset.
    oidc_request_url string
    The URL of the OIDC provider to request an ID token from, e.g. in GitHub Actions. Requires oidcRequestToken. Falls back to the ARM_OIDC_REQUEST_URL or ACTIONS_ID_TOKEN_REQUEST_URL environment variables when unset.
    oidc_token string
    A JWT token for OIDC authentication. Conflicts with oidcRequestToken. Falls back to the ARM_OIDC_TOKEN environment variable when unset.
    oidc_token_file_path string
    The path to a file containing a JWT token for OIDC authentication. Conflicts with oidcRequestToken. Falls back to the ARM_OIDC_TOKEN_FILE_PATH environment variable when unset.
    resource_group_name string
    The name of the resource group holding the storage account. Required when using AzureAD authentication against the Azure Resource Manager API to look up the storage access key.
    sas_token string
    A SAS token for accessing the storage container. Falls back to the ARM_SAS_TOKEN environment variable when unset.
    subscription_id string
    The subscription ID holding the storage account. Falls back to the ARM_SUBSCRIPTION_ID environment variable when unset.
    tenant_id string
    The tenant ID to authenticate against. Falls back to the ARM_TENANT_ID environment variable when unset.
    use_azuread_auth bool
    Whether to authenticate against the storage container with AzureAD instead of an access key. Falls back to the ARM_USE_AZUREAD environment variable when unset.
    use_msi bool
    Whether to authenticate using Managed Service Identity. Falls back to the ARM_USE_MSI environment variable when unset.
    use_oidc bool
    Whether to authenticate using OIDC. Falls back to the ARM_USE_OIDC environment variable when unset.
    workspace string
    The Terraform workspace to read state from.
    containerName String
    The name of the storage container within the storage account.
    key String
    The name of the blob holding the Terraform state file inside the storage container.
    storageAccountName String
    The name of the storage account.
    accessKey String
    The access key of the storage account. Falls back to the ARM_ACCESS_KEY environment variable when unset.
    clientCertificatePassword String
    The password for the client certificate specified in clientCertificatePath. Falls back to the ARM_CLIENT_CERTIFICATE_PASSWORD environment variable when unset.
    clientCertificatePath String
    The path to the PFX file used as the client certificate for service principal authentication. Falls back to the ARM_CLIENT_CERTIFICATE_PATH environment variable when unset.
    clientId String
    The client ID to authenticate as. Falls back to the ARM_CLIENT_ID environment variable when unset.
    clientSecret String
    The client secret used for service principal authentication. Falls back to the ARM_CLIENT_SECRET environment variable when unset.
    endpoint String
    A custom endpoint for the Azure Resource Manager API. Falls back to the ARM_ENDPOINT environment variable when unset.
    environment String
    The Azure cloud environment to use: public (default), china, german, stack or usgovernment. Falls back to the ARM_ENVIRONMENT environment variable when unset.
    metadataHost String
    The hostname of the Azure metadata service used to obtain the cloud environment. Falls back to the ARM_METADATA_HOST environment variable when unset.
    msiEndpoint String
    The endpoint of the Managed Service Identity. Falls back to the ARM_MSI_ENDPOINT environment variable when unset.
    oidcRequestToken String
    The bearer token for requests to the oidcRequestUrl URL. Falls back to the ARM_OIDC_REQUEST_TOKEN or ACTIONS_ID_TOKEN_REQUEST_TOKEN environment variables when unset.
    oidcRequestUrl String
    The URL of the OIDC provider to request an ID token from, e.g. in GitHub Actions. Requires oidcRequestToken. Falls back to the ARM_OIDC_REQUEST_URL or ACTIONS_ID_TOKEN_REQUEST_URL environment variables when unset.
    oidcToken String
    A JWT token for OIDC authentication. Conflicts with oidcRequestToken. Falls back to the ARM_OIDC_TOKEN environment variable when unset.
    oidcTokenFilePath String
    The path to a file containing a JWT token for OIDC authentication. Conflicts with oidcRequestToken. Falls back to the ARM_OIDC_TOKEN_FILE_PATH environment variable when unset.
    resourceGroupName String
    The name of the resource group holding the storage account. Required when using AzureAD authentication against the Azure Resource Manager API to look up the storage access key.
    sasToken String
    A SAS token for accessing the storage container. Falls back to the ARM_SAS_TOKEN environment variable when unset.
    subscriptionId String
    The subscription ID holding the storage account. Falls back to the ARM_SUBSCRIPTION_ID environment variable when unset.
    tenantId String
    The tenant ID to authenticate against. Falls back to the ARM_TENANT_ID environment variable when unset.
    useAzureadAuth Boolean
    Whether to authenticate against the storage container with AzureAD instead of an access key. Falls back to the ARM_USE_AZUREAD environment variable when unset.
    useMsi Boolean
    Whether to authenticate using Managed Service Identity. Falls back to the ARM_USE_MSI environment variable when unset.
    useOidc Boolean
    Whether to authenticate using OIDC. Falls back to the ARM_USE_OIDC environment variable when unset.
    workspace String
    The Terraform workspace to read state from.
    containerName string
    The name of the storage container within the storage account.
    key string
    The name of the blob holding the Terraform state file inside the storage container.
    storageAccountName string
    The name of the storage account.
    accessKey string
    The access key of the storage account. Falls back to the ARM_ACCESS_KEY environment variable when unset.
    clientCertificatePassword string
    The password for the client certificate specified in clientCertificatePath. Falls back to the ARM_CLIENT_CERTIFICATE_PASSWORD environment variable when unset.
    clientCertificatePath string
    The path to the PFX file used as the client certificate for service principal authentication. Falls back to the ARM_CLIENT_CERTIFICATE_PATH environment variable when unset.
    clientId string
    The client ID to authenticate as. Falls back to the ARM_CLIENT_ID environment variable when unset.
    clientSecret string
    The client secret used for service principal authentication. Falls back to the ARM_CLIENT_SECRET environment variable when unset.
    endpoint string
    A custom endpoint for the Azure Resource Manager API. Falls back to the ARM_ENDPOINT environment variable when unset.
    environment string
    The Azure cloud environment to use: public (default), china, german, stack or usgovernment. Falls back to the ARM_ENVIRONMENT environment variable when unset.
    metadataHost string
    The hostname of the Azure metadata service used to obtain the cloud environment. Falls back to the ARM_METADATA_HOST environment variable when unset.
    msiEndpoint string
    The endpoint of the Managed Service Identity. Falls back to the ARM_MSI_ENDPOINT environment variable when unset.
    oidcRequestToken string
    The bearer token for requests to the oidcRequestUrl URL. Falls back to the ARM_OIDC_REQUEST_TOKEN or ACTIONS_ID_TOKEN_REQUEST_TOKEN environment variables when unset.
    oidcRequestUrl string
    The URL of the OIDC provider to request an ID token from, e.g. in GitHub Actions. Requires oidcRequestToken. Falls back to the ARM_OIDC_REQUEST_URL or ACTIONS_ID_TOKEN_REQUEST_URL environment variables when unset.
    oidcToken string
    A JWT token for OIDC authentication. Conflicts with oidcRequestToken. Falls back to the ARM_OIDC_TOKEN environment variable when unset.
    oidcTokenFilePath string
    The path to a file containing a JWT token for OIDC authentication. Conflicts with oidcRequestToken. Falls back to the ARM_OIDC_TOKEN_FILE_PATH environment variable when unset.
    resourceGroupName string
    The name of the resource group holding the storage account. Required when using AzureAD authentication against the Azure Resource Manager API to look up the storage access key.
    sasToken string
    A SAS token for accessing the storage container. Falls back to the ARM_SAS_TOKEN environment variable when unset.
    subscriptionId string
    The subscription ID holding the storage account. Falls back to the ARM_SUBSCRIPTION_ID environment variable when unset.
    tenantId string
    The tenant ID to authenticate against. Falls back to the ARM_TENANT_ID environment variable when unset.
    useAzureadAuth boolean
    Whether to authenticate against the storage container with AzureAD instead of an access key. Falls back to the ARM_USE_AZUREAD environment variable when unset.
    useMsi boolean
    Whether to authenticate using Managed Service Identity. Falls back to the ARM_USE_MSI environment variable when unset.
    useOidc boolean
    Whether to authenticate using OIDC. Falls back to the ARM_USE_OIDC environment variable when unset.
    workspace string
    The Terraform workspace to read state from.
    container_name str
    The name of the storage container within the storage account.
    key str
    The name of the blob holding the Terraform state file inside the storage container.
    storage_account_name str
    The name of the storage account.
    access_key str
    The access key of the storage account. Falls back to the ARM_ACCESS_KEY environment variable when unset.
    client_certificate_password str
    The password for the client certificate specified in clientCertificatePath. Falls back to the ARM_CLIENT_CERTIFICATE_PASSWORD environment variable when unset.
    client_certificate_path str
    The path to the PFX file used as the client certificate for service principal authentication. Falls back to the ARM_CLIENT_CERTIFICATE_PATH environment variable when unset.
    client_id str
    The client ID to authenticate as. Falls back to the ARM_CLIENT_ID environment variable when unset.
    client_secret str
    The client secret used for service principal authentication. Falls back to the ARM_CLIENT_SECRET environment variable when unset.
    endpoint str
    A custom endpoint for the Azure Resource Manager API. Falls back to the ARM_ENDPOINT environment variable when unset.
    environment str
    The Azure cloud environment to use: public (default), china, german, stack or usgovernment. Falls back to the ARM_ENVIRONMENT environment variable when unset.
    metadata_host str
    The hostname of the Azure metadata service used to obtain the cloud environment. Falls back to the ARM_METADATA_HOST environment variable when unset.
    msi_endpoint str
    The endpoint of the Managed Service Identity. Falls back to the ARM_MSI_ENDPOINT environment variable when unset.
    oidc_request_token str
    The bearer token for requests to the oidcRequestUrl URL. Falls back to the ARM_OIDC_REQUEST_TOKEN or ACTIONS_ID_TOKEN_REQUEST_TOKEN environment variables when unset.
    oidc_request_url str
    The URL of the OIDC provider to request an ID token from, e.g. in GitHub Actions. Requires oidcRequestToken. Falls back to the ARM_OIDC_REQUEST_URL or ACTIONS_ID_TOKEN_REQUEST_URL environment variables when unset.
    oidc_token str
    A JWT token for OIDC authentication. Conflicts with oidcRequestToken. Falls back to the ARM_OIDC_TOKEN environment variable when unset.
    oidc_token_file_path str
    The path to a file containing a JWT token for OIDC authentication. Conflicts with oidcRequestToken. Falls back to the ARM_OIDC_TOKEN_FILE_PATH environment variable when unset.
    resource_group_name str
    The name of the resource group holding the storage account. Required when using AzureAD authentication against the Azure Resource Manager API to look up the storage access key.
    sas_token str
    A SAS token for accessing the storage container. Falls back to the ARM_SAS_TOKEN environment variable when unset.
    subscription_id str
    The subscription ID holding the storage account. Falls back to the ARM_SUBSCRIPTION_ID environment variable when unset.
    tenant_id str
    The tenant ID to authenticate against. Falls back to the ARM_TENANT_ID environment variable when unset.
    use_azuread_auth bool
    Whether to authenticate against the storage container with AzureAD instead of an access key. Falls back to the ARM_USE_AZUREAD environment variable when unset.
    use_msi bool
    Whether to authenticate using Managed Service Identity. Falls back to the ARM_USE_MSI environment variable when unset.
    use_oidc bool
    Whether to authenticate using OIDC. Falls back to the ARM_USE_OIDC environment variable when unset.
    workspace str
    The Terraform workspace to read state from.
    containerName String
    The name of the storage container within the storage account.
    key String
    The name of the blob holding the Terraform state file inside the storage container.
    storageAccountName String
    The name of the storage account.
    accessKey String
    The access key of the storage account. Falls back to the ARM_ACCESS_KEY environment variable when unset.
    clientCertificatePassword String
    The password for the client certificate specified in clientCertificatePath. Falls back to the ARM_CLIENT_CERTIFICATE_PASSWORD environment variable when unset.
    clientCertificatePath String
    The path to the PFX file used as the client certificate for service principal authentication. Falls back to the ARM_CLIENT_CERTIFICATE_PATH environment variable when unset.
    clientId String
    The client ID to authenticate as. Falls back to the ARM_CLIENT_ID environment variable when unset.
    clientSecret String
    The client secret used for service principal authentication. Falls back to the ARM_CLIENT_SECRET environment variable when unset.
    endpoint String
    A custom endpoint for the Azure Resource Manager API. Falls back to the ARM_ENDPOINT environment variable when unset.
    environment String
    The Azure cloud environment to use: public (default), china, german, stack or usgovernment. Falls back to the ARM_ENVIRONMENT environment variable when unset.
    metadataHost String
    The hostname of the Azure metadata service used to obtain the cloud environment. Falls back to the ARM_METADATA_HOST environment variable when unset.
    msiEndpoint String
    The endpoint of the Managed Service Identity. Falls back to the ARM_MSI_ENDPOINT environment variable when unset.
    oidcRequestToken String
    The bearer token for requests to the oidcRequestUrl URL. Falls back to the ARM_OIDC_REQUEST_TOKEN or ACTIONS_ID_TOKEN_REQUEST_TOKEN environment variables when unset.
    oidcRequestUrl String
    The URL of the OIDC provider to request an ID token from, e.g. in GitHub Actions. Requires oidcRequestToken. Falls back to the ARM_OIDC_REQUEST_URL or ACTIONS_ID_TOKEN_REQUEST_URL environment variables when unset.
    oidcToken String
    A JWT token for OIDC authentication. Conflicts with oidcRequestToken. Falls back to the ARM_OIDC_TOKEN environment variable when unset.
    oidcTokenFilePath String
    The path to a file containing a JWT token for OIDC authentication. Conflicts with oidcRequestToken. Falls back to the ARM_OIDC_TOKEN_FILE_PATH environment variable when unset.
    resourceGroupName String
    The name of the resource group holding the storage account. Required when using AzureAD authentication against the Azure Resource Manager API to look up the storage access key.
    sasToken String
    A SAS token for accessing the storage container. Falls back to the ARM_SAS_TOKEN environment variable when unset.
    subscriptionId String
    The subscription ID holding the storage account. Falls back to the ARM_SUBSCRIPTION_ID environment variable when unset.
    tenantId String
    The tenant ID to authenticate against. Falls back to the ARM_TENANT_ID environment variable when unset.
    useAzureadAuth Boolean
    Whether to authenticate against the storage container with AzureAD instead of an access key. Falls back to the ARM_USE_AZUREAD environment variable when unset.
    useMsi Boolean
    Whether to authenticate using Managed Service Identity. Falls back to the ARM_USE_MSI environment variable when unset.
    useOidc Boolean
    Whether to authenticate using OIDC. Falls back to the ARM_USE_OIDC environment variable when unset.
    workspace String
    The Terraform workspace to read state from.

    getAzureRMReference Result

    The following output properties are available:

    Outputs Dictionary<string, object>
    The outputs displayed from Terraform state.
    Outputs map[string]interface{}
    The outputs displayed from Terraform state.
    outputs map(any)
    The outputs displayed from Terraform state.
    outputs Map<String,Object>
    The outputs displayed from Terraform state.
    outputs {[key: string]: any}
    The outputs displayed from Terraform state.
    outputs Mapping[str, Any]
    The outputs displayed from Terraform state.
    outputs Map<Any>
    The outputs displayed from Terraform state.

    Package Details

    Repository
    terraform pulumi/pulumi-terraform
    License
    Apache-2.0
    terraform logo
    Viewing docs for Terraform v6.1.0
    published on Monday, Jul 20, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-terraform

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial