features

Documentation

Index

• func DeprecatedInFivePointOh(deprecationMessage string) string
• func DeprecatedInFourPointOh(deprecationMessage string) string
• func EnhancedValidationEnabled() bool
• func FivePointOh() bool
• func FivePointOhBeta() bool
• func FourPointOh() bool
• func FourPointOhBeta() bool
• func UseDynamicTestLocations() bool
• type ApiManagementFeatures
• type AppConfigurationFeatures
• type ApplicationInsightFeatures
• type CognitiveAccountFeatures
• type KeyVaultFeatures
• type LogAnalyticsWorkspaceFeatures
• type MachineLearningFeatures
• type ManagedDiskFeatures
• type PostgresqlFlexibleServerFeatures
• type RecoveryServiceFeatures
• type RecoveryServicesVault
• type ResourceGroupFeatures
• type SubscriptionFeatures
• type TemplateDeploymentFeatures
• type UserFeatures
  • func Default() UserFeatures
• type VirtualMachineFeatures
• type VirtualMachineScaleSetFeatures

Functions

func DeprecatedInFivePointOh

func DeprecatedInFivePointOh(deprecationMessage string) string

nolint gocritic DeprecatedInFivePointOh returns the deprecation message if the provider is running in 4.0 mode - otherwise is returns an empty string (such that this deprecation should be ignored). This can be used for the following scenarios:

• Signify resources which will be Deprecated in 5.0, but not Removed (which will happen in a later release).
• For properties undergoing a rename, where the renamed property will only be introduced in the next release

func DeprecatedInFourPointOh

func DeprecatedInFourPointOh(deprecationMessage string) string

nolint gocritic DeprecatedInFourPointOh returns the deprecation message if the provider is running in 4.0 mode - otherwise is returns an empty string (such that this deprecation should be ignored). This can be used for the following scenarios:

• Signify resources which will be Deprecated in 4.0, but not Removed (which will happen in a later release).
• For properties undergoing a rename, where the renamed property will only be introduced in the next release

func EnhancedValidationEnabled

func EnhancedValidationEnabled() bool

EnhancedValidationEnabled returns whether the feature for Enhanced Validation is enabled.

This functionality calls out to the Azure MetaData Service to cache the list of supported Azure Locations for the specified Endpoint - and then uses that to provide enhanced validation

This is enabled by default as of version 2.20 of the Azure Provider, and can be disabled by setting the Environment Variable `ARM_PROVIDER_ENHANCED_VALIDATION` to `false`.

func FivePointOh

func FivePointOh() bool

FourPointOh returns whether this provider is running in 5.0 mode that is to say - the final 5.0 release

This exists to allow breaking changes to be piped through the provider during the development of 4.x until 5.0 is ready.

func FivePointOhBeta

func FivePointOhBeta() bool

FivePointOhBeta returns whether this provider is running in 5.0 mode which is an opt-in Beta of the changes coming in 5.0.

This exists to allow breaking changes to be piped through the provider during the development of 4.x until 5.0 is ready.

func FourPointOh

func FourPointOh() bool

FourPointOh returns whether this provider is running in 4.0 mode that is to say - the final 4.0 release

This exists to allow breaking changes to be piped through the provider during the development of 3.x until 4.0 is ready.

func FourPointOhBeta

func FourPointOhBeta() bool

FourPointOhBeta returns whether this provider is running in 4.0 mode which is an opt-in Beta of the changes coming in 4.0.

This exists to allow breaking changes to be piped through the provider during the development of 3.x until 4.0 is ready.

The environment variable `ARM_FOURPOINTZERO_BETA` has been added to facilitate testing. But it should be noted that `ARM_FOURPOINTZERO_BETA` is ** NOT READY FOR PUBLIC USE ** and ** SHOULD NOT BE SET IN PRODUCTION ENVIRONMENTS ** Setting `ARM_FOURPOINTZERO_BETA` will cause irreversible changes to your state.

func UseDynamicTestLocations

func UseDynamicTestLocations() bool

UseDynamicTestLocations returns whether or not the Acceptance Test data should use dynamic values for test locations

In practice this means that of the available test locations, the primary, secondary and ternary locations will change dynamically for each test

The primary benefit of this is to distribute the tests across Azure Regions, to improve the overall reliability. In time this'll become the default value.

It's possible to opt into this by setting `ARM_PROVIDER_DYNAMIC_TEST` to `true`.

Types

type ApiManagementFeatures

type ApiManagementFeatures struct {
	PurgeSoftDeleteOnDestroy bool
	RecoverSoftDeleted       bool
}

type AppConfigurationFeatures

type AppConfigurationFeatures struct {
	PurgeSoftDeleteOnDestroy bool
	RecoverSoftDeleted       bool
}

type ApplicationInsightFeatures

type ApplicationInsightFeatures struct {
	DisableGeneratedRule bool
}

type CognitiveAccountFeatures

type CognitiveAccountFeatures struct {
	PurgeSoftDeleteOnDestroy bool
}

type KeyVaultFeatures

type KeyVaultFeatures struct {
	PurgeSoftDeleteOnDestroy         bool
	PurgeSoftDeletedKeysOnDestroy    bool
	PurgeSoftDeletedCertsOnDestroy   bool
	PurgeSoftDeletedSecretsOnDestroy bool
	PurgeSoftDeletedHSMsOnDestroy    bool
	PurgeSoftDeletedHSMKeysOnDestroy bool
	RecoverSoftDeletedKeyVaults      bool
	RecoverSoftDeletedKeys           bool
	RecoverSoftDeletedCerts          bool
	RecoverSoftDeletedSecrets        bool
	RecoverSoftDeletedHSMKeys        bool
}

type LogAnalyticsWorkspaceFeatures

type LogAnalyticsWorkspaceFeatures struct {
	PermanentlyDeleteOnDestroy bool
}

type MachineLearningFeatures

type MachineLearningFeatures struct {
	PurgeSoftDeletedWorkspaceOnDestroy bool
}

type ManagedDiskFeatures

type ManagedDiskFeatures struct {
	ExpandWithoutDowntime bool
}

type PostgresqlFlexibleServerFeatures

type PostgresqlFlexibleServerFeatures struct {
	RestartServerOnConfigurationValueChange bool
}

type RecoveryServiceFeatures

type RecoveryServiceFeatures struct {
	VMBackupStopProtectionAndRetainDataOnDestroy bool
	PurgeProtectedItemsFromVaultOnDestroy        bool
}

type RecoveryServicesVault

type RecoveryServicesVault struct {
	RecoverSoftDeletedBackupProtectedVM bool
}

type ResourceGroupFeatures

type ResourceGroupFeatures struct {
	PreventDeletionIfContainsResources bool
}

type SubscriptionFeatures

type SubscriptionFeatures struct {
	PreventCancellationOnDestroy bool
}

type TemplateDeploymentFeatures

type TemplateDeploymentFeatures struct {
	DeleteNestedItemsDuringDeletion bool
}

type UserFeatures

type UserFeatures struct {
	ApiManagement            ApiManagementFeatures
	AppConfiguration         AppConfigurationFeatures
	ApplicationInsights      ApplicationInsightFeatures
	CognitiveAccount         CognitiveAccountFeatures
	VirtualMachine           VirtualMachineFeatures
	VirtualMachineScaleSet   VirtualMachineScaleSetFeatures
	KeyVault                 KeyVaultFeatures
	TemplateDeployment       TemplateDeploymentFeatures
	LogAnalyticsWorkspace    LogAnalyticsWorkspaceFeatures
	ResourceGroup            ResourceGroupFeatures
	RecoveryServicesVault    RecoveryServicesVault
	ManagedDisk              ManagedDiskFeatures
	Subscription             SubscriptionFeatures
	PostgresqlFlexibleServer PostgresqlFlexibleServerFeatures
	MachineLearning          MachineLearningFeatures
	RecoveryService          RecoveryServiceFeatures
}

func Default

func Default() UserFeatures

type VirtualMachineFeatures

type VirtualMachineFeatures struct {
	DetachImplicitDataDiskOnDeletion bool
	DeleteOSDiskOnDeletion           bool
	GracefulShutdown                 bool
	SkipShutdownAndForceDelete       bool
}

type VirtualMachineScaleSetFeatures

type VirtualMachineScaleSetFeatures struct {
	ForceDelete               bool
	ReimageOnManualUpgrade    bool
	RollInstancesWhenRequired bool
	ScaleToZeroOnDelete       bool
}