ansible.builtin.azure_rm_subnet_info (v2.9.17) — module

Get Azure Subnet facts

| "added in version" 2.8 of ansible.builtin"

Authors: Zim Kalinowski (@zikalino)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.9.17

Description

Get facts of Azure Subnet.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  - name: Get facts of specific subnet
    azure_rm_subnet_info:
      resource_group: myResourceGroup
      virtual_network_name: myVirtualNetwork
      name: mySubnet
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  - name: List facts for all subnets in virtual network
    azure_rm_subnet_info:
      resource_group: myResourceGroup
      virtual_network_name: myVirtualNetwork
      name: mySubnet

Inputs

    
name:
    description:
    - The name of the subnet.

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

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.
    type: str

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

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

resource_group:
    description:
    - The name of the resource group.
    required: true

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

virtual_network_name:
    description:
    - The name of the virtual network.
    required: true

Outputs

subnets:
  contains:
    address_prefix_cidr:
      description:
      - CIDR defining the IPv4 address space of the subnet.
      returned: always
      sample: 10.1.0.0/16
      type: str
    id:
      description:
      - Subnet resource ID.
      returned: always
      sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/my
        VirtualNetwork/subnets/mySubnet
      type: str
    name:
      description:
      - Name of the subnet.
      returned: always
      sample: mySubnet
      type: str
    provisioning_state:
      description:
      - Provisioning state.
      returned: always
      sample: Succeeded
      type: str
    resource_group:
      description:
      - Name of resource group.
      returned: always
      sample: myResourceGroup
      type: str
    route_table:
      description:
      - Associated route table ID.
      returned: always
      sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/routeTables/myRouteTable
      type: str
    security_group:
      description:
      - Associated security group ID.
      returned: always
      sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkSecurityGr
        oups/myNsg
      type: str
    service_endpoints:
      contains:
        locations:
          description:
          - A list of location names.
          returned: always
          sample:
          - eastus
          - westus
          type: list
        provisioning_state:
          description:
          - Provisioning state.
          returned: always
          sample: Succeeded
          type: str
        service:
          description:
          - The type of the endpoint service.
          returned: always
          sample: Microsoft.Sql
          type: str
      description:
      - List of service endpoints.
      returned: when available
      type: list
    virtual_network_name:
      description:
      - Name of the containing virtual network.
      returned: always
      sample: myVirtualNetwork
      type: str
  description:
  - A list of dictionaries containing facts for subnet.
  returned: always
  type: complex

See also