com.azure.resourcemanager.resources.models

Package containing the data models for ResourceManagementClient. ResourceManagement Client.

Classes

ActionOnUnmanage

Defines the behavior of resources that are no longer managed after the stack is updated or deleted.

Alias

The alias type.

AliasPath

The type of the paths for alias.

AliasPathAttributes

The attributes of the token that the alias path is referring to.

AliasPathMetadata

The AliasPathMetadata model.

AliasPathTokenType

The type of the token that the alias path is referring to.

AliasPattern

The type of the pattern for an alias path.

ApiProfile

The ApiProfile model.

AssignmentScopeValidation

The option whether validate the exemption is at or under the assignment scope.

AssignmentType

The type of policy assignment.

AuthorizationProfile

Authorization Profile.

AvailabilityZoneMappings

Availability zone mappings for the region.

AvailabilityZonePeers

List of availability zones shared by the subscriptions.

AzureResourceBase

Common properties for all Azure resources.

BasicDependency

Deployment dependency information.

ChangeAttributes

Details about the change resource.

ChangeBase

An individual change on the target resource.

ChangeProperties

The properties of a change.

ChangeResourceListResult

The list of resources.

CheckZonePeersRequest

Check zone peers request parameters.

DataBoundary

The data boundary definition.

DataBoundaryProperties

Data boundary properties.

DataEffect

The data effect definition.

DataManifestCustomResourceFunctionDefinition

The custom resource function definition.

DataPolicyManifestListResult

List of data policy manifests.

DebugSetting

The debug setting.

DefaultName

Defines values for DefaultName.

DenySettings

Defines how resources deployed by the Deployment stack are locked.

DenySettingsMode

denySettings Mode that defines denied actions.

DenyStatusMode

denyAssignment settings applied to the resource.

Dependency

Deployment dependency information.

DeploymentDiagnosticsDefinition

The DeploymentDiagnosticsDefinition model.

DeploymentExtensionConfigItem

The DeploymentExtensionConfigItem model.

DeploymentExtensionDefinition

The DeploymentExtensionDefinition model.

DeploymentExternalInput

Deployment external input for parameterization.

DeploymentExternalInputDefinition

Deployment external input definition for parameterization.

DeploymentIdentity

The Managed Identity configuration for a deployment.

DeploymentIdentityType

The identity type.

DeploymentListResult

List of deployments.

DeploymentOperationProperties

Deployment operation properties.

DeploymentOperationsListResult

List of deployment operations.

DeploymentParameter

Deployment parameter for the template.

DeploymentProperties

Deployment properties.

DeploymentPropertiesExtended

Deployment properties with additional details.

DeploymentStackListResult

List of Deployment stacks.

DeploymentStackProvisioningState

State of the deployment stack.

DeploymentStackValidateProperties

The Deployment stack validation result details.

DeploymentStacksDebugSetting

The debug setting.

DeploymentStacksDeleteDetachEnum

Specifies an action for a newly unmanaged resource.

DeploymentStacksParametersLink

Entity representing the reference to the deployment parameters.

DeploymentStacksTemplateLink

Entity representing the reference to the template.

DeploymentWhatIf

Deployment What-if operation parameters.

DeploymentWhatIfProperties

Deployment What-if properties.

DeploymentWhatIfSettings

Deployment What-If operation settings.

EnforcementMode

The policy assignment enforcement mode.

ErrorAdditionalInfo

The resource management error additional info.

ExemptionCategory

The policy exemption category.

ExportTemplateOutputFormat

The output format for the exported resources.

ExportTemplateRequest

Export resource group template request parameters.

ExpressionEvaluationOptions

Specifies whether template expressions are evaluated within the scope of the parent template or nested template.

ExpressionEvaluationOptionsScopeType

The scope to be used for evaluation of parameters, variables and functions in a nested template.

ExtendedLocation

Resource extended location.

ExtendedLocationType

The extended location type.

ExtensionConfigPropertyType

Defines values for ExtensionConfigPropertyType.

ExternalEndpointResult

The result of the external endpoint.

ExternalEvaluationEndpointInvocationResult

The external evaluation endpoint invocation results.

ExternalEvaluationEndpointSettings

The settings of an external endpoint providing evaluation results.

ExternalEvaluationEnforcementSettings

The details of the source of external evaluation results required by the policy during enforcement evaluation.

FeatureOperationsListResult

List of previewed features.

FeatureProperties

Information about feature.

ForceDeletionResourceType

Resource type for force deletion.

HttpMessage

HTTP message.

Identity

Identity for the resource.

IdentityUserAssignedIdentitiesValue

The IdentityUserAssignedIdentitiesValue model.

KeyVaultParameterReference

Azure Key Vault parameter reference.

KeyVaultReference

Azure Key Vault reference.

Level

Denotes the additional response level.

LocationListResult

Location list operation response.

LocationMetadata

Location metadata information.

LockLevel

The level of the lock.

ManagedByTenant

Information about a tenant managing the subscription.

ManagedResourceReference

The managed resource model.

ManagementLockListResult

The list of locks.

ManagementLockOwner

Lock owner properties.

NonComplianceMessage

A message that describes why a resource is non-compliant with the policy.

OnErrorDeployment

Deployment on error behavior.

OnErrorDeploymentExtended

Deployment on error behavior with additional details.

OperationDisplay

The object that represents the operation.

OperationListResult

Result of the request to list Microsoft.Resources operations.

OverrideKind

The override kind.

OverrideModel

The policy property value override.

PairedRegion

Information regarding paired region.

ParameterDefinitionsValue

The definition of a parameter that can be provided to the policy.

ParameterDefinitionsValueMetadata

General metadata for the parameter.

ParameterType

The data type of the parameter.

ParameterValuesValue

The value of a parameter.

ParametersLink

Entity representing the reference to the deployment parameters.

Peers

Information about shared availability zone.

Permission

Role definition permissions.

Plan

Plan for the resource.

PolicyAssignmentListResult

List of policy assignments.

PolicyAssignmentUpdate

The policy assignment for Patch request.

PolicyDefinitionGroup

The policy definition group.

PolicyDefinitionListResult

List of policy definitions.

PolicyDefinitionReference

The policy definition reference.

PolicyExemptionListResult

List of policy exemptions.

PolicyExemptionUpdate

The policy exemption for Patch request.

PolicyLogInfo

The policy log info.

PolicySetDefinitionListResult

List of policy set definitions.

PolicyTokenOperation

The resource operation to acquire a token for.

PolicyTokenRequest

The policy token request properties.

PolicyTokenResult

The result of the completed token acquisition operation.

PolicyType

The type of policy definition.

ProviderAuthorizationConsentState

The provider authorization consent state.

ProviderConsentDefinition

The provider consent.

ProviderExtendedLocation

The provider extended location.

ProviderListResult

List of resource providers.

ProviderPermission

The provider permission.

ProviderRegistrationRequest

The provider registration definition.

ProviderResourceType

Resource type managed by the resource provider.

ProvisioningState

Denotes the state of provisioning.

RegionCategory

The category of the region.

RegionType

The type of the region.

ResourceGroupListResult

List of resource groups.

ResourceGroupPatchable

Resource group information.

ResourceGroupProperties

The resource group properties.

ResourceListResult

List of resource groups.

ResourceName

Name and Type of the Resource.

ResourceNameStatus

Is the resource name Allowed or Reserved.

ResourceReference

The resource Id model.

ResourceReferenceExtended

The resourceId extended model.

ResourceSelector

The resource selector to filter policies by resource properties.

ResourceStatusMode

Current management state of the resource in the deployment stack.

ResourceTypeAliases

The resource type aliases definition.

ResourcesMoveInfo

Parameters of move resources.

RoleDefinition

Role definition properties.

ScopedDeployment

Deployment operation parameters.

ScopedDeploymentWhatIf

Deployment What-if operation parameters.

Selector

The selector expression.

SelectorKind

The selector kind.

Sku

SKU for the resource.

StatusMessage

Operation status message object.

SubscriptionFeatureRegistrationApprovalType

The feature approval type.

SubscriptionFeatureRegistrationList

The list of subscription feature registrations.

SubscriptionFeatureRegistrationProperties

The SubscriptionFeatureRegistrationProperties model.

SubscriptionFeatureRegistrationState

The state.

SubscriptionListResult

Subscription list operation response.

SubscriptionPolicies

Subscription policies.

TagCount

Tag count.

Tags

A dictionary of name and value pairs.

TagsListResult

List of subscription tags.

TagsPatchOperation

The operation type for the patch API.

TagsPatchResource

Wrapper resource for tags patch API request only.

TargetResource

Target resource.

TemplateLink

Entity representing the reference to the template.

TenantListResult

Tenant Ids information.

UnmanageActionManagementGroupMode

Defines values for UnmanageActionManagementGroupMode.

UnmanageActionResourceGroupMode

Defines values for UnmanageActionResourceGroupMode.

UnmanageActionResourceMode

Defines values for UnmanageActionResourceMode.

UserAssignedIdentity

User assigned identity properties.

ValidationLevel

The level of validation performed on the deployment.

WhatIfChange

Information about a single resource change predicted by What-If operation.

WhatIfPropertyChange

The predicted change to the resource property.

ZoneMapping

The ZoneMapping model.

Interfaces

Deployment

An immutable client-side representation of an Azure deployment.

Deployment.Definition

Container interface for all the deployment definitions.

Deployment.DefinitionStages

Grouping of all the deployment definition stages.

Deployment.DefinitionStages.Blank

The first stage of deployment definition.

Deployment.DefinitionStages.WithCreate

A deployment definition with sufficient inputs to create a new deployment in the cloud, but exposing additional optional inputs to specify.

Deployment.DefinitionStages.WithGroup

A deployment definition allowing resource group to be specified.

Deployment.DefinitionStages.WithMode

A deployment definition allowing the deployment mode to be specified.

Deployment.DefinitionStages.WithParameters

A deployment definition allowing the parameters to be specified.

Deployment.DefinitionStages.WithTemplate

A deployment definition allowing the template to be specified.

Deployment.Execution

Container interface for all the deployment execution.

Deployment.ExecutionStages

Grouping of all the deployment execution stages.

Deployment.ExecutionStages.Blank

The first stage of deployment execution.

Deployment.ExecutionStages.WithExecute

A deployment definition allowing the execution to be specified.

Deployment.ExecutionStages.WithWhatIf

A deployment execution allowing What-if parameters to be specified.

Deployment.ExecutionStages.WithWhatIfDeploymentMode

A deployment execution allowing deployment mode to be specified.

Deployment.ExecutionStages.WithWhatIfLocation

A deployment execution allowing data storage location to be specified.

Deployment.ExecutionStages.WithWhatIfOnErrorDeploymentType

A deployment execution allowing on error deployment type to be specified.

Deployment.ExecutionStages.WithWhatIfParameter

A deployment execution allowing parameter to be specified.

Deployment.ExecutionStages.WithWhatIfResultFormat

A deployment execution allowing result format to be specified.

Deployment.ExecutionStages.WithWhatIfTemplate

A deployment execution allowing template to be specified.

Deployment.Update

The template for a deployment update operation, containing all the settings that can be modified.

Deployment.UpdateStages

Grouping of all the deployment updates stages.

Deployment.UpdateStages.WithMode

A deployment update allowing to change the deployment mode.

Deployment.UpdateStages.WithParameters

A deployment update allowing to change the parameters.

Deployment.UpdateStages.WithTemplate

A deployment update allowing to change the template.

DeploymentExportResult

An immutable client-side representation of an Azure deployment template export result.

DeploymentOperation

An immutable client-side representation of a deployment operation.

DeploymentOperations

Entry point to deployment operation management API.

Deployments

Entry point to template deployment in Azure.

Feature

An immutable client-side representation of an Azure feature.

Features

Entry point to features management API.

GenericResource

An immutable client-side representation of an Azure generic resource.

GenericResource.Definition

The entirety of the generic resource definition.

GenericResource.DefinitionStages

Grouping of generic resource definition stages.

GenericResource.DefinitionStages.Blank

A generic resource definition allowing region to be specified.

GenericResource.DefinitionStages.WithApiVersion

A generic resource definition allowing api version to be specified.

GenericResource.DefinitionStages.WithCreate

A deployment definition with sufficient inputs to create a new resource in the cloud, but exposing additional optional inputs to specify.

GenericResource.DefinitionStages.WithGroup

A generic resource definition allowing resource group to be specified.

GenericResource.DefinitionStages.WithParentResource

A generic resource definition allowing parent resource to be specified.

GenericResource.DefinitionStages.WithPlan

A generic resource definition allowing plan to be specified.

GenericResource.DefinitionStages.WithProviderNamespace

A generic resource definition allowing provider namespace to be specified.

GenericResource.DefinitionStages.WithResourceType

A generic resource definition allowing resource type to be specified.

GenericResource.Update

The template for a generic resource update operation, containing all the settings that can be modified.

GenericResource.UpdateStages

Grouping of generic resource update stages.

GenericResource.UpdateStages.WithApiVersion

The template for a generic resource update operation for specifying the resource provider API version.

GenericResource.UpdateStages.WithIdentity

The template for a generic resource update operation for specifying the managed identity.

GenericResource.UpdateStages.WithKind

The template for a generic resource update operation for specifying the resource kind.

GenericResource.UpdateStages.WithParentResource

A generic resource update allowing to change the parent resource.

GenericResource.UpdateStages.WithPlan

A generic resource update allowing to change the resource plan.

GenericResource.UpdateStages.WithProperties

A generic resource update allowing to change the resource properties.

GenericResource.UpdateStages.WithSku

The template for a generic resource update operation for specifying the resource SKU.

GenericResources

Entry point to generic resources management API.

Location

An immutable client-side representation of an Azure location.

ManagementLock

Management lock.

ManagementLock.Definition

Container interface for all the definitions.

ManagementLock.DefinitionStages

Grouping of management lock definition stages.

ManagementLock.DefinitionStages.Blank

The first stage of a management lock definition.

ManagementLock.DefinitionStages.WithCreate

The stage of the management lock definition which contains all the minimum required inputs for the resource to be created but also allows for any other optional settings to be specified.

ManagementLock.DefinitionStages.WithLevel

The stage of a management lock definition allowing to specify notes for the lock.

ManagementLock.DefinitionStages.WithLockedResource

The stage of a management lock definition allowing to specify the resource to lock.

ManagementLock.DefinitionStages.WithNotes

The stage of a management lock definition allowing to specify the level of the lock.

ManagementLock.Update

Container interface for all the updates.

ManagementLock.UpdateStages

Grouping of management lock update stages.

ManagementLock.UpdateStages.WithLevel

The stage of a management lock update allowing to modify the level of the lock.

ManagementLock.UpdateStages.WithLockedResource

The stage of a management lock update allowing to specify the resource to lock.

ManagementLock.UpdateStages.WithNotes

The stage of a management lock definition allowing to specify the level of the lock.

ManagementLocks

Entry point to management lock management.

PolicyAssignment

An immutable client-side representation of an Azure policy assignment.

PolicyAssignment.Definition

Container interface for all the definitions that need to be implemented.

PolicyAssignment.DefinitionStages

Grouping of all the policy assignment definition stages.

PolicyAssignment.DefinitionStages.Blank

The first stage of the policy assignment.

PolicyAssignment.DefinitionStages.WithCreate

A policy assignment with sufficient inputs to create a new policy assignment in the cloud, but exposing additional optional inputs to specify.

PolicyAssignment.DefinitionStages.WithDisplayName

A policy assignment allowing the display name to be set.

PolicyAssignment.DefinitionStages.WithEnforcementMode

A policy assignment allowing the enforcement mode to be set.

PolicyAssignment.DefinitionStages.WithExcludedScopes

A policy assignment allowing the excluded scopes to be set.

PolicyAssignment.DefinitionStages.WithParameters

A policy assignment allowing the parameters to be set.

PolicyAssignment.DefinitionStages.WithPolicyDefinition

A policy assignment allowing the policy definition to be set.

PolicyAssignment.DefinitionStages.WithScope

A policy assignment specifying the scope of the policy.

PolicyAssignments

Entry point to policy assignment management API.

PolicyDefinition

An immutable client-side representation of an Azure policy.

PolicyDefinition.Definition

Container interface for all the definitions that need to be implemented.

PolicyDefinition.DefinitionStages

Grouping of all the policy definition stages.

PolicyDefinition.DefinitionStages.Blank

The first stage of the policy definition.

PolicyDefinition.DefinitionStages.WithCreate

A policy definition with sufficient inputs to create a new policy in the cloud, but exposing additional optional inputs to specify.

PolicyDefinition.DefinitionStages.WithDescription

A policy definition allowing policy description to be set.

PolicyDefinition.DefinitionStages.WithDisplayName

A policy definition allowing the display name to be set.

PolicyDefinition.DefinitionStages.WithMetadata

A policy definition allowing policy definition metadata to be set.

PolicyDefinition.DefinitionStages.WithMode

A policy definition allowing policy definition mode to be set.

PolicyDefinition.DefinitionStages.WithParameters

A policy definition allowing parameters to be set.

PolicyDefinition.DefinitionStages.WithPolicyRule

A policy definition allowing the policy rule to be set.

PolicyDefinition.DefinitionStages.WithPolicyType

A policy definition specifying the policy type to be blob.

PolicyDefinition.Update

The template for a policy update operation, containing all the settings that can be modified.

PolicyDefinition.UpdateStages

Grouping of all the policy update stages.

PolicyDefinition.UpdateStages.WithDescription

A policy definition allowing the policy description to be set.

PolicyDefinition.UpdateStages.WithDisplayName

A policy definition allowing the display name to be set.

PolicyDefinition.UpdateStages.WithMetadata

A policy definition allowing policy definition metadata to be set.

PolicyDefinition.UpdateStages.WithMode

A policy definition allowing policy definition mode to be set.

PolicyDefinition.UpdateStages.WithPolicyRule

A policy definition allowing the policy rule to be set.

PolicyDefinition.UpdateStages.WithPolicyType

A policy definition allowing the policy type to be set.

PolicyDefinitions

Entry point to tenant management API.

Provider

An immutable client-side representation of an Azure resource provider.

Providers

Entry point to providers management API.

ResourceGroup

An immutable client-side representation of an Azure resource group.

ResourceGroup.Definition

Container interface for all the definitions that need to be implemented.

ResourceGroup.DefinitionStages

Grouping of all the resource group definition stages.

ResourceGroup.DefinitionStages.Blank

A resource group definition allowing location to be set.

ResourceGroup.DefinitionStages.WithCreate

A resource group definition with sufficient inputs to create a new resource group in the cloud, but exposing additional optional inputs to specify.

ResourceGroup.Update

The template for a resource group update operation, containing all the settings that can be modified.

ResourceGroup.UpdateStages

Grouping of all the resource group update stages.

ResourceGroupExportResult

An immutable client-side representation of an Azure deployment template export result.

ResourceGroups

Entry point to resource group management API.

Subscription

An immutable client-side representation of an Azure subscription.

Subscriptions

Entry point to subscription management API.

TagOperations

Entry point to tag management API.

TagResource

An immutable client-side representation of an Azure resource with tags.

Tenant

An immutable client-side representation of an Azure tenant.

Tenants

Entry point to tenant management API.

WhatIfOperationResult

An immutable client-side representation of an Azure deployment What-if operation result.

Enums

AliasPatternType

The type of alias pattern.

AliasType

The type of the alias.

ChangeCategory

The entity that made the change.

ChangeType

Type of change that will be made to the resource when the deployment is executed.

DeploymentMode

The mode that is used to deploy resources.

LocationType

The location type.

OnErrorDeploymentType

The deployment on error behavior type.

PropertyChangeType

The type of property change.

ProvisioningOperation

The name of the current provisioning operation.

ResourceChangeType

The type of change that was captured in the resource.

ResourceGroupExportTemplateOptions

The export template options.

ResourceIdentityType

The identity type.

ResourcePropertyChangeType

The type of change that occurred.

SpendingLimit

The subscription spending limit.

SubscriptionState

The subscription state.

TenantCategory

Category of the tenant.

WhatIfResultFormat

The format of the What-If results.