features

Documentation

Index

• func DeprecatedInThreePointOh(deprecationMessage string) string
• func EnhancedValidationEnabled() bool
• func KubeConfigsAreSensitive() bool
• func ThreePointOh() bool
• func ThreePointOhAppServiceResources() bool
• func ThreePointOhBeta() bool
• func UseDynamicTestLocations() bool
• type ApiManagementFeatures
• type CognitiveAccountFeatures
• type KeyVaultFeatures
• type LogAnalyticsWorkspaceFeatures
• type NetworkFeatures
• type ResourceGroupFeatures
• type TemplateDeploymentFeatures
• type UserFeatures
  • func Default() UserFeatures
• type VirtualMachineFeatures
• type VirtualMachineScaleSetFeatures

Functions

func DeprecatedInThreePointOh

func DeprecatedInThreePointOh(deprecationMessage string) string

nolint gocritic DeprecatedInThreePointOh returns the deprecation message if the provider is running in 3.0 mode - otherwise is returns an empty string (such that this deprecation should be ignored).

This will be used to signify resources which will be Deprecated in 3.0, but not Removed (which will happen in a later, presumably 4.x release).

func EnhancedValidationEnabled

func EnhancedValidationEnabled() bool

EnhancedValidationEnabled returns whether or not 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 KubeConfigsAreSensitive

func KubeConfigsAreSensitive() bool

func ThreePointOh

func ThreePointOh() bool

ThreePointOh returns whether this provider is running in 3.0 mode that is to say - the final 3.0 release

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

func ThreePointOhAppServiceResources

func ThreePointOhAppServiceResources() bool

ThreePointOhAppServiceResources returns whether this provider is opted into the Beta Resources coming in v3.0 - or explicitly opted into v3.0.

func ThreePointOhBeta

func ThreePointOhBeta() bool

ThreePointOhBeta returns whether this provider is running in 3.0 mode which is an opt-in Beta of the (non-breaking changes) coming in 3.0.

Any features behind this flag should be backwards-compatible to allow users to try out 3.0 functionality.

Whilst this currently isn't exposed, this will be via an Environment Variable in the future.

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
}

type CognitiveAccountFeatures

type CognitiveAccountFeatures struct {
	PurgeSoftDeleteOnDestroy bool
}

type KeyVaultFeatures

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

type LogAnalyticsWorkspaceFeatures

type LogAnalyticsWorkspaceFeatures struct {
	PermanentlyDeleteOnDestroy bool
}

type NetworkFeatures

type NetworkFeatures struct {
	RelaxedLocking bool
}

type ResourceGroupFeatures

type ResourceGroupFeatures struct {
	PreventDeletionIfContainsResources bool
}

type TemplateDeploymentFeatures

type TemplateDeploymentFeatures struct {
	DeleteNestedItemsDuringDeletion bool
}

type UserFeatures

type UserFeatures struct {
	ApiManagement          ApiManagementFeatures
	CognitiveAccount       CognitiveAccountFeatures
	VirtualMachine         VirtualMachineFeatures
	VirtualMachineScaleSet VirtualMachineScaleSetFeatures
	KeyVault               KeyVaultFeatures
	Network                NetworkFeatures
	TemplateDeployment     TemplateDeploymentFeatures
	LogAnalyticsWorkspace  LogAnalyticsWorkspaceFeatures
	ResourceGroup          ResourceGroupFeatures
}

func Default

func Default() UserFeatures

type VirtualMachineFeatures

type VirtualMachineFeatures struct {
	DeleteOSDiskOnDeletion     bool
	GracefulShutdown           bool
	SkipShutdownAndForceDelete bool
}

type VirtualMachineScaleSetFeatures

type VirtualMachineScaleSetFeatures struct {
	ForceDelete               bool
	RollInstancesWhenRequired bool
	ScaleToZeroOnDelete       bool
}