@pulumi/meraki
Version:
A Pulumi package for creating and managing Cisco Meraki resources. Based on terraform-provider-meraki: version v0.2.0
117 lines (116 loc) • 5 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.organizations.getSmAdminsRoles({
* endingBefore: "string",
* organizationId: "string",
* perPage: 1,
* startingAfter: "string",
* });
* export const merakiOrganizationsSmAdminsRolesExample = example.then(example => example.item);
* ```
*/
export declare function getSmAdminsRoles(args?: GetSmAdminsRolesArgs, opts?: pulumi.InvokeOptions): Promise<GetSmAdminsRolesResult>;
/**
* A collection of arguments for invoking getSmAdminsRoles.
*/
export interface GetSmAdminsRolesArgs {
/**
* endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
*/
endingBefore?: string;
/**
* organizationId path parameter. Organization ID
*/
organizationId?: string;
/**
* perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 50.
*/
perPage?: number;
/**
* roleId path parameter. Role ID
*/
roleId?: string;
/**
* startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
*/
startingAfter?: string;
}
/**
* A collection of values returned by getSmAdminsRoles.
*/
export interface GetSmAdminsRolesResult {
/**
* endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
*/
readonly endingBefore?: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
readonly item: outputs.organizations.GetSmAdminsRolesItem;
/**
* organizationId path parameter. Organization ID
*/
readonly organizationId?: string;
/**
* perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 50.
*/
readonly perPage?: number;
/**
* roleId path parameter. Role ID
*/
readonly roleId?: string;
/**
* startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
*/
readonly startingAfter?: string;
}
/**
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as meraki from "@pulumi/meraki";
*
* const example = meraki.organizations.getSmAdminsRoles({
* endingBefore: "string",
* organizationId: "string",
* perPage: 1,
* startingAfter: "string",
* });
* export const merakiOrganizationsSmAdminsRolesExample = example.then(example => example.item);
* ```
*/
export declare function getSmAdminsRolesOutput(args?: GetSmAdminsRolesOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetSmAdminsRolesResult>;
/**
* A collection of arguments for invoking getSmAdminsRoles.
*/
export interface GetSmAdminsRolesOutputArgs {
/**
* endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
*/
endingBefore?: pulumi.Input<string>;
/**
* organizationId path parameter. Organization ID
*/
organizationId?: pulumi.Input<string>;
/**
* perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 50.
*/
perPage?: pulumi.Input<number>;
/**
* roleId path parameter. Role ID
*/
roleId?: pulumi.Input<string>;
/**
* startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
*/
startingAfter?: pulumi.Input<string>;
}