azure

package
v0.30.6 Latest Latest
Warning

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

 Go to latest Published: Sep 30, 2020 License: Apache-2.0 Imports: 21 Imported by: 9

Documentation

Index

Constants

View Source 
const (
	// AuthFromEnvClient is an env variable supported by the Azure SDK
	AuthFromEnvClient = "AZURE_CLIENT_ID"

	// AuthFromEnvTenant is an env variable supported by the Azure SDK
	AuthFromEnvTenant = "AZURE_TENANT_ID"

	// AuthFromFile is an env variable supported by the Azure SDK
	AuthFromFile = "AZURE_AUTH_LOCATION"
)
View Source 
const (
	// AzureSubscriptionID is an optional env variable supported by the `azurerm` Terraform provider to
	// designate a target Azure subscription ID
	AzureSubscriptionID = "ARM_SUBSCRIPTION_ID"

	// AzureResGroupName is an optional env variable custom to Terratest to designate a target Azure resource group
	AzureResGroupName = "AZURE_RES_GROUP_NAME"
)

Variables

This section is empty.

Functions

func AvailabilitySetExists added in v0.30.3 

func AvailabilitySetExists(t testing.TestingT, avsName string, resGroupName string, subscriptionID string) bool

AvailabilitySetExists indicates whether the specified Azure Availability Set exists. This function would fail the test if there is an error.

func AvailabilitySetExistsE added in v0.30.3 

func AvailabilitySetExistsE(t testing.TestingT, avsName string, resGroupName string, subscriptionID string) (bool, error)

AvailabilitySetExistsE indicates whether the specified Azure Availability Set exists

func CheckAvailabilitySetContainsVM added in v0.30.3 

func CheckAvailabilitySetContainsVM(t testing.TestingT, vmName string, avsName string, resGroupName string, subscriptionID string) bool

CheckAvailabilitySetContainsVM checks if the Virtual Machine is contained in the Availability Set VMs. This function would fail the test if there is an error.

func CheckAvailabilitySetContainsVME added in v0.30.3 

func CheckAvailabilitySetContainsVME(t testing.TestingT, vmName string, avsName string, resGroupName string, subscriptionID string) (bool, error)

CheckAvailabilitySetContainsVME checks if the Virtual Machine is contained in the Availability Set VMs

func CheckPublicDNSNameAvailability added in v0.30.6 

func CheckPublicDNSNameAvailability(t testing.TestingT, location string, domainNameLabel string, subscriptionID string) bool

CheckPublicDNSNameAvailability checks whether a Domain Name in the cloudapp.azure.com zone is available for use. This function would fail the test if there is an error.

func CheckPublicDNSNameAvailabilityE added in v0.30.6 

func CheckPublicDNSNameAvailabilityE(location string, domainNameLabel string, subscriptionID string) (bool, error)

CheckPublicDNSNameAvailabilityE checks whether a Domain Name in the cloudapp.azure.com zone is available for use.

func CheckSubnetContainsIP added in v0.30.6 

func CheckSubnetContainsIP(t testing.TestingT, IP string, subnetName string, vnetName string, resGroupName string, subscriptionID string) bool

CheckSubnetContainsIP checks if the Private IP is contined in the Subnet Address Range. This function would fail the test if there is an error.

func CheckSubnetContainsIPE added in v0.30.6 

func CheckSubnetContainsIPE(ipAddress string, subnetName string, vnetName string, resGroupName string, subscriptionID string) (bool, error)

CheckSubnetContainsIPE checks if the Private IP is contined in the Subnet Address Range.

func GetActionGroupResource added in v0.30.2 

func GetActionGroupResource(t *testing.T, ruleName string, resGroupName string, subscriptionID string) *insights.ActionGroupResource

GetActionGroupResource gets the ActionGroupResource. ruleName - required to find the ActionGroupResource. resGroupName - use an empty string if you have the AZURE_RES_GROUP_NAME environment variable set subscriptionId - use an empty string if you have the ARM_SUBSCRIPTION_ID environment variable set

func GetActionGroupResourceE added in v0.30.2 

func GetActionGroupResourceE(ruleName string, resGroupName string, subscriptionID string) (*insights.ActionGroupResource, error)

GetActionGroupResourceE gets the ActionGroupResource with Error details on error. ruleName - required to find the ActionGroupResource. resGroupName - use an empty string if you have the AZURE_RES_GROUP_NAME environment variable set subscriptionId - use an empty string if you have the ARM_SUBSCRIPTION_ID environment variable set

func GetAllAzureRegions 

func GetAllAzureRegions(t testing.TestingT, subscriptionID string) []string

GetAllAzureRegions gets the list of Azure regions available in this subscription.

func GetAllAzureRegionsE 

func GetAllAzureRegionsE(t testing.TestingT, subscriptionID string) ([]string, error)

GetAllAzureRegionsE gets the list of Azure regions available in this subscription

func GetAvailabilitySetClientE added in v0.30.3 

func GetAvailabilitySetClientE(subscriptionID string) (*compute.AvailabilitySetsClient, error)

GetAvailabilitySetClientE gets a new Availability Set client in the specified Azure Subscription

func GetAvailabilitySetE added in v0.30.3 

func GetAvailabilitySetE(t testing.TestingT, avsName string, resGroupName string, subscriptionID string) (*compute.AvailabilitySet, error)

GetAvailabilitySetE gets an Availability Set in the specified Azure Resource Group

func GetAvailabilitySetFaultDomainCount added in v0.30.3 

func GetAvailabilitySetFaultDomainCount(t testing.TestingT, avsName string, resGroupName string, subscriptionID string) int32

GetAvailabilitySetFaultDomainCount gets the Fault Domain Count for the specified Azure Availability Set. This function would fail the test if there is an error.

func GetAvailabilitySetFaultDomainCountE added in v0.30.3 

func GetAvailabilitySetFaultDomainCountE(t testing.TestingT, avsName string, resGroupName string, subscriptionID string) (int32, error)

GetAvailabilitySetFaultDomainCountE gets the Fault Domain Count for the specified Azure Availability Set

func GetAvailabilitySetVMNamesInCaps added in v0.30.3 

func GetAvailabilitySetVMNamesInCaps(t testing.TestingT, avsName string, resGroupName string, subscriptionID string) []string

GetAvailabilitySetVMNamesInCaps gets a list of VM names in the specified Azure Availability Set. This function would fail the test if there is an error.

func GetAvailabilitySetVMNamesInCapsE added in v0.30.3 

func GetAvailabilitySetVMNamesInCapsE(t testing.TestingT, avsName string, resGroupName string, subscriptionID string) ([]string, error)

GetAvailabilitySetVMNamesInCapsE gets a list of VM names in the specified Azure Availability Set

func GetCustomNsgRulesClient added in v0.30.4 

func GetCustomNsgRulesClient(t *testing.T, subscriptionID string) network.SecurityRulesClient

GetCustomNsgRulesClient returns a rules client which can be used to read the list of *custom* security rules defined on an network security group. Note that the "custom" rules are those defined by end users. This function would fail the test if there is an error.

func GetCustomNsgRulesClientE added in v0.30.4 

func GetCustomNsgRulesClientE(subscriptionID string) (network.SecurityRulesClient, error)

GetCustomNsgRulesClientE returns a rules client which can be used to read the list of *custom* security rules defined on an network security group. Note that the "custom" rules are those defined by end users.

func GetDefaultNsgRulesClient added in v0.30.4 

func GetDefaultNsgRulesClient(t *testing.T, subscriptionID string) network.DefaultSecurityRulesClient

GetDefaultNsgRulesClient returns a rules client which can be used to read the list of *default* security rules defined on an network security group. Note that the "default" rules are those provided implicitly by the Azure platform. This function would fail the test if there is an error.

func GetDefaultNsgRulesClientE added in v0.30.4 

func GetDefaultNsgRulesClientE(subscriptionID string) (network.DefaultSecurityRulesClient, error)

GetDefaultNsgRulesClientE returns a rules client which can be used to read the list of *default* security rules defined on an network security group. Note that the "default" rules are those provided implicitly by the Azure platform.

func GetIPOfPublicIPAddressByName added in v0.30.6 

func GetIPOfPublicIPAddressByName(t testing.TestingT, publicAddressName string, resGroupName string, subscriptionID string) string

GetIPOfPublicIPAddressByName gets the Public IP of the Public IP Address specified. This function would fail the test if there is an error.

func GetIPOfPublicIPAddressByNameE added in v0.30.6 

func GetIPOfPublicIPAddressByNameE(publicAddressName string, resGroupName string, subscriptionID string) (string, error)

GetIPOfPublicIPAddressByNameE gets the Public IP of the Public IP Address specified.

func GetManagedClusterE added in v0.24.2 

func GetManagedClusterE(t testing.TestingT, resourceGroupName, clusterName, subscriptionID string) (*containerservice.ManagedCluster, error)

GetManagedClusterE will return ManagedCluster

func GetManagedClustersClientE added in v0.24.2 

func GetManagedClustersClientE(subscriptionID string) (*containerservice.ManagedClustersClient, error)

GetManagedClustersClientE is a helper function that will setup an Azure ManagedClusters client on your behalf

func GetNameFromResourceID added in v0.30.3 

func GetNameFromResourceID(resourceID string) string

GetNameFromResourceID gets the Name from an Azure Resource ID

func GetNetworkInterfaceClientE added in v0.30.6 

func GetNetworkInterfaceClientE(subscriptionID string) (*network.InterfacesClient, error)

GetNetworkInterfaceClientE creates a new Network Interface client in the specified Azure Subscription.

func GetNetworkInterfaceConfigurationClientE added in v0.30.6 

func GetNetworkInterfaceConfigurationClientE(subscriptionID string) (*network.InterfaceIPConfigurationsClient, error)

GetNetworkInterfaceConfigurationClientE creates a new Network Interface Configuration client in the specified Azure Subscription.

func GetNetworkInterfaceConfigurationE added in v0.30.6 

func GetNetworkInterfaceConfigurationE(nicName string, nicConfigName string, resGroupName string, subscriptionID string) (*network.InterfaceIPConfiguration, error)

GetNetworkInterfaceConfigurationE gets a Network Interface Configuration in the specified Azure Resource Group.

func GetNetworkInterfaceE added in v0.30.6 

func GetNetworkInterfaceE(nicName string, resGroupName string, subscriptionID string) (*network.Interface, error)

GetNetworkInterfaceE gets a Network Interface in the specified Azure Resource Group.

func GetNetworkInterfacePrivateIPs added in v0.30.6 

func GetNetworkInterfacePrivateIPs(t testing.TestingT, nicName string, resGroupName string, subscriptionID string) []string

GetNetworkInterfacePrivateIPs gets a list of the Private IPs of a Network Interface configs. This function would fail the test if there is an error.

func GetNetworkInterfacePrivateIPsE added in v0.30.6 

func GetNetworkInterfacePrivateIPsE(nicName string, resGroupName string, subscriptionID string) ([]string, error)

GetNetworkInterfacePrivateIPsE gets a list of the Private IPs of a Network Interface configs.

func GetNetworkInterfacePublicIPs added in v0.30.6 

func GetNetworkInterfacePublicIPs(t testing.TestingT, nicName string, resGroupName string, subscriptionID string) []string

GetNetworkInterfacePublicIPs returns a list of all the Public IPs found in the Network Interface configurations. This function would fail the test if there is an error.

func GetNetworkInterfacePublicIPsE added in v0.30.6 

func GetNetworkInterfacePublicIPsE(nicName string, resGroupName string, subscriptionID string) ([]string, error)

GetNetworkInterfacePublicIPsE returns a list of all the Public IPs found in the Network Interface configurations.

func GetPublicIPAddressClientE added in v0.30.6 

func GetPublicIPAddressClientE(subscriptionID string) (*network.PublicIPAddressesClient, error)

GetPublicIPAddressClientE creates a Public IP Addresses client in the specified Azure Subscription.

func GetPublicIPAddressE added in v0.30.6 

func GetPublicIPAddressE(publicIPAddressName string, resGroupName string, subscriptionID string) (*network.PublicIPAddress, error)

GetPublicIPAddressE gets a Public IP Addresses in the specified Azure Resource Group.

func GetRandomRegion 

func GetRandomRegion(t testing.TestingT, approvedRegions []string, forbiddenRegions []string, subscriptionID string) string

GetRandomRegion gets a randomly chosen Azure region. If approvedRegions is not empty, this will be a region from the approvedRegions list; otherwise, this method will fetch the latest list of regions from the Azure APIs and pick one of those. If forbiddenRegions is not empty, this method will make sure the returned region is not in the forbiddenRegions list.

func GetRandomRegionE 

func GetRandomRegionE(t testing.TestingT, approvedRegions []string, forbiddenRegions []string, subscriptionID string) (string, error)

GetRandomRegionE gets a randomly chosen Azure region. If approvedRegions is not empty, this will be a region from the approvedRegions list; otherwise, this method will fetch the latest list of regions from the Azure APIs and pick one of those. If forbiddenRegions is not empty, this method will make sure the returned region is not in the forbiddenRegions list

func GetRandomStableRegion 

func GetRandomStableRegion(t testing.TestingT, approvedRegions []string, forbiddenRegions []string, subscriptionID string) string

GetRandomStableRegion gets a randomly chosen Azure region that is considered stable. Like GetRandomRegion, you can further restrict the stable region list using approvedRegions and forbiddenRegions. We consider stable regions to be those that have been around for at least 1 year. Note that regions in the approvedRegions list that are not considered stable are ignored.

func GetSizeOfVirtualMachine 

func GetSizeOfVirtualMachine(t testing.TestingT, vmName string, resGroupName string, subscriptionID string) compute.VirtualMachineSizeTypes

GetSizeOfVirtualMachine gets the size type of the given Azure Virtual Machine. This function would fail the test if there is an error.

func GetSizeOfVirtualMachineE 

func GetSizeOfVirtualMachineE(t testing.TestingT, vmName string, resGroupName string, subscriptionID string) (compute.VirtualMachineSizeTypes, error)

GetSizeOfVirtualMachineE gets the size type of the given Azure Virtual Machine

func GetSubnetClientE added in v0.30.6 

func GetSubnetClientE(subscriptionID string) (*network.SubnetsClient, error)

GetSubnetClientE creates a subnet client.

func GetSubnetE added in v0.30.6 

func GetSubnetE(subnetName string, vnetName string, resGroupName string, subscriptionID string) (*network.Subnet, error)

GetSubnetE gets a subnet.

func GetSubscriptionClient 

func GetSubscriptionClient() (*subscriptions.Client, error)

GetSubscriptionClient is a helper function that will setup an Azure Subscription client on your behalf

func GetTagsForVirtualMachine 

func GetTagsForVirtualMachine(t testing.TestingT, vmName string, resGroupName string, subscriptionID string) map[string]string

GetTagsForVirtualMachine gets the tags of the given Virtual Machine as a map. This function would fail the test if there is an error.

func GetTagsForVirtualMachineE 

func GetTagsForVirtualMachineE(t testing.TestingT, vmName string, resGroupName string, subscriptionID string) (map[string]string, error)

GetTagsForVirtualMachineE gets the tags of the given Virtual Machine as a map

func GetTargetAzureResourceGroupName added in v0.29.1 

func GetTargetAzureResourceGroupName(resourceGroupName string) (string, error)

GetTargetAzureResourceGroupName is a helper function to find the correct target Azure Resource Group name, with provided arguments taking precedence over environment variables

func GetTargetAzureSubscription added in v0.29.1 

func GetTargetAzureSubscription(subscriptionID string) (string, error)

GetTargetAzureSubscription is a helper function to find the correct target Azure Subscription ID, with provided arguments taking precedence over environment variables

func GetVirtualMachineClientE added in v0.30.3 

func GetVirtualMachineClientE(subscriptionID string) (*compute.VirtualMachinesClient, error)

GetVirtualMachineClientE is a helper function that will setup an Azure Virtual Machine client on your behalf.

func GetVirtualNetworkDNSServerIPs added in v0.30.6 

func GetVirtualNetworkDNSServerIPs(t testing.TestingT, vnetName string, resGroupName string, subscriptionID string) []string

GetVirtualNetworkDNSServerIPs gets a list of all Virtual Network DNS server IPs. This function would fail the test if there is an error.

func GetVirtualNetworkDNSServerIPsE added in v0.30.6 

func GetVirtualNetworkDNSServerIPsE(vnetName string, resGroupName string, subscriptionID string) ([]string, error)

GetVirtualNetworkDNSServerIPsE gets a list of all Virtual Network DNS server IPs with Error.

func GetVirtualNetworkE added in v0.30.6 

func GetVirtualNetworkE(vnetName string, resGroupName string, subscriptionID string) (*network.VirtualNetwork, error)

GetVirtualNetworkE gets Virtual Network in the specified Azure Resource Group.

func GetVirtualNetworkSubnets added in v0.30.6 

func GetVirtualNetworkSubnets(t testing.TestingT, vnetName string, resGroupName string, subscriptionID string) map[string]string

GetVirtualNetworkSubnets gets all Subnet names and their respective address prefixes in the specified Virtual Network. This function would fail the test if there is an error.

func GetVirtualNetworkSubnetsE added in v0.30.6 

func GetVirtualNetworkSubnetsE(vnetName string, resGroupName string, subscriptionID string) (map[string]string, error)

GetVirtualNetworkSubnetsE gets all Subnet names and their respective address prefixes in the specified Virtual Network. Returning both the name and prefix together helps reduce calls for these frequently accessed properties.

func GetVirtualNetworksClientE added in v0.30.6 

func GetVirtualNetworksClientE(subscriptionID string) (*network.VirtualNetworksClient, error)

GetVirtualNetworksClientE creates a virtual network client in the specified Azure Subscription.

func NetworkInterfaceExists added in v0.30.6 

func NetworkInterfaceExists(t testing.TestingT, nicName string, resGroupName string, subscriptionID string) bool

NetworkInterfaceExists indicates whether the specified Azure Network Interface exists. This function would fail the test if there is an error.

func NetworkInterfaceExistsE added in v0.30.6 

func NetworkInterfaceExistsE(nicName string, resGroupName string, subscriptionID string) (bool, error)

NetworkInterfaceExistsE indicates whether the specified Azure Network Interface exists.

func NewAuthorizer 

func NewAuthorizer() (*autorest.Authorizer, error)

NewAuthorizer creates an Azure authorizer adhering to standard auth mechanisms provided by the Azure Go SDK See Azure Go Auth docs here: https://docs.microsoft.com/en-us/go/azure/azure-sdk-go-authorization

func PublicAddressExists added in v0.30.6 

func PublicAddressExists(t testing.TestingT, publicAddressName string, resGroupName string, subscriptionID string) bool

PublicAddressExists indicates whether the specified AzurePublic Address exists. This function would fail the test if there is an error.

func PublicAddressExistsE added in v0.30.6 

func PublicAddressExistsE(publicAddressName string, resGroupName string, subscriptionID string) (bool, error)

PublicAddressExistsE indicates whether the specified AzurePublic Address exists.

func ResourceNotFoundErrorExists added in v0.30.6 

func ResourceNotFoundErrorExists(err error) bool

ResourceNotFoundErrorExists checks the Service Error Code for the 'Resource Not Found' error

func SubnetExists added in v0.30.6 

func SubnetExists(t testing.TestingT, subnetName string, vnetName string, resGroupName string, subscriptionID string) bool

SubnetExists indicates whether the specified Azure Virtual Network Subnet exists. This function would fail the test if there is an error.

func SubnetExistsE added in v0.30.6 

func SubnetExistsE(subnetName string, vnetName string, resGroupName string, subscriptionID string) (bool, error)

SubnetExistsE indicates whether the specified Azure Virtual Network Subnet exists.

func VirtualNetworkExists added in v0.30.6 

func VirtualNetworkExists(t testing.TestingT, vnetName string, resGroupName string, subscriptionID string) bool

VirtualNetworkExists indicates whether the specified Azure Virtual Network exists. This function would fail the test if there is an error.

func VirtualNetworkExistsE added in v0.30.6 

func VirtualNetworkExistsE(vnetName string, resGroupName string, subscriptionID string) (bool, error)

VirtualNetworkExistsE indicates whether the specified Azure Virtual Network exists.

Types

type FailedToParseError added in v0.30.6 

type FailedToParseError struct {
	// contains filtered or unexported fields
}

FailedToParseError is returned when an object cannot be parsed

func NewFailedToParseError added in v0.30.6 

func NewFailedToParseError(objectType string, objectID string) FailedToParseError

NewFailedToParseError creates a new not found error when an expected object is not found in the search space

func (FailedToParseError) Error added in v0.30.6 

func (err FailedToParseError) Error() string

type NotFoundError added in v0.30.3 

type NotFoundError struct {
	// contains filtered or unexported fields
}

NotFoundError is returned when an expected object is not found in the search spa

func NewNotFoundError added in v0.30.3 

func NewNotFoundError(objectType string, objectID string, region string) NotFoundError

NewNotFoundError creates a new not found error when an expected object is not found in the search space

func (NotFoundError) Error added in v0.30.3 

func (err NotFoundError) Error() string

type NsgRuleSummary added in v0.30.4 

type NsgRuleSummary struct {
	Name                     string
	Description              string
	Protocol                 string
	SourcePortRange          string
	DestinationPortRange     string
	SourceAddressPrefix      string
	DestinationAddressPrefix string
	Access                   string
	Priority                 int32
	Direction                string
}

NsgRuleSummary is a string-based (non-pointer) summary of an NSG rule with several helper methods attached to help with verification of rule configuratoin.

func (*NsgRuleSummary) AllowsDestinationPort added in v0.30.4 

func (summarizedRule *NsgRuleSummary) AllowsDestinationPort(t *testing.T, port string) bool

AllowsDestinationPort checks to see if the rule allows a specific destination port. This is helpful when verifying that a given rule is configured properly for a given port.

func (*NsgRuleSummary) AllowsSourcePort added in v0.30.4 

func (summarizedRule *NsgRuleSummary) AllowsSourcePort(t *testing.T, port string) bool

AllowsSourcePort checks to see if the rule allows a specific source port. This is helpful when verifying that a given rule is configured properly for a given port.

type NsgRuleSummaryList added in v0.30.4 

type NsgRuleSummaryList struct {
	SummarizedRules []NsgRuleSummary
}

NsgRuleSummaryList holds a colleciton of NsgRuleSummary rules

func GetAllNSGRules added in v0.30.4 

func GetAllNSGRules(t *testing.T, resourceGroupName, nsgName, subscriptionID string) NsgRuleSummaryList

GetAllNSGRules returns an NsgRuleSummaryList instance containing the combined "default" and "custom" rules from a network security group. This function would fail the test if there is an error.

func GetAllNSGRulesE added in v0.30.4 

func GetAllNSGRulesE(resourceGroupName, nsgName, subscriptionID string) (NsgRuleSummaryList, error)

GetAllNSGRulesE returns an NsgRuleSummaryList instance containing the combined "default" and "custom" rules from a network security group.

func (*NsgRuleSummaryList) FindRuleByName added in v0.30.4 

func (summarizedRules *NsgRuleSummaryList) FindRuleByName(name string) NsgRuleSummary

FindRuleByName looks for a matching rule by name within the current collection of rules.

type ResourceGroupNameNotFound 

type ResourceGroupNameNotFound struct{}

ResourceGroupNameNotFound is an error that occurs when the target Azure Resource Group name could not be found or was not provided

func (ResourceGroupNameNotFound) Error 

func (err ResourceGroupNameNotFound) Error() string

type SubscriptionIDNotFound 

type SubscriptionIDNotFound struct{}

SubscriptionIDNotFound is an error that occurs when the Azure Subscription ID could not be found or was not provided

func (SubscriptionIDNotFound) Error 

func (err SubscriptionIDNotFound) Error() string

Source Files

View all Source files

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.