1. Packages
  2. AzAPI
  3. API Docs
  4. DataPlaneResource
AzAPI v1.9.0 published on Monday, Sep 18, 2023 by dirien

azapi.DataPlaneResource

Explore with Pulumi AI

azapi logo
AzAPI v1.9.0 published on Monday, Sep 18, 2023 by dirien

    This resource can manage some Azure data plane resource.

    Example Usage

    terraform {
      required_providers {
        azapi = {
          source = "Azure/azapi"
        }
      }
    }
    
    provider "azapi" {
    }
    
    provider "azurerm" {
      features {}
    }
    
    data "azurerm_synapse_workspace" "example" {
      name                = "example-workspace"
      resource_group_name = azurerm_resource_group.example.name
    }
    
    resource "azapi_data_plane_resource" "dataset" {
      type      = "Microsoft.Synapse/workspaces/datasets@2020-12-01"
      parent_id = trimprefix(data.azurerm_synapse_workspace.example.connectivity_endpoints.dev, "https://")
      name      = "example-dataset"
      body = jsonencode({
        properties = {
          type = "AzureBlob",
          typeProperties = {
            folderPath = {
              value = "@dataset().MyFolderPath"
              type  = "Expression"
            }
            fileName = {
              value = "@dataset().MyFileName"
              type  = "Expression"
            }
            format = {
              type = "TextFormat"
            }
          }
          parameters = {
            MyFolderPath = {
              type = "String"
            }
            MyFileName = {
              type = "String"
            }
          }
        }
      })
    }
    

    Available Resources

    Resource TypeURLParent ID Example
    Microsoft.AppConfiguration/configurationStores/keyValues/kv/{key}{storeName}.azconfig.io
    Microsoft.DeviceUpdate/accounts/groups/deviceupdate/{instanceId}/management/groups/{groupId}{accountName}.api.adu.microsoft.com/deviceupdate/{instanceName}
    Microsoft.DeviceUpdate/accounts/groups/deployments/deviceUpdate/{instanceId}/management/groups/{groupId}/deployments/{deploymentId}{accountName}.api.adu.microsoft.com/deviceupdate/{instanceName}/management/groups/{groupId}
    Microsoft.DeviceUpdate/accounts/v2/deployments/deviceupdate/{instanceId}/v2/management/deployments/{deploymentId}{accountName}.api.adu.microsoft.com/deviceupdate/{instanceName}
    Microsoft.DeviceUpdate/accounts/v2/groups/deviceupdate/{instanceId}/v2/management/groups/{groupId}{accountName}.api.adu.microsoft.com/deviceupdate/{instanceName}
    Microsoft.DigitalTwins/digitalTwinsInstances/digitaltwins/digitaltwins/{id}{instanceName}.api.weu.digitaltwins.azure.net
    Microsoft.DigitalTwins/digitalTwinsInstances/digitaltwins/relationships/digitaltwins/{id}/relationships/{relationshipId}{instanceName}.api.weu.digitaltwins.azure.net/digitaltwins/{digitalTwinId}
    Microsoft.DigitalTwins/digitalTwinsInstances/eventroutes/eventroutes/{id}{instanceName}.api.weu.digitaltwins.azure.net
    Microsoft.DigitalTwins/digitalTwinsInstances/jobs/imports/jobs/imports/{id}{instanceName}.api.weu.digitaltwins.azure.net
    Microsoft.IoTCentral/IoTApps/organizations/organizations/{organizationId}{appSubdomain}.azureiotcentral.com
    Microsoft.IoTCentral/IoTApps/scheduledJobs/scheduledJobs/{scheduledJobId}{appSubdomain}.azureiotcentral.com
    Microsoft.IoTCentral/IoTApps/users/users/{userId}{appSubdomain}.azureiotcentral.com
    Microsoft.IoTCentral/iotApps/apiTokens/apiTokens/{tokenId}{appSubdomain}.azureiotcentral.com
    Microsoft.IoTCentral/iotApps/continuousDataExports/continuousDataExports/{exportId}{appSubdomain}.azureiotcentral.com
    Microsoft.IoTCentral/iotApps/dashboards/dashboards/{dashboardId}{appSubdomain}.azureiotcentral.com
    Microsoft.IoTCentral/iotApps/dataExport/destinations/dataExport/destinations/{destinationId}{appSubdomain}.azureiotcentral.com
    Microsoft.IoTCentral/iotApps/dataExport/exports/dataExport/exports/{exportId}{appSubdomain}.azureiotcentral.com
    Microsoft.IoTCentral/iotApps/deploymentManifests/deploymentManifests/{deploymentManifestId}{appSubdomain}.azureiotcentral.com
    Microsoft.IoTCentral/iotApps/deviceGroups/deviceGroups/{deviceGroupId}{appSubdomain}.azureiotcentral.com
    Microsoft.IoTCentral/iotApps/deviceTemplates/deviceTemplates/{deviceTemplateId}{appSubdomain}.azureiotcentral.com
    Microsoft.IoTCentral/iotApps/devices/devices/{deviceId}{appSubdomain}.azureiotcentral.com
    Microsoft.IoTCentral/iotApps/devices/attestation/devices/{deviceId}/attestation{appSubdomain}.azureiotcentral.com
    Microsoft.IoTCentral/iotApps/devices/relationships/devices/{deviceId}/relationships/{relationshipId}{appSubdomain}.azureiotcentral.com/devices/{deviceId}
    Microsoft.IoTCentral/iotApps/enrollmentGroups/enrollmentGroups/{enrollmentGroupId}{appSubdomain}.azureiotcentral.com
    Microsoft.IoTCentral/iotApps/enrollmentGroups/certificates/enrollmentGroups/{enrollmentGroupId}/certificates/{entry}{appSubdomain}.azureiotcentral.com/enrollmentGroups/{enrollmentGroupId}
    Microsoft.KeyVault/vaults/certificates/contacts/certificates/contacts{vaultName}.vault.azure.net
    Microsoft.KeyVault/vaults/certificates/issuers/certificates/issuers/{issuer-name}{vaultName}.vault.azure.net
    Microsoft.KeyVault/vaults/storage/storage/{storage-account-name}{vaultName}.vault.azure.net
    Microsoft.KeyVault/vaults/storage/sas/storage/{storage-account-name}/sas/{sas-definition-name}{vaultName}.vault.azure.net/storage/{storage-account-name}
    Microsoft.Purview/accounts/Account/collections/collections/{collectionName}{accountName}.purview.azure.com
    Microsoft.Purview/accounts/Account/resourceSetRuleConfigs/resourceSetRuleConfigs/defaultResourceSetRuleConfig{accountName}.purview.azure.com
    Microsoft.Purview/accounts/Scanning/azureKeyVaults/azureKeyVaults/{azureKeyVaultName}{accountName}.purview.azure.com/scan
    Microsoft.Purview/accounts/Scanning/classificationrules/classificationrules/{classificationRuleName}{accountName}.purview.azure.com/scan
    Microsoft.Purview/accounts/Scanning/credentials/credentials/{credentialName}{accountName}.purview.azure.com/scan
    Microsoft.Purview/accounts/Scanning/datasources/datasources/{dataSourceName}{accountName}.purview.azure.com/scan
    Microsoft.Purview/accounts/Scanning/datasources/scans/datasources/{dataSourceName}/scans/{scanName}{accountName}.purview.azure.com/scan/datasources/{dataSourceName}
    Microsoft.Purview/accounts/Scanning/datasources/scans/triggers/datasources/{dataSourceName}/scans/{scanName}/triggers/default{accountName}.purview.azure.com/scan/datasources/{dataSourceName}/scans/{scanName}
    Microsoft.Purview/accounts/Scanning/integrationruntimes/integrationruntimes/{integrationRuntimeName}{accountName}.purview.azure.com/scan
    Microsoft.Purview/accounts/Scanning/managedvirtualnetworks/managedprivateendpoints/managedvirtualnetworks/{managedVirtualNetworkName}/managedprivateendpoints/{managedPrivateEndpointName}{accountName}.purview.azure.com/scan/managedvirtualnetworks/{managedVirtualNetworkName}
    Microsoft.Purview/accounts/Workflow/workflows/workflows/{workflowId}{accountName}.purview.azure.com
    Microsoft.Synapse/workspaces/dataflows/dataflows/{dataFlowName}{workspaceName}.dev.azuresynapse.net
    Microsoft.Synapse/workspaces/datasets/datasets/{datasetName}{workspaceName}.dev.azuresynapse.net
    Microsoft.Synapse/workspaces/kqlScripts/kqlScripts/{kqlScriptName}{workspaceName}.dev.azuresynapse.net
    Microsoft.Synapse/workspaces/libraries/libraries/{libraryName}{workspaceName}.dev.azuresynapse.net
    Microsoft.Synapse/workspaces/linkconnections/linkconnections/{linkConnectionName}{workspaceName}.dev.azuresynapse.net
    Microsoft.Synapse/workspaces/linkedservices/linkedservices/{linkedServiceName}{workspaceName}.dev.azuresynapse.net
    Microsoft.Synapse/workspaces/managedVirtualNetworks/managedPrivateEndpoints/managedVirtualNetworks/{managedVirtualNetworkName}/managedPrivateEndpoints/{managedPrivateEndpointName}{workspaceName}.dev.azuresynapse.net/managedVirtualNetworks/{managedVirtualNetworkName}
    Microsoft.Synapse/workspaces/notebooks/notebooks/{notebookName}{workspaceName}.dev.azuresynapse.net
    Microsoft.Synapse/workspaces/pipelines/pipelines/{pipelineName}{workspaceName}.dev.azuresynapse.net
    Microsoft.Synapse/workspaces/roleAssignments/roleAssignments/{roleAssignmentId}{workspaceName}.dev.azuresynapse.net
    Microsoft.Synapse/workspaces/sparkJobDefinitions/sparkJobDefinitions/{sparkJobDefinitionName}{workspaceName}.dev.azuresynapse.net
    Microsoft.Synapse/workspaces/sparkconfigurations/sparkconfigurations/{sparkConfigurationName}{workspaceName}.dev.azuresynapse.net
    Microsoft.Synapse/workspaces/sqlScripts/sqlScripts/{sqlScriptName}{workspaceName}.dev.azuresynapse.net
    Microsoft.Synapse/workspaces/triggers/triggers/{triggerName}{workspaceName}.dev.azuresynapse.net

    Create DataPlaneResource Resource

    new DataPlaneResource(name: string, args: DataPlaneResourceArgs, opts?: CustomResourceOptions);
    @overload
    def DataPlaneResource(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          body: Optional[str] = None,
                          ignore_casing: Optional[bool] = None,
                          ignore_missing_property: Optional[bool] = None,
                          locks: Optional[Sequence[str]] = None,
                          name: Optional[str] = None,
                          parent_id: Optional[str] = None,
                          response_export_values: Optional[Sequence[str]] = None,
                          type: Optional[str] = None)
    @overload
    def DataPlaneResource(resource_name: str,
                          args: DataPlaneResourceArgs,
                          opts: Optional[ResourceOptions] = None)
    func NewDataPlaneResource(ctx *Context, name string, args DataPlaneResourceArgs, opts ...ResourceOption) (*DataPlaneResource, error)
    public DataPlaneResource(string name, DataPlaneResourceArgs args, CustomResourceOptions? opts = null)
    public DataPlaneResource(String name, DataPlaneResourceArgs args)
    public DataPlaneResource(String name, DataPlaneResourceArgs args, CustomResourceOptions options)
    
    type: azapi:DataPlaneResource
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args DataPlaneResourceArgs
    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 DataPlaneResourceArgs
    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 DataPlaneResourceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DataPlaneResourceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DataPlaneResourceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    DataPlaneResource Resource Properties

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

    Inputs

    The DataPlaneResource resource accepts the following input properties:

    ParentId string

    The ID of the azure resource in which this resource is created. Changing this forces a new resource to be created.

    Type string

    It is in a format like <resource-type>@<api-version>. <api-version> is version of the API used to manage this azure data plane resource.

    Note For the available resource types and parent IDs, please refer to the Available Resources section below.

    Body string

    A JSON object that contains the request body used to create and update data plane resource.

    IgnoreCasing bool

    Whether ignore incorrect casing returned in body to suppress plan-diff. Defaults to false.

    IgnoreMissingProperty bool

    Whether ignore not returned properties like credentials in body to suppress plan-diff. Defaults to true.

    Locks List<string>

    A list of ARM resource IDs which are used to avoid create/modify/delete azapi resources at the same time.

    Name string

    Specifies the name of the azure resource. Changing this forces a new resource to be created.

    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"
    }
    }
    }
    }
    
    ParentId string

    The ID of the azure resource in which this resource is created. Changing this forces a new resource to be created.

    Type string

    It is in a format like <resource-type>@<api-version>. <api-version> is version of the API used to manage this azure data plane resource.

    Note For the available resource types and parent IDs, please refer to the Available Resources section below.

    Body string

    A JSON object that contains the request body used to create and update data plane resource.

    IgnoreCasing bool

    Whether ignore incorrect casing returned in body to suppress plan-diff. Defaults to false.

    IgnoreMissingProperty bool

    Whether ignore not returned properties like credentials in body to suppress plan-diff. Defaults to true.

    Locks []string

    A list of ARM resource IDs which are used to avoid create/modify/delete azapi resources at the same time.

    Name string

    Specifies the name of the azure resource. Changing this forces a new resource to be created.

    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"
    }
    }
    }
    }
    
    parentId String

    The ID of the azure resource in which this resource is created. Changing this forces a new resource to be created.

    type String

    It is in a format like <resource-type>@<api-version>. <api-version> is version of the API used to manage this azure data plane resource.

    Note For the available resource types and parent IDs, please refer to the Available Resources section below.

    body String

    A JSON object that contains the request body used to create and update data plane resource.

    ignoreCasing Boolean

    Whether ignore incorrect casing returned in body to suppress plan-diff. Defaults to false.

    ignoreMissingProperty Boolean

    Whether ignore not returned properties like credentials in body to suppress plan-diff. Defaults to true.

    locks List<String>

    A list of ARM resource IDs which are used to avoid create/modify/delete azapi resources at the same time.

    name String

    Specifies the name of the azure resource. Changing this forces a new resource to be created.

    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"
    }
    }
    }
    }
    
    parentId string

    The ID of the azure resource in which this resource is created. Changing this forces a new resource to be created.

    type string

    It is in a format like <resource-type>@<api-version>. <api-version> is version of the API used to manage this azure data plane resource.

    Note For the available resource types and parent IDs, please refer to the Available Resources section below.

    body string

    A JSON object that contains the request body used to create and update data plane resource.

    ignoreCasing boolean

    Whether ignore incorrect casing returned in body to suppress plan-diff. Defaults to false.

    ignoreMissingProperty boolean

    Whether ignore not returned properties like credentials in body to suppress plan-diff. Defaults to true.

    locks string[]

    A list of ARM resource IDs which are used to avoid create/modify/delete azapi resources at the same time.

    name string

    Specifies the name of the azure resource. Changing this forces a new resource to be created.

    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"
    }
    }
    }
    }
    
    parent_id str

    The ID of the azure resource in which this resource is created. Changing this forces a new resource to be created.

    type str

    It is in a format like <resource-type>@<api-version>. <api-version> is version of the API used to manage this azure data plane resource.

    Note For the available resource types and parent IDs, please refer to the Available Resources section below.

    body str

    A JSON object that contains the request body used to create and update data plane resource.

    ignore_casing bool

    Whether ignore incorrect casing returned in body to suppress plan-diff. Defaults to false.

    ignore_missing_property bool

    Whether ignore not returned properties like credentials in body to suppress plan-diff. Defaults to true.

    locks Sequence[str]

    A list of ARM resource IDs which are used to avoid create/modify/delete azapi resources at the same time.

    name str

    Specifies the name of the azure resource. Changing this forces a new resource to be created.

    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"
    }
    }
    }
    }
    
    parentId String

    The ID of the azure resource in which this resource is created. Changing this forces a new resource to be created.

    type String

    It is in a format like <resource-type>@<api-version>. <api-version> is version of the API used to manage this azure data plane resource.

    Note For the available resource types and parent IDs, please refer to the Available Resources section below.

    body String

    A JSON object that contains the request body used to create and update data plane resource.

    ignoreCasing Boolean

    Whether ignore incorrect casing returned in body to suppress plan-diff. Defaults to false.

    ignoreMissingProperty Boolean

    Whether ignore not returned properties like credentials in body to suppress plan-diff. Defaults to true.

    locks List<String>

    A list of ARM resource IDs which are used to avoid create/modify/delete azapi resources at the same time.

    name String

    Specifies the name of the azure resource. Changing this forces a new resource to be created.

    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"
    }
    }
    }
    }
    

    Outputs

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

    Id string

    The provider-assigned unique ID for this managed resource.

    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_data_plane_resource.example.output).properties.loginServer
    }
    
    Id string

    The provider-assigned unique ID for this managed resource.

    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_data_plane_resource.example.output).properties.loginServer
    }
    
    id String

    The provider-assigned unique ID for this managed resource.

    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_data_plane_resource.example.output).properties.loginServer
    }
    
    id string

    The provider-assigned unique ID for this managed resource.

    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_data_plane_resource.example.output).properties.loginServer
    }
    
    id str

    The provider-assigned unique ID for this managed resource.

    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_data_plane_resource.example.output).properties.loginServer
    }
    
    id String

    The provider-assigned unique ID for this managed resource.

    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_data_plane_resource.example.output).properties.loginServer
    }
    

    Look up Existing DataPlaneResource Resource

    Get an existing DataPlaneResource resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: DataPlaneResourceState, opts?: CustomResourceOptions): DataPlaneResource
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            body: Optional[str] = None,
            ignore_casing: Optional[bool] = None,
            ignore_missing_property: Optional[bool] = None,
            locks: Optional[Sequence[str]] = None,
            name: Optional[str] = None,
            output: Optional[str] = None,
            parent_id: Optional[str] = None,
            response_export_values: Optional[Sequence[str]] = None,
            type: Optional[str] = None) -> DataPlaneResource
    func GetDataPlaneResource(ctx *Context, name string, id IDInput, state *DataPlaneResourceState, opts ...ResourceOption) (*DataPlaneResource, error)
    public static DataPlaneResource Get(string name, Input<string> id, DataPlaneResourceState? state, CustomResourceOptions? opts = null)
    public static DataPlaneResource get(String name, Output<String> id, DataPlaneResourceState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Body string

    A JSON object that contains the request body used to create and update data plane resource.

    IgnoreCasing bool

    Whether ignore incorrect casing returned in body to suppress plan-diff. Defaults to false.

    IgnoreMissingProperty bool

    Whether ignore not returned properties like credentials in body to suppress plan-diff. Defaults to true.

    Locks List<string>

    A list of ARM resource IDs which are used to avoid create/modify/delete azapi resources at the same time.

    Name string

    Specifies the name of the azure resource. Changing this forces a new resource to be created.

    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_data_plane_resource.example.output).properties.loginServer
    }
    
    ParentId string

    The ID of the azure resource in which this resource is created. Changing this forces a new resource to be created.

    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>. <api-version> is version of the API used to manage this azure data plane resource.

    Note For the available resource types and parent IDs, please refer to the Available Resources section below.

    Body string

    A JSON object that contains the request body used to create and update data plane resource.

    IgnoreCasing bool

    Whether ignore incorrect casing returned in body to suppress plan-diff. Defaults to false.

    IgnoreMissingProperty bool

    Whether ignore not returned properties like credentials in body to suppress plan-diff. Defaults to true.

    Locks []string

    A list of ARM resource IDs which are used to avoid create/modify/delete azapi resources at the same time.

    Name string

    Specifies the name of the azure resource. Changing this forces a new resource to be created.

    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_data_plane_resource.example.output).properties.loginServer
    }
    
    ParentId string

    The ID of the azure resource in which this resource is created. Changing this forces a new resource to be created.

    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>. <api-version> is version of the API used to manage this azure data plane resource.

    Note For the available resource types and parent IDs, please refer to the Available Resources section below.

    body String

    A JSON object that contains the request body used to create and update data plane resource.

    ignoreCasing Boolean

    Whether ignore incorrect casing returned in body to suppress plan-diff. Defaults to false.

    ignoreMissingProperty Boolean

    Whether ignore not returned properties like credentials in body to suppress plan-diff. Defaults to true.

    locks List<String>

    A list of ARM resource IDs which are used to avoid create/modify/delete azapi resources at the same time.

    name String

    Specifies the name of the azure resource. Changing this forces a new resource to be created.

    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_data_plane_resource.example.output).properties.loginServer
    }
    
    parentId String

    The ID of the azure resource in which this resource is created. Changing this forces a new resource to be created.

    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>. <api-version> is version of the API used to manage this azure data plane resource.

    Note For the available resource types and parent IDs, please refer to the Available Resources section below.

    body string

    A JSON object that contains the request body used to create and update data plane resource.

    ignoreCasing boolean

    Whether ignore incorrect casing returned in body to suppress plan-diff. Defaults to false.

    ignoreMissingProperty boolean

    Whether ignore not returned properties like credentials in body to suppress plan-diff. Defaults to true.

    locks string[]

    A list of ARM resource IDs which are used to avoid create/modify/delete azapi resources at the same time.

    name string

    Specifies the name of the azure resource. Changing this forces a new resource to be created.

    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_data_plane_resource.example.output).properties.loginServer
    }
    
    parentId string

    The ID of the azure resource in which this resource is created. Changing this forces a new resource to be created.

    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>. <api-version> is version of the API used to manage this azure data plane resource.

    Note For the available resource types and parent IDs, please refer to the Available Resources section below.

    body str

    A JSON object that contains the request body used to create and update data plane resource.

    ignore_casing bool

    Whether ignore incorrect casing returned in body to suppress plan-diff. Defaults to false.

    ignore_missing_property bool

    Whether ignore not returned properties like credentials in body to suppress plan-diff. Defaults to true.

    locks Sequence[str]

    A list of ARM resource IDs which are used to avoid create/modify/delete azapi resources at the same time.

    name str

    Specifies the name of the azure resource. Changing this forces a new resource to be created.

    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_data_plane_resource.example.output).properties.loginServer
    }
    
    parent_id str

    The ID of the azure resource in which this resource is created. Changing this forces a new resource to be created.

    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 str

    It is in a format like <resource-type>@<api-version>. <api-version> is version of the API used to manage this azure data plane resource.

    Note For the available resource types and parent IDs, please refer to the Available Resources section below.

    body String

    A JSON object that contains the request body used to create and update data plane resource.

    ignoreCasing Boolean

    Whether ignore incorrect casing returned in body to suppress plan-diff. Defaults to false.

    ignoreMissingProperty Boolean

    Whether ignore not returned properties like credentials in body to suppress plan-diff. Defaults to true.

    locks List<String>

    A list of ARM resource IDs which are used to avoid create/modify/delete azapi resources at the same time.

    name String

    Specifies the name of the azure resource. Changing this forces a new resource to be created.

    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_data_plane_resource.example.output).properties.loginServer
    }
    
    parentId String

    The ID of the azure resource in which this resource is created. Changing this forces a new resource to be created.

    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>. <api-version> is version of the API used to manage this azure data plane resource.

    Note For the available resource types and parent IDs, please refer to the Available Resources section below.

    Package Details

    Repository
    azapi dirien/pulumi-azapi
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the azapi Terraform Provider.

    azapi logo
    AzAPI v1.9.0 published on Monday, Sep 18, 2023 by dirien