Try SpotterManage Express Route Circuits
| "added in version" 1.7.0 of azure.azcollection"
Authors: Praveen Ghuge (@praveenghuge), Karl Dasan (@ikarldasan), Sakar Mehra (@sakar97)
Install with ansible-galaxy collection install azure.azcollection:==2.3.0
collections:
- name: azure.azcollection
version: 2.3.0Create, update and delete instance of Express Route.
- name: "Create Express route"
azure_rm_expressroute:
resource_group: rg
location: eastus
name: exp
allow_classic_operations: true
global_reach_enabled: false
tags:
- a: b
authorizations:
- name: authorization_test
service_provider_properties:
service_provider_name: Aryaka Networks
peering_location: Seattle
bandwidth_in_mbps: '200'
sku:
tier: premium
family: metereddata
- name: Delete Express route
azure_rm_expressroute:
resource_group: rg
name: exp
state: absent
sku:
description:
- The name of the SKU.
- Please see L(https://azure.microsoft.com/en-in/pricing/details/expressroute/,)
- Required sku when I(state=present).
suboptions:
family:
choices:
- metereddata
- unlimiteddata
description:
- the family of the SKU
required: true
type: str
tier:
choices:
- standard
- premium
description:
- The tier of the SKU
required: true
type: str
type: dict
name:
description:
- Unique name of the app service plan to create or update.
required: true
type: str
tags:
description:
- Dictionary of string:string pairs to assign as metadata to the object.
- Metadata tags on the object will be updated with any provided values.
- To remove tags set append_tags option to false.
- Currently, Azure DNS zones and Traffic Manager services also don't allow the use
of spaces in the tag.
- Azure Front Door doesn't support the use of
- Azure Automation and Azure CDN only support 15 tags on resources.
type: dict
state:
choices:
- absent
- present
default: present
description:
- Assert the state of the express route.
- Use C(present) to create or update an express route and C(absent) to delete it.
type: str
secret:
description:
- Azure client secret. Use when authenticating with a Service Principal.
type: str
tenant:
description:
- Azure tenant ID. Use when authenticating with a Service Principal.
type: str
ad_user:
description:
- Active Directory username. Use when authenticating with an Active Directory user
rather than service principal.
type: str
profile:
description:
- Security profile found in ~/.azure/credentials file.
type: str
location:
description:
- Resource location. If not set, location from the resource group will be used as
default.
type: str
log_mode:
description:
- Parent argument.
type: str
log_path:
description:
- Parent argument.
type: str
password:
description:
- Active Directory user password. Use when authenticating with an Active Directory
user rather than service principal.
type: str
client_id:
description:
- Azure client ID. Use when authenticating with a Service Principal or Managed Identity
(msi).
- Can also be set via the C(AZURE_CLIENT_ID) environment variable.
type: str
thumbprint:
description:
- The thumbprint of the private key specified in I(x509_certificate_path).
- Use when authenticating with a Service Principal.
- Required if I(x509_certificate_path) is defined.
type: str
version_added: 1.14.0
version_added_collection: azure.azcollection
api_profile:
default: latest
description:
- Selects an API profile to use when communicating with Azure services. Default value
of C(latest) is appropriate for public clouds; future values will allow use with
Azure Stack.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
append_tags:
default: true
description:
- Use to control if tags field is canonical or just appends to existing tags.
- When canonical, any tags not found in the tags parameter will be removed from the
object's metadata.
type: bool
auth_source:
choices:
- auto
- cli
- credential_file
- env
- msi
default: auto
description:
- Controls the source of the credentials to use for authentication.
- Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable.
- When set to C(auto) (the default) the precedence is module parameters -> C(env)
-> C(credential_file) -> C(cli).
- When set to C(env), the credentials will be read from the environment variables
- When set to C(credential_file), it will read the profile from C(~/.azure/credentials).
- When set to C(cli), the credentials will be sources from the Azure CLI profile.
C(subscription_id) or the environment variable C(AZURE_SUBSCRIPTION_ID) can be used
to identify the subscription ID if more than one is present otherwise the default
az cli subscription is used.
- When set to C(msi), the host machine must be an azure resource with an enabled MSI
extension. C(subscription_id) or the environment variable C(AZURE_SUBSCRIPTION_ID)
can be used to identify the subscription ID if the resource is granted access to
more than one subscription, otherwise the first subscription is chosen.
- The C(msi) was added in Ansible 2.6.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
authorizations:
description:
- The list of authorizations.
elements: dict
suboptions:
name:
description: Name of the authorization.
required: true
type: str
type: list
resource_group:
description:
- Name of the resource group to which the resource belongs.
required: true
type: str
subscription_id:
description:
- Your Azure subscription Id.
type: str
cloud_environment:
default: AzureCloud
description:
- For cloud environments other than the US public cloud, the environment name (as
defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a
metadata discovery endpoint URL (required for Azure Stack). Can also be set via
credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
adfs_authority_url:
description:
- Azure AD authority url. Use when authenticating with Username/password, and has
your own ADFS authority.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
cert_validation_mode:
choices:
- ignore
- validate
description:
- Controls the certificate validation behavior for Azure endpoints. By default, all
modules will validate the server certificate, but when an HTTPS proxy is in use,
or against Azure Stack, it may be necessary to disable this behavior by passing
C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION)
environment variable.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
global_reach_enabled:
description:
- Flag denoting global reach status.
type: bool
x509_certificate_path:
description:
- Path to the X509 certificate used to create the service principal in PEM format.
- The certificate must be appended to the private key.
- Use when authenticating with a Service Principal.
type: path
version_added: 1.14.0
version_added_collection: azure.azcollection
allow_classic_operations:
description:
- Support for classic operations.
type: bool
disable_instance_discovery:
default: false
description:
- Determines whether or not instance discovery is performed when attempting to authenticate.
Setting this to true will completely disable both instance discovery and authority
validation. This functionality is intended for use in scenarios where the metadata
endpoint cannot be reached such as in private clouds or Azure Stack. The process
of instance discovery entails retrieving authority metadata from https://login.microsoft.com/
to validate the authority. By setting this to **True**, the validation of the authority
is disabled. As a result, it is crucial to ensure that the configured authority
host is valid and trustworthy.
- Set via credential file profile or the C(AZURE_DISABLE_INSTANCE_DISCOVERY) environment
variable.
type: bool
version_added: 2.3.0
version_added_collection: azure.azcollection
service_provider_properties:
description:
- The service Provider properties
suboptions:
bandwidth_in_mbps:
description:
- The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort
resource.
type: str
peering_location:
description:
- The peering location
type: str
service_provider_name:
description:
- Name of service provider
type: str
type: dict
state:
description:
- Current state of the express route.
returned: always
sample:
additional_properties: {}
allow_classic_operations: true
authorizations:
- authorization_key: d83e18b5-0200-4e0b-9cdb-6fdf95b00267
authorization_use_status: Available
etag: W/'09572845-c667-410c-b664-ed8e39242c13'
id: /subscriptions/subs_id/resourceGroups/rg/providers/Microsoft.Network/expressRouteCircuits/exp/authorizations/az
name: authorization_test
provisioning_state: Succeeded
type: Microsoft.Network/expressRouteCircuits/authorizations
bandwidth_in_gbps: null
circuit_provisioning_state: Enabled
express_route_port: null
gateway_manager_etag: ''
global_reach_enabled: false
id: /subscriptions/subs_id/resourceGroups/rg/providers/Microsoft.Network/expressRouteCircuits/exp
location: eastus
name: exp
peerings: []
provisioning_state: Succeeded
service_key: e1956383-63b6-4709-8baa-3615bbf5d22b
service_provider_notes: null
service_provider_provisioning_state: NotProvisioned
stag: 27
status: Deleted
tags:
a: b
type: Microsoft.Network/expressRouteCircuits
type: dict