Docs Home
AzAPI v1.12.2 published on Saturday, May 11, 2024 by dirien
azapi.DataPlaneResource
Explore with Pulumi AI
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 Type | URL | Parent 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
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new DataPlaneResource(name: string, args: DataPlaneResourceArgs, opts?: CustomResourceOptions);@overload
def DataPlaneResource(resource_name: str,
args: DataPlaneResourceArgs,
opts: Optional[ResourceOptions] = None)
@overload
def DataPlaneResource(resource_name: str,
opts: Optional[ResourceOptions] = None,
parent_id: Optional[str] = None,
type: Optional[str] = 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,
response_export_values: Optional[Sequence[str]] = 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.
Parameters
- 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var dataPlaneResourceResource = new Azapi.DataPlaneResource("dataPlaneResourceResource", new()
{
ParentId = "string",
Type = "string",
Body = "string",
IgnoreCasing = false,
IgnoreMissingProperty = false,
Locks = new[]
{
"string",
},
Name = "string",
ResponseExportValues = new[]
{
"string",
},
});
example, err := azapi.NewDataPlaneResource(ctx, "dataPlaneResourceResource", &azapi.DataPlaneResourceArgs{
ParentId: pulumi.String("string"),
Type: pulumi.String("string"),
Body: pulumi.String("string"),
IgnoreCasing: pulumi.Bool(false),
IgnoreMissingProperty: pulumi.Bool(false),
Locks: pulumi.StringArray{
pulumi.String("string"),
},
Name: pulumi.String("string"),
ResponseExportValues: pulumi.StringArray{
pulumi.String("string"),
},
})
var dataPlaneResourceResource = new DataPlaneResource("dataPlaneResourceResource", DataPlaneResourceArgs.builder()
.parentId("string")
.type("string")
.body("string")
.ignoreCasing(false)
.ignoreMissingProperty(false)
.locks("string")
.name("string")
.responseExportValues("string")
.build());
data_plane_resource_resource = azapi.DataPlaneResource("dataPlaneResourceResource",
parent_id="string",
type="string",
body="string",
ignore_casing=False,
ignore_missing_property=False,
locks=["string"],
name="string",
response_export_values=["string"])
const dataPlaneResourceResource = new azapi.DataPlaneResource("dataPlaneResourceResource", {
parentId: "string",
type: "string",
body: "string",
ignoreCasing: false,
ignoreMissingProperty: false,
locks: ["string"],
name: "string",
responseExportValues: ["string"],
});
type: azapi:DataPlaneResource
properties:
body: string
ignoreCasing: false
ignoreMissingProperty: false
locks:
- string
name: string
parentId: string
responseExportValues:
- string
type: string
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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The DataPlaneResource resource accepts the following input properties:
- Parent
Id 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 Resourcessection below.- Body string
- 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
bodyto suppress plan-diff. Defaults tofalse. - Ignore
Missing boolProperty - Whether ignore not returned properties like credentials in
bodyto suppress plan-diff. Defaults totrue. - 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.
- Response
Export List<string>Values - 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 propertyoutput.{ "properties" : { "loginServer" : "registry1.azurecr.io" "policies" : { "quarantinePolicy" = { "status" = "disabled" } } } }
- Parent
Id 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 Resourcessection below.- Body string
- 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
bodyto suppress plan-diff. Defaults tofalse. - Ignore
Missing boolProperty - Whether ignore not returned properties like credentials in
bodyto suppress plan-diff. Defaults totrue. - 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.
- Response
Export []stringValues - 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 propertyoutput.{ "properties" : { "loginServer" : "registry1.azurecr.io" "policies" : { "quarantinePolicy" = { "status" = "disabled" } } } }
- parent
Id 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 Resourcessection below.- body String
- A JSON object that contains the request body used to create and update data plane resource.
- ignore
Casing Boolean - Whether ignore incorrect casing returned in
bodyto suppress plan-diff. Defaults tofalse. - ignore
Missing BooleanProperty - Whether ignore not returned properties like credentials in
bodyto suppress plan-diff. Defaults totrue. - 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.
- response
Export List<String>Values - 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 propertyoutput.{ "properties" : { "loginServer" : "registry1.azurecr.io" "policies" : { "quarantinePolicy" = { "status" = "disabled" } } } }
- parent
Id 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 Resourcessection below.- body string
- A JSON object that contains the request body used to create and update data plane resource.
- ignore
Casing boolean - Whether ignore incorrect casing returned in
bodyto suppress plan-diff. Defaults tofalse. - ignore
Missing booleanProperty - Whether ignore not returned properties like credentials in
bodyto suppress plan-diff. Defaults totrue. - 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.
- response
Export string[]Values - 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 propertyoutput.{ "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 Resourcessection 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
bodyto suppress plan-diff. Defaults tofalse. - ignore_
missing_ boolproperty - Whether ignore not returned properties like credentials in
bodyto suppress plan-diff. Defaults totrue. - 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_ Sequence[str]values - 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 propertyoutput.{ "properties" : { "loginServer" : "registry1.azurecr.io" "policies" : { "quarantinePolicy" = { "status" = "disabled" } } } }
- parent
Id 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 Resourcessection below.- body String
- A JSON object that contains the request body used to create and update data plane resource.
- ignore
Casing Boolean - Whether ignore incorrect casing returned in
bodyto suppress plan-diff. Defaults tofalse. - ignore
Missing BooleanProperty - Whether ignore not returned properties like credentials in
bodyto suppress plan-diff. Defaults totrue. - 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.
- response
Export List<String>Values - 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 propertyoutput.{ "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) -> DataPlaneResourcefunc 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.
- Body string
- 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
bodyto suppress plan-diff. Defaults tofalse. - Ignore
Missing boolProperty - Whether ignore not returned properties like credentials in
bodyto suppress plan-diff. Defaults totrue. - 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 } - Parent
Id string - The ID of the azure resource in which this resource is created. Changing this forces a new resource to be created.
- Response
Export List<string>Values - 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 propertyoutput.{ "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 Resourcessection below.
- Body string
- 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
bodyto suppress plan-diff. Defaults tofalse. - Ignore
Missing boolProperty - Whether ignore not returned properties like credentials in
bodyto suppress plan-diff. Defaults totrue. - 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 } - Parent
Id string - The ID of the azure resource in which this resource is created. Changing this forces a new resource to be created.
- Response
Export []stringValues - 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 propertyoutput.{ "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 Resourcessection below.
- body String
- A JSON object that contains the request body used to create and update data plane resource.
- ignore
Casing Boolean - Whether ignore incorrect casing returned in
bodyto suppress plan-diff. Defaults tofalse. - ignore
Missing BooleanProperty - Whether ignore not returned properties like credentials in
bodyto suppress plan-diff. Defaults totrue. - 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 } - parent
Id String - The ID of the azure resource in which this resource is created. Changing this forces a new resource to be created.
- response
Export List<String>Values - 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 propertyoutput.{ "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 Resourcessection below.
- body string
- A JSON object that contains the request body used to create and update data plane resource.
- ignore
Casing boolean - Whether ignore incorrect casing returned in
bodyto suppress plan-diff. Defaults tofalse. - ignore
Missing booleanProperty - Whether ignore not returned properties like credentials in
bodyto suppress plan-diff. Defaults totrue. - 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 } - parent
Id string - The ID of the azure resource in which this resource is created. Changing this forces a new resource to be created.
- response
Export string[]Values - 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 propertyoutput.{ "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 Resourcessection 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
bodyto suppress plan-diff. Defaults tofalse. - ignore_
missing_ boolproperty - Whether ignore not returned properties like credentials in
bodyto suppress plan-diff. Defaults totrue. - 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_ Sequence[str]values - 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 propertyoutput.{ "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 Resourcessection below.
- body String
- A JSON object that contains the request body used to create and update data plane resource.
- ignore
Casing Boolean - Whether ignore incorrect casing returned in
bodyto suppress plan-diff. Defaults tofalse. - ignore
Missing BooleanProperty - Whether ignore not returned properties like credentials in
bodyto suppress plan-diff. Defaults totrue. - 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 } - parent
Id String - The ID of the azure resource in which this resource is created. Changing this forces a new resource to be created.
- response
Export List<String>Values - 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 propertyoutput.{ "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 Resourcessection below.
Package Details
- Repository
- azapi dirien/pulumi-azapi
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
azapiTerraform Provider.