1. Packages
  2. Azure Native
  3. API Docs
  4. devtestlab
  5. getPolicy
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi

azure-native.devtestlab.getPolicy

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi

    Get policy. Azure REST API version: 2018-09-15.

    Other available API versions: 2016-05-15.

    Using getPolicy

    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 getPolicy(args: GetPolicyArgs, opts?: InvokeOptions): Promise<GetPolicyResult>
    function getPolicyOutput(args: GetPolicyOutputArgs, opts?: InvokeOptions): Output<GetPolicyResult>
    def get_policy(expand: Optional[str] = None,
                   lab_name: Optional[str] = None,
                   name: Optional[str] = None,
                   policy_set_name: Optional[str] = None,
                   resource_group_name: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetPolicyResult
    def get_policy_output(expand: Optional[pulumi.Input[str]] = None,
                   lab_name: Optional[pulumi.Input[str]] = None,
                   name: Optional[pulumi.Input[str]] = None,
                   policy_set_name: Optional[pulumi.Input[str]] = None,
                   resource_group_name: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetPolicyResult]
    func LookupPolicy(ctx *Context, args *LookupPolicyArgs, opts ...InvokeOption) (*LookupPolicyResult, error)
    func LookupPolicyOutput(ctx *Context, args *LookupPolicyOutputArgs, opts ...InvokeOption) LookupPolicyResultOutput

    > Note: This function is named LookupPolicy in the Go SDK.

    public static class GetPolicy 
    {
        public static Task<GetPolicyResult> InvokeAsync(GetPolicyArgs args, InvokeOptions? opts = null)
        public static Output<GetPolicyResult> Invoke(GetPolicyInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetPolicyResult> getPolicy(GetPolicyArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:devtestlab:getPolicy
      arguments:
        # arguments dictionary

    The following arguments are supported:

    LabName string
    The name of the lab.
    Name string
    The name of the policy.
    PolicySetName string
    The name of the policy set.
    ResourceGroupName string
    The name of the resource group.
    Expand string
    Specify the $expand query. Example: 'properties($select=description)'
    LabName string
    The name of the lab.
    Name string
    The name of the policy.
    PolicySetName string
    The name of the policy set.
    ResourceGroupName string
    The name of the resource group.
    Expand string
    Specify the $expand query. Example: 'properties($select=description)'
    labName String
    The name of the lab.
    name String
    The name of the policy.
    policySetName String
    The name of the policy set.
    resourceGroupName String
    The name of the resource group.
    expand String
    Specify the $expand query. Example: 'properties($select=description)'
    labName string
    The name of the lab.
    name string
    The name of the policy.
    policySetName string
    The name of the policy set.
    resourceGroupName string
    The name of the resource group.
    expand string
    Specify the $expand query. Example: 'properties($select=description)'
    lab_name str
    The name of the lab.
    name str
    The name of the policy.
    policy_set_name str
    The name of the policy set.
    resource_group_name str
    The name of the resource group.
    expand str
    Specify the $expand query. Example: 'properties($select=description)'
    labName String
    The name of the lab.
    name String
    The name of the policy.
    policySetName String
    The name of the policy set.
    resourceGroupName String
    The name of the resource group.
    expand String
    Specify the $expand query. Example: 'properties($select=description)'

    getPolicy Result

    The following output properties are available:

    CreatedDate string
    The creation date of the policy.
    Id string
    The identifier of the resource.
    Name string
    The name of the resource.
    ProvisioningState string
    The provisioning status of the resource.
    Type string
    The type of the resource.
    UniqueIdentifier string
    The unique immutable identifier of a resource (Guid).
    Description string
    The description of the policy.
    EvaluatorType string
    The evaluator type of the policy (i.e. AllowedValuesPolicy, MaxValuePolicy).
    FactData string
    The fact data of the policy.
    FactName string
    The fact name of the policy (e.g. LabVmCount, LabVmSize, MaxVmsAllowedPerLab, etc.
    Location string
    The location of the resource.
    Status string
    The status of the policy.
    Tags Dictionary<string, string>
    The tags of the resource.
    Threshold string
    The threshold of the policy (i.e. a number for MaxValuePolicy, and a JSON array of values for AllowedValuesPolicy).
    CreatedDate string
    The creation date of the policy.
    Id string
    The identifier of the resource.
    Name string
    The name of the resource.
    ProvisioningState string
    The provisioning status of the resource.
    Type string
    The type of the resource.
    UniqueIdentifier string
    The unique immutable identifier of a resource (Guid).
    Description string
    The description of the policy.
    EvaluatorType string
    The evaluator type of the policy (i.e. AllowedValuesPolicy, MaxValuePolicy).
    FactData string
    The fact data of the policy.
    FactName string
    The fact name of the policy (e.g. LabVmCount, LabVmSize, MaxVmsAllowedPerLab, etc.
    Location string
    The location of the resource.
    Status string
    The status of the policy.
    Tags map[string]string
    The tags of the resource.
    Threshold string
    The threshold of the policy (i.e. a number for MaxValuePolicy, and a JSON array of values for AllowedValuesPolicy).
    createdDate String
    The creation date of the policy.
    id String
    The identifier of the resource.
    name String
    The name of the resource.
    provisioningState String
    The provisioning status of the resource.
    type String
    The type of the resource.
    uniqueIdentifier String
    The unique immutable identifier of a resource (Guid).
    description String
    The description of the policy.
    evaluatorType String
    The evaluator type of the policy (i.e. AllowedValuesPolicy, MaxValuePolicy).
    factData String
    The fact data of the policy.
    factName String
    The fact name of the policy (e.g. LabVmCount, LabVmSize, MaxVmsAllowedPerLab, etc.
    location String
    The location of the resource.
    status String
    The status of the policy.
    tags Map<String,String>
    The tags of the resource.
    threshold String
    The threshold of the policy (i.e. a number for MaxValuePolicy, and a JSON array of values for AllowedValuesPolicy).
    createdDate string
    The creation date of the policy.
    id string
    The identifier of the resource.
    name string
    The name of the resource.
    provisioningState string
    The provisioning status of the resource.
    type string
    The type of the resource.
    uniqueIdentifier string
    The unique immutable identifier of a resource (Guid).
    description string
    The description of the policy.
    evaluatorType string
    The evaluator type of the policy (i.e. AllowedValuesPolicy, MaxValuePolicy).
    factData string
    The fact data of the policy.
    factName string
    The fact name of the policy (e.g. LabVmCount, LabVmSize, MaxVmsAllowedPerLab, etc.
    location string
    The location of the resource.
    status string
    The status of the policy.
    tags {[key: string]: string}
    The tags of the resource.
    threshold string
    The threshold of the policy (i.e. a number for MaxValuePolicy, and a JSON array of values for AllowedValuesPolicy).
    created_date str
    The creation date of the policy.
    id str
    The identifier of the resource.
    name str
    The name of the resource.
    provisioning_state str
    The provisioning status of the resource.
    type str
    The type of the resource.
    unique_identifier str
    The unique immutable identifier of a resource (Guid).
    description str
    The description of the policy.
    evaluator_type str
    The evaluator type of the policy (i.e. AllowedValuesPolicy, MaxValuePolicy).
    fact_data str
    The fact data of the policy.
    fact_name str
    The fact name of the policy (e.g. LabVmCount, LabVmSize, MaxVmsAllowedPerLab, etc.
    location str
    The location of the resource.
    status str
    The status of the policy.
    tags Mapping[str, str]
    The tags of the resource.
    threshold str
    The threshold of the policy (i.e. a number for MaxValuePolicy, and a JSON array of values for AllowedValuesPolicy).
    createdDate String
    The creation date of the policy.
    id String
    The identifier of the resource.
    name String
    The name of the resource.
    provisioningState String
    The provisioning status of the resource.
    type String
    The type of the resource.
    uniqueIdentifier String
    The unique immutable identifier of a resource (Guid).
    description String
    The description of the policy.
    evaluatorType String
    The evaluator type of the policy (i.e. AllowedValuesPolicy, MaxValuePolicy).
    factData String
    The fact data of the policy.
    factName String
    The fact name of the policy (e.g. LabVmCount, LabVmSize, MaxVmsAllowedPerLab, etc.
    location String
    The location of the resource.
    status String
    The status of the policy.
    tags Map<String>
    The tags of the resource.
    threshold String
    The threshold of the policy (i.e. a number for MaxValuePolicy, and a JSON array of values for AllowedValuesPolicy).

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi