azapi

package
v1.12.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 3, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Overview

A Pulumi package for creating and managing Azapi resources

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type DataPlaneResource added in v1.12.0 

type DataPlaneResource struct {
	pulumi.CustomResourceState

	// A JSON object that contains the request body used to create and update data plane resource.
	Body pulumi.StringPtrOutput `pulumi:"body"`
	// Whether ignore incorrect casing returned in `body` to suppress plan-diff. Defaults to `false`.
	IgnoreCasing pulumi.BoolPtrOutput `pulumi:"ignoreCasing"`
	// Whether ignore not returned properties like credentials in `body` to suppress plan-diff. Defaults to `true`.
	IgnoreMissingProperty pulumi.BoolPtrOutput `pulumi:"ignoreMissingProperty"`
	// A list of ARM resource IDs which are used to avoid create/modify/delete azapi resources at the same time.
	Locks pulumi.StringArrayOutput `pulumi:"locks"`
	// Specifies the name of the azure resource. Changing this forces a new resource to be created.
	Name pulumi.StringOutput `pulumi:"name"`
	// The output json containing the properties specified in `responseExportValues`. Here're some examples to decode json and extract the value.
	Output pulumi.StringOutput `pulumi:"output"`
	// The ID of the azure resource in which this resource is created. Changing this forces a new resource to be created.
	ParentId pulumi.StringOutput `pulumi:"parentId"`
	// 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`.
	ResponseExportValues pulumi.StringArrayOutput `pulumi:"responseExportValues"`
	// 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.
	Type pulumi.StringOutput `pulumi:"type"`
}

This resource can manage some Azure data plane resource.

## Example Usage

## 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 |

func GetDataPlaneResource added in v1.12.0 

func GetDataPlaneResource(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *DataPlaneResourceState, opts ...pulumi.ResourceOption) (*DataPlaneResource, error)

GetDataPlaneResource gets an existing DataPlaneResource resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewDataPlaneResource added in v1.12.0 

func NewDataPlaneResource(ctx *pulumi.Context,
	name string, args *DataPlaneResourceArgs, opts ...pulumi.ResourceOption) (*DataPlaneResource, error)

NewDataPlaneResource registers a new resource with the given unique name, arguments, and options.

func (*DataPlaneResource) ElementType added in v1.12.0 

func (*DataPlaneResource) ElementType() reflect.Type

func (*DataPlaneResource) ToDataPlaneResourceOutput added in v1.12.0 

func (i *DataPlaneResource) ToDataPlaneResourceOutput() DataPlaneResourceOutput

func (*DataPlaneResource) ToDataPlaneResourceOutputWithContext added in v1.12.0 

func (i *DataPlaneResource) ToDataPlaneResourceOutputWithContext(ctx context.Context) DataPlaneResourceOutput

type DataPlaneResourceArgs added in v1.12.0 

type DataPlaneResourceArgs struct {
	// A JSON object that contains the request body used to create and update data plane resource.
	Body pulumi.StringPtrInput
	// Whether ignore incorrect casing returned in `body` to suppress plan-diff. Defaults to `false`.
	IgnoreCasing pulumi.BoolPtrInput
	// Whether ignore not returned properties like credentials in `body` to suppress plan-diff. Defaults to `true`.
	IgnoreMissingProperty pulumi.BoolPtrInput
	// A list of ARM resource IDs which are used to avoid create/modify/delete azapi resources at the same time.
	Locks pulumi.StringArrayInput
	// Specifies the name of the azure resource. Changing this forces a new resource to be created.
	Name pulumi.StringPtrInput
	// The ID of the azure resource in which this resource is created. Changing this forces a new resource to be created.
	ParentId pulumi.StringInput
	// 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`.
	ResponseExportValues pulumi.StringArrayInput
	// 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.
	Type pulumi.StringInput
}

The set of arguments for constructing a DataPlaneResource resource.

func (DataPlaneResourceArgs) ElementType added in v1.12.0 

func (DataPlaneResourceArgs) ElementType() reflect.Type

type DataPlaneResourceArray added in v1.12.0 

type DataPlaneResourceArray []DataPlaneResourceInput

func (DataPlaneResourceArray) ElementType added in v1.12.0 

func (DataPlaneResourceArray) ElementType() reflect.Type

func (DataPlaneResourceArray) ToDataPlaneResourceArrayOutput added in v1.12.0 

func (i DataPlaneResourceArray) ToDataPlaneResourceArrayOutput() DataPlaneResourceArrayOutput

func (DataPlaneResourceArray) ToDataPlaneResourceArrayOutputWithContext added in v1.12.0 

func (i DataPlaneResourceArray) ToDataPlaneResourceArrayOutputWithContext(ctx context.Context) DataPlaneResourceArrayOutput

type DataPlaneResourceArrayInput added in v1.12.0 

type DataPlaneResourceArrayInput interface {
	pulumi.Input

	ToDataPlaneResourceArrayOutput() DataPlaneResourceArrayOutput
	ToDataPlaneResourceArrayOutputWithContext(context.Context) DataPlaneResourceArrayOutput
}

DataPlaneResourceArrayInput is an input type that accepts DataPlaneResourceArray and DataPlaneResourceArrayOutput values. You can construct a concrete instance of `DataPlaneResourceArrayInput` via: 

DataPlaneResourceArray{ DataPlaneResourceArgs{...} }

type DataPlaneResourceArrayOutput added in v1.12.0 

type DataPlaneResourceArrayOutput struct{ *pulumi.OutputState }

func (DataPlaneResourceArrayOutput) ElementType added in v1.12.0 

func (DataPlaneResourceArrayOutput) ElementType() reflect.Type

func (DataPlaneResourceArrayOutput) Index added in v1.12.0 

func (o DataPlaneResourceArrayOutput) Index(i pulumi.IntInput) DataPlaneResourceOutput

func (DataPlaneResourceArrayOutput) ToDataPlaneResourceArrayOutput added in v1.12.0 

func (o DataPlaneResourceArrayOutput) ToDataPlaneResourceArrayOutput() DataPlaneResourceArrayOutput

func (DataPlaneResourceArrayOutput) ToDataPlaneResourceArrayOutputWithContext added in v1.12.0 

func (o DataPlaneResourceArrayOutput) ToDataPlaneResourceArrayOutputWithContext(ctx context.Context) DataPlaneResourceArrayOutput

type DataPlaneResourceInput added in v1.12.0 

type DataPlaneResourceInput interface {
	pulumi.Input

	ToDataPlaneResourceOutput() DataPlaneResourceOutput
	ToDataPlaneResourceOutputWithContext(ctx context.Context) DataPlaneResourceOutput
}

type DataPlaneResourceMap added in v1.12.0 

type DataPlaneResourceMap map[string]DataPlaneResourceInput

func (DataPlaneResourceMap) ElementType added in v1.12.0 

func (DataPlaneResourceMap) ElementType() reflect.Type

func (DataPlaneResourceMap) ToDataPlaneResourceMapOutput added in v1.12.0 

func (i DataPlaneResourceMap) ToDataPlaneResourceMapOutput() DataPlaneResourceMapOutput

func (DataPlaneResourceMap) ToDataPlaneResourceMapOutputWithContext added in v1.12.0 

func (i DataPlaneResourceMap) ToDataPlaneResourceMapOutputWithContext(ctx context.Context) DataPlaneResourceMapOutput

type DataPlaneResourceMapInput added in v1.12.0 

type DataPlaneResourceMapInput interface {
	pulumi.Input

	ToDataPlaneResourceMapOutput() DataPlaneResourceMapOutput
	ToDataPlaneResourceMapOutputWithContext(context.Context) DataPlaneResourceMapOutput
}

DataPlaneResourceMapInput is an input type that accepts DataPlaneResourceMap and DataPlaneResourceMapOutput values. You can construct a concrete instance of `DataPlaneResourceMapInput` via: 

DataPlaneResourceMap{ "key": DataPlaneResourceArgs{...} }

type DataPlaneResourceMapOutput added in v1.12.0 

type DataPlaneResourceMapOutput struct{ *pulumi.OutputState }

func (DataPlaneResourceMapOutput) ElementType added in v1.12.0 

func (DataPlaneResourceMapOutput) ElementType() reflect.Type

func (DataPlaneResourceMapOutput) MapIndex added in v1.12.0 

func (o DataPlaneResourceMapOutput) MapIndex(k pulumi.StringInput) DataPlaneResourceOutput

func (DataPlaneResourceMapOutput) ToDataPlaneResourceMapOutput added in v1.12.0 

func (o DataPlaneResourceMapOutput) ToDataPlaneResourceMapOutput() DataPlaneResourceMapOutput

func (DataPlaneResourceMapOutput) ToDataPlaneResourceMapOutputWithContext added in v1.12.0 

func (o DataPlaneResourceMapOutput) ToDataPlaneResourceMapOutputWithContext(ctx context.Context) DataPlaneResourceMapOutput

type DataPlaneResourceOutput added in v1.12.0 

type DataPlaneResourceOutput struct{ *pulumi.OutputState }

func (DataPlaneResourceOutput) Body added in v1.12.0 

func (o DataPlaneResourceOutput) Body() pulumi.StringPtrOutput

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

func (DataPlaneResourceOutput) ElementType added in v1.12.0 

func (DataPlaneResourceOutput) ElementType() reflect.Type

func (DataPlaneResourceOutput) IgnoreCasing added in v1.12.0 

func (o DataPlaneResourceOutput) IgnoreCasing() pulumi.BoolPtrOutput

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

func (DataPlaneResourceOutput) IgnoreMissingProperty added in v1.12.0 

func (o DataPlaneResourceOutput) IgnoreMissingProperty() pulumi.BoolPtrOutput

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

func (DataPlaneResourceOutput) Locks added in v1.12.0 

func (o DataPlaneResourceOutput) Locks() pulumi.StringArrayOutput

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

func (DataPlaneResourceOutput) Name added in v1.12.0 

func (o DataPlaneResourceOutput) Name() pulumi.StringOutput

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

func (DataPlaneResourceOutput) Output added in v1.12.0 

func (o DataPlaneResourceOutput) Output() pulumi.StringOutput

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

func (DataPlaneResourceOutput) ParentId added in v1.12.0 

func (o DataPlaneResourceOutput) ParentId() pulumi.StringOutput

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

func (DataPlaneResourceOutput) ResponseExportValues added in v1.12.0 

func (o DataPlaneResourceOutput) ResponseExportValues() pulumi.StringArrayOutput

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`.

func (DataPlaneResourceOutput) ToDataPlaneResourceOutput added in v1.12.0 

func (o DataPlaneResourceOutput) ToDataPlaneResourceOutput() DataPlaneResourceOutput

func (DataPlaneResourceOutput) ToDataPlaneResourceOutputWithContext added in v1.12.0 

func (o DataPlaneResourceOutput) ToDataPlaneResourceOutputWithContext(ctx context.Context) DataPlaneResourceOutput

func (DataPlaneResourceOutput) Type added in v1.12.0 

func (o DataPlaneResourceOutput) Type() pulumi.StringOutput

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.

type DataPlaneResourceState added in v1.12.0 

type DataPlaneResourceState struct {
	// A JSON object that contains the request body used to create and update data plane resource.
	Body pulumi.StringPtrInput
	// Whether ignore incorrect casing returned in `body` to suppress plan-diff. Defaults to `false`.
	IgnoreCasing pulumi.BoolPtrInput
	// Whether ignore not returned properties like credentials in `body` to suppress plan-diff. Defaults to `true`.
	IgnoreMissingProperty pulumi.BoolPtrInput
	// A list of ARM resource IDs which are used to avoid create/modify/delete azapi resources at the same time.
	Locks pulumi.StringArrayInput
	// Specifies the name of the azure resource. Changing this forces a new resource to be created.
	Name pulumi.StringPtrInput
	// The output json containing the properties specified in `responseExportValues`. Here're some examples to decode json and extract the value.
	Output pulumi.StringPtrInput
	// The ID of the azure resource in which this resource is created. Changing this forces a new resource to be created.
	ParentId pulumi.StringPtrInput
	// 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`.
	ResponseExportValues pulumi.StringArrayInput
	// 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.
	Type pulumi.StringPtrInput
}

func (DataPlaneResourceState) ElementType added in v1.12.0 

func (DataPlaneResourceState) ElementType() reflect.Type

type GetResourceIdArgs added in v1.12.0 

type GetResourceIdArgs struct {
	// Specifies the name of the azure resource.
	Name *string `pulumi:"name"`
	// The ID of the azure resource in which this resource is created. It supports different kinds of deployment scope for **top level** resources:
	// - resource group scope: `parentId` should be the ID of a resource group, it's recommended to manage a resource group by azurerm_resource_group.
	// - management group scope: `parentId` should be the ID of a management group, it's recommended to manage a management group by azurerm_management_group.
	// - extension scope: `parentId` should be the ID of the resource you're adding the extension to.
	// - subscription scope: `parentId` should be like `/subscriptions/00000000-0000-0000-0000-000000000000`
	// - tenant scope: `parentId` should be `/`
	//
	// For child level resources, the `parentId` should be the ID of its parent resource, for example, subnet resource's `parentId` is the ID of the vnet.
	ParentId *string `pulumi:"parentId"`
	// The ID of an existing azure source.
	//
	// > **Note:** Configuring `name` and `parentId` is an alternative way to configure `resourceId`.
	ResourceId *string `pulumi:"resourceId"`
	// 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.
	Type string `pulumi:"type"`
}

A collection of arguments for invoking getResourceId.

type GetResourceIdOutputArgs added in v1.12.0 

type GetResourceIdOutputArgs struct {
	// Specifies the name of the azure resource.
	Name pulumi.StringPtrInput `pulumi:"name"`
	// The ID of the azure resource in which this resource is created. It supports different kinds of deployment scope for **top level** resources:
	// - resource group scope: `parentId` should be the ID of a resource group, it's recommended to manage a resource group by azurerm_resource_group.
	// - management group scope: `parentId` should be the ID of a management group, it's recommended to manage a management group by azurerm_management_group.
	// - extension scope: `parentId` should be the ID of the resource you're adding the extension to.
	// - subscription scope: `parentId` should be like `/subscriptions/00000000-0000-0000-0000-000000000000`
	// - tenant scope: `parentId` should be `/`
	//
	// For child level resources, the `parentId` should be the ID of its parent resource, for example, subnet resource's `parentId` is the ID of the vnet.
	ParentId pulumi.StringPtrInput `pulumi:"parentId"`
	// The ID of an existing azure source.
	//
	// > **Note:** Configuring `name` and `parentId` is an alternative way to configure `resourceId`.
	ResourceId pulumi.StringPtrInput `pulumi:"resourceId"`
	// 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.
	Type pulumi.StringInput `pulumi:"type"`
}

A collection of arguments for invoking getResourceId.

func (GetResourceIdOutputArgs) ElementType added in v1.12.0 

func (GetResourceIdOutputArgs) ElementType() reflect.Type

type GetResourceIdResult added in v1.12.0 

type GetResourceIdResult struct {
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// The name of the azure resource.
	Name string `pulumi:"name"`
	// The ID of the azure resource in which this resource is created.
	ParentId string `pulumi:"parentId"`
	// The map of the resource ID parts, where the key is the part name and the value is the part value. e.g. `virtualNetworks=myVnet`.
	Parts map[string]string `pulumi:"parts"`
	// The azure resource provider namespace of the azure resource.
	ProviderNamespace string `pulumi:"providerNamespace"`
	// The resource group name of the azure resource.
	ResourceGroupName string `pulumi:"resourceGroupName"`
	ResourceId        string `pulumi:"resourceId"`
	// The subscription ID of the azure resource.
	SubscriptionId string `pulumi:"subscriptionId"`
	Type           string `pulumi:"type"`
}

A collection of values returned by getResourceId.

func GetResourceId added in v1.12.0 

func GetResourceId(ctx *pulumi.Context, args *GetResourceIdArgs, opts ...pulumi.InvokeOption) (*GetResourceIdResult, error)

This resource can parse an Azure resource ID into its separate fields.

## Example Usage

type GetResourceIdResultOutput added in v1.12.0 

type GetResourceIdResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getResourceId.

func GetResourceIdOutput added in v1.12.0 

func GetResourceIdOutput(ctx *pulumi.Context, args GetResourceIdOutputArgs, opts ...pulumi.InvokeOption) GetResourceIdResultOutput

func (GetResourceIdResultOutput) ElementType added in v1.12.0 

func (GetResourceIdResultOutput) ElementType() reflect.Type

func (GetResourceIdResultOutput) Id added in v1.12.0 

func (o GetResourceIdResultOutput) Id() pulumi.StringOutput

The provider-assigned unique ID for this managed resource.

func (GetResourceIdResultOutput) Name added in v1.12.0 

func (o GetResourceIdResultOutput) Name() pulumi.StringOutput

The name of the azure resource.

func (GetResourceIdResultOutput) ParentId added in v1.12.0 

func (o GetResourceIdResultOutput) ParentId() pulumi.StringOutput

The ID of the azure resource in which this resource is created.

func (GetResourceIdResultOutput) Parts added in v1.12.0 

func (o GetResourceIdResultOutput) Parts() pulumi.StringMapOutput

The map of the resource ID parts, where the key is the part name and the value is the part value. e.g. `virtualNetworks=myVnet`.

func (GetResourceIdResultOutput) ProviderNamespace added in v1.12.0 

func (o GetResourceIdResultOutput) ProviderNamespace() pulumi.StringOutput

The azure resource provider namespace of the azure resource.

func (GetResourceIdResultOutput) ResourceGroupName added in v1.12.0 

func (o GetResourceIdResultOutput) ResourceGroupName() pulumi.StringOutput

The resource group name of the azure resource.

func (GetResourceIdResultOutput) ResourceId added in v1.12.0 

func (o GetResourceIdResultOutput) ResourceId() pulumi.StringOutput

func (GetResourceIdResultOutput) SubscriptionId added in v1.12.0 

func (o GetResourceIdResultOutput) SubscriptionId() pulumi.StringOutput

The subscription ID of the azure resource.

func (GetResourceIdResultOutput) ToGetResourceIdResultOutput added in v1.12.0 

func (o GetResourceIdResultOutput) ToGetResourceIdResultOutput() GetResourceIdResultOutput

func (GetResourceIdResultOutput) ToGetResourceIdResultOutputWithContext added in v1.12.0 

func (o GetResourceIdResultOutput) ToGetResourceIdResultOutputWithContext(ctx context.Context) GetResourceIdResultOutput

func (GetResourceIdResultOutput) Type added in v1.12.0 

func (o GetResourceIdResultOutput) Type() pulumi.StringOutput

type GetResourceIdentity 

type GetResourceIdentity struct {
	// A list of User Managed Identity ID's which should be assigned to the azure resource.
	IdentityIds []string `pulumi:"identityIds"`
	// The Principal ID for the Service Principal associated with the Managed Service Identity of this azure resource.
	PrincipalId string `pulumi:"principalId"`
	// The Tenant ID for the Service Principal associated with the Managed Service Identity of this azure resource.
	TenantId string `pulumi:"tenantId"`
	// 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.
	Type string `pulumi:"type"`
}

type GetResourceIdentityArgs 

type GetResourceIdentityArgs struct {
	// A list of User Managed Identity ID's which should be assigned to the azure resource.
	IdentityIds pulumi.StringArrayInput `pulumi:"identityIds"`
	// The Principal ID for the Service Principal associated with the Managed Service Identity of this azure resource.
	PrincipalId pulumi.StringInput `pulumi:"principalId"`
	// The Tenant ID for the Service Principal associated with the Managed Service Identity of this azure resource.
	TenantId pulumi.StringInput `pulumi:"tenantId"`
	// 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.
	Type pulumi.StringInput `pulumi:"type"`
}

func (GetResourceIdentityArgs) ElementType 

func (GetResourceIdentityArgs) ElementType() reflect.Type

func (GetResourceIdentityArgs) ToGetResourceIdentityOutput 

func (i GetResourceIdentityArgs) ToGetResourceIdentityOutput() GetResourceIdentityOutput

func (GetResourceIdentityArgs) ToGetResourceIdentityOutputWithContext 

func (i GetResourceIdentityArgs) ToGetResourceIdentityOutputWithContext(ctx context.Context) GetResourceIdentityOutput

func (GetResourceIdentityArgs) ToGetResourceIdentityPtrOutput 

func (i GetResourceIdentityArgs) ToGetResourceIdentityPtrOutput() GetResourceIdentityPtrOutput

func (GetResourceIdentityArgs) ToGetResourceIdentityPtrOutputWithContext 

func (i GetResourceIdentityArgs) ToGetResourceIdentityPtrOutputWithContext(ctx context.Context) GetResourceIdentityPtrOutput

type GetResourceIdentityInput 

type GetResourceIdentityInput interface {
	pulumi.Input

	ToGetResourceIdentityOutput() GetResourceIdentityOutput
	ToGetResourceIdentityOutputWithContext(context.Context) GetResourceIdentityOutput
}

GetResourceIdentityInput is an input type that accepts GetResourceIdentityArgs and GetResourceIdentityOutput values. You can construct a concrete instance of `GetResourceIdentityInput` via: 

GetResourceIdentityArgs{...}

type GetResourceIdentityOutput 

type GetResourceIdentityOutput struct{ *pulumi.OutputState }

func (GetResourceIdentityOutput) ElementType 

func (GetResourceIdentityOutput) ElementType() reflect.Type

func (GetResourceIdentityOutput) IdentityIds 

func (o GetResourceIdentityOutput) IdentityIds() pulumi.StringArrayOutput

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

func (GetResourceIdentityOutput) PrincipalId 

func (o GetResourceIdentityOutput) PrincipalId() pulumi.StringOutput

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

func (GetResourceIdentityOutput) TenantId 

func (o GetResourceIdentityOutput) TenantId() pulumi.StringOutput

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

func (GetResourceIdentityOutput) ToGetResourceIdentityOutput 

func (o GetResourceIdentityOutput) ToGetResourceIdentityOutput() GetResourceIdentityOutput

func (GetResourceIdentityOutput) ToGetResourceIdentityOutputWithContext 

func (o GetResourceIdentityOutput) ToGetResourceIdentityOutputWithContext(ctx context.Context) GetResourceIdentityOutput

func (GetResourceIdentityOutput) ToGetResourceIdentityPtrOutput 

func (o GetResourceIdentityOutput) ToGetResourceIdentityPtrOutput() GetResourceIdentityPtrOutput

func (GetResourceIdentityOutput) ToGetResourceIdentityPtrOutputWithContext 

func (o GetResourceIdentityOutput) ToGetResourceIdentityPtrOutputWithContext(ctx context.Context) GetResourceIdentityPtrOutput

func (GetResourceIdentityOutput) Type 

func (o GetResourceIdentityOutput) Type() pulumi.StringOutput

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.

type GetResourceIdentityPtrInput 

type GetResourceIdentityPtrInput interface {
	pulumi.Input

	ToGetResourceIdentityPtrOutput() GetResourceIdentityPtrOutput
	ToGetResourceIdentityPtrOutputWithContext(context.Context) GetResourceIdentityPtrOutput
}

GetResourceIdentityPtrInput is an input type that accepts GetResourceIdentityArgs, GetResourceIdentityPtr and GetResourceIdentityPtrOutput values. You can construct a concrete instance of `GetResourceIdentityPtrInput` via: 

        GetResourceIdentityArgs{...}

or:

        nil

func GetResourceIdentityPtr 

func GetResourceIdentityPtr(v *GetResourceIdentityArgs) GetResourceIdentityPtrInput

type GetResourceIdentityPtrOutput 

type GetResourceIdentityPtrOutput struct{ *pulumi.OutputState }

func (GetResourceIdentityPtrOutput) Elem 

func (o GetResourceIdentityPtrOutput) Elem() GetResourceIdentityOutput

func (GetResourceIdentityPtrOutput) ElementType 

func (GetResourceIdentityPtrOutput) ElementType() reflect.Type

func (GetResourceIdentityPtrOutput) IdentityIds 

func (o GetResourceIdentityPtrOutput) IdentityIds() pulumi.StringArrayOutput

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

func (GetResourceIdentityPtrOutput) PrincipalId 

func (o GetResourceIdentityPtrOutput) PrincipalId() pulumi.StringPtrOutput

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

func (GetResourceIdentityPtrOutput) TenantId 

func (o GetResourceIdentityPtrOutput) TenantId() pulumi.StringPtrOutput

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

func (GetResourceIdentityPtrOutput) ToGetResourceIdentityPtrOutput 

func (o GetResourceIdentityPtrOutput) ToGetResourceIdentityPtrOutput() GetResourceIdentityPtrOutput

func (GetResourceIdentityPtrOutput) ToGetResourceIdentityPtrOutputWithContext 

func (o GetResourceIdentityPtrOutput) ToGetResourceIdentityPtrOutputWithContext(ctx context.Context) GetResourceIdentityPtrOutput

func (GetResourceIdentityPtrOutput) Type 

func (o GetResourceIdentityPtrOutput) Type() pulumi.StringPtrOutput

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.

type GetResourceListArgs added in v1.12.0 

type GetResourceListArgs struct {
	// The parent resource ID to list resources under. e.g. `/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup`.
	ParentId string `pulumi:"parentId"`
	// 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 `["value"]`, it will set the following json to computed property `output`.
	ResponseExportValues []string `pulumi:"responseExportValues"`
	// 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.
	Type string `pulumi:"type"`
}

A collection of arguments for invoking getResourceList.

type GetResourceListOutputArgs added in v1.12.0 

type GetResourceListOutputArgs struct {
	// The parent resource ID to list resources under. e.g. `/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup`.
	ParentId pulumi.StringInput `pulumi:"parentId"`
	// 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 `["value"]`, it will set the following json to computed property `output`.
	ResponseExportValues pulumi.StringArrayInput `pulumi:"responseExportValues"`
	// 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.
	Type pulumi.StringInput `pulumi:"type"`
}

A collection of arguments for invoking getResourceList.

func (GetResourceListOutputArgs) ElementType added in v1.12.0 

func (GetResourceListOutputArgs) ElementType() reflect.Type

type GetResourceListResult added in v1.12.0 

type GetResourceListResult struct {
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// The output json containing the properties specified in `responseExportValues`. Here are some examples to decode json and extract the value.
	Output               string   `pulumi:"output"`
	ParentId             string   `pulumi:"parentId"`
	ResponseExportValues []string `pulumi:"responseExportValues"`
	Type                 string   `pulumi:"type"`
}

A collection of values returned by getResourceList.

func GetResourceList added in v1.12.0 

func GetResourceList(ctx *pulumi.Context, args *GetResourceListArgs, opts ...pulumi.InvokeOption) (*GetResourceListResult, error)

This resource can list all resources of a specific type under a scope. If the API supports paging, it will automatically fetch all pages and return the full list.

## Example Usage

type GetResourceListResultOutput added in v1.12.0 

type GetResourceListResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getResourceList.

func GetResourceListOutput added in v1.12.0 

func GetResourceListOutput(ctx *pulumi.Context, args GetResourceListOutputArgs, opts ...pulumi.InvokeOption) GetResourceListResultOutput

func (GetResourceListResultOutput) ElementType added in v1.12.0 

func (GetResourceListResultOutput) ElementType() reflect.Type

func (GetResourceListResultOutput) Id added in v1.12.0 

func (o GetResourceListResultOutput) Id() pulumi.StringOutput

The provider-assigned unique ID for this managed resource.

func (GetResourceListResultOutput) Output added in v1.12.0 

func (o GetResourceListResultOutput) Output() pulumi.StringOutput

The output json containing the properties specified in `responseExportValues`. Here are some examples to decode json and extract the value.

func (GetResourceListResultOutput) ParentId added in v1.12.0 

func (o GetResourceListResultOutput) ParentId() pulumi.StringOutput

func (GetResourceListResultOutput) ResponseExportValues added in v1.12.0 

func (o GetResourceListResultOutput) ResponseExportValues() pulumi.StringArrayOutput

func (GetResourceListResultOutput) ToGetResourceListResultOutput added in v1.12.0 

func (o GetResourceListResultOutput) ToGetResourceListResultOutput() GetResourceListResultOutput

func (GetResourceListResultOutput) ToGetResourceListResultOutputWithContext added in v1.12.0 

func (o GetResourceListResultOutput) ToGetResourceListResultOutputWithContext(ctx context.Context) GetResourceListResultOutput

func (GetResourceListResultOutput) Type added in v1.12.0 

func (o GetResourceListResultOutput) Type() pulumi.StringOutput

type LookupResourceActionArgs 

type LookupResourceActionArgs struct {
	// The name of the resource action. It's also possible to make Http requests towards the resource ID if leave this field empty.
	Action *string `pulumi:"action"`
	// A JSON object that contains the request body.
	Body *string `pulumi:"body"`
	// Specifies the Http method of the azure resource action. Allowed values are `POST` and `GET`. Defaults to `POST`.
	Method *string `pulumi:"method"`
	// The ID of an existing azure source.
	ResourceId *string `pulumi:"resourceId"`
	// 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 `["keys"]`, it will set the following json to computed property `output`.
	ResponseExportValues []string `pulumi:"responseExportValues"`
	// 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.
	Type string `pulumi:"type"`
}

A collection of arguments for invoking getResourceAction.

type LookupResourceActionOutputArgs 

type LookupResourceActionOutputArgs struct {
	// The name of the resource action. It's also possible to make Http requests towards the resource ID if leave this field empty.
	Action pulumi.StringPtrInput `pulumi:"action"`
	// A JSON object that contains the request body.
	Body pulumi.StringPtrInput `pulumi:"body"`
	// Specifies the Http method of the azure resource action. Allowed values are `POST` and `GET`. Defaults to `POST`.
	Method pulumi.StringPtrInput `pulumi:"method"`
	// The ID of an existing azure source.
	ResourceId pulumi.StringPtrInput `pulumi:"resourceId"`
	// 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 `["keys"]`, it will set the following json to computed property `output`.
	ResponseExportValues pulumi.StringArrayInput `pulumi:"responseExportValues"`
	// 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.
	Type pulumi.StringInput `pulumi:"type"`
}

A collection of arguments for invoking getResourceAction.

func (LookupResourceActionOutputArgs) ElementType 

func (LookupResourceActionOutputArgs) ElementType() reflect.Type

type LookupResourceActionResult 

type LookupResourceActionResult struct {
	Action *string `pulumi:"action"`
	Body   *string `pulumi:"body"`
	// The provider-assigned unique ID for this managed resource.
	Id     string  `pulumi:"id"`
	Method *string `pulumi:"method"`
	// The output json containing the properties specified in `responseExportValues`. Here are some examples to decode json and extract the value.
	Output               string   `pulumi:"output"`
	ResourceId           *string  `pulumi:"resourceId"`
	ResponseExportValues []string `pulumi:"responseExportValues"`
	Type                 string   `pulumi:"type"`
}

A collection of values returned by getResourceAction.

func LookupResourceAction 

func LookupResourceAction(ctx *pulumi.Context, args *LookupResourceActionArgs, opts ...pulumi.InvokeOption) (*LookupResourceActionResult, error)

This resource can perform resource action which gets information from an existing resource. It's recommended to use `ResourceAction` data source to perform readonly action, please use `ResourceAction` resource, if user wants to perform actions which change a resource's state.

## Example Usage

Here's an example to use the `ResourceAction` data source to get a provider's permissions.

Here's an example to use the `ResourceAction` data source to perform a provider action.

type LookupResourceActionResultOutput 

type LookupResourceActionResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getResourceAction.

func LookupResourceActionOutput 

func LookupResourceActionOutput(ctx *pulumi.Context, args LookupResourceActionOutputArgs, opts ...pulumi.InvokeOption) LookupResourceActionResultOutput

func (LookupResourceActionResultOutput) Action 

func (o LookupResourceActionResultOutput) Action() pulumi.StringPtrOutput

func (LookupResourceActionResultOutput) Body 

func (o LookupResourceActionResultOutput) Body() pulumi.StringPtrOutput

func (LookupResourceActionResultOutput) ElementType 

func (LookupResourceActionResultOutput) ElementType() reflect.Type

func (LookupResourceActionResultOutput) Id 

func (o LookupResourceActionResultOutput) Id() pulumi.StringOutput

The provider-assigned unique ID for this managed resource.

func (LookupResourceActionResultOutput) Method 

func (o LookupResourceActionResultOutput) Method() pulumi.StringPtrOutput

func (LookupResourceActionResultOutput) Output 

func (o LookupResourceActionResultOutput) Output() pulumi.StringOutput

The output json containing the properties specified in `responseExportValues`. Here are some examples to decode json and extract the value.

func (LookupResourceActionResultOutput) ResourceId 

func (o LookupResourceActionResultOutput) ResourceId() pulumi.StringPtrOutput

func (LookupResourceActionResultOutput) ResponseExportValues 

func (o LookupResourceActionResultOutput) ResponseExportValues() pulumi.StringArrayOutput

func (LookupResourceActionResultOutput) ToLookupResourceActionResultOutput 

func (o LookupResourceActionResultOutput) ToLookupResourceActionResultOutput() LookupResourceActionResultOutput

func (LookupResourceActionResultOutput) ToLookupResourceActionResultOutputWithContext 

func (o LookupResourceActionResultOutput) ToLookupResourceActionResultOutputWithContext(ctx context.Context) LookupResourceActionResultOutput

func (LookupResourceActionResultOutput) Type 

func (o LookupResourceActionResultOutput) Type() pulumi.StringOutput

type LookupResourceArgs 

type LookupResourceArgs struct {
	// An `identity` block as defined below, which contains the Managed Service Identity information for this azure resource.
	Identity *GetResourceIdentity `pulumi:"identity"`
	// Specifies the name of the azure resource.
	Name *string `pulumi:"name"`
	// The ID of the azure resource in which this resource is created. It supports different kinds of deployment scope for **top level** resources:
	// - resource group scope: `parentId` should be the ID of a resource group, it's recommended to manage a resource group by azurerm_resource_group.
	// - management group scope: `parentId` should be the ID of a management group, it's recommended to manage a management group by azurerm_management_group.
	// - extension scope: `parentId` should be the ID of the resource you're adding the extension to.
	// - subscription scope: `parentId` should be like `/subscriptions/00000000-0000-0000-0000-000000000000`
	// - tenant scope: `parentId` should be `/`
	//
	// For child level resources, the `parentId` should be the ID of its parent resource, for example, subnet resource's `parentId` is the ID of the vnet.
	//
	// For type `Microsoft.Resources/resourceGroups`, the `parentId` could be omitted, it defaults to subscription ID specified in provider or the default subscription(You could check the default subscription by azure cli command: `az account show`).
	ParentId *string `pulumi:"parentId"`
	// The ID of an existing azure source.
	//
	// > **Note:** Configuring `name` and `parentId` is an alternative way to configure `resourceId`.
	ResourceId *string `pulumi:"resourceId"`
	// 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`.
	ResponseExportValues []string `pulumi:"responseExportValues"`
	// 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.
	Type string `pulumi:"type"`
}

A collection of arguments for invoking getResource.

type LookupResourceOutputArgs 

type LookupResourceOutputArgs struct {
	// An `identity` block as defined below, which contains the Managed Service Identity information for this azure resource.
	Identity GetResourceIdentityPtrInput `pulumi:"identity"`
	// Specifies the name of the azure resource.
	Name pulumi.StringPtrInput `pulumi:"name"`
	// The ID of the azure resource in which this resource is created. It supports different kinds of deployment scope for **top level** resources:
	// - resource group scope: `parentId` should be the ID of a resource group, it's recommended to manage a resource group by azurerm_resource_group.
	// - management group scope: `parentId` should be the ID of a management group, it's recommended to manage a management group by azurerm_management_group.
	// - extension scope: `parentId` should be the ID of the resource you're adding the extension to.
	// - subscription scope: `parentId` should be like `/subscriptions/00000000-0000-0000-0000-000000000000`
	// - tenant scope: `parentId` should be `/`
	//
	// For child level resources, the `parentId` should be the ID of its parent resource, for example, subnet resource's `parentId` is the ID of the vnet.
	//
	// For type `Microsoft.Resources/resourceGroups`, the `parentId` could be omitted, it defaults to subscription ID specified in provider or the default subscription(You could check the default subscription by azure cli command: `az account show`).
	ParentId pulumi.StringPtrInput `pulumi:"parentId"`
	// The ID of an existing azure source.
	//
	// > **Note:** Configuring `name` and `parentId` is an alternative way to configure `resourceId`.
	ResourceId pulumi.StringPtrInput `pulumi:"resourceId"`
	// 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`.
	ResponseExportValues pulumi.StringArrayInput `pulumi:"responseExportValues"`
	// 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.
	Type pulumi.StringInput `pulumi:"type"`
}

A collection of arguments for invoking getResource.

func (LookupResourceOutputArgs) ElementType 

func (LookupResourceOutputArgs) ElementType() reflect.Type

type LookupResourceResult 

type LookupResourceResult struct {
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// An `identity` block as defined below, which contains the Managed Service Identity information for this azure resource.
	Identity GetResourceIdentity `pulumi:"identity"`
	// The Azure Region where the azure resource should exist.
	Location string  `pulumi:"location"`
	Name     *string `pulumi:"name"`
	// The output json containing the properties specified in `responseExportValues`. Here're some examples to decode json and extract the value.
	Output               string   `pulumi:"output"`
	ParentId             string   `pulumi:"parentId"`
	ResourceId           *string  `pulumi:"resourceId"`
	ResponseExportValues []string `pulumi:"responseExportValues"`
	// A mapping of tags which should be assigned to the azure resource.
	Tags map[string]string `pulumi:"tags"`
	// The Type of Identity which should be used for this azure resource. Possible values are `SystemAssigned`, `UserAssigned` and `SystemAssigned,UserAssigned`.
	Type string `pulumi:"type"`
}

A collection of values returned by getResource.

func LookupResource 

func LookupResource(ctx *pulumi.Context, args *LookupResourceArgs, opts ...pulumi.InvokeOption) (*LookupResourceResult, error)

This resource can access any existing Azure resource manager resource.

## Example Usage

type LookupResourceResultOutput 

type LookupResourceResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getResource.

func LookupResourceOutput 

func LookupResourceOutput(ctx *pulumi.Context, args LookupResourceOutputArgs, opts ...pulumi.InvokeOption) LookupResourceResultOutput

func (LookupResourceResultOutput) ElementType 

func (LookupResourceResultOutput) ElementType() reflect.Type

func (LookupResourceResultOutput) Id 

func (o LookupResourceResultOutput) Id() pulumi.StringOutput

The provider-assigned unique ID for this managed resource.

func (LookupResourceResultOutput) Identity 

func (o LookupResourceResultOutput) Identity() GetResourceIdentityOutput

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

func (LookupResourceResultOutput) Location 

func (o LookupResourceResultOutput) Location() pulumi.StringOutput

The Azure Region where the azure resource should exist.

func (LookupResourceResultOutput) Name 

func (o LookupResourceResultOutput) Name() pulumi.StringPtrOutput

func (LookupResourceResultOutput) Output 

func (o LookupResourceResultOutput) Output() pulumi.StringOutput

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

func (LookupResourceResultOutput) ParentId 

func (o LookupResourceResultOutput) ParentId() pulumi.StringOutput

func (LookupResourceResultOutput) ResourceId 

func (o LookupResourceResultOutput) ResourceId() pulumi.StringPtrOutput

func (LookupResourceResultOutput) ResponseExportValues 

func (o LookupResourceResultOutput) ResponseExportValues() pulumi.StringArrayOutput

func (LookupResourceResultOutput) Tags 

func (o LookupResourceResultOutput) Tags() pulumi.StringMapOutput

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

func (LookupResourceResultOutput) ToLookupResourceResultOutput 

func (o LookupResourceResultOutput) ToLookupResourceResultOutput() LookupResourceResultOutput

func (LookupResourceResultOutput) ToLookupResourceResultOutputWithContext 

func (o LookupResourceResultOutput) ToLookupResourceResultOutputWithContext(ctx context.Context) LookupResourceResultOutput

func (LookupResourceResultOutput) Type 

func (o LookupResourceResultOutput) Type() pulumi.StringOutput

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

type Provider 

type Provider struct {
	pulumi.ProviderResourceState

	// The password associated with the Client Certificate. For use when authenticating as a Service Principal using a Client
	// Certificate
	ClientCertificatePassword pulumi.StringPtrOutput `pulumi:"clientCertificatePassword"`
	// The path to the Client Certificate associated with the Service Principal for use when authenticating as a Service
	// Principal using a Client Certificate.
	ClientCertificatePath pulumi.StringPtrOutput `pulumi:"clientCertificatePath"`
	// The Client ID which should be used.
	ClientId pulumi.StringPtrOutput `pulumi:"clientId"`
	// The Client Secret which should be used. For use When authenticating as a Service Principal using a Client Secret.
	ClientSecret pulumi.StringPtrOutput `pulumi:"clientSecret"`
	// The value of the x-ms-correlation-request-id header (otherwise an auto-generated UUID will be used).
	CustomCorrelationRequestId pulumi.StringPtrOutput `pulumi:"customCorrelationRequestId"`
	DefaultLocation            pulumi.StringPtrOutput `pulumi:"defaultLocation"`
	DefaultName                pulumi.StringPtrOutput `pulumi:"defaultName"`
	// Deprecated: It will not work in the next minor release and will be removed in the next major release. Please specify the naming prefix and suffix in the resource's `name` field instead.
	DefaultNamingPrefix pulumi.StringPtrOutput `pulumi:"defaultNamingPrefix"`
	// Deprecated: It will not work in the next minor release and will be removed in the next major release. Please specify the naming prefix and suffix in the resource's `name` field instead.
	DefaultNamingSuffix pulumi.StringPtrOutput `pulumi:"defaultNamingSuffix"`
	// The Cloud Environment which should be used. Possible values are public, usgovernment and china. Defaults to public.
	Environment pulumi.StringOutput `pulumi:"environment"`
	// The bearer token for the request to the OIDC provider. For use When authenticating as a Service Principal using OpenID
	// Connect.
	OidcRequestToken pulumi.StringPtrOutput `pulumi:"oidcRequestToken"`
	// The URL for the OIDC provider from which to request an ID token. For use When authenticating as a Service Principal
	// using OpenID Connect.
	OidcRequestUrl pulumi.StringPtrOutput `pulumi:"oidcRequestUrl"`
	// The OIDC ID token for use when authenticating as a Service Principal using OpenID Connect.
	OidcToken pulumi.StringPtrOutput `pulumi:"oidcToken"`
	// The path to a file containing an OIDC ID token for use when authenticating as a Service Principal using OpenID Connect.
	OidcTokenFilePath pulumi.StringPtrOutput `pulumi:"oidcTokenFilePath"`
	// A GUID/UUID that is registered with Microsoft to facilitate partner resource usage attribution.
	PartnerId pulumi.StringPtrOutput `pulumi:"partnerId"`
	// The Subscription ID which should be used.
	SubscriptionId pulumi.StringPtrOutput `pulumi:"subscriptionId"`
	// The Tenant ID which should be used.
	TenantId pulumi.StringPtrOutput `pulumi:"tenantId"`
}

The provider type for the azapi package. By default, resources use package-wide configuration settings, however an explicit `Provider` instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the [documentation](https://www.pulumi.com/docs/reference/programming-model/#providers) for more information.

func NewProvider 

func NewProvider(ctx *pulumi.Context,
	name string, args *ProviderArgs, opts ...pulumi.ResourceOption) (*Provider, error)

NewProvider registers a new resource with the given unique name, arguments, and options.

func (*Provider) ElementType 

func (*Provider) ElementType() reflect.Type

func (*Provider) ToProviderOutput 

func (i *Provider) ToProviderOutput() ProviderOutput

func (*Provider) ToProviderOutputWithContext 

func (i *Provider) ToProviderOutputWithContext(ctx context.Context) ProviderOutput

type ProviderArgs 

type ProviderArgs struct {
	AuxiliaryTenantIds pulumi.StringArrayInput
	// The password associated with the Client Certificate. For use when authenticating as a Service Principal using a Client
	// Certificate
	ClientCertificatePassword pulumi.StringPtrInput
	// The path to the Client Certificate associated with the Service Principal for use when authenticating as a Service
	// Principal using a Client Certificate.
	ClientCertificatePath pulumi.StringPtrInput
	// The Client ID which should be used.
	ClientId pulumi.StringPtrInput
	// The Client Secret which should be used. For use When authenticating as a Service Principal using a Client Secret.
	ClientSecret pulumi.StringPtrInput
	// The value of the x-ms-correlation-request-id header (otherwise an auto-generated UUID will be used).
	CustomCorrelationRequestId pulumi.StringPtrInput
	DefaultLocation            pulumi.StringPtrInput
	DefaultName                pulumi.StringPtrInput
	// Deprecated: It will not work in the next minor release and will be removed in the next major release. Please specify the naming prefix and suffix in the resource's `name` field instead.
	DefaultNamingPrefix pulumi.StringPtrInput
	// Deprecated: It will not work in the next minor release and will be removed in the next major release. Please specify the naming prefix and suffix in the resource's `name` field instead.
	DefaultNamingSuffix pulumi.StringPtrInput
	DefaultTags         pulumi.StringMapInput
	// This will disable the x-ms-correlation-request-id header.
	DisableCorrelationRequestId pulumi.BoolPtrInput
	// This will disable the Terraform Partner ID which is used if a custom `partner_id` isn't specified.
	DisableTerraformPartnerId pulumi.BoolPtrInput
	Endpoint                  ProviderEndpointPtrInput
	// The Cloud Environment which should be used. Possible values are public, usgovernment and china. Defaults to public.
	Environment pulumi.StringInput
	// The bearer token for the request to the OIDC provider. For use When authenticating as a Service Principal using OpenID
	// Connect.
	OidcRequestToken pulumi.StringPtrInput
	// The URL for the OIDC provider from which to request an ID token. For use When authenticating as a Service Principal
	// using OpenID Connect.
	OidcRequestUrl pulumi.StringPtrInput
	// The OIDC ID token for use when authenticating as a Service Principal using OpenID Connect.
	OidcToken pulumi.StringPtrInput
	// The path to a file containing an OIDC ID token for use when authenticating as a Service Principal using OpenID Connect.
	OidcTokenFilePath pulumi.StringPtrInput
	// A GUID/UUID that is registered with Microsoft to facilitate partner resource usage attribution.
	PartnerId pulumi.StringPtrInput
	// Should the Provider skip registering all of the Resource Providers that it supports, if they're not already registered?
	SkipProviderRegistration pulumi.BoolPtrInput
	// The Subscription ID which should be used.
	SubscriptionId pulumi.StringPtrInput
	// The Tenant ID which should be used.
	TenantId pulumi.StringPtrInput
	// Allow Azure CLI to be used for Authentication.
	UseCli pulumi.BoolPtrInput
	// Allow Managed Service Identity to be used for Authentication.
	UseMsi pulumi.BoolPtrInput
	// Allow OpenID Connect to be used for authentication
	UseOidc pulumi.BoolPtrInput
}

The set of arguments for constructing a Provider resource.

func (ProviderArgs) ElementType 

func (ProviderArgs) ElementType() reflect.Type

type ProviderEndpoint added in v1.12.0 

type ProviderEndpoint struct {
	// The Active Directory login endpoint which should be used.
	ActiveDirectoryAuthorityHost *string `pulumi:"activeDirectoryAuthorityHost"`
	// The resource ID to obtain AD tokens for.
	ResourceManagerAudience *string `pulumi:"resourceManagerAudience"`
	// The Resource Manager Endpoint which should be used.
	ResourceManagerEndpoint *string `pulumi:"resourceManagerEndpoint"`
}

type ProviderEndpointArgs added in v1.12.0 

type ProviderEndpointArgs struct {
	// The Active Directory login endpoint which should be used.
	ActiveDirectoryAuthorityHost pulumi.StringPtrInput `pulumi:"activeDirectoryAuthorityHost"`
	// The resource ID to obtain AD tokens for.
	ResourceManagerAudience pulumi.StringPtrInput `pulumi:"resourceManagerAudience"`
	// The Resource Manager Endpoint which should be used.
	ResourceManagerEndpoint pulumi.StringPtrInput `pulumi:"resourceManagerEndpoint"`
}

func (ProviderEndpointArgs) ElementType added in v1.12.0 

func (ProviderEndpointArgs) ElementType() reflect.Type

func (ProviderEndpointArgs) ToProviderEndpointOutput added in v1.12.0 

func (i ProviderEndpointArgs) ToProviderEndpointOutput() ProviderEndpointOutput

func (ProviderEndpointArgs) ToProviderEndpointOutputWithContext added in v1.12.0 

func (i ProviderEndpointArgs) ToProviderEndpointOutputWithContext(ctx context.Context) ProviderEndpointOutput

func (ProviderEndpointArgs) ToProviderEndpointPtrOutput added in v1.12.0 

func (i ProviderEndpointArgs) ToProviderEndpointPtrOutput() ProviderEndpointPtrOutput

func (ProviderEndpointArgs) ToProviderEndpointPtrOutputWithContext added in v1.12.0 

func (i ProviderEndpointArgs) ToProviderEndpointPtrOutputWithContext(ctx context.Context) ProviderEndpointPtrOutput

type ProviderEndpointInput added in v1.12.0 

type ProviderEndpointInput interface {
	pulumi.Input

	ToProviderEndpointOutput() ProviderEndpointOutput
	ToProviderEndpointOutputWithContext(context.Context) ProviderEndpointOutput
}

ProviderEndpointInput is an input type that accepts ProviderEndpointArgs and ProviderEndpointOutput values. You can construct a concrete instance of `ProviderEndpointInput` via: 

ProviderEndpointArgs{...}

type ProviderEndpointOutput added in v1.12.0 

type ProviderEndpointOutput struct{ *pulumi.OutputState }

func (ProviderEndpointOutput) ActiveDirectoryAuthorityHost added in v1.12.0 

func (o ProviderEndpointOutput) ActiveDirectoryAuthorityHost() pulumi.StringPtrOutput

The Active Directory login endpoint which should be used.

func (ProviderEndpointOutput) ElementType added in v1.12.0 

func (ProviderEndpointOutput) ElementType() reflect.Type

func (ProviderEndpointOutput) ResourceManagerAudience added in v1.12.0 

func (o ProviderEndpointOutput) ResourceManagerAudience() pulumi.StringPtrOutput

The resource ID to obtain AD tokens for.

func (ProviderEndpointOutput) ResourceManagerEndpoint added in v1.12.0 

func (o ProviderEndpointOutput) ResourceManagerEndpoint() pulumi.StringPtrOutput

The Resource Manager Endpoint which should be used.

func (ProviderEndpointOutput) ToProviderEndpointOutput added in v1.12.0 

func (o ProviderEndpointOutput) ToProviderEndpointOutput() ProviderEndpointOutput

func (ProviderEndpointOutput) ToProviderEndpointOutputWithContext added in v1.12.0 

func (o ProviderEndpointOutput) ToProviderEndpointOutputWithContext(ctx context.Context) ProviderEndpointOutput

func (ProviderEndpointOutput) ToProviderEndpointPtrOutput added in v1.12.0 

func (o ProviderEndpointOutput) ToProviderEndpointPtrOutput() ProviderEndpointPtrOutput

func (ProviderEndpointOutput) ToProviderEndpointPtrOutputWithContext added in v1.12.0 

func (o ProviderEndpointOutput) ToProviderEndpointPtrOutputWithContext(ctx context.Context) ProviderEndpointPtrOutput

type ProviderEndpointPtrInput added in v1.12.0 

type ProviderEndpointPtrInput interface {
	pulumi.Input

	ToProviderEndpointPtrOutput() ProviderEndpointPtrOutput
	ToProviderEndpointPtrOutputWithContext(context.Context) ProviderEndpointPtrOutput
}

ProviderEndpointPtrInput is an input type that accepts ProviderEndpointArgs, ProviderEndpointPtr and ProviderEndpointPtrOutput values. You can construct a concrete instance of `ProviderEndpointPtrInput` via: 

        ProviderEndpointArgs{...}

or:

        nil

func ProviderEndpointPtr added in v1.12.0 

func ProviderEndpointPtr(v *ProviderEndpointArgs) ProviderEndpointPtrInput

type ProviderEndpointPtrOutput added in v1.12.0 

type ProviderEndpointPtrOutput struct{ *pulumi.OutputState }

func (ProviderEndpointPtrOutput) ActiveDirectoryAuthorityHost added in v1.12.0 

func (o ProviderEndpointPtrOutput) ActiveDirectoryAuthorityHost() pulumi.StringPtrOutput

The Active Directory login endpoint which should be used.

func (ProviderEndpointPtrOutput) Elem added in v1.12.0 

func (o ProviderEndpointPtrOutput) Elem() ProviderEndpointOutput

func (ProviderEndpointPtrOutput) ElementType added in v1.12.0 

func (ProviderEndpointPtrOutput) ElementType() reflect.Type

func (ProviderEndpointPtrOutput) ResourceManagerAudience added in v1.12.0 

func (o ProviderEndpointPtrOutput) ResourceManagerAudience() pulumi.StringPtrOutput

The resource ID to obtain AD tokens for.

func (ProviderEndpointPtrOutput) ResourceManagerEndpoint added in v1.12.0 

func (o ProviderEndpointPtrOutput) ResourceManagerEndpoint() pulumi.StringPtrOutput

The Resource Manager Endpoint which should be used.

func (ProviderEndpointPtrOutput) ToProviderEndpointPtrOutput added in v1.12.0 

func (o ProviderEndpointPtrOutput) ToProviderEndpointPtrOutput() ProviderEndpointPtrOutput

func (ProviderEndpointPtrOutput) ToProviderEndpointPtrOutputWithContext added in v1.12.0 

func (o ProviderEndpointPtrOutput) ToProviderEndpointPtrOutputWithContext(ctx context.Context) ProviderEndpointPtrOutput

type ProviderInput 

type ProviderInput interface {
	pulumi.Input

	ToProviderOutput() ProviderOutput
	ToProviderOutputWithContext(ctx context.Context) ProviderOutput
}

type ProviderOutput 

type ProviderOutput struct{ *pulumi.OutputState }

func (ProviderOutput) ClientCertificatePassword 

func (o ProviderOutput) ClientCertificatePassword() pulumi.StringPtrOutput

The password associated with the Client Certificate. For use when authenticating as a Service Principal using a Client Certificate

func (ProviderOutput) ClientCertificatePath 

func (o ProviderOutput) ClientCertificatePath() pulumi.StringPtrOutput

The path to the Client Certificate associated with the Service Principal for use when authenticating as a Service Principal using a Client Certificate.

func (ProviderOutput) ClientId 

func (o ProviderOutput) ClientId() pulumi.StringPtrOutput

The Client ID which should be used.

func (ProviderOutput) ClientSecret 

func (o ProviderOutput) ClientSecret() pulumi.StringPtrOutput

The Client Secret which should be used. For use When authenticating as a Service Principal using a Client Secret.

func (ProviderOutput) CustomCorrelationRequestId added in v1.12.0 

func (o ProviderOutput) CustomCorrelationRequestId() pulumi.StringPtrOutput

The value of the x-ms-correlation-request-id header (otherwise an auto-generated UUID will be used).

func (ProviderOutput) DefaultLocation 

func (o ProviderOutput) DefaultLocation() pulumi.StringPtrOutput

func (ProviderOutput) DefaultName added in v1.4.0 

func (o ProviderOutput) DefaultName() pulumi.StringPtrOutput

func (ProviderOutput) DefaultNamingPrefix deprecated added in v1.4.0 

func (o ProviderOutput) DefaultNamingPrefix() pulumi.StringPtrOutput

Deprecated: It will not work in the next minor release and will be removed in the next major release. Please specify the naming prefix and suffix in the resource's `name` field instead.

func (ProviderOutput) DefaultNamingSuffix deprecated added in v1.4.0 

func (o ProviderOutput) DefaultNamingSuffix() pulumi.StringPtrOutput

Deprecated: It will not work in the next minor release and will be removed in the next major release. Please specify the naming prefix and suffix in the resource's `name` field instead.

func (ProviderOutput) ElementType 

func (ProviderOutput) ElementType() reflect.Type

func (ProviderOutput) Environment 

func (o ProviderOutput) Environment() pulumi.StringOutput

The Cloud Environment which should be used. Possible values are public, usgovernment and china. Defaults to public.

func (ProviderOutput) OidcRequestToken 

func (o ProviderOutput) OidcRequestToken() pulumi.StringPtrOutput

The bearer token for the request to the OIDC provider. For use When authenticating as a Service Principal using OpenID Connect.

func (ProviderOutput) OidcRequestUrl 

func (o ProviderOutput) OidcRequestUrl() pulumi.StringPtrOutput

The URL for the OIDC provider from which to request an ID token. For use When authenticating as a Service Principal using OpenID Connect.

func (ProviderOutput) OidcToken 

func (o ProviderOutput) OidcToken() pulumi.StringPtrOutput

The OIDC ID token for use when authenticating as a Service Principal using OpenID Connect.

func (ProviderOutput) OidcTokenFilePath 

func (o ProviderOutput) OidcTokenFilePath() pulumi.StringPtrOutput

The path to a file containing an OIDC ID token for use when authenticating as a Service Principal using OpenID Connect.

func (ProviderOutput) PartnerId 

func (o ProviderOutput) PartnerId() pulumi.StringPtrOutput

A GUID/UUID that is registered with Microsoft to facilitate partner resource usage attribution.

func (ProviderOutput) SubscriptionId 

func (o ProviderOutput) SubscriptionId() pulumi.StringPtrOutput

The Subscription ID which should be used.

func (ProviderOutput) TenantId 

func (o ProviderOutput) TenantId() pulumi.StringPtrOutput

The Tenant ID which should be used.

func (ProviderOutput) ToProviderOutput 

func (o ProviderOutput) ToProviderOutput() ProviderOutput

func (ProviderOutput) ToProviderOutputWithContext 

func (o ProviderOutput) ToProviderOutputWithContext(ctx context.Context) ProviderOutput

type Resource 

type Resource struct {
	pulumi.CustomResourceState

	// A JSON object that contains the request body used to create and update azure resource.
	Body pulumi.StringPtrOutput `pulumi:"body"`
	// A `identity` block as defined below.
	Identity ResourceIdentityOutput `pulumi:"identity"`
	// A list of properties that should be ignored when comparing the `body` with its current state.
	IgnoreBodyChanges pulumi.StringArrayOutput `pulumi:"ignoreBodyChanges"`
	// Whether ignore incorrect casing returned in `body` to suppress plan-diff. Defaults to `false`.
	IgnoreCasing pulumi.BoolPtrOutput `pulumi:"ignoreCasing"`
	// Whether ignore not returned properties like credentials in `body` to suppress plan-diff. Defaults to `true`.
	IgnoreMissingProperty pulumi.BoolPtrOutput `pulumi:"ignoreMissingProperty"`
	// The Azure Region where the azure resource should exist.
	Location pulumi.StringOutput `pulumi:"location"`
	// A list of ARM resource IDs which are used to avoid create/modify/delete azapi resources at the same time.
	Locks pulumi.StringArrayOutput `pulumi:"locks"`
	// Specifies the name of the azure resource. Changing this forces a new resource to be created.
	Name pulumi.StringOutput `pulumi:"name"`
	// The output json containing the properties specified in `responseExportValues`. Here're some examples to decode json and extract the value.
	Output pulumi.StringOutput `pulumi:"output"`
	// 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: `parentId` should be the ID of a resource group, it's recommended to manage a resource group by azurerm_resource_group.
	// - management group scope: `parentId` should be the ID of a management group, it's recommended to manage a management group by azurerm_management_group.
	// - extension scope: `parentId` should be the ID of the resource you're adding the extension to.
	// - subscription scope: `parentId` should be like `/subscriptions/00000000-0000-0000-0000-000000000000`
	// - tenant scope: `parentId` should be `/`
	//
	// For child level resources, the `parentId` should be the ID of its parent resource, for example, subnet resource's `parentId` is the ID of the vnet.
	//
	// For type `Microsoft.Resources/resourceGroups`, the `parentId` could be omitted, it defaults to subscription ID specified in provider or the default subscription(You could check the default subscription by azure cli command: `az account show`).
	ParentId pulumi.StringOutput `pulumi:"parentId"`
	// Whether to remove special characters in resource name. Defaults to `false`.
	//
	// Deprecated: It will not work in the next minor release and will be removed in the next major release. Please specify the `name` field and remove the special characters in the `name` field instead.
	RemovingSpecialChars pulumi.BoolPtrOutput `pulumi:"removingSpecialChars"`
	// 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`.
	ResponseExportValues pulumi.StringArrayOutput `pulumi:"responseExportValues"`
	// Whether enabled the validation on `type` and `body` with embedded schema. Defaults to `true`.
	SchemaValidationEnabled pulumi.BoolPtrOutput `pulumi:"schemaValidationEnabled"`
	// A mapping of tags which should be assigned to the azure resource.
	Tags pulumi.StringMapOutput `pulumi:"tags"`
	// 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.
	Type pulumi.StringOutput `pulumi:"type"`
}

This resource can manage any Azure resource manager resource.

## Example Usage

## Import

Azure resource can be imported using the `resource id`, e.g.<break><break> ```sh<break> $ pulumi import azapi:index/resource:Resource example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resGroup1/providers/Microsoft.MachineLearningServices/workspaces/workspace1/computes/cluster1 <break>```<break><break> It also supports specifying API version by using the `resource id` with `api-version` as a query parameter, e.g.<break><break> ```sh<break> $ pulumi import azapi:index/resource:Resource example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resGroup1/providers/Microsoft.MachineLearningServices/workspaces/workspace1/computes/cluster1?api-version=2021-07-01 <break>```<break><break>

func GetResource 

func GetResource(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ResourceState, opts ...pulumi.ResourceOption) (*Resource, error)

GetResource gets an existing Resource resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewResource 

func NewResource(ctx *pulumi.Context,
	name string, args *ResourceArgs, opts ...pulumi.ResourceOption) (*Resource, error)

NewResource registers a new resource with the given unique name, arguments, and options.

func (*Resource) ElementType 

func (*Resource) ElementType() reflect.Type

func (*Resource) ToResourceOutput 

func (i *Resource) ToResourceOutput() ResourceOutput

func (*Resource) ToResourceOutputWithContext 

func (i *Resource) ToResourceOutputWithContext(ctx context.Context) ResourceOutput

type ResourceAction 

type ResourceAction struct {
	pulumi.CustomResourceState

	// The name of the resource action. It's also possible to make Http requests towards the resource ID if leave this field empty.
	Action pulumi.StringPtrOutput `pulumi:"action"`
	// A JSON object that contains the request body.
	Body pulumi.StringPtrOutput `pulumi:"body"`
	// A list of ARM resource IDs which are used to avoid modify azapi resources at the same time.
	Locks pulumi.StringArrayOutput `pulumi:"locks"`
	// Specifies the Http method of the azure resource action. Allowed values are `POST`, `PATCH`, `PUT` and `DELETE`. Defaults to `POST`.
	Method pulumi.StringPtrOutput `pulumi:"method"`
	// The output json containing the properties specified in `responseExportValues`. Here are some examples to decode json and extract the value.
	Output pulumi.StringOutput `pulumi:"output"`
	// The ID of an existing azure source.
	ResourceId pulumi.StringOutput `pulumi:"resourceId"`
	// 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 `["keys"]`, it will set the following json to computed property `output`.
	ResponseExportValues pulumi.StringArrayOutput `pulumi:"responseExportValues"`
	// 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.
	Type pulumi.StringOutput `pulumi:"type"`
	// When to perform the action, value must be one of: `apply`, `destroy`. Default is `apply`.
	When pulumi.StringPtrOutput `pulumi:"when"`
}

This resource can perform any Azure resource manager resource action. It's recommended to use `ResourceAction` resource to perform actions which change a resource's state, please use `ResourceAction` data source, if user wants to perform readonly action.

> **Note** The action can be performed on either apply or destroy. The default is apply, see `when` argument for more details.

## Example Usage

Here's an example to use the `ResourceAction` resource to register a provider.

Here's an example to use the `ResourceAction` resource to perform a provider action.

func GetResourceAction 

func GetResourceAction(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ResourceActionState, opts ...pulumi.ResourceOption) (*ResourceAction, error)

GetResourceAction gets an existing ResourceAction resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewResourceAction 

func NewResourceAction(ctx *pulumi.Context,
	name string, args *ResourceActionArgs, opts ...pulumi.ResourceOption) (*ResourceAction, error)

NewResourceAction registers a new resource with the given unique name, arguments, and options.

func (*ResourceAction) ElementType 

func (*ResourceAction) ElementType() reflect.Type

func (*ResourceAction) ToResourceActionOutput 

func (i *ResourceAction) ToResourceActionOutput() ResourceActionOutput

func (*ResourceAction) ToResourceActionOutputWithContext 

func (i *ResourceAction) ToResourceActionOutputWithContext(ctx context.Context) ResourceActionOutput

type ResourceActionArgs 

type ResourceActionArgs struct {
	// The name of the resource action. It's also possible to make Http requests towards the resource ID if leave this field empty.
	Action pulumi.StringPtrInput
	// A JSON object that contains the request body.
	Body pulumi.StringPtrInput
	// A list of ARM resource IDs which are used to avoid modify azapi resources at the same time.
	Locks pulumi.StringArrayInput
	// Specifies the Http method of the azure resource action. Allowed values are `POST`, `PATCH`, `PUT` and `DELETE`. Defaults to `POST`.
	Method pulumi.StringPtrInput
	// The ID of an existing azure source.
	ResourceId pulumi.StringInput
	// 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 `["keys"]`, it will set the following json to computed property `output`.
	ResponseExportValues pulumi.StringArrayInput
	// 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.
	Type pulumi.StringInput
	// When to perform the action, value must be one of: `apply`, `destroy`. Default is `apply`.
	When pulumi.StringPtrInput
}

The set of arguments for constructing a ResourceAction resource.

func (ResourceActionArgs) ElementType 

func (ResourceActionArgs) ElementType() reflect.Type

type ResourceActionArray 

type ResourceActionArray []ResourceActionInput

func (ResourceActionArray) ElementType 

func (ResourceActionArray) ElementType() reflect.Type

func (ResourceActionArray) ToResourceActionArrayOutput 

func (i ResourceActionArray) ToResourceActionArrayOutput() ResourceActionArrayOutput

func (ResourceActionArray) ToResourceActionArrayOutputWithContext 

func (i ResourceActionArray) ToResourceActionArrayOutputWithContext(ctx context.Context) ResourceActionArrayOutput

type ResourceActionArrayInput 

type ResourceActionArrayInput interface {
	pulumi.Input

	ToResourceActionArrayOutput() ResourceActionArrayOutput
	ToResourceActionArrayOutputWithContext(context.Context) ResourceActionArrayOutput
}

ResourceActionArrayInput is an input type that accepts ResourceActionArray and ResourceActionArrayOutput values. You can construct a concrete instance of `ResourceActionArrayInput` via: 

ResourceActionArray{ ResourceActionArgs{...} }

type ResourceActionArrayOutput 

type ResourceActionArrayOutput struct{ *pulumi.OutputState }

func (ResourceActionArrayOutput) ElementType 

func (ResourceActionArrayOutput) ElementType() reflect.Type

func (ResourceActionArrayOutput) Index 

func (o ResourceActionArrayOutput) Index(i pulumi.IntInput) ResourceActionOutput

func (ResourceActionArrayOutput) ToResourceActionArrayOutput 

func (o ResourceActionArrayOutput) ToResourceActionArrayOutput() ResourceActionArrayOutput

func (ResourceActionArrayOutput) ToResourceActionArrayOutputWithContext 

func (o ResourceActionArrayOutput) ToResourceActionArrayOutputWithContext(ctx context.Context) ResourceActionArrayOutput

type ResourceActionInput 

type ResourceActionInput interface {
	pulumi.Input

	ToResourceActionOutput() ResourceActionOutput
	ToResourceActionOutputWithContext(ctx context.Context) ResourceActionOutput
}

type ResourceActionMap 

type ResourceActionMap map[string]ResourceActionInput

func (ResourceActionMap) ElementType 

func (ResourceActionMap) ElementType() reflect.Type

func (ResourceActionMap) ToResourceActionMapOutput 

func (i ResourceActionMap) ToResourceActionMapOutput() ResourceActionMapOutput

func (ResourceActionMap) ToResourceActionMapOutputWithContext 

func (i ResourceActionMap) ToResourceActionMapOutputWithContext(ctx context.Context) ResourceActionMapOutput

type ResourceActionMapInput 

type ResourceActionMapInput interface {
	pulumi.Input

	ToResourceActionMapOutput() ResourceActionMapOutput
	ToResourceActionMapOutputWithContext(context.Context) ResourceActionMapOutput
}

ResourceActionMapInput is an input type that accepts ResourceActionMap and ResourceActionMapOutput values. You can construct a concrete instance of `ResourceActionMapInput` via: 

ResourceActionMap{ "key": ResourceActionArgs{...} }

type ResourceActionMapOutput 

type ResourceActionMapOutput struct{ *pulumi.OutputState }

func (ResourceActionMapOutput) ElementType 

func (ResourceActionMapOutput) ElementType() reflect.Type

func (ResourceActionMapOutput) MapIndex 

func (o ResourceActionMapOutput) MapIndex(k pulumi.StringInput) ResourceActionOutput

func (ResourceActionMapOutput) ToResourceActionMapOutput 

func (o ResourceActionMapOutput) ToResourceActionMapOutput() ResourceActionMapOutput

func (ResourceActionMapOutput) ToResourceActionMapOutputWithContext 

func (o ResourceActionMapOutput) ToResourceActionMapOutputWithContext(ctx context.Context) ResourceActionMapOutput

type ResourceActionOutput 

type ResourceActionOutput struct{ *pulumi.OutputState }

func (ResourceActionOutput) Action 

func (o ResourceActionOutput) Action() pulumi.StringPtrOutput

The name of the resource action. It's also possible to make Http requests towards the resource ID if leave this field empty.

func (ResourceActionOutput) Body 

func (o ResourceActionOutput) Body() pulumi.StringPtrOutput

A JSON object that contains the request body.

func (ResourceActionOutput) ElementType 

func (ResourceActionOutput) ElementType() reflect.Type

func (ResourceActionOutput) Locks 

func (o ResourceActionOutput) Locks() pulumi.StringArrayOutput

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

func (ResourceActionOutput) Method 

func (o ResourceActionOutput) Method() pulumi.StringPtrOutput

Specifies the Http method of the azure resource action. Allowed values are `POST`, `PATCH`, `PUT` and `DELETE`. Defaults to `POST`.

func (ResourceActionOutput) Output 

func (o ResourceActionOutput) Output() pulumi.StringOutput

The output json containing the properties specified in `responseExportValues`. Here are some examples to decode json and extract the value.

func (ResourceActionOutput) ResourceId 

func (o ResourceActionOutput) ResourceId() pulumi.StringOutput

The ID of an existing azure source.

func (ResourceActionOutput) ResponseExportValues 

func (o ResourceActionOutput) ResponseExportValues() pulumi.StringArrayOutput

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 `["keys"]`, it will set the following json to computed property `output`.

func (ResourceActionOutput) ToResourceActionOutput 

func (o ResourceActionOutput) ToResourceActionOutput() ResourceActionOutput

func (ResourceActionOutput) ToResourceActionOutputWithContext 

func (o ResourceActionOutput) ToResourceActionOutputWithContext(ctx context.Context) ResourceActionOutput

func (ResourceActionOutput) Type 

func (o ResourceActionOutput) Type() pulumi.StringOutput

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.

func (ResourceActionOutput) When added in v1.12.0 

func (o ResourceActionOutput) When() pulumi.StringPtrOutput

When to perform the action, value must be one of: `apply`, `destroy`. Default is `apply`.

type ResourceActionState 

type ResourceActionState struct {
	// The name of the resource action. It's also possible to make Http requests towards the resource ID if leave this field empty.
	Action pulumi.StringPtrInput
	// A JSON object that contains the request body.
	Body pulumi.StringPtrInput
	// A list of ARM resource IDs which are used to avoid modify azapi resources at the same time.
	Locks pulumi.StringArrayInput
	// Specifies the Http method of the azure resource action. Allowed values are `POST`, `PATCH`, `PUT` and `DELETE`. Defaults to `POST`.
	Method pulumi.StringPtrInput
	// The output json containing the properties specified in `responseExportValues`. Here are some examples to decode json and extract the value.
	Output pulumi.StringPtrInput
	// The ID of an existing azure source.
	ResourceId pulumi.StringPtrInput
	// 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 `["keys"]`, it will set the following json to computed property `output`.
	ResponseExportValues pulumi.StringArrayInput
	// 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.
	Type pulumi.StringPtrInput
	// When to perform the action, value must be one of: `apply`, `destroy`. Default is `apply`.
	When pulumi.StringPtrInput
}

func (ResourceActionState) ElementType 

func (ResourceActionState) ElementType() reflect.Type

type ResourceArgs 

type ResourceArgs struct {
	// A JSON object that contains the request body used to create and update azure resource.
	Body pulumi.StringPtrInput
	// A `identity` block as defined below.
	Identity ResourceIdentityPtrInput
	// A list of properties that should be ignored when comparing the `body` with its current state.
	IgnoreBodyChanges pulumi.StringArrayInput
	// Whether ignore incorrect casing returned in `body` to suppress plan-diff. Defaults to `false`.
	IgnoreCasing pulumi.BoolPtrInput
	// Whether ignore not returned properties like credentials in `body` to suppress plan-diff. Defaults to `true`.
	IgnoreMissingProperty pulumi.BoolPtrInput
	// The Azure Region where the azure resource should exist.
	Location pulumi.StringPtrInput
	// A list of ARM resource IDs which are used to avoid create/modify/delete azapi resources at the same time.
	Locks pulumi.StringArrayInput
	// Specifies the name of the azure resource. Changing this forces a new resource to be created.
	Name pulumi.StringPtrInput
	// 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: `parentId` should be the ID of a resource group, it's recommended to manage a resource group by azurerm_resource_group.
	// - management group scope: `parentId` should be the ID of a management group, it's recommended to manage a management group by azurerm_management_group.
	// - extension scope: `parentId` should be the ID of the resource you're adding the extension to.
	// - subscription scope: `parentId` should be like `/subscriptions/00000000-0000-0000-0000-000000000000`
	// - tenant scope: `parentId` should be `/`
	//
	// For child level resources, the `parentId` should be the ID of its parent resource, for example, subnet resource's `parentId` is the ID of the vnet.
	//
	// For type `Microsoft.Resources/resourceGroups`, the `parentId` could be omitted, it defaults to subscription ID specified in provider or the default subscription(You could check the default subscription by azure cli command: `az account show`).
	ParentId pulumi.StringPtrInput
	// Whether to remove special characters in resource name. Defaults to `false`.
	//
	// Deprecated: It will not work in the next minor release and will be removed in the next major release. Please specify the `name` field and remove the special characters in the `name` field instead.
	RemovingSpecialChars pulumi.BoolPtrInput
	// 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`.
	ResponseExportValues pulumi.StringArrayInput
	// Whether enabled the validation on `type` and `body` with embedded schema. Defaults to `true`.
	SchemaValidationEnabled pulumi.BoolPtrInput
	// A mapping of tags which should be assigned to the azure resource.
	Tags pulumi.StringMapInput
	// 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.
	Type pulumi.StringInput
}

The set of arguments for constructing a Resource resource.

func (ResourceArgs) ElementType 

func (ResourceArgs) ElementType() reflect.Type

type ResourceArray 

type ResourceArray []ResourceInput

func (ResourceArray) ElementType 

func (ResourceArray) ElementType() reflect.Type

func (ResourceArray) ToResourceArrayOutput 

func (i ResourceArray) ToResourceArrayOutput() ResourceArrayOutput

func (ResourceArray) ToResourceArrayOutputWithContext 

func (i ResourceArray) ToResourceArrayOutputWithContext(ctx context.Context) ResourceArrayOutput

type ResourceArrayInput 

type ResourceArrayInput interface {
	pulumi.Input

	ToResourceArrayOutput() ResourceArrayOutput
	ToResourceArrayOutputWithContext(context.Context) ResourceArrayOutput
}

ResourceArrayInput is an input type that accepts ResourceArray and ResourceArrayOutput values. You can construct a concrete instance of `ResourceArrayInput` via: 

ResourceArray{ ResourceArgs{...} }

type ResourceArrayOutput 

type ResourceArrayOutput struct{ *pulumi.OutputState }

func (ResourceArrayOutput) ElementType 

func (ResourceArrayOutput) ElementType() reflect.Type

func (ResourceArrayOutput) Index 

func (o ResourceArrayOutput) Index(i pulumi.IntInput) ResourceOutput

func (ResourceArrayOutput) ToResourceArrayOutput 

func (o ResourceArrayOutput) ToResourceArrayOutput() ResourceArrayOutput

func (ResourceArrayOutput) ToResourceArrayOutputWithContext 

func (o ResourceArrayOutput) ToResourceArrayOutputWithContext(ctx context.Context) ResourceArrayOutput

type ResourceIdentity 

type ResourceIdentity struct {
	// A list of User Managed Identity ID's which should be assigned to the azure resource.
	IdentityIds []string `pulumi:"identityIds"`
	// The Principal ID for the Service Principal associated with the Managed Service Identity of this azure resource.
	PrincipalId *string `pulumi:"principalId"`
	// The Tenant ID for the Service Principal associated with the Managed Service Identity of this azure resource.
	TenantId *string `pulumi:"tenantId"`
	// The Type of Identity which should be used for this azure resource. Possible values are `SystemAssigned`, `UserAssigned` and `SystemAssigned,UserAssigned`.
	Type string `pulumi:"type"`
}

type ResourceIdentityArgs 

type ResourceIdentityArgs struct {
	// A list of User Managed Identity ID's which should be assigned to the azure resource.
	IdentityIds pulumi.StringArrayInput `pulumi:"identityIds"`
	// The Principal ID for the Service Principal associated with the Managed Service Identity of this azure resource.
	PrincipalId pulumi.StringPtrInput `pulumi:"principalId"`
	// The Tenant ID for the Service Principal associated with the Managed Service Identity of this azure resource.
	TenantId pulumi.StringPtrInput `pulumi:"tenantId"`
	// The Type of Identity which should be used for this azure resource. Possible values are `SystemAssigned`, `UserAssigned` and `SystemAssigned,UserAssigned`.
	Type pulumi.StringInput `pulumi:"type"`
}

func (ResourceIdentityArgs) ElementType 

func (ResourceIdentityArgs) ElementType() reflect.Type

func (ResourceIdentityArgs) ToResourceIdentityOutput 

func (i ResourceIdentityArgs) ToResourceIdentityOutput() ResourceIdentityOutput

func (ResourceIdentityArgs) ToResourceIdentityOutputWithContext 

func (i ResourceIdentityArgs) ToResourceIdentityOutputWithContext(ctx context.Context) ResourceIdentityOutput

func (ResourceIdentityArgs) ToResourceIdentityPtrOutput 

func (i ResourceIdentityArgs) ToResourceIdentityPtrOutput() ResourceIdentityPtrOutput

func (ResourceIdentityArgs) ToResourceIdentityPtrOutputWithContext 

func (i ResourceIdentityArgs) ToResourceIdentityPtrOutputWithContext(ctx context.Context) ResourceIdentityPtrOutput

type ResourceIdentityInput 

type ResourceIdentityInput interface {
	pulumi.Input

	ToResourceIdentityOutput() ResourceIdentityOutput
	ToResourceIdentityOutputWithContext(context.Context) ResourceIdentityOutput
}

ResourceIdentityInput is an input type that accepts ResourceIdentityArgs and ResourceIdentityOutput values. You can construct a concrete instance of `ResourceIdentityInput` via: 

ResourceIdentityArgs{...}

type ResourceIdentityOutput 

type ResourceIdentityOutput struct{ *pulumi.OutputState }

func (ResourceIdentityOutput) ElementType 

func (ResourceIdentityOutput) ElementType() reflect.Type

func (ResourceIdentityOutput) IdentityIds 

func (o ResourceIdentityOutput) IdentityIds() pulumi.StringArrayOutput

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

func (ResourceIdentityOutput) PrincipalId 

func (o ResourceIdentityOutput) PrincipalId() pulumi.StringPtrOutput

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

func (ResourceIdentityOutput) TenantId 

func (o ResourceIdentityOutput) TenantId() pulumi.StringPtrOutput

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

func (ResourceIdentityOutput) ToResourceIdentityOutput 

func (o ResourceIdentityOutput) ToResourceIdentityOutput() ResourceIdentityOutput

func (ResourceIdentityOutput) ToResourceIdentityOutputWithContext 

func (o ResourceIdentityOutput) ToResourceIdentityOutputWithContext(ctx context.Context) ResourceIdentityOutput

func (ResourceIdentityOutput) ToResourceIdentityPtrOutput 

func (o ResourceIdentityOutput) ToResourceIdentityPtrOutput() ResourceIdentityPtrOutput

func (ResourceIdentityOutput) ToResourceIdentityPtrOutputWithContext 

func (o ResourceIdentityOutput) ToResourceIdentityPtrOutputWithContext(ctx context.Context) ResourceIdentityPtrOutput

func (ResourceIdentityOutput) Type 

func (o ResourceIdentityOutput) Type() pulumi.StringOutput

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

type ResourceIdentityPtrInput 

type ResourceIdentityPtrInput interface {
	pulumi.Input

	ToResourceIdentityPtrOutput() ResourceIdentityPtrOutput
	ToResourceIdentityPtrOutputWithContext(context.Context) ResourceIdentityPtrOutput
}

ResourceIdentityPtrInput is an input type that accepts ResourceIdentityArgs, ResourceIdentityPtr and ResourceIdentityPtrOutput values. You can construct a concrete instance of `ResourceIdentityPtrInput` via: 

        ResourceIdentityArgs{...}

or:

        nil

func ResourceIdentityPtr 

func ResourceIdentityPtr(v *ResourceIdentityArgs) ResourceIdentityPtrInput

type ResourceIdentityPtrOutput 

type ResourceIdentityPtrOutput struct{ *pulumi.OutputState }

func (ResourceIdentityPtrOutput) Elem 

func (o ResourceIdentityPtrOutput) Elem() ResourceIdentityOutput

func (ResourceIdentityPtrOutput) ElementType 

func (ResourceIdentityPtrOutput) ElementType() reflect.Type

func (ResourceIdentityPtrOutput) IdentityIds 

func (o ResourceIdentityPtrOutput) IdentityIds() pulumi.StringArrayOutput

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

func (ResourceIdentityPtrOutput) PrincipalId 

func (o ResourceIdentityPtrOutput) PrincipalId() pulumi.StringPtrOutput

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

func (ResourceIdentityPtrOutput) TenantId 

func (o ResourceIdentityPtrOutput) TenantId() pulumi.StringPtrOutput

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

func (ResourceIdentityPtrOutput) ToResourceIdentityPtrOutput 

func (o ResourceIdentityPtrOutput) ToResourceIdentityPtrOutput() ResourceIdentityPtrOutput

func (ResourceIdentityPtrOutput) ToResourceIdentityPtrOutputWithContext 

func (o ResourceIdentityPtrOutput) ToResourceIdentityPtrOutputWithContext(ctx context.Context) ResourceIdentityPtrOutput

func (ResourceIdentityPtrOutput) Type 

func (o ResourceIdentityPtrOutput) Type() pulumi.StringPtrOutput

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

type ResourceInput 

type ResourceInput interface {
	pulumi.Input

	ToResourceOutput() ResourceOutput
	ToResourceOutputWithContext(ctx context.Context) ResourceOutput
}

type ResourceMap 

type ResourceMap map[string]ResourceInput

func (ResourceMap) ElementType 

func (ResourceMap) ElementType() reflect.Type

func (ResourceMap) ToResourceMapOutput 

func (i ResourceMap) ToResourceMapOutput() ResourceMapOutput

func (ResourceMap) ToResourceMapOutputWithContext 

func (i ResourceMap) ToResourceMapOutputWithContext(ctx context.Context) ResourceMapOutput

type ResourceMapInput 

type ResourceMapInput interface {
	pulumi.Input

	ToResourceMapOutput() ResourceMapOutput
	ToResourceMapOutputWithContext(context.Context) ResourceMapOutput
}

ResourceMapInput is an input type that accepts ResourceMap and ResourceMapOutput values. You can construct a concrete instance of `ResourceMapInput` via: 

ResourceMap{ "key": ResourceArgs{...} }

type ResourceMapOutput 

type ResourceMapOutput struct{ *pulumi.OutputState }

func (ResourceMapOutput) ElementType 

func (ResourceMapOutput) ElementType() reflect.Type

func (ResourceMapOutput) MapIndex 

func (o ResourceMapOutput) MapIndex(k pulumi.StringInput) ResourceOutput

func (ResourceMapOutput) ToResourceMapOutput 

func (o ResourceMapOutput) ToResourceMapOutput() ResourceMapOutput

func (ResourceMapOutput) ToResourceMapOutputWithContext 

func (o ResourceMapOutput) ToResourceMapOutputWithContext(ctx context.Context) ResourceMapOutput

type ResourceOutput 

type ResourceOutput struct{ *pulumi.OutputState }

func (ResourceOutput) Body 

func (o ResourceOutput) Body() pulumi.StringPtrOutput

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

func (ResourceOutput) ElementType 

func (ResourceOutput) ElementType() reflect.Type

func (ResourceOutput) Identity 

func (o ResourceOutput) Identity() ResourceIdentityOutput

A `identity` block as defined below.

func (ResourceOutput) IgnoreBodyChanges added in v1.12.0 

func (o ResourceOutput) IgnoreBodyChanges() pulumi.StringArrayOutput

A list of properties that should be ignored when comparing the `body` with its current state.

func (ResourceOutput) IgnoreCasing 

func (o ResourceOutput) IgnoreCasing() pulumi.BoolPtrOutput

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

func (ResourceOutput) IgnoreMissingProperty 

func (o ResourceOutput) IgnoreMissingProperty() pulumi.BoolPtrOutput

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

func (ResourceOutput) Location 

func (o ResourceOutput) Location() pulumi.StringOutput

The Azure Region where the azure resource should exist.

func (ResourceOutput) Locks 

func (o ResourceOutput) Locks() pulumi.StringArrayOutput

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

func (ResourceOutput) Name 

func (o ResourceOutput) Name() pulumi.StringOutput

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

func (ResourceOutput) Output 

func (o ResourceOutput) Output() pulumi.StringOutput

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

func (ResourceOutput) ParentId 

func (o ResourceOutput) ParentId() pulumi.StringOutput

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: `parentId` should be the ID of a resource group, it's recommended to manage a resource group by azurerm_resource_group. - management group scope: `parentId` should be the ID of a management group, it's recommended to manage a management group by azurerm_management_group. - extension scope: `parentId` should be the ID of the resource you're adding the extension to. - subscription scope: `parentId` should be like `/subscriptions/00000000-0000-0000-0000-000000000000` - tenant scope: `parentId` should be `/`

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

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

func (ResourceOutput) RemovingSpecialChars deprecated added in v1.4.0 

func (o ResourceOutput) RemovingSpecialChars() pulumi.BoolPtrOutput

Whether to remove special characters in resource name. Defaults to `false`.

Deprecated: It will not work in the next minor release and will be removed in the next major release. Please specify the `name` field and remove the special characters in the `name` field instead.

func (ResourceOutput) ResponseExportValues 

func (o ResourceOutput) ResponseExportValues() pulumi.StringArrayOutput

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`.

func (ResourceOutput) SchemaValidationEnabled 

func (o ResourceOutput) SchemaValidationEnabled() pulumi.BoolPtrOutput

Whether enabled the validation on `type` and `body` with embedded schema. Defaults to `true`.

func (ResourceOutput) Tags 

func (o ResourceOutput) Tags() pulumi.StringMapOutput

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

func (ResourceOutput) ToResourceOutput 

func (o ResourceOutput) ToResourceOutput() ResourceOutput

func (ResourceOutput) ToResourceOutputWithContext 

func (o ResourceOutput) ToResourceOutputWithContext(ctx context.Context) ResourceOutput

func (ResourceOutput) Type 

func (o ResourceOutput) Type() pulumi.StringOutput

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.

type ResourceState 

type ResourceState struct {
	// A JSON object that contains the request body used to create and update azure resource.
	Body pulumi.StringPtrInput
	// A `identity` block as defined below.
	Identity ResourceIdentityPtrInput
	// A list of properties that should be ignored when comparing the `body` with its current state.
	IgnoreBodyChanges pulumi.StringArrayInput
	// Whether ignore incorrect casing returned in `body` to suppress plan-diff. Defaults to `false`.
	IgnoreCasing pulumi.BoolPtrInput
	// Whether ignore not returned properties like credentials in `body` to suppress plan-diff. Defaults to `true`.
	IgnoreMissingProperty pulumi.BoolPtrInput
	// The Azure Region where the azure resource should exist.
	Location pulumi.StringPtrInput
	// A list of ARM resource IDs which are used to avoid create/modify/delete azapi resources at the same time.
	Locks pulumi.StringArrayInput
	// Specifies the name of the azure resource. Changing this forces a new resource to be created.
	Name pulumi.StringPtrInput
	// The output json containing the properties specified in `responseExportValues`. Here're some examples to decode json and extract the value.
	Output pulumi.StringPtrInput
	// 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: `parentId` should be the ID of a resource group, it's recommended to manage a resource group by azurerm_resource_group.
	// - management group scope: `parentId` should be the ID of a management group, it's recommended to manage a management group by azurerm_management_group.
	// - extension scope: `parentId` should be the ID of the resource you're adding the extension to.
	// - subscription scope: `parentId` should be like `/subscriptions/00000000-0000-0000-0000-000000000000`
	// - tenant scope: `parentId` should be `/`
	//
	// For child level resources, the `parentId` should be the ID of its parent resource, for example, subnet resource's `parentId` is the ID of the vnet.
	//
	// For type `Microsoft.Resources/resourceGroups`, the `parentId` could be omitted, it defaults to subscription ID specified in provider or the default subscription(You could check the default subscription by azure cli command: `az account show`).
	ParentId pulumi.StringPtrInput
	// Whether to remove special characters in resource name. Defaults to `false`.
	//
	// Deprecated: It will not work in the next minor release and will be removed in the next major release. Please specify the `name` field and remove the special characters in the `name` field instead.
	RemovingSpecialChars pulumi.BoolPtrInput
	// 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`.
	ResponseExportValues pulumi.StringArrayInput
	// Whether enabled the validation on `type` and `body` with embedded schema. Defaults to `true`.
	SchemaValidationEnabled pulumi.BoolPtrInput
	// A mapping of tags which should be assigned to the azure resource.
	Tags pulumi.StringMapInput
	// 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.
	Type pulumi.StringPtrInput
}

func (ResourceState) ElementType 

func (ResourceState) ElementType() reflect.Type

type UpdateResource 

type UpdateResource struct {
	pulumi.CustomResourceState

	// A JSON object that contains the request body used to add on an existing azure resource.
	Body pulumi.StringPtrOutput `pulumi:"body"`
	// A list of properties that should be ignored when comparing the `body` with its current state.
	IgnoreBodyChanges pulumi.StringArrayOutput `pulumi:"ignoreBodyChanges"`
	// Whether ignore incorrect casing returned in `body` to suppress plan-diff. Defaults to `false`.
	IgnoreCasing pulumi.BoolPtrOutput `pulumi:"ignoreCasing"`
	// Whether ignore not returned properties like credentials in `body` to suppress plan-diff. Defaults to `true`.
	IgnoreMissingProperty pulumi.BoolPtrOutput `pulumi:"ignoreMissingProperty"`
	// A list of ARM resource IDs which are used to avoid create/modify/delete azapi resources at the same time.
	Locks pulumi.StringArrayOutput `pulumi:"locks"`
	// Specifies the name of the azure resource. Changing this forces a new resource to be created.
	Name pulumi.StringOutput `pulumi:"name"`
	// The output json containing the properties specified in `responseExportValues`. Here're some examples to decode json and extract the value.
	Output pulumi.StringOutput `pulumi:"output"`
	// 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: `parentId` should be the ID of a resource group, it's recommended to manage a resource group by azurerm_resource_group.
	// - management group scope: `parentId` should be the ID of a management group, it's recommended to manage a management group by azurerm_management_group.
	// - extension scope: `parentId` should be the ID of the resource you're adding the extension to.
	// - subscription scope: `parentId` should be like `/subscriptions/00000000-0000-0000-0000-000000000000`
	// - tenant scope: `parentId` should be `/`
	//
	// For child level resources, the `parentId` should be the ID of its parent resource, for example, subnet resource's `parentId` is the ID of the vnet.
	ParentId pulumi.StringOutput `pulumi:"parentId"`
	// The ID of an existing azure source. Changing this forces a new azure resource to be created.
	//
	// > **Note:** Configuring `name` and `parentId` is an alternative way to configure `resourceId`.
	ResourceId pulumi.StringOutput `pulumi:"resourceId"`
	// 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`.
	ResponseExportValues pulumi.StringArrayOutput `pulumi:"responseExportValues"`
	// 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.
	Type pulumi.StringOutput `pulumi:"type"`
}

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 `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.

## Example Usage

func GetUpdateResource 

func GetUpdateResource(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *UpdateResourceState, opts ...pulumi.ResourceOption) (*UpdateResource, error)

GetUpdateResource gets an existing UpdateResource resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewUpdateResource 

func NewUpdateResource(ctx *pulumi.Context,
	name string, args *UpdateResourceArgs, opts ...pulumi.ResourceOption) (*UpdateResource, error)

NewUpdateResource registers a new resource with the given unique name, arguments, and options.

func (*UpdateResource) ElementType 

func (*UpdateResource) ElementType() reflect.Type

func (*UpdateResource) ToUpdateResourceOutput 

func (i *UpdateResource) ToUpdateResourceOutput() UpdateResourceOutput

func (*UpdateResource) ToUpdateResourceOutputWithContext 

func (i *UpdateResource) ToUpdateResourceOutputWithContext(ctx context.Context) UpdateResourceOutput

type UpdateResourceArgs 

type UpdateResourceArgs struct {
	// A JSON object that contains the request body used to add on an existing azure resource.
	Body pulumi.StringPtrInput
	// A list of properties that should be ignored when comparing the `body` with its current state.
	IgnoreBodyChanges pulumi.StringArrayInput
	// Whether ignore incorrect casing returned in `body` to suppress plan-diff. Defaults to `false`.
	IgnoreCasing pulumi.BoolPtrInput
	// Whether ignore not returned properties like credentials in `body` to suppress plan-diff. Defaults to `true`.
	IgnoreMissingProperty pulumi.BoolPtrInput
	// A list of ARM resource IDs which are used to avoid create/modify/delete azapi resources at the same time.
	Locks pulumi.StringArrayInput
	// Specifies the name of the azure resource. Changing this forces a new resource to be created.
	Name pulumi.StringPtrInput
	// 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: `parentId` should be the ID of a resource group, it's recommended to manage a resource group by azurerm_resource_group.
	// - management group scope: `parentId` should be the ID of a management group, it's recommended to manage a management group by azurerm_management_group.
	// - extension scope: `parentId` should be the ID of the resource you're adding the extension to.
	// - subscription scope: `parentId` should be like `/subscriptions/00000000-0000-0000-0000-000000000000`
	// - tenant scope: `parentId` should be `/`
	//
	// For child level resources, the `parentId` should be the ID of its parent resource, for example, subnet resource's `parentId` is the ID of the vnet.
	ParentId pulumi.StringPtrInput
	// The ID of an existing azure source. Changing this forces a new azure resource to be created.
	//
	// > **Note:** Configuring `name` and `parentId` is an alternative way to configure `resourceId`.
	ResourceId pulumi.StringPtrInput
	// 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`.
	ResponseExportValues pulumi.StringArrayInput
	// 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.
	Type pulumi.StringInput
}

The set of arguments for constructing a UpdateResource resource.

func (UpdateResourceArgs) ElementType 

func (UpdateResourceArgs) ElementType() reflect.Type

type UpdateResourceArray 

type UpdateResourceArray []UpdateResourceInput

func (UpdateResourceArray) ElementType 

func (UpdateResourceArray) ElementType() reflect.Type

func (UpdateResourceArray) ToUpdateResourceArrayOutput 

func (i UpdateResourceArray) ToUpdateResourceArrayOutput() UpdateResourceArrayOutput

func (UpdateResourceArray) ToUpdateResourceArrayOutputWithContext 

func (i UpdateResourceArray) ToUpdateResourceArrayOutputWithContext(ctx context.Context) UpdateResourceArrayOutput

type UpdateResourceArrayInput 

type UpdateResourceArrayInput interface {
	pulumi.Input

	ToUpdateResourceArrayOutput() UpdateResourceArrayOutput
	ToUpdateResourceArrayOutputWithContext(context.Context) UpdateResourceArrayOutput
}

UpdateResourceArrayInput is an input type that accepts UpdateResourceArray and UpdateResourceArrayOutput values. You can construct a concrete instance of `UpdateResourceArrayInput` via: 

UpdateResourceArray{ UpdateResourceArgs{...} }

type UpdateResourceArrayOutput 

type UpdateResourceArrayOutput struct{ *pulumi.OutputState }

func (UpdateResourceArrayOutput) ElementType 

func (UpdateResourceArrayOutput) ElementType() reflect.Type

func (UpdateResourceArrayOutput) Index 

func (o UpdateResourceArrayOutput) Index(i pulumi.IntInput) UpdateResourceOutput

func (UpdateResourceArrayOutput) ToUpdateResourceArrayOutput 

func (o UpdateResourceArrayOutput) ToUpdateResourceArrayOutput() UpdateResourceArrayOutput

func (UpdateResourceArrayOutput) ToUpdateResourceArrayOutputWithContext 

func (o UpdateResourceArrayOutput) ToUpdateResourceArrayOutputWithContext(ctx context.Context) UpdateResourceArrayOutput

type UpdateResourceInput 

type UpdateResourceInput interface {
	pulumi.Input

	ToUpdateResourceOutput() UpdateResourceOutput
	ToUpdateResourceOutputWithContext(ctx context.Context) UpdateResourceOutput
}

type UpdateResourceMap 

type UpdateResourceMap map[string]UpdateResourceInput

func (UpdateResourceMap) ElementType 

func (UpdateResourceMap) ElementType() reflect.Type

func (UpdateResourceMap) ToUpdateResourceMapOutput 

func (i UpdateResourceMap) ToUpdateResourceMapOutput() UpdateResourceMapOutput

func (UpdateResourceMap) ToUpdateResourceMapOutputWithContext 

func (i UpdateResourceMap) ToUpdateResourceMapOutputWithContext(ctx context.Context) UpdateResourceMapOutput

type UpdateResourceMapInput 

type UpdateResourceMapInput interface {
	pulumi.Input

	ToUpdateResourceMapOutput() UpdateResourceMapOutput
	ToUpdateResourceMapOutputWithContext(context.Context) UpdateResourceMapOutput
}

UpdateResourceMapInput is an input type that accepts UpdateResourceMap and UpdateResourceMapOutput values. You can construct a concrete instance of `UpdateResourceMapInput` via: 

UpdateResourceMap{ "key": UpdateResourceArgs{...} }

type UpdateResourceMapOutput 

type UpdateResourceMapOutput struct{ *pulumi.OutputState }

func (UpdateResourceMapOutput) ElementType 

func (UpdateResourceMapOutput) ElementType() reflect.Type

func (UpdateResourceMapOutput) MapIndex 

func (o UpdateResourceMapOutput) MapIndex(k pulumi.StringInput) UpdateResourceOutput

func (UpdateResourceMapOutput) ToUpdateResourceMapOutput 

func (o UpdateResourceMapOutput) ToUpdateResourceMapOutput() UpdateResourceMapOutput

func (UpdateResourceMapOutput) ToUpdateResourceMapOutputWithContext 

func (o UpdateResourceMapOutput) ToUpdateResourceMapOutputWithContext(ctx context.Context) UpdateResourceMapOutput

type UpdateResourceOutput 

type UpdateResourceOutput struct{ *pulumi.OutputState }

func (UpdateResourceOutput) Body 

func (o UpdateResourceOutput) Body() pulumi.StringPtrOutput

A JSON object that contains the request body used to add on an existing azure resource.

func (UpdateResourceOutput) ElementType 

func (UpdateResourceOutput) ElementType() reflect.Type

func (UpdateResourceOutput) IgnoreBodyChanges added in v1.12.0 

func (o UpdateResourceOutput) IgnoreBodyChanges() pulumi.StringArrayOutput

A list of properties that should be ignored when comparing the `body` with its current state.

func (UpdateResourceOutput) IgnoreCasing 

func (o UpdateResourceOutput) IgnoreCasing() pulumi.BoolPtrOutput

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

func (UpdateResourceOutput) IgnoreMissingProperty 

func (o UpdateResourceOutput) IgnoreMissingProperty() pulumi.BoolPtrOutput

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

func (UpdateResourceOutput) Locks 

func (o UpdateResourceOutput) Locks() pulumi.StringArrayOutput

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

func (UpdateResourceOutput) Name 

func (o UpdateResourceOutput) Name() pulumi.StringOutput

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

func (UpdateResourceOutput) Output 

func (o UpdateResourceOutput) Output() pulumi.StringOutput

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

func (UpdateResourceOutput) ParentId 

func (o UpdateResourceOutput) ParentId() pulumi.StringOutput

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: `parentId` should be the ID of a resource group, it's recommended to manage a resource group by azurerm_resource_group. - management group scope: `parentId` should be the ID of a management group, it's recommended to manage a management group by azurerm_management_group. - extension scope: `parentId` should be the ID of the resource you're adding the extension to. - subscription scope: `parentId` should be like `/subscriptions/00000000-0000-0000-0000-000000000000` - tenant scope: `parentId` should be `/`

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

func (UpdateResourceOutput) ResourceId 

func (o UpdateResourceOutput) ResourceId() pulumi.StringOutput

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

> **Note:** Configuring `name` and `parentId` is an alternative way to configure `resourceId`.

func (UpdateResourceOutput) ResponseExportValues 

func (o UpdateResourceOutput) ResponseExportValues() pulumi.StringArrayOutput

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`.

func (UpdateResourceOutput) ToUpdateResourceOutput 

func (o UpdateResourceOutput) ToUpdateResourceOutput() UpdateResourceOutput

func (UpdateResourceOutput) ToUpdateResourceOutputWithContext 

func (o UpdateResourceOutput) ToUpdateResourceOutputWithContext(ctx context.Context) UpdateResourceOutput

func (UpdateResourceOutput) Type 

func (o UpdateResourceOutput) Type() pulumi.StringOutput

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.

type UpdateResourceState 

type UpdateResourceState struct {
	// A JSON object that contains the request body used to add on an existing azure resource.
	Body pulumi.StringPtrInput
	// A list of properties that should be ignored when comparing the `body` with its current state.
	IgnoreBodyChanges pulumi.StringArrayInput
	// Whether ignore incorrect casing returned in `body` to suppress plan-diff. Defaults to `false`.
	IgnoreCasing pulumi.BoolPtrInput
	// Whether ignore not returned properties like credentials in `body` to suppress plan-diff. Defaults to `true`.
	IgnoreMissingProperty pulumi.BoolPtrInput
	// A list of ARM resource IDs which are used to avoid create/modify/delete azapi resources at the same time.
	Locks pulumi.StringArrayInput
	// Specifies the name of the azure resource. Changing this forces a new resource to be created.
	Name pulumi.StringPtrInput
	// The output json containing the properties specified in `responseExportValues`. Here're some examples to decode json and extract the value.
	Output pulumi.StringPtrInput
	// 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: `parentId` should be the ID of a resource group, it's recommended to manage a resource group by azurerm_resource_group.
	// - management group scope: `parentId` should be the ID of a management group, it's recommended to manage a management group by azurerm_management_group.
	// - extension scope: `parentId` should be the ID of the resource you're adding the extension to.
	// - subscription scope: `parentId` should be like `/subscriptions/00000000-0000-0000-0000-000000000000`
	// - tenant scope: `parentId` should be `/`
	//
	// For child level resources, the `parentId` should be the ID of its parent resource, for example, subnet resource's `parentId` is the ID of the vnet.
	ParentId pulumi.StringPtrInput
	// The ID of an existing azure source. Changing this forces a new azure resource to be created.
	//
	// > **Note:** Configuring `name` and `parentId` is an alternative way to configure `resourceId`.
	ResourceId pulumi.StringPtrInput
	// 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`.
	ResponseExportValues pulumi.StringArrayInput
	// 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.
	Type pulumi.StringPtrInput
}

func (UpdateResourceState) ElementType 

func (UpdateResourceState) ElementType() reflect.Type

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.