@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 4.39 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Retrieves the properties of an existing Azure Cosmos DB SQL Role Definition with the given Id.
*
* Uses Azure REST API version 2024-11-15.
*
* Other available API versions: 2020-06-01-preview, 2021-03-01-preview, 2021-04-01-preview, 2021-04-15, 2021-05-15, 2021-06-15, 2021-07-01-preview, 2021-10-15, 2021-10-15-preview, 2021-11-15-preview, 2022-02-15-preview, 2022-05-15, 2022-05-15-preview, 2022-08-15, 2022-08-15-preview, 2022-11-15, 2022-11-15-preview, 2023-03-01-preview, 2023-03-15, 2023-03-15-preview, 2023-04-15, 2023-09-15, 2023-09-15-preview, 2023-11-15, 2023-11-15-preview, 2024-02-15-preview, 2024-05-15, 2024-05-15-preview, 2024-08-15, 2024-09-01-preview, 2024-12-01-preview, 2025-04-15, 2025-05-01-preview. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native cosmosdb [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getSqlResourceSqlRoleDefinition(args: GetSqlResourceSqlRoleDefinitionArgs, opts?: pulumi.InvokeOptions): Promise<GetSqlResourceSqlRoleDefinitionResult>;
export interface GetSqlResourceSqlRoleDefinitionArgs {
/**
* Cosmos DB database account name.
*/
accountName: string;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: string;
/**
* The GUID for the Role Definition.
*/
roleDefinitionId: string;
}
/**
* An Azure Cosmos DB SQL Role Definition.
*/
export interface GetSqlResourceSqlRoleDefinitionResult {
/**
* A set of fully qualified Scopes at or below which Role Assignments may be created using this Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Must have at least one element. Scopes higher than Database account are not enforceable as assignable Scopes. Note that resources referenced in assignable Scopes need not exist.
*/
readonly assignableScopes?: string[];
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: string;
/**
* The unique resource identifier of the database account.
*/
readonly id: string;
/**
* The name of the database account.
*/
readonly name: string;
/**
* The set of operations allowed through this Role Definition.
*/
readonly permissions?: outputs.cosmosdb.PermissionResponse[];
/**
* A user-friendly name for the Role Definition. Must be unique for the database account.
*/
readonly roleName?: string;
/**
* The type of Azure resource.
*/
readonly type: string;
}
/**
* Retrieves the properties of an existing Azure Cosmos DB SQL Role Definition with the given Id.
*
* Uses Azure REST API version 2024-11-15.
*
* Other available API versions: 2020-06-01-preview, 2021-03-01-preview, 2021-04-01-preview, 2021-04-15, 2021-05-15, 2021-06-15, 2021-07-01-preview, 2021-10-15, 2021-10-15-preview, 2021-11-15-preview, 2022-02-15-preview, 2022-05-15, 2022-05-15-preview, 2022-08-15, 2022-08-15-preview, 2022-11-15, 2022-11-15-preview, 2023-03-01-preview, 2023-03-15, 2023-03-15-preview, 2023-04-15, 2023-09-15, 2023-09-15-preview, 2023-11-15, 2023-11-15-preview, 2024-02-15-preview, 2024-05-15, 2024-05-15-preview, 2024-08-15, 2024-09-01-preview, 2024-12-01-preview, 2025-04-15, 2025-05-01-preview. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native cosmosdb [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getSqlResourceSqlRoleDefinitionOutput(args: GetSqlResourceSqlRoleDefinitionOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetSqlResourceSqlRoleDefinitionResult>;
export interface GetSqlResourceSqlRoleDefinitionOutputArgs {
/**
* Cosmos DB database account name.
*/
accountName: pulumi.Input<string>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
/**
* The GUID for the Role Definition.
*/
roleDefinitionId: pulumi.Input<string>;
}