Azure Native v3.2.0, Apr 14 25

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

azure-native.monitor.getPrivateLinkScope

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

Using getPrivateLinkScope

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.

TypeScript
Python
Go
C#
Java
YAML

function getPrivateLinkScope(args: GetPrivateLinkScopeArgs, opts?: InvokeOptions): Promise<GetPrivateLinkScopeResult>
function getPrivateLinkScopeOutput(args: GetPrivateLinkScopeOutputArgs, opts?: InvokeOptions): Output<GetPrivateLinkScopeResult>

def get_private_link_scope(resource_group_name: Optional[str] = None,
                           scope_name: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetPrivateLinkScopeResult
def get_private_link_scope_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                           scope_name: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetPrivateLinkScopeResult]

func LookupPrivateLinkScope(ctx *Context, args *LookupPrivateLinkScopeArgs, opts ...InvokeOption) (*LookupPrivateLinkScopeResult, error)
func LookupPrivateLinkScopeOutput(ctx *Context, args *LookupPrivateLinkScopeOutputArgs, opts ...InvokeOption) LookupPrivateLinkScopeResultOutput

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

public static class GetPrivateLinkScope 
{
    public static Task<GetPrivateLinkScopeResult> InvokeAsync(GetPrivateLinkScopeArgs args, InvokeOptions? opts = null)
    public static Output<GetPrivateLinkScopeResult> Invoke(GetPrivateLinkScopeInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetPrivateLinkScopeResult> getPrivateLinkScope(GetPrivateLinkScopeArgs args, InvokeOptions options)
public static Output<GetPrivateLinkScopeResult> getPrivateLinkScope(GetPrivateLinkScopeArgs args, InvokeOptions options)

fn::invoke:
  function: azure-native:monitor:getPrivateLinkScope
  arguments:
    # arguments dictionary

The following arguments are supported:

ResourceGroupName string: The name of the resource group. The name is case insensitive.
ScopeName string: The name of the Azure Monitor PrivateLinkScope resource.

ResourceGroupName string: The name of the resource group. The name is case insensitive.
ScopeName string: The name of the Azure Monitor PrivateLinkScope resource.

resourceGroupName String: The name of the resource group. The name is case insensitive.
scopeName String: The name of the Azure Monitor PrivateLinkScope resource.

resourceGroupName string: The name of the resource group. The name is case insensitive.
scopeName string: The name of the Azure Monitor PrivateLinkScope resource.

resource_group_name str: The name of the resource group. The name is case insensitive.
scope_name str: The name of the Azure Monitor PrivateLinkScope resource.

resourceGroupName String: The name of the resource group. The name is case insensitive.
scopeName String: The name of the Azure Monitor PrivateLinkScope resource.

getPrivateLinkScope Result

The following output properties are available:

AccessModeSettings Pulumi.AzureNative.Monitor.Outputs.AccessModeSettingsResponse: Access mode settings
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}
Location string: The geo-location where the resource lives
Name string: The name of the resource
PrivateEndpointConnections List<Pulumi.AzureNative.Monitor.Outputs.PrivateEndpointConnectionResponse>: List of private endpoint connections.
ProvisioningState string: Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it.
SystemData Pulumi.AzureNative.Monitor.Outputs.SystemDataResponse: System data
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Tags Dictionary<string, string>: Resource tags.

AccessModeSettings AccessModeSettingsResponse: Access mode settings
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}
Location string: The geo-location where the resource lives
Name string: The name of the resource
PrivateEndpointConnections []PrivateEndpointConnectionResponse: List of private endpoint connections.
ProvisioningState string: Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it.
SystemData SystemDataResponse: System data
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Tags map[string]string: Resource tags.

accessModeSettings AccessModeSettingsResponse: Access mode settings
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}
location String: The geo-location where the resource lives
name String: The name of the resource
privateEndpointConnections List<PrivateEndpointConnectionResponse>: List of private endpoint connections.
provisioningState String: Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it.
systemData SystemDataResponse: System data
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
tags Map<String,String>: Resource tags.

accessModeSettings AccessModeSettingsResponse: Access mode settings
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}
location string: The geo-location where the resource lives
name string: The name of the resource
privateEndpointConnections PrivateEndpointConnectionResponse[]: List of private endpoint connections.
provisioningState string: Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it.
systemData SystemDataResponse: System data
type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
tags {[key: string]: string}: Resource tags.

access_mode_settings AccessModeSettingsResponse: Access mode settings
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}
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.
provisioning_state str: Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it.
system_data SystemDataResponse: System data
type str: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
tags Mapping[str, str]: Resource tags.

accessModeSettings Property Map: Access mode settings
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}
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.
provisioningState String: Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it.
systemData Property Map: System data
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
tags Map<String>: Resource tags.

Supporting Types

AccessModeSettingsExclusionResponse

IngestionAccessMode string: Specifies the access mode of ingestion through the specified private endpoint connection in the exclusion.
PrivateEndpointConnectionName string: The private endpoint connection name associated to the private endpoint on which we want to apply the specific access mode settings.
QueryAccessMode string: Specifies the access mode of queries through the specified private endpoint connection in the exclusion.

IngestionAccessMode string: Specifies the access mode of ingestion through the specified private endpoint connection in the exclusion.
PrivateEndpointConnectionName string: The private endpoint connection name associated to the private endpoint on which we want to apply the specific access mode settings.
QueryAccessMode string: Specifies the access mode of queries through the specified private endpoint connection in the exclusion.

ingestionAccessMode String: Specifies the access mode of ingestion through the specified private endpoint connection in the exclusion.
privateEndpointConnectionName String: The private endpoint connection name associated to the private endpoint on which we want to apply the specific access mode settings.
queryAccessMode String: Specifies the access mode of queries through the specified private endpoint connection in the exclusion.

ingestionAccessMode string: Specifies the access mode of ingestion through the specified private endpoint connection in the exclusion.
privateEndpointConnectionName string: The private endpoint connection name associated to the private endpoint on which we want to apply the specific access mode settings.
queryAccessMode string: Specifies the access mode of queries through the specified private endpoint connection in the exclusion.

ingestion_access_mode str: Specifies the access mode of ingestion through the specified private endpoint connection in the exclusion.
private_endpoint_connection_name str: The private endpoint connection name associated to the private endpoint on which we want to apply the specific access mode settings.
query_access_mode str: Specifies the access mode of queries through the specified private endpoint connection in the exclusion.

ingestionAccessMode String: Specifies the access mode of ingestion through the specified private endpoint connection in the exclusion.
privateEndpointConnectionName String: The private endpoint connection name associated to the private endpoint on which we want to apply the specific access mode settings.
queryAccessMode String: Specifies the access mode of queries through the specified private endpoint connection in the exclusion.

AccessModeSettingsResponse

IngestionAccessMode string: Specifies the default access mode of ingestion through associated private endpoints in scope. If not specified default value is 'Open'. You can override this default setting for a specific private endpoint connection by adding an exclusion in the 'exclusions' array.
QueryAccessMode string: Specifies the default access mode of queries through associated private endpoints in scope. If not specified default value is 'Open'. You can override this default setting for a specific private endpoint connection by adding an exclusion in the 'exclusions' array.
Exclusions List<Pulumi.AzureNative.Monitor.Inputs.AccessModeSettingsExclusionResponse>: List of exclusions that override the default access mode settings for specific private endpoint connections.

IngestionAccessMode string: Specifies the default access mode of ingestion through associated private endpoints in scope. If not specified default value is 'Open'. You can override this default setting for a specific private endpoint connection by adding an exclusion in the 'exclusions' array.
QueryAccessMode string: Specifies the default access mode of queries through associated private endpoints in scope. If not specified default value is 'Open'. You can override this default setting for a specific private endpoint connection by adding an exclusion in the 'exclusions' array.
Exclusions []AccessModeSettingsExclusionResponse: List of exclusions that override the default access mode settings for specific private endpoint connections.

ingestionAccessMode String: Specifies the default access mode of ingestion through associated private endpoints in scope. If not specified default value is 'Open'. You can override this default setting for a specific private endpoint connection by adding an exclusion in the 'exclusions' array.
queryAccessMode String: Specifies the default access mode of queries through associated private endpoints in scope. If not specified default value is 'Open'. You can override this default setting for a specific private endpoint connection by adding an exclusion in the 'exclusions' array.
exclusions List<AccessModeSettingsExclusionResponse>: List of exclusions that override the default access mode settings for specific private endpoint connections.

ingestionAccessMode string: Specifies the default access mode of ingestion through associated private endpoints in scope. If not specified default value is 'Open'. You can override this default setting for a specific private endpoint connection by adding an exclusion in the 'exclusions' array.
queryAccessMode string: Specifies the default access mode of queries through associated private endpoints in scope. If not specified default value is 'Open'. You can override this default setting for a specific private endpoint connection by adding an exclusion in the 'exclusions' array.
exclusions AccessModeSettingsExclusionResponse[]: List of exclusions that override the default access mode settings for specific private endpoint connections.

ingestion_access_mode str: Specifies the default access mode of ingestion through associated private endpoints in scope. If not specified default value is 'Open'. You can override this default setting for a specific private endpoint connection by adding an exclusion in the 'exclusions' array.
query_access_mode str: Specifies the default access mode of queries through associated private endpoints in scope. If not specified default value is 'Open'. You can override this default setting for a specific private endpoint connection by adding an exclusion in the 'exclusions' array.
exclusions Sequence[AccessModeSettingsExclusionResponse]: List of exclusions that override the default access mode settings for specific private endpoint connections.

ingestionAccessMode String: Specifies the default access mode of ingestion through associated private endpoints in scope. If not specified default value is 'Open'. You can override this default setting for a specific private endpoint connection by adding an exclusion in the 'exclusions' array.
queryAccessMode String: Specifies the default access mode of queries through associated private endpoints in scope. If not specified default value is 'Open'. You can override this default setting for a specific private endpoint connection by adding an exclusion in the 'exclusions' array.
exclusions List<Property Map>: List of exclusions that override the default access mode settings for specific private endpoint connections.

PrivateEndpointConnectionResponse

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
PrivateLinkServiceConnectionState Pulumi.AzureNative.Monitor.Inputs.PrivateLinkServiceConnectionStateResponse: A collection of information about the state of the connection between service consumer and provider.
ProvisioningState string: The provisioning state of the private endpoint connection resource.
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
GroupIds List<string>: The group ids for the private endpoint resource.
PrivateEndpoint Pulumi.AzureNative.Monitor.Inputs.PrivateEndpointResponse: The resource of private end point.
SystemData Pulumi.AzureNative.Monitor.Inputs.SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.

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
PrivateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse: A collection of information about the state of the connection between service consumer and provider.
ProvisioningState string: The provisioning state of the private endpoint connection resource.
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
GroupIds []string: The group ids for the private endpoint resource.
PrivateEndpoint PrivateEndpointResponse: The resource of private end point.
SystemData SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.

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
privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse: A collection of information about the state of the connection between service consumer and provider.
provisioningState String: The provisioning state of the private endpoint connection resource.
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
groupIds List<String>: The group ids for the private endpoint resource.
privateEndpoint PrivateEndpointResponse: The resource of private end point.
systemData SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.

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
privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse: A collection of information about the state of the connection between service consumer and provider.
provisioningState string: The provisioning state of the private endpoint connection resource.
type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
groupIds string[]: The group ids for the private endpoint resource.
privateEndpoint PrivateEndpointResponse: The resource of private end point.
systemData SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.

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
private_link_service_connection_state PrivateLinkServiceConnectionStateResponse: A collection of information about the state of the connection between service consumer and provider.
provisioning_state str: The provisioning state of the private endpoint connection resource.
type str: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
group_ids Sequence[str]: The group ids for the private endpoint resource.
private_endpoint PrivateEndpointResponse: The resource of private end point.
system_data SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.

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
privateLinkServiceConnectionState Property Map: A collection of information about the state of the connection between service consumer and provider.
provisioningState String: The provisioning state of the private endpoint connection resource.
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
groupIds List<String>: The group ids for the private endpoint resource.
privateEndpoint Property Map: The resource of private end point.
systemData Property Map: Azure Resource Manager metadata containing createdBy and modifiedBy information.

PrivateEndpointResponse

Id string: The ARM identifier for Private Endpoint

Id string: The ARM identifier for Private Endpoint

id String: The ARM identifier for Private Endpoint

id string: The ARM identifier for Private Endpoint

id str: The ARM identifier for Private Endpoint

id 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

azure-native.monitor.getPrivateLinkScope

On this page

On this page

Using getPrivateLinkScope

getPrivateLinkScope Result

Supporting Types

AccessModeSettingsExclusionResponse

AccessModeSettingsResponse

PrivateEndpointConnectionResponse

PrivateEndpointResponse

PrivateLinkServiceConnectionStateResponse

SystemDataResponse

Package Details

On this page

On this page