[ aws . observabilityadmin ]

list-resources-by-connector

Description

Lists resources in your cloud provider that the connector can access, such as management groups, subscriptions, resource types, Regions, resources, and Event Hubs. Use the results to build a telemetry manifest. This operation returns results in pages. To get the next page, pass the returned NextToken in the next call. We recommend that you use pagination to ensure that the operation returns quickly and successfully.

See also: AWS API Documentation

Synopsis

  list-resources-by-connector
--connector-identifier <value>
--selector <value>
[--max-results <value>]
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]
[--help]

Options

--connector-identifier (string) [required]

The connector to use for the query. Specify one of the following:

  • The Amazon Resource Name (ARN) of the connector
  • The ID of the connector

Constraints:

  • min: 1
  • max: 1011
  • pattern: ([a-z0-9]+|arn:aws[a-z0-9\-]*:observabilityadmin:[a-z0-9-]+:[0-9]{12}:connector/(azure/)?[a-z0-9]+)

--selector (tagged union structure) [required]

What to list: one cloud provider, and one type of resource in that provider.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: Azure.

Azure -> (tagged union structure)

The type of Azure resource to list.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: ManagementGroups, Subscriptions, ResourceTypes, Regions, ResourceIds, EventHubs.

ManagementGroups -> (structure)

Lists Azure management groups.

ParentManagementGroupId -> (string)

Lists the management groups under this management group. If you omit this value, the query starts at the tenant root group.

Constraints:

  • min: 1
  • max: 90
  • pattern: [-\w._()]+

Subscriptions -> (structure)

Lists Azure subscriptions.

ManagementGroupId -> (string)

Limits the results to subscriptions under this management group.

Constraints:

  • min: 1
  • max: 90
  • pattern: [-\w._()]+

ResourceTypes -> (structure)

Lists the Azure resource types that have resources in scope.

Scope -> (structure)

Limits the query to a management group or to specific subscriptions.

ManagementGroupId -> (string)

Limits the query to resources under this management group.

Constraints:

  • min: 1
  • max: 90
  • pattern: [-\w._()]+

SubscriptionIds -> (list)

Limits the query to these subscriptions. You can specify 1–1000 subscriptions.

Constraints:

  • min: 1
  • max: 1000

(string)

Constraints:

  • min: 36
  • max: 36
  • pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}

Regions -> (structure)

Lists the Azure Regions that have resources in scope.

Scope -> (structure)

Limits the query to a management group or to specific subscriptions.

ManagementGroupId -> (string)

Limits the query to resources under this management group.

Constraints:

  • min: 1
  • max: 90
  • pattern: [-\w._()]+

SubscriptionIds -> (list)

Limits the query to these subscriptions. You can specify 1–1000 subscriptions.

Constraints:

  • min: 1
  • max: 1000

(string)

Constraints:

  • min: 36
  • max: 36
  • pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}

ResourceIds -> (structure)

Lists Azure resources.

Scope -> (structure)

Limits the query to a management group or to specific subscriptions.

ManagementGroupId -> (string)

Limits the query to resources under this management group.

Constraints:

  • min: 1
  • max: 90
  • pattern: [-\w._()]+

SubscriptionIds -> (list)

Limits the query to these subscriptions. You can specify 1–1000 subscriptions.

Constraints:

  • min: 1
  • max: 1000

(string)

Constraints:

  • min: 36
  • max: 36
  • pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}

ResourceType -> (string)

Limits the results to one Azure resource type, for example Microsoft.Compute/virtualMachines .

Constraints:

  • min: 1
  • max: 256
  • pattern: [A-Za-z0-9]+\.[A-Za-z0-9]+/[A-Za-z0-9/]+

Region -> (string)

Limits the results to one Azure Region, for example eastus .

Constraints:

  • min: 1
  • max: 64
  • pattern: [a-z0-9]+

TagFilters -> (list)

Limits the results to resources that have these tags. A resource must match the filters for all tag keys, and any of the values for each key. The service matches tag keys and values case-insensitively, as Azure does.

Constraints:

  • min: 1
  • max: 50

(structure)

A tag filter. A resource matches only if it has the tag. Filters for different tag keys must all match; for one tag key, any of the values can match.

Key -> (string) [required]

The tag key. Up to 512 characters. The characters < > % & ? / $ { } ‘ “ ` and control characters aren’t allowed.

Constraints:

  • min: 1
  • max: 512
  • pattern: [^<>%&\\?/${}'"`\u0000-\u001F\u007F]+

Values -> (list) [required]

The tag values to match. A resource matches if it has any of these values for the tag key.

Constraints:

  • min: 1
  • max: 50

(string)

Constraints:

  • min: 0
  • max: 256
  • pattern: [^${}'"`\\<>\u0000-\u001F\u007F]*

EventHubs -> (structure)

Lists Azure Event Hubs.

Scope -> (structure)

Limits the query to a management group or to specific subscriptions.

ManagementGroupId -> (string)

Limits the query to resources under this management group.

Constraints:

  • min: 1
  • max: 90
  • pattern: [-\w._()]+

SubscriptionIds -> (list)

Limits the query to these subscriptions. You can specify 1–1000 subscriptions.

Constraints:

  • min: 1
  • max: 1000

(string)

Constraints:

  • min: 36
  • max: 36
  • pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}

NamespaceName -> (string)

Limits the results to Event Hubs in this namespace.

Constraints:

  • min: 6
  • max: 50
  • pattern: [A-Za-z][A-Za-z0-9-]{4,48}[A-Za-z0-9]

Region -> (string)

Limits the results to one Azure Region, for example eastus .

Constraints:

  • min: 1
  • max: 64
  • pattern: [a-z0-9]+

JSON Syntax:

{
  "Azure": {
    "ManagementGroups": {
      "ParentManagementGroupId": "string"
    },
    "Subscriptions": {
      "ManagementGroupId": "string"
    },
    "ResourceTypes": {
      "Scope": {
        "ManagementGroupId": "string",
        "SubscriptionIds": ["string", ...]
      }
    },
    "Regions": {
      "Scope": {
        "ManagementGroupId": "string",
        "SubscriptionIds": ["string", ...]
      }
    },
    "ResourceIds": {
      "Scope": {
        "ManagementGroupId": "string",
        "SubscriptionIds": ["string", ...]
      },
      "ResourceType": "string",
      "Region": "string",
      "TagFilters": [
        {
          "Key": "string",
          "Values": ["string", ...]
        }
        ...
      ]
    },
    "EventHubs": {
      "Scope": {
        "ManagementGroupId": "string",
        "SubscriptionIds": ["string", ...]
      },
      "NamespaceName": "string",
      "Region": "string"
    }
  }
}

--max-results (integer)

The maximum number of results to return in one call. For an EventHubs query, a page can contain more results than this value.

Constraints:

  • min: 1
  • max: 1000

--next-token (string)

The token for the next page of results, returned by a previous call.

Constraints:

  • min: 1
  • max: 8192
  • pattern: [A-Za-z0-9+/=_-]+

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream
  • off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

--help (boolean)

Display help for the command/subcommand.

Output

Results -> (tagged union structure)

The results, in the same shape as the Selector that you specified.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: Azure.

Azure -> (tagged union structure)

The results of an Azure discovery query.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: ManagementGroups, Subscriptions, ResourceTypes, Regions, ResourceIds, EventHubs.

ManagementGroups -> (list)

The Azure management groups.

(structure)

Information about an Azure management group.

Id -> (string) [required]

The ID of the management group.

Constraints:

  • min: 1
  • max: 90
  • pattern: [-\w._()]+

Name -> (string)

The name of the management group.

DisplayName -> (string)

The display name of the management group.

Subscriptions -> (list)

The Azure subscriptions.

(structure)

Information about an Azure subscription.

SubscriptionId -> (string) [required]

The ID of the subscription.

Constraints:

  • min: 36
  • max: 36
  • pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}

DisplayName -> (string)

The display name of the subscription.

State -> (string)

The state of the subscription in Azure, for example Enabled .

ManagementGroupId -> (string)

The ID of the management group that contains the subscription.

Constraints:

  • min: 1
  • max: 90
  • pattern: [-\w._()]+

ResourceTypes -> (list)

The Azure resource types.

(string)

Constraints:

  • min: 1
  • max: 256
  • pattern: [A-Za-z0-9]+\.[A-Za-z0-9]+/[A-Za-z0-9/]+

Regions -> (list)

The Azure Regions.

(string)

Constraints:

  • min: 1
  • max: 64
  • pattern: [a-z0-9]+

ResourceIds -> (list)

The Azure resources.

(structure)

Information about an Azure resource.

ResourceId -> (string) [required]

The Azure Resource Manager ID of the resource.

Constraints:

  • min: 1
  • max: 1024

ResourceType -> (string)

The Azure resource type, for example Microsoft.Compute/virtualMachines .

Constraints:

  • min: 1
  • max: 256
  • pattern: [A-Za-z0-9]+\.[A-Za-z0-9]+/[A-Za-z0-9/]+

Region -> (string)

The Azure Region of the resource, for example eastus .

Constraints:

  • min: 1
  • max: 64
  • pattern: [a-z0-9]+

SubscriptionId -> (string)

The Azure subscription that contains the resource.

Constraints:

  • min: 36
  • max: 36
  • pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}

Tags -> (map)

The tags on the resource. Absent if the resource has no tags.

Constraints:

  • min: 0
  • max: 50

key -> (string)

Constraints:

  • min: 1
  • max: 512

value -> (string)

Constraints:

  • min: 0
  • max: 256

EventHubs -> (list)

The Azure Event Hubs.

(structure)

Information about an Azure Event Hub.

ResourceId -> (string) [required]

The Azure Resource Manager ID of the Event Hub.

Constraints:

  • min: 1
  • max: 1024

EventHubName -> (string) [required]

The name of the Event Hub.

NamespaceName -> (string) [required]

The name of the Event Hubs namespace that contains the Event Hub.

Constraints:

  • min: 6
  • max: 50
  • pattern: [A-Za-z][A-Za-z0-9-]{4,48}[A-Za-z0-9]

FullyQualifiedNamespace -> (string) [required]

The fully qualified host name of the Event Hubs namespace, for example <namespace>.servicebus.windows.net . The suffix differs in sovereign clouds.

Region -> (string)

The Azure Region of the Event Hub, for example eastus .

Constraints:

  • min: 1
  • max: 64
  • pattern: [a-z0-9]+

SubscriptionId -> (string)

The Azure subscription that contains the Event Hub.

Constraints:

  • min: 36
  • max: 36
  • pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}

NextToken -> (string)

The token to use in the next call to get the next page of results. Absent when there are no more results.

Constraints:

  • min: 1
  • max: 8192
  • pattern: [A-Za-z0-9+/=_-]+