Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. redis
  5. getAccessPolicy
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.redis.getAccessPolicy

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

Gets the detailed information about an access policy of a redis cache

Uses Azure REST API version 2024-11-01.

Other available API versions: 2023-05-01-preview, 2023-08-01, 2024-03-01, 2024-04-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native redis [ApiVersion]. See the version guide for details.

Using getAccessPolicy

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 getAccessPolicy(args: GetAccessPolicyArgs, opts?: InvokeOptions): Promise<GetAccessPolicyResult>
function getAccessPolicyOutput(args: GetAccessPolicyOutputArgs, opts?: InvokeOptions): Output<GetAccessPolicyResult>
Copy
def get_access_policy(access_policy_name: Optional[str] = None,
                      cache_name: Optional[str] = None,
                      resource_group_name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetAccessPolicyResult
def get_access_policy_output(access_policy_name: Optional[pulumi.Input[str]] = None,
                      cache_name: Optional[pulumi.Input[str]] = None,
                      resource_group_name: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetAccessPolicyResult]
Copy
func LookupAccessPolicy(ctx *Context, args *LookupAccessPolicyArgs, opts ...InvokeOption) (*LookupAccessPolicyResult, error)
func LookupAccessPolicyOutput(ctx *Context, args *LookupAccessPolicyOutputArgs, opts ...InvokeOption) LookupAccessPolicyResultOutput
Copy

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

public static class GetAccessPolicy 
{
    public static Task<GetAccessPolicyResult> InvokeAsync(GetAccessPolicyArgs args, InvokeOptions? opts = null)
    public static Output<GetAccessPolicyResult> Invoke(GetAccessPolicyInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetAccessPolicyResult> getAccessPolicy(GetAccessPolicyArgs args, InvokeOptions options)
public static Output<GetAccessPolicyResult> getAccessPolicy(GetAccessPolicyArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:redis:getAccessPolicy
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AccessPolicyName
This property is required.
Changes to this property will trigger replacement.
string
The name of the access policy that is being added to the Redis cache.
CacheName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Redis cache.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
AccessPolicyName
This property is required.
Changes to this property will trigger replacement.
string
The name of the access policy that is being added to the Redis cache.
CacheName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Redis cache.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
accessPolicyName
This property is required.
Changes to this property will trigger replacement.
String
The name of the access policy that is being added to the Redis cache.
cacheName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Redis cache.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
accessPolicyName
This property is required.
Changes to this property will trigger replacement.
string
The name of the access policy that is being added to the Redis cache.
cacheName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Redis cache.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
access_policy_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the access policy that is being added to the Redis cache.
cache_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Redis cache.
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.
accessPolicyName
This property is required.
Changes to this property will trigger replacement.
String
The name of the access policy that is being added to the Redis cache.
cacheName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Redis cache.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.

getAccessPolicy 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
Permissions string
Permissions for the access policy. Learn how to configure permissions at https://aka.ms/redis/AADPreRequisites
ProvisioningState string
Provisioning state of access policy
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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
Permissions string
Permissions for the access policy. Learn how to configure permissions at https://aka.ms/redis/AADPreRequisites
ProvisioningState string
Provisioning state of access policy
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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
permissions String
Permissions for the access policy. Learn how to configure permissions at https://aka.ms/redis/AADPreRequisites
provisioningState String
Provisioning state of access policy
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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
permissions string
Permissions for the access policy. Learn how to configure permissions at https://aka.ms/redis/AADPreRequisites
provisioningState string
Provisioning state of access policy
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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
permissions str
Permissions for the access policy. Learn how to configure permissions at https://aka.ms/redis/AADPreRequisites
provisioning_state str
Provisioning state of access policy
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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
permissions String
Permissions for the access policy. Learn how to configure permissions at https://aka.ms/redis/AADPreRequisites
provisioningState String
Provisioning state of access policy
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

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