@pulumi/meraki
Version:
A Pulumi package for creating and managing Cisco Meraki resources. Based on terraform-provider-meraki: version v0.2.0
105 lines (104 loc) • 3.58 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as meraki from "@pulumi/meraki";
*
* const example = meraki.networks.getBluetoothClients({
* bluetoothClientId: "string",
* connectivityHistoryTimespan: 1,
* includeConnectivityHistory: false,
* networkId: "string",
* });
* export const merakiNetworksBluetoothClientsExample = example.then(example => example.item);
* ```
*/
export declare function getBluetoothClients(args: GetBluetoothClientsArgs, opts?: pulumi.InvokeOptions): Promise<GetBluetoothClientsResult>;
/**
* A collection of arguments for invoking getBluetoothClients.
*/
export interface GetBluetoothClientsArgs {
/**
* bluetoothClientId path parameter. Bluetooth client ID
*/
bluetoothClientId: string;
/**
* connectivityHistoryTimespan query parameter. The timespan, in seconds, for the connectivityHistory data. By default 1 day, 86400, will be used.
*/
connectivityHistoryTimespan?: number;
/**
* includeConnectivityHistory query parameter. Include the connectivity history for this client
*/
includeConnectivityHistory?: boolean;
/**
* networkId path parameter. Network ID
*/
networkId: string;
}
/**
* A collection of values returned by getBluetoothClients.
*/
export interface GetBluetoothClientsResult {
/**
* bluetoothClientId path parameter. Bluetooth client ID
*/
readonly bluetoothClientId: string;
/**
* connectivityHistoryTimespan query parameter. The timespan, in seconds, for the connectivityHistory data. By default 1 day, 86400, will be used.
*/
readonly connectivityHistoryTimespan?: number;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
/**
* includeConnectivityHistory query parameter. Include the connectivity history for this client
*/
readonly includeConnectivityHistory?: boolean;
readonly item: outputs.networks.GetBluetoothClientsItem;
/**
* networkId path parameter. Network ID
*/
readonly networkId: string;
}
/**
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as meraki from "@pulumi/meraki";
*
* const example = meraki.networks.getBluetoothClients({
* bluetoothClientId: "string",
* connectivityHistoryTimespan: 1,
* includeConnectivityHistory: false,
* networkId: "string",
* });
* export const merakiNetworksBluetoothClientsExample = example.then(example => example.item);
* ```
*/
export declare function getBluetoothClientsOutput(args: GetBluetoothClientsOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetBluetoothClientsResult>;
/**
* A collection of arguments for invoking getBluetoothClients.
*/
export interface GetBluetoothClientsOutputArgs {
/**
* bluetoothClientId path parameter. Bluetooth client ID
*/
bluetoothClientId: pulumi.Input<string>;
/**
* connectivityHistoryTimespan query parameter. The timespan, in seconds, for the connectivityHistory data. By default 1 day, 86400, will be used.
*/
connectivityHistoryTimespan?: pulumi.Input<number>;
/**
* includeConnectivityHistory query parameter. Include the connectivity history for this client
*/
includeConnectivityHistory?: pulumi.Input<boolean>;
/**
* networkId path parameter. Network ID
*/
networkId: pulumi.Input<string>;
}