Skip to content

Latest commit

 

History

History
63 lines (47 loc) · 3.42 KB

account_availability_list.md

File metadata and controls

63 lines (47 loc) · 3.42 KB

account_availability_list

List and filter on Account Availabilities.

WARNING! This module makes use of beta endpoints and requires the C(api_version) field be explicitly set to C(v4beta).

Minimum Required Fields

Field Type Required Description
api_token str Required The Linode account personal access token. It is necessary to run the module.
It can be exposed by the environment variable LINODE_API_TOKEN instead.
See details in Usage.

Examples

- name: List all of the region resource availabilities to the account
  linode.cloud.account_availability_list:
    api_version: v4beta

Parameters

Field Type Required Description
order str Optional The order to list Account Availabilities in. (Choices: desc, asc; Default: asc)
order_by str Optional The attribute to order Account Availabilities by.
filters (sub-options) list Optional A list of filters to apply to the resulting Account Availabilities.
count int Optional The number of Account Availabilities to return. If undefined, all results will be returned.

filters

Field Type Required Description
name str Required The name of the field to filter on. Valid filterable fields can be found here.
values list Required A list of values to allow for this field. Fields will pass this filter if at least one of these values matches.

Return Values

  • account_availabilities - The returned Account Availabilities.

    • Sample Response:
      [
          {
            "region": "ap-west",
            "available": ["NodeBalancers", "Block Storage", "Kubernetes"],
            "unavailable": ["Linode"]
          },
          {
            "region": "ca-central",
            "available": ["NodeBalancers", "Kubernetes"],
            "unavailable": ["Linode", "Block Storage"]
          }
      ]
    • See the Linode API response documentation for a list of returned fields