@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 4.13 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as enums from "../types/enums";
/**
* Contract details.
*
* Uses Azure REST API version 2022-09-01-preview. In version 2.x of the Azure Native provider, it used API version 2022-09-01-preview.
*
* Other available API versions: 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01, 2024-06-01-preview. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native apimanagement [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare class WorkspaceGroup extends pulumi.CustomResource {
/**
* Get an existing WorkspaceGroup resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): WorkspaceGroup;
/**
* Returns true if the given object is an instance of WorkspaceGroup. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is WorkspaceGroup;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.
*/
readonly builtIn: pulumi.Output<boolean>;
/**
* Group description. Can contain HTML formatting tags.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Group name.
*/
readonly displayName: pulumi.Output<string>;
/**
* For external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory `aad://<tenant>.onmicrosoft.com/groups/<group object id>`; otherwise the value is null.
*/
readonly externalId: pulumi.Output<string | undefined>;
/**
* The name of the resource
*/
readonly name: pulumi.Output<string>;
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: pulumi.Output<string>;
/**
* Create a WorkspaceGroup resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: WorkspaceGroupArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a WorkspaceGroup resource.
*/
export interface WorkspaceGroupArgs {
/**
* Group description.
*/
description?: pulumi.Input<string>;
/**
* Group name.
*/
displayName: pulumi.Input<string>;
/**
* Identifier of the external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory `aad://<tenant>.onmicrosoft.com/groups/<group object id>`; otherwise the value is null.
*/
externalId?: pulumi.Input<string>;
/**
* Group identifier. Must be unique in the current API Management service instance.
*/
groupId?: pulumi.Input<string>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
/**
* The name of the API Management service.
*/
serviceName: pulumi.Input<string>;
/**
* Group type.
*/
type?: pulumi.Input<enums.apimanagement.GroupType>;
/**
* Workspace identifier. Must be unique in the current API Management service instance.
*/
workspaceId: pulumi.Input<string>;
}