Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. chaos
  5. getPrivateAccess
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.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.chaos.getPrivateAccess

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.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native

Get a private access resource

Uses Azure REST API version 2024-03-22-preview.

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

Using getPrivateAccess

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 getPrivateAccess(args: GetPrivateAccessArgs, opts?: InvokeOptions): Promise<GetPrivateAccessResult>
function getPrivateAccessOutput(args: GetPrivateAccessOutputArgs, opts?: InvokeOptions): Output<GetPrivateAccessResult>
Copy
def get_private_access(private_access_name: Optional[str] = None,
                       resource_group_name: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetPrivateAccessResult
def get_private_access_output(private_access_name: Optional[pulumi.Input[str]] = None,
                       resource_group_name: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetPrivateAccessResult]
Copy
func LookupPrivateAccess(ctx *Context, args *LookupPrivateAccessArgs, opts ...InvokeOption) (*LookupPrivateAccessResult, error)
func LookupPrivateAccessOutput(ctx *Context, args *LookupPrivateAccessOutputArgs, opts ...InvokeOption) LookupPrivateAccessResultOutput
Copy

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

public static class GetPrivateAccess 
{
    public static Task<GetPrivateAccessResult> InvokeAsync(GetPrivateAccessArgs args, InvokeOptions? opts = null)
    public static Output<GetPrivateAccessResult> Invoke(GetPrivateAccessInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetPrivateAccessResult> getPrivateAccess(GetPrivateAccessArgs args, InvokeOptions options)
public static Output<GetPrivateAccessResult> getPrivateAccess(GetPrivateAccessArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:chaos:getPrivateAccess
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

PrivateAccessName
This property is required.
Changes to this property will trigger replacement.
string
The name of the private access resource that is being created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
String that represents an Azure resource group.
PrivateAccessName
This property is required.
Changes to this property will trigger replacement.
string
The name of the private access resource that is being created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
String that represents an Azure resource group.
privateAccessName
This property is required.
Changes to this property will trigger replacement.
String
The name of the private access resource that is being created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
String that represents an Azure resource group.
privateAccessName
This property is required.
Changes to this property will trigger replacement.
string
The name of the private access resource that is being created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
String that represents an Azure resource group.
private_access_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the private access resource that is being created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
String that represents an Azure resource group.
privateAccessName
This property is required.
Changes to this property will trigger replacement.
String
The name of the private access resource that is being created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The maximum name length is 80 characters.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
String that represents an Azure resource group.

getPrivateAccess 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. E.g. "/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.Chaos.Outputs.PrivateEndpointConnectionResponse>
A readonly collection of private endpoint connection. Currently only one endpoint connection is supported.
ProvisioningState string
Most recent provisioning state for the given privateAccess resource.
SystemData Pulumi.AzureNative.Chaos.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"
PublicNetworkAccess string
Public Network Access Control for PrivateAccess resource.
Tags Dictionary<string, string>
Resource tags.
AzureApiVersion string
The Azure API version of the resource.
Id string
Fully qualified resource ID for the resource. E.g. "/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
A readonly collection of private endpoint connection. Currently only one endpoint connection is supported.
ProvisioningState string
Most recent provisioning state for the given privateAccess resource.
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"
PublicNetworkAccess string
Public Network Access Control for PrivateAccess resource.
Tags map[string]string
Resource tags.
azureApiVersion String
The Azure API version of the resource.
id String
Fully qualified resource ID for the resource. E.g. "/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>
A readonly collection of private endpoint connection. Currently only one endpoint connection is supported.
provisioningState String
Most recent provisioning state for the given privateAccess resource.
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"
publicNetworkAccess String
Public Network Access Control for PrivateAccess resource.
tags Map<String,String>
Resource tags.
azureApiVersion string
The Azure API version of the resource.
id string
Fully qualified resource ID for the resource. E.g. "/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[]
A readonly collection of private endpoint connection. Currently only one endpoint connection is supported.
provisioningState string
Most recent provisioning state for the given privateAccess resource.
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"
publicNetworkAccess string
Public Network Access Control for PrivateAccess resource.
tags {[key: string]: string}
Resource tags.
azure_api_version str
The Azure API version of the resource.
id str
Fully qualified resource ID for the resource. E.g. "/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]
A readonly collection of private endpoint connection. Currently only one endpoint connection is supported.
provisioning_state str
Most recent provisioning state for the given privateAccess resource.
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"
public_network_access str
Public Network Access Control for PrivateAccess resource.
tags Mapping[str, str]
Resource tags.
azureApiVersion String
The Azure API version of the resource.
id String
Fully qualified resource ID for the resource. E.g. "/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>
A readonly collection of private endpoint connection. Currently only one endpoint connection is supported.
provisioningState String
Most recent provisioning state for the given privateAccess resource.
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"
publicNetworkAccess String
Public Network Access Control for PrivateAccess resource.
tags Map<String>
Resource tags.

Supporting Types

PrivateEndpointConnectionResponse

GroupIds This property is required. List<string>
The group ids for the private endpoint resource.
Id This property is required. string
Fully qualified resource ID for the resource. E.g. "/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.Chaos.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.Chaos.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.Chaos.Inputs.PrivateEndpointResponse
The private endpoint resource.
GroupIds This property is required. []string
The group ids for the private endpoint resource.
Id This property is required. string
Fully qualified resource ID for the resource. E.g. "/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 private endpoint resource.
groupIds This property is required. List<String>
The group ids for the private endpoint resource.
id This property is required. String
Fully qualified resource ID for the resource. E.g. "/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 private endpoint resource.
groupIds This property is required. string[]
The group ids for the private endpoint resource.
id This property is required. string
Fully qualified resource ID for the resource. E.g. "/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 private endpoint resource.
group_ids This property is required. Sequence[str]
The group ids for the private endpoint resource.
id This property is required. str
Fully qualified resource ID for the resource. E.g. "/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 private endpoint resource.
groupIds This property is required. List<String>
The group ids for the private endpoint resource.
id This property is required. String
Fully qualified resource ID for the resource. E.g. "/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 private endpoint resource.

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.

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.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-azure-native