@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 4.46 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* This operation retrieves the policy set definition in the given management group with the given name.
*
* Uses Azure REST API version 2025-01-01.
*
* Other available API versions: 2020-09-01, 2021-06-01, 2023-04-01, 2024-05-01, 2025-03-01. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native authorization [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getPolicySetDefinitionAtManagementGroup(args: GetPolicySetDefinitionAtManagementGroupArgs, opts?: pulumi.InvokeOptions): Promise<GetPolicySetDefinitionAtManagementGroupResult>;
export interface GetPolicySetDefinitionAtManagementGroupArgs {
/**
* Comma-separated list of additional properties to be included in the response. Supported values are 'LatestDefinitionVersion, EffectiveDefinitionVersion'.
*/
expand?: string;
/**
* The ID of the management group.
*/
managementGroupId: string;
/**
* The name of the policy set definition to get.
*/
policySetDefinitionName: string;
}
/**
* The policy set definition.
*/
export interface GetPolicySetDefinitionAtManagementGroupResult {
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: string;
/**
* The policy set definition description.
*/
readonly description?: string;
/**
* The display name of the policy set definition.
*/
readonly displayName?: string;
/**
* The ID of the policy set definition.
*/
readonly id: string;
/**
* The policy set definition metadata. Metadata is an open ended object and is typically a collection of key value pairs.
*/
readonly metadata?: any;
/**
* The name of the policy set definition.
*/
readonly name: string;
/**
* The policy set definition parameters that can be used in policy definition references.
*/
readonly parameters?: {
[key: string]: outputs.authorization.ParameterDefinitionsValueResponse;
};
/**
* The metadata describing groups of policy definition references within the policy set definition.
*/
readonly policyDefinitionGroups?: outputs.authorization.PolicyDefinitionGroupResponse[];
/**
* An array of policy definition references.
*/
readonly policyDefinitions: outputs.authorization.PolicyDefinitionReferenceResponse[];
/**
* The type of policy set definition. Possible values are NotSpecified, BuiltIn, Custom, and Static.
*/
readonly policyType?: string;
/**
* The system metadata relating to this resource.
*/
readonly systemData: outputs.authorization.SystemDataResponse;
/**
* The type of the resource (Microsoft.Authorization/policySetDefinitions).
*/
readonly type: string;
/**
* The policy set definition version in #.#.# format.
*/
readonly version?: string;
/**
* A list of available versions for this policy set definition.
*/
readonly versions?: string[];
}
/**
* This operation retrieves the policy set definition in the given management group with the given name.
*
* Uses Azure REST API version 2025-01-01.
*
* Other available API versions: 2020-09-01, 2021-06-01, 2023-04-01, 2024-05-01, 2025-03-01. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native authorization [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getPolicySetDefinitionAtManagementGroupOutput(args: GetPolicySetDefinitionAtManagementGroupOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetPolicySetDefinitionAtManagementGroupResult>;
export interface GetPolicySetDefinitionAtManagementGroupOutputArgs {
/**
* Comma-separated list of additional properties to be included in the response. Supported values are 'LatestDefinitionVersion, EffectiveDefinitionVersion'.
*/
expand?: pulumi.Input<string>;
/**
* The ID of the management group.
*/
managementGroupId: pulumi.Input<string>;
/**
* The name of the policy set definition to get.
*/
policySetDefinitionName: pulumi.Input<string>;
}