Docs Packages
  1. Pulumi Registry
  2. AzAPI
  3. API Docs
  4. UpdateResource
azapi logo
AzAPI v1.6.0, May 19 23

azapi.UpdateResource

Explore with Pulumi AI

This resource can manage a subset of any existing Azure resource manager resource’s properties.

Note This resource is used to add or modify properties on an existing resource. When delete azapi.UpdateResource, no operation will be performed, and these properties will stay unchanged. If you want to restore the modified properties to some values, you must apply the restored properties before deleting.

Create UpdateResource Resource

new UpdateResource(name: string, args: UpdateResourceArgs, opts?: CustomResourceOptions);
@overload
def UpdateResource(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,
                   resource_id: Optional[str] = None,
                   response_export_values: Optional[Sequence[str]] = None,
                   type: Optional[str] = None)
@overload
def UpdateResource(resource_name: str,
                   args: UpdateResourceArgs,
                   opts: Optional[ResourceOptions] = None)
func NewUpdateResource(ctx *Context, name string, args UpdateResourceArgs, opts ...ResourceOption) (*UpdateResource, error)
public UpdateResource(string name, UpdateResourceArgs args, CustomResourceOptions? opts = null)
public UpdateResource(String name, UpdateResourceArgs args)
public UpdateResource(String name, UpdateResourceArgs args, CustomResourceOptions options)

type: azapi:UpdateResource
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args UpdateResourceArgs
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 UpdateResourceArgs
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 UpdateResourceArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args UpdateResourceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args UpdateResourceArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

UpdateResource 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 UpdateResource resource accepts the following input properties:

Type string

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

Body string

A JSON object that contains the request body used to add on an existing azure 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.

ParentId string

The ID of the azure resource in which this resource is created. Changing this forces a new resource to be created. It supports different kinds of deployment scope for top level resources:

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

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

ResourceId string

The ID of an existing azure source. Changing this forces a new azure resource to be created.

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

ResponseExportValues List<string>

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

import * as pulumi from "@pulumi/pulumi";

import pulumi

using System.Collections.Generic;
using System.Linq;
using Pulumi;

return await Deployment.RunAsync(() =>
{
});


package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
    }
}

{}
Type string

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

Body string

A JSON object that contains the request body used to add on an existing azure 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.

ParentId string

The ID of the azure resource in which this resource is created. Changing this forces a new resource to be created. It supports different kinds of deployment scope for top level resources:

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

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

ResourceId string

The ID of an existing azure source. Changing this forces a new azure resource to be created.

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

ResponseExportValues []string

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

import * as pulumi from "@pulumi/pulumi";

import pulumi

using System.Collections.Generic;
using System.Linq;
using Pulumi;

return await Deployment.RunAsync(() =>
{
});


package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
    }
}

{}
type String

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

body String

A JSON object that contains the request body used to add on an existing azure 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.

parentId String

The ID of the azure resource in which this resource is created. Changing this forces a new resource to be created. It supports different kinds of deployment scope for top level resources:

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

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

resourceId String

The ID of an existing azure source. Changing this forces a new azure resource to be created.

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

responseExportValues List<String>

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

import * as pulumi from "@pulumi/pulumi";

import pulumi

using System.Collections.Generic;
using System.Linq;
using Pulumi;

return await Deployment.RunAsync(() =>
{
});


package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
    }
}

{}
type string

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

body string

A JSON object that contains the request body used to add on an existing azure 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.

parentId string

The ID of the azure resource in which this resource is created. Changing this forces a new resource to be created. It supports different kinds of deployment scope for top level resources:

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

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

resourceId string

The ID of an existing azure source. Changing this forces a new azure resource to be created.

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

responseExportValues string[]

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

import * as pulumi from "@pulumi/pulumi";

import pulumi

using System.Collections.Generic;
using System.Linq;
using Pulumi;

return await Deployment.RunAsync(() =>
{
});


package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
    }
}

{}
type str

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

body str

A JSON object that contains the request body used to add on an existing azure 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.

parent_id str

The ID of the azure resource in which this resource is created. Changing this forces a new resource to be created. It supports different kinds of deployment scope for top level resources:

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

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

resource_id str

The ID of an existing azure source. Changing this forces a new azure resource to be created.

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

response_export_values Sequence[str]

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

import * as pulumi from "@pulumi/pulumi";

import pulumi

using System.Collections.Generic;
using System.Linq;
using Pulumi;

return await Deployment.RunAsync(() =>
{
});


package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
    }
}

{}
type String

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

body String

A JSON object that contains the request body used to add on an existing azure 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.

parentId String

The ID of the azure resource in which this resource is created. Changing this forces a new resource to be created. It supports different kinds of deployment scope for top level resources:

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

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

resourceId String

The ID of an existing azure source. Changing this forces a new azure resource to be created.

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

responseExportValues List<String>

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

import * as pulumi from "@pulumi/pulumi";

import pulumi

using System.Collections.Generic;
using System.Linq;
using Pulumi;

return await Deployment.RunAsync(() =>
{
});


package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
    }
}

{}

Outputs

All input properties are implicitly available as output properties. Additionally, the UpdateResource 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.

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.

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.

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.

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.

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.

Look up Existing UpdateResource Resource

Get an existing UpdateResource 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?: UpdateResourceState, opts?: CustomResourceOptions): UpdateResource
@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,
        resource_id: Optional[str] = None,
        response_export_values: Optional[Sequence[str]] = None,
        type: Optional[str] = None) -> UpdateResource
func GetUpdateResource(ctx *Context, name string, id IDInput, state *UpdateResourceState, opts ...ResourceOption) (*UpdateResource, error)
public static UpdateResource Get(string name, Input<string> id, UpdateResourceState? state, CustomResourceOptions? opts = null)
public static UpdateResource get(String name, Output<String> id, UpdateResourceState 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 add on an existing azure 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.

ParentId string

The ID of the azure resource in which this resource is created. Changing this forces a new resource to be created. It supports different kinds of deployment scope for top level resources:

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

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

ResourceId string

The ID of an existing azure source. Changing this forces a new azure resource to be created.

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

ResponseExportValues List<string>

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

import * as pulumi from "@pulumi/pulumi";

import pulumi

using System.Collections.Generic;
using System.Linq;
using Pulumi;

return await Deployment.RunAsync(() =>
{
});


package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
    }
}

{}
Type string

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

Body string

A JSON object that contains the request body used to add on an existing azure 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.

ParentId string

The ID of the azure resource in which this resource is created. Changing this forces a new resource to be created. It supports different kinds of deployment scope for top level resources:

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

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

ResourceId string

The ID of an existing azure source. Changing this forces a new azure resource to be created.

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

ResponseExportValues []string

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

import * as pulumi from "@pulumi/pulumi";

import pulumi

using System.Collections.Generic;
using System.Linq;
using Pulumi;

return await Deployment.RunAsync(() =>
{
});


package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
    }
}

{}
Type string

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

body String

A JSON object that contains the request body used to add on an existing azure 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.

parentId String

The ID of the azure resource in which this resource is created. Changing this forces a new resource to be created. It supports different kinds of deployment scope for top level resources:

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

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

resourceId String

The ID of an existing azure source. Changing this forces a new azure resource to be created.

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

responseExportValues List<String>

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

import * as pulumi from "@pulumi/pulumi";

import pulumi

using System.Collections.Generic;
using System.Linq;
using Pulumi;

return await Deployment.RunAsync(() =>
{
});


package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
    }
}

{}
type String

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

body string

A JSON object that contains the request body used to add on an existing azure 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.

parentId string

The ID of the azure resource in which this resource is created. Changing this forces a new resource to be created. It supports different kinds of deployment scope for top level resources:

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

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

resourceId string

The ID of an existing azure source. Changing this forces a new azure resource to be created.

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

responseExportValues string[]

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

import * as pulumi from "@pulumi/pulumi";

import pulumi

using System.Collections.Generic;
using System.Linq;
using Pulumi;

return await Deployment.RunAsync(() =>
{
});


package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
    }
}

{}
type string

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

body str

A JSON object that contains the request body used to add on an existing azure 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.

parent_id str

The ID of the azure resource in which this resource is created. Changing this forces a new resource to be created. It supports different kinds of deployment scope for top level resources:

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

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

resource_id str

The ID of an existing azure source. Changing this forces a new azure resource to be created.

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

response_export_values Sequence[str]

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

import * as pulumi from "@pulumi/pulumi";

import pulumi

using System.Collections.Generic;
using System.Linq;
using Pulumi;

return await Deployment.RunAsync(() =>
{
});


package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
    }
}

{}
type str

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

body String

A JSON object that contains the request body used to add on an existing azure 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.

parentId String

The ID of the azure resource in which this resource is created. Changing this forces a new resource to be created. It supports different kinds of deployment scope for top level resources:

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

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

resourceId String

The ID of an existing azure source. Changing this forces a new azure resource to be created.

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

responseExportValues List<String>

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

import * as pulumi from "@pulumi/pulumi";

import pulumi

using System.Collections.Generic;
using System.Linq;
using Pulumi;

return await Deployment.RunAsync(() =>
{
});


package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
    }
}

{}
type String

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

Package Details

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

This Pulumi package is based on the azapi Terraform Provider.