Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. apimanagement
  5. getPolicyRestriction
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.apimanagement.getPolicyRestriction

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

Get the policy restriction of the Api Management service.

Uses Azure REST API version 2024-06-01-preview.

Other available API versions: 2023-05-01-preview, 2023-09-01-preview, 2024-05-01. 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 for details.

Using getPolicyRestriction

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 getPolicyRestriction(args: GetPolicyRestrictionArgs, opts?: InvokeOptions): Promise<GetPolicyRestrictionResult>
function getPolicyRestrictionOutput(args: GetPolicyRestrictionOutputArgs, opts?: InvokeOptions): Output<GetPolicyRestrictionResult>
Copy
def get_policy_restriction(policy_restriction_id: Optional[str] = None,
                           resource_group_name: Optional[str] = None,
                           service_name: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetPolicyRestrictionResult
def get_policy_restriction_output(policy_restriction_id: Optional[pulumi.Input[str]] = None,
                           resource_group_name: Optional[pulumi.Input[str]] = None,
                           service_name: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetPolicyRestrictionResult]
Copy
func LookupPolicyRestriction(ctx *Context, args *LookupPolicyRestrictionArgs, opts ...InvokeOption) (*LookupPolicyRestrictionResult, error)
func LookupPolicyRestrictionOutput(ctx *Context, args *LookupPolicyRestrictionOutputArgs, opts ...InvokeOption) LookupPolicyRestrictionResultOutput
Copy

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

public static class GetPolicyRestriction 
{
    public static Task<GetPolicyRestrictionResult> InvokeAsync(GetPolicyRestrictionArgs args, InvokeOptions? opts = null)
    public static Output<GetPolicyRestrictionResult> Invoke(GetPolicyRestrictionInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetPolicyRestrictionResult> getPolicyRestriction(GetPolicyRestrictionArgs args, InvokeOptions options)
public static Output<GetPolicyRestrictionResult> getPolicyRestriction(GetPolicyRestrictionArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:apimanagement:getPolicyRestriction
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

PolicyRestrictionId
This property is required.
Changes to this property will trigger replacement.
string
Policy restrictions after an entity level
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
PolicyRestrictionId
This property is required.
Changes to this property will trigger replacement.
string
Policy restrictions after an entity level
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
policyRestrictionId
This property is required.
Changes to this property will trigger replacement.
String
Policy restrictions after an entity level
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API Management service.
policyRestrictionId
This property is required.
Changes to this property will trigger replacement.
string
Policy restrictions after an entity level
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
policy_restriction_id
This property is required.
Changes to this property will trigger replacement.
str
Policy restrictions after an entity level
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
service_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the API Management service.
policyRestrictionId
This property is required.
Changes to this property will trigger replacement.
String
Policy restrictions after an entity level
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API Management service.

getPolicyRestriction Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
RequireBase string
Indicates if base policy should be enforced for the policy document.
Scope string
Path to the policy document.
AzureApiVersion string
The Azure API version of the resource.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
RequireBase string
Indicates if base policy should be enforced for the policy document.
Scope string
Path to the policy document.
azureApiVersion String
The Azure API version of the resource.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String
The name of the resource
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
requireBase String
Indicates if base policy should be enforced for the policy document.
scope String
Path to the policy document.
azureApiVersion string
The Azure API version of the resource.
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name string
The name of the resource
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
requireBase string
Indicates if base policy should be enforced for the policy document.
scope string
Path to the policy document.
azure_api_version str
The Azure API version of the resource.
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name str
The name of the resource
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
require_base str
Indicates if base policy should be enforced for the policy document.
scope str
Path to the policy document.
azureApiVersion String
The Azure API version of the resource.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String
The name of the resource
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
requireBase String
Indicates if base policy should be enforced for the policy document.
scope String
Path to the policy document.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native