Cisco Meraki v0.2.4 published on Friday, Jun 14, 2024 by Pulumi
meraki.organizations.getSmAdminsRoles
Explore with Pulumi AI
Example Usage
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);
import pulumi
import pulumi_meraki as meraki
example = meraki.organizations.get_sm_admins_roles(ending_before="string",
organization_id="string",
per_page=1,
starting_after="string")
pulumi.export("merakiOrganizationsSmAdminsRolesExample", example.item)
package main
import (
"github.com/pulumi/pulumi-meraki/sdk/go/meraki/organizations"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := organizations.LookupSmAdminsRoles(ctx, &organizations.LookupSmAdminsRolesArgs{
EndingBefore: pulumi.StringRef("string"),
OrganizationId: pulumi.StringRef("string"),
PerPage: pulumi.IntRef(1),
StartingAfter: pulumi.StringRef("string"),
}, nil)
if err != nil {
return err
}
ctx.Export("merakiOrganizationsSmAdminsRolesExample", example.Item)
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Meraki = Pulumi.Meraki;
return await Deployment.RunAsync(() =>
{
var example = Meraki.Organizations.GetSmAdminsRoles.Invoke(new()
{
EndingBefore = "string",
OrganizationId = "string",
PerPage = 1,
StartingAfter = "string",
});
return new Dictionary<string, object?>
{
["merakiOrganizationsSmAdminsRolesExample"] = example.Apply(getSmAdminsRolesResult => getSmAdminsRolesResult.Item),
};
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.meraki.organizations.OrganizationsFunctions;
import com.pulumi.meraki.organizations.inputs.GetSmAdminsRolesArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var example = OrganizationsFunctions.getSmAdminsRoles(GetSmAdminsRolesArgs.builder()
.endingBefore("string")
.organizationId("string")
.perPage(1)
.startingAfter("string")
.build());
ctx.export("merakiOrganizationsSmAdminsRolesExample", example.applyValue(getSmAdminsRolesResult -> getSmAdminsRolesResult.item()));
}
}
variables:
example:
fn::invoke:
Function: meraki:organizations:getSmAdminsRoles
Arguments:
endingBefore: string
organizationId: string
perPage: 1
startingAfter: string
outputs:
merakiOrganizationsSmAdminsRolesExample: ${example.item}
Using getSmAdminsRoles
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getSmAdminsRoles(args: GetSmAdminsRolesArgs, opts?: InvokeOptions): Promise<GetSmAdminsRolesResult>
function getSmAdminsRolesOutput(args: GetSmAdminsRolesOutputArgs, opts?: InvokeOptions): Output<GetSmAdminsRolesResult>
def get_sm_admins_roles(ending_before: Optional[str] = None,
organization_id: Optional[str] = None,
per_page: Optional[int] = None,
role_id: Optional[str] = None,
starting_after: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetSmAdminsRolesResult
def get_sm_admins_roles_output(ending_before: Optional[pulumi.Input[str]] = None,
organization_id: Optional[pulumi.Input[str]] = None,
per_page: Optional[pulumi.Input[int]] = None,
role_id: Optional[pulumi.Input[str]] = None,
starting_after: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetSmAdminsRolesResult]
func LookupSmAdminsRoles(ctx *Context, args *LookupSmAdminsRolesArgs, opts ...InvokeOption) (*LookupSmAdminsRolesResult, error)
func LookupSmAdminsRolesOutput(ctx *Context, args *LookupSmAdminsRolesOutputArgs, opts ...InvokeOption) LookupSmAdminsRolesResultOutput
> Note: This function is named LookupSmAdminsRoles
in the Go SDK.
public static class GetSmAdminsRoles
{
public static Task<GetSmAdminsRolesResult> InvokeAsync(GetSmAdminsRolesArgs args, InvokeOptions? opts = null)
public static Output<GetSmAdminsRolesResult> Invoke(GetSmAdminsRolesInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetSmAdminsRolesResult> getSmAdminsRoles(GetSmAdminsRolesArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: meraki:organizations/getSmAdminsRoles:getSmAdminsRoles
arguments:
# arguments dictionary
The following arguments are supported:
- Ending
Before string - 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.
- Organization
Id string - organizationId path parameter. Organization ID
- Per
Page int - perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 50.
- Role
Id string - roleId path parameter. Role ID
- Starting
After 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.
- Ending
Before string - 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.
- Organization
Id string - organizationId path parameter. Organization ID
- Per
Page int - perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 50.
- Role
Id string - roleId path parameter. Role ID
- Starting
After 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.
- ending
Before String - 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.
- organization
Id String - organizationId path parameter. Organization ID
- per
Page Integer - perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 50.
- role
Id String - roleId path parameter. Role ID
- starting
After 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.
- ending
Before string - 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.
- organization
Id string - organizationId path parameter. Organization ID
- per
Page number - perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 50.
- role
Id string - roleId path parameter. Role ID
- starting
After 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.
- ending_
before str - 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.
- organization_
id str - organizationId path parameter. Organization ID
- per_
page int - perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 50.
- role_
id str - roleId path parameter. Role ID
- starting_
after str - 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.
- ending
Before String - 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.
- organization
Id String - organizationId path parameter. Organization ID
- per
Page Number - perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 50.
- role
Id String - roleId path parameter. Role ID
- starting
After 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.
getSmAdminsRoles Result
The following output properties are available:
- Id string
- The provider-assigned unique ID for this managed resource.
- Item
Get
Sm Admins Roles Item - Ending
Before string - 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.
- Organization
Id string - organizationId path parameter. Organization ID
- Per
Page int - perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 50.
- Role
Id string - roleId path parameter. Role ID
- Starting
After 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.
- Id string
- The provider-assigned unique ID for this managed resource.
- Item
Get
Sm Admins Roles Item - Ending
Before string - 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.
- Organization
Id string - organizationId path parameter. Organization ID
- Per
Page int - perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 50.
- Role
Id string - roleId path parameter. Role ID
- Starting
After 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.
- id String
- The provider-assigned unique ID for this managed resource.
- item
Get
Sm Admins Roles Item - ending
Before String - 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.
- organization
Id String - organizationId path parameter. Organization ID
- per
Page Integer - perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 50.
- role
Id String - roleId path parameter. Role ID
- starting
After 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.
- id string
- The provider-assigned unique ID for this managed resource.
- item
Get
Sm Admins Roles Item - ending
Before string - 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.
- organization
Id string - organizationId path parameter. Organization ID
- per
Page number - perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 50.
- role
Id string - roleId path parameter. Role ID
- starting
After 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.
- id str
- The provider-assigned unique ID for this managed resource.
- item
Get
Sm Admins Roles Item - ending_
before str - 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.
- organization_
id str - organizationId path parameter. Organization ID
- per_
page int - perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 50.
- role_
id str - roleId path parameter. Role ID
- starting_
after str - 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.
- id String
- The provider-assigned unique ID for this managed resource.
- item Property Map
- ending
Before String - 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.
- organization
Id String - organizationId path parameter. Organization ID
- per
Page Number - perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 50.
- role
Id String - roleId path parameter. Role ID
- starting
After 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.
Supporting Types
GetSmAdminsRolesItem
Package Details
- Repository
- meraki pulumi/pulumi-meraki
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
meraki
Terraform Provider.