Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. cache
  5. getRedisEnterprise
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.cache.getRedisEnterprise

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets information about a RedisEnterprise cluster Azure REST API version: 2023-03-01-preview.

Other available API versions: 2020-10-01-preview, 2023-07-01, 2023-08-01-preview, 2023-10-01-preview, 2023-11-01, 2024-02-01, 2024-03-01-preview, 2024-06-01-preview, 2024-09-01-preview, 2024-10-01.

Using getRedisEnterprise

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 getRedisEnterprise(args: GetRedisEnterpriseArgs, opts?: InvokeOptions): Promise<GetRedisEnterpriseResult>
function getRedisEnterpriseOutput(args: GetRedisEnterpriseOutputArgs, opts?: InvokeOptions): Output<GetRedisEnterpriseResult>
Copy
def get_redis_enterprise(cluster_name: Optional[str] = None,
                         resource_group_name: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetRedisEnterpriseResult
def get_redis_enterprise_output(cluster_name: Optional[pulumi.Input[str]] = None,
                         resource_group_name: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetRedisEnterpriseResult]
Copy
func LookupRedisEnterprise(ctx *Context, args *LookupRedisEnterpriseArgs, opts ...InvokeOption) (*LookupRedisEnterpriseResult, error)
func LookupRedisEnterpriseOutput(ctx *Context, args *LookupRedisEnterpriseOutputArgs, opts ...InvokeOption) LookupRedisEnterpriseResultOutput
Copy

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

public static class GetRedisEnterprise 
{
    public static Task<GetRedisEnterpriseResult> InvokeAsync(GetRedisEnterpriseArgs args, InvokeOptions? opts = null)
    public static Output<GetRedisEnterpriseResult> Invoke(GetRedisEnterpriseInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetRedisEnterpriseResult> getRedisEnterprise(GetRedisEnterpriseArgs args, InvokeOptions options)
public static Output<GetRedisEnterpriseResult> getRedisEnterprise(GetRedisEnterpriseArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:cache:getRedisEnterprise
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ClusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the RedisEnterprise cluster.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ClusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the RedisEnterprise cluster.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
clusterName
This property is required.
Changes to this property will trigger replacement.
String
The name of the RedisEnterprise cluster.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
clusterName
This property is required.
Changes to this property will trigger replacement.
string
The name of the RedisEnterprise cluster.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
cluster_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the RedisEnterprise cluster.
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.
clusterName
This property is required.
Changes to this property will trigger replacement.
String
The name of the RedisEnterprise cluster.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.

getRedisEnterprise Result

The following output properties are available:

HostName string
DNS name of the cluster endpoint
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Location string
The geo-location where the resource lives
Name string
The name of the resource
PrivateEndpointConnections List<Pulumi.AzureNative.Cache.Outputs.PrivateEndpointConnectionResponse>
List of private endpoint connections associated with the specified RedisEnterprise cluster
ProvisioningState string
Current provisioning status of the cluster
RedisVersion string
Version of redis the cluster supports, e.g. '6'
ResourceState string
Current resource status of the cluster
Sku Pulumi.AzureNative.Cache.Outputs.EnterpriseSkuResponse
The SKU to create, which affects price, performance, and features.
SystemData Pulumi.AzureNative.Cache.Outputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Encryption Pulumi.AzureNative.Cache.Outputs.ClusterPropertiesResponseEncryption
Encryption-at-rest configuration for the cluster.
Identity Pulumi.AzureNative.Cache.Outputs.ManagedServiceIdentityResponse
The identity of the resource.
MinimumTlsVersion string
The minimum TLS version for the cluster to support, e.g. '1.2'
Tags Dictionary<string, string>
Resource tags.
Zones List<string>
The Availability Zones where this cluster will be deployed.
HostName string
DNS name of the cluster endpoint
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Location string
The geo-location where the resource lives
Name string
The name of the resource
PrivateEndpointConnections []PrivateEndpointConnectionResponse
List of private endpoint connections associated with the specified RedisEnterprise cluster
ProvisioningState string
Current provisioning status of the cluster
RedisVersion string
Version of redis the cluster supports, e.g. '6'
ResourceState string
Current resource status of the cluster
Sku EnterpriseSkuResponse
The SKU to create, which affects price, performance, and features.
SystemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Encryption ClusterPropertiesResponseEncryption
Encryption-at-rest configuration for the cluster.
Identity ManagedServiceIdentityResponse
The identity of the resource.
MinimumTlsVersion string
The minimum TLS version for the cluster to support, e.g. '1.2'
Tags map[string]string
Resource tags.
Zones []string
The Availability Zones where this cluster will be deployed.
hostName String
DNS name of the cluster endpoint
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location String
The geo-location where the resource lives
name String
The name of the resource
privateEndpointConnections List<PrivateEndpointConnectionResponse>
List of private endpoint connections associated with the specified RedisEnterprise cluster
provisioningState String
Current provisioning status of the cluster
redisVersion String
Version of redis the cluster supports, e.g. '6'
resourceState String
Current resource status of the cluster
sku EnterpriseSkuResponse
The SKU to create, which affects price, performance, and features.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
encryption ClusterPropertiesResponseEncryption
Encryption-at-rest configuration for the cluster.
identity ManagedServiceIdentityResponse
The identity of the resource.
minimumTlsVersion String
The minimum TLS version for the cluster to support, e.g. '1.2'
tags Map<String,String>
Resource tags.
zones List<String>
The Availability Zones where this cluster will be deployed.
hostName string
DNS name of the cluster endpoint
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location string
The geo-location where the resource lives
name string
The name of the resource
privateEndpointConnections PrivateEndpointConnectionResponse[]
List of private endpoint connections associated with the specified RedisEnterprise cluster
provisioningState string
Current provisioning status of the cluster
redisVersion string
Version of redis the cluster supports, e.g. '6'
resourceState string
Current resource status of the cluster
sku EnterpriseSkuResponse
The SKU to create, which affects price, performance, and features.
systemData SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
encryption ClusterPropertiesResponseEncryption
Encryption-at-rest configuration for the cluster.
identity ManagedServiceIdentityResponse
The identity of the resource.
minimumTlsVersion string
The minimum TLS version for the cluster to support, e.g. '1.2'
tags {[key: string]: string}
Resource tags.
zones string[]
The Availability Zones where this cluster will be deployed.
host_name str
DNS name of the cluster endpoint
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location str
The geo-location where the resource lives
name str
The name of the resource
private_endpoint_connections Sequence[PrivateEndpointConnectionResponse]
List of private endpoint connections associated with the specified RedisEnterprise cluster
provisioning_state str
Current provisioning status of the cluster
redis_version str
Version of redis the cluster supports, e.g. '6'
resource_state str
Current resource status of the cluster
sku EnterpriseSkuResponse
The SKU to create, which affects price, performance, and features.
system_data SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
encryption ClusterPropertiesResponseEncryption
Encryption-at-rest configuration for the cluster.
identity ManagedServiceIdentityResponse
The identity of the resource.
minimum_tls_version str
The minimum TLS version for the cluster to support, e.g. '1.2'
tags Mapping[str, str]
Resource tags.
zones Sequence[str]
The Availability Zones where this cluster will be deployed.
hostName String
DNS name of the cluster endpoint
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location String
The geo-location where the resource lives
name String
The name of the resource
privateEndpointConnections List<Property Map>
List of private endpoint connections associated with the specified RedisEnterprise cluster
provisioningState String
Current provisioning status of the cluster
redisVersion String
Version of redis the cluster supports, e.g. '6'
resourceState String
Current resource status of the cluster
sku Property Map
The SKU to create, which affects price, performance, and features.
systemData Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
encryption Property Map
Encryption-at-rest configuration for the cluster.
identity Property Map
The identity of the resource.
minimumTlsVersion String
The minimum TLS version for the cluster to support, e.g. '1.2'
tags Map<String>
Resource tags.
zones List<String>
The Availability Zones where this cluster will be deployed.

Supporting Types

ClusterPropertiesResponseCustomerManagedKeyEncryption

KeyEncryptionKeyIdentity Pulumi.AzureNative.Cache.Inputs.ClusterPropertiesResponseKeyEncryptionKeyIdentity
All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault.
KeyEncryptionKeyUrl string
Key encryption key Url, versioned only. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78
KeyEncryptionKeyIdentity ClusterPropertiesResponseKeyEncryptionKeyIdentity
All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault.
KeyEncryptionKeyUrl string
Key encryption key Url, versioned only. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78
keyEncryptionKeyIdentity ClusterPropertiesResponseKeyEncryptionKeyIdentity
All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault.
keyEncryptionKeyUrl String
Key encryption key Url, versioned only. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78
keyEncryptionKeyIdentity ClusterPropertiesResponseKeyEncryptionKeyIdentity
All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault.
keyEncryptionKeyUrl string
Key encryption key Url, versioned only. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78
key_encryption_key_identity ClusterPropertiesResponseKeyEncryptionKeyIdentity
All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault.
key_encryption_key_url str
Key encryption key Url, versioned only. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78
keyEncryptionKeyIdentity Property Map
All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault.
keyEncryptionKeyUrl String
Key encryption key Url, versioned only. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78

ClusterPropertiesResponseEncryption

CustomerManagedKeyEncryption Pulumi.AzureNative.Cache.Inputs.ClusterPropertiesResponseCustomerManagedKeyEncryption
All Customer-managed key encryption properties for the resource. Set this to an empty object to use Microsoft-managed key encryption.
CustomerManagedKeyEncryption ClusterPropertiesResponseCustomerManagedKeyEncryption
All Customer-managed key encryption properties for the resource. Set this to an empty object to use Microsoft-managed key encryption.
customerManagedKeyEncryption ClusterPropertiesResponseCustomerManagedKeyEncryption
All Customer-managed key encryption properties for the resource. Set this to an empty object to use Microsoft-managed key encryption.
customerManagedKeyEncryption ClusterPropertiesResponseCustomerManagedKeyEncryption
All Customer-managed key encryption properties for the resource. Set this to an empty object to use Microsoft-managed key encryption.
customer_managed_key_encryption ClusterPropertiesResponseCustomerManagedKeyEncryption
All Customer-managed key encryption properties for the resource. Set this to an empty object to use Microsoft-managed key encryption.
customerManagedKeyEncryption Property Map
All Customer-managed key encryption properties for the resource. Set this to an empty object to use Microsoft-managed key encryption.

ClusterPropertiesResponseKeyEncryptionKeyIdentity

IdentityType string
Only userAssignedIdentity is supported in this API version; other types may be supported in the future
UserAssignedIdentityResourceId string
User assigned identity to use for accessing key encryption key Url. Ex: /subscriptions//resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId.
IdentityType string
Only userAssignedIdentity is supported in this API version; other types may be supported in the future
UserAssignedIdentityResourceId string
User assigned identity to use for accessing key encryption key Url. Ex: /subscriptions//resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId.
identityType String
Only userAssignedIdentity is supported in this API version; other types may be supported in the future
userAssignedIdentityResourceId String
User assigned identity to use for accessing key encryption key Url. Ex: /subscriptions//resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId.
identityType string
Only userAssignedIdentity is supported in this API version; other types may be supported in the future
userAssignedIdentityResourceId string
User assigned identity to use for accessing key encryption key Url. Ex: /subscriptions//resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId.
identity_type str
Only userAssignedIdentity is supported in this API version; other types may be supported in the future
user_assigned_identity_resource_id str
User assigned identity to use for accessing key encryption key Url. Ex: /subscriptions//resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId.
identityType String
Only userAssignedIdentity is supported in this API version; other types may be supported in the future
userAssignedIdentityResourceId String
User assigned identity to use for accessing key encryption key Url. Ex: /subscriptions//resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId.

EnterpriseSkuResponse

Name This property is required. string
The type of RedisEnterprise cluster to deploy. Possible values: (Enterprise_E10, EnterpriseFlash_F300 etc.)
Capacity int
The size of the RedisEnterprise cluster. Defaults to 2 or 3 depending on SKU. Valid values are (2, 4, 6, ...) for Enterprise SKUs and (3, 9, 15, ...) for Flash SKUs.
Name This property is required. string
The type of RedisEnterprise cluster to deploy. Possible values: (Enterprise_E10, EnterpriseFlash_F300 etc.)
Capacity int
The size of the RedisEnterprise cluster. Defaults to 2 or 3 depending on SKU. Valid values are (2, 4, 6, ...) for Enterprise SKUs and (3, 9, 15, ...) for Flash SKUs.
name This property is required. String
The type of RedisEnterprise cluster to deploy. Possible values: (Enterprise_E10, EnterpriseFlash_F300 etc.)
capacity Integer
The size of the RedisEnterprise cluster. Defaults to 2 or 3 depending on SKU. Valid values are (2, 4, 6, ...) for Enterprise SKUs and (3, 9, 15, ...) for Flash SKUs.
name This property is required. string
The type of RedisEnterprise cluster to deploy. Possible values: (Enterprise_E10, EnterpriseFlash_F300 etc.)
capacity number
The size of the RedisEnterprise cluster. Defaults to 2 or 3 depending on SKU. Valid values are (2, 4, 6, ...) for Enterprise SKUs and (3, 9, 15, ...) for Flash SKUs.
name This property is required. str
The type of RedisEnterprise cluster to deploy. Possible values: (Enterprise_E10, EnterpriseFlash_F300 etc.)
capacity int
The size of the RedisEnterprise cluster. Defaults to 2 or 3 depending on SKU. Valid values are (2, 4, 6, ...) for Enterprise SKUs and (3, 9, 15, ...) for Flash SKUs.
name This property is required. String
The type of RedisEnterprise cluster to deploy. Possible values: (Enterprise_E10, EnterpriseFlash_F300 etc.)
capacity Number
The size of the RedisEnterprise cluster. Defaults to 2 or 3 depending on SKU. Valid values are (2, 4, 6, ...) for Enterprise SKUs and (3, 9, 15, ...) for Flash SKUs.

ManagedServiceIdentityResponse

PrincipalId This property is required. string
The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
TenantId This property is required. string
The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
Type This property is required. string
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.Cache.Inputs.UserAssignedIdentityResponse>
The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
PrincipalId This property is required. string
The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
TenantId This property is required. string
The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
Type This property is required. string
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
UserAssignedIdentities map[string]UserAssignedIdentityResponse
The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
principalId This property is required. String
The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId This property is required. String
The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type This property is required. String
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
userAssignedIdentities Map<String,UserAssignedIdentityResponse>
The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
principalId This property is required. string
The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId This property is required. string
The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type This property is required. string
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
userAssignedIdentities {[key: string]: UserAssignedIdentityResponse}
The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
principal_id This property is required. str
The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenant_id This property is required. str
The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type This property is required. str
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
user_assigned_identities Mapping[str, UserAssignedIdentityResponse]
The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
principalId This property is required. String
The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId This property is required. String
The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type This property is required. String
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
userAssignedIdentities Map<Property Map>
The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

PrivateEndpointConnectionResponse

Id This property is required. string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name This property is required. string
The name of the resource
PrivateLinkServiceConnectionState This property is required. Pulumi.AzureNative.Cache.Inputs.PrivateLinkServiceConnectionStateResponse
A collection of information about the state of the connection between service consumer and provider.
ProvisioningState This property is required. string
The provisioning state of the private endpoint connection resource.
SystemData This property is required. Pulumi.AzureNative.Cache.Inputs.SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type This property is required. string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
PrivateEndpoint Pulumi.AzureNative.Cache.Inputs.PrivateEndpointResponse
The resource of private end point.
Id This property is required. string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name This property is required. string
The name of the resource
PrivateLinkServiceConnectionState This property is required. PrivateLinkServiceConnectionStateResponse
A collection of information about the state of the connection between service consumer and provider.
ProvisioningState This property is required. string
The provisioning state of the private endpoint connection resource.
SystemData This property is required. SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type This property is required. string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
PrivateEndpoint PrivateEndpointResponse
The resource of private end point.
id This property is required. String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name This property is required. String
The name of the resource
privateLinkServiceConnectionState This property is required. PrivateLinkServiceConnectionStateResponse
A collection of information about the state of the connection between service consumer and provider.
provisioningState This property is required. String
The provisioning state of the private endpoint connection resource.
systemData This property is required. SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type This property is required. String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
privateEndpoint PrivateEndpointResponse
The resource of private end point.
id This property is required. string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name This property is required. string
The name of the resource
privateLinkServiceConnectionState This property is required. PrivateLinkServiceConnectionStateResponse
A collection of information about the state of the connection between service consumer and provider.
provisioningState This property is required. string
The provisioning state of the private endpoint connection resource.
systemData This property is required. SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type This property is required. string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
privateEndpoint PrivateEndpointResponse
The resource of private end point.
id This property is required. str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name This property is required. str
The name of the resource
private_link_service_connection_state This property is required. PrivateLinkServiceConnectionStateResponse
A collection of information about the state of the connection between service consumer and provider.
provisioning_state This property is required. str
The provisioning state of the private endpoint connection resource.
system_data This property is required. SystemDataResponse
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type This property is required. str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
private_endpoint PrivateEndpointResponse
The resource of private end point.
id This property is required. String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name This property is required. String
The name of the resource
privateLinkServiceConnectionState This property is required. Property Map
A collection of information about the state of the connection between service consumer and provider.
provisioningState This property is required. String
The provisioning state of the private endpoint connection resource.
systemData This property is required. Property Map
Azure Resource Manager metadata containing createdBy and modifiedBy information.
type This property is required. String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
privateEndpoint Property Map
The resource of private end point.

PrivateEndpointResponse

Id This property is required. string
The ARM identifier for Private Endpoint
Id This property is required. string
The ARM identifier for Private Endpoint
id This property is required. String
The ARM identifier for Private Endpoint
id This property is required. string
The ARM identifier for Private Endpoint
id This property is required. str
The ARM identifier for Private Endpoint
id This property is required. String
The ARM identifier for Private Endpoint

PrivateLinkServiceConnectionStateResponse

ActionsRequired string
A message indicating if changes on the service provider require any updates on the consumer.
Description string
The reason for approval/rejection of the connection.
Status string
Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
ActionsRequired string
A message indicating if changes on the service provider require any updates on the consumer.
Description string
The reason for approval/rejection of the connection.
Status string
Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
actionsRequired String
A message indicating if changes on the service provider require any updates on the consumer.
description String
The reason for approval/rejection of the connection.
status String
Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
actionsRequired string
A message indicating if changes on the service provider require any updates on the consumer.
description string
The reason for approval/rejection of the connection.
status string
Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
actions_required str
A message indicating if changes on the service provider require any updates on the consumer.
description str
The reason for approval/rejection of the connection.
status str
Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
actionsRequired String
A message indicating if changes on the service provider require any updates on the consumer.
description String
The reason for approval/rejection of the connection.
status String
Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

UserAssignedIdentityResponse

ClientId This property is required. string
The client ID of the assigned identity.
PrincipalId This property is required. string
The principal ID of the assigned identity.
ClientId This property is required. string
The client ID of the assigned identity.
PrincipalId This property is required. string
The principal ID of the assigned identity.
clientId This property is required. String
The client ID of the assigned identity.
principalId This property is required. String
The principal ID of the assigned identity.
clientId This property is required. string
The client ID of the assigned identity.
principalId This property is required. string
The principal ID of the assigned identity.
client_id This property is required. str
The client ID of the assigned identity.
principal_id This property is required. str
The principal ID of the assigned identity.
clientId This property is required. String
The client ID of the assigned identity.
principalId This property is required. String
The principal ID of the assigned identity.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native