Docs Packages
  1. Packages
  2. Azure Native
  3. API Docs
  4. kubernetesconfiguration
  5. getPrivateLinkScope
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.37.0 published on Monday, Apr 15, 2024 by Pulumi
pulumi/pulumi-azure-native

azure-native.kubernetesconfiguration.getPrivateLinkScope

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.37.0 published on Monday, Apr 15, 2024 by Pulumi
pulumi/pulumi-azure-native

    Returns a Azure Arc PrivateLinkScope. Azure REST API version: 2022-04-02-preview.

    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.

    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)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: azure-native:kubernetesconfiguration: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 Arc PrivateLinkScope resource.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ScopeName string
    The name of the Azure Arc PrivateLinkScope resource.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    scopeName String
    The name of the Azure Arc PrivateLinkScope resource.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    scopeName string
    The name of the Azure Arc 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 Arc PrivateLinkScope resource.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    scopeName String
    The name of the Azure Arc PrivateLinkScope resource.

    getPrivateLinkScope Result

    The following output properties are available:

    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
    Properties Pulumi.AzureNative.KubernetesConfiguration.Outputs.KubernetesConfigurationPrivateLinkScopePropertiesResponse
    Properties that define a Azure Arc PrivateLinkScope resource.
    SystemData Pulumi.AzureNative.KubernetesConfiguration.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"
    Tags Dictionary<string, string>
    Resource tags.
    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
    Properties KubernetesConfigurationPrivateLinkScopePropertiesResponse
    Properties that define a Azure Arc PrivateLinkScope 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"
    Tags map[string]string
    Resource tags.
    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
    properties KubernetesConfigurationPrivateLinkScopePropertiesResponse
    Properties that define a Azure Arc PrivateLinkScope 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"
    tags Map<String,String>
    Resource tags.
    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
    properties KubernetesConfigurationPrivateLinkScopePropertiesResponse
    Properties that define a Azure Arc PrivateLinkScope 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"
    tags {[key: string]: string}
    Resource tags.
    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
    properties KubernetesConfigurationPrivateLinkScopePropertiesResponse
    Properties that define a Azure Arc PrivateLinkScope 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"
    tags Mapping[str, str]
    Resource tags.
    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
    properties Property Map
    Properties that define a Azure Arc PrivateLinkScope 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"
    tags Map<String>
    Resource tags.

    Supporting Types

    KubernetesConfigurationPrivateLinkScopePropertiesResponse

    ClusterResourceId string
    Managed Cluster ARM ID for the private link scope (Required)
    PrivateEndpointConnections List<Pulumi.AzureNative.KubernetesConfiguration.Inputs.PrivateEndpointConnectionResponse>
    The collection of associated Private Endpoint Connections.
    PrivateLinkScopeId string
    The Guid id of the private link scope.
    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. Values will include Provisioning ,Succeeded, Canceled and Failed.
    PublicNetworkAccess string
    Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints.
    ClusterResourceId string
    Managed Cluster ARM ID for the private link scope (Required)
    PrivateEndpointConnections []PrivateEndpointConnectionResponse
    The collection of associated Private Endpoint Connections.
    PrivateLinkScopeId string
    The Guid id of the private link scope.
    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. Values will include Provisioning ,Succeeded, Canceled and Failed.
    PublicNetworkAccess string
    Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints.
    clusterResourceId String
    Managed Cluster ARM ID for the private link scope (Required)
    privateEndpointConnections List<PrivateEndpointConnectionResponse>
    The collection of associated Private Endpoint Connections.
    privateLinkScopeId String
    The Guid id of the private link scope.
    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. Values will include Provisioning ,Succeeded, Canceled and Failed.
    publicNetworkAccess String
    Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints.
    clusterResourceId string
    Managed Cluster ARM ID for the private link scope (Required)
    privateEndpointConnections PrivateEndpointConnectionResponse[]
    The collection of associated Private Endpoint Connections.
    privateLinkScopeId string
    The Guid id of the private link scope.
    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. Values will include Provisioning ,Succeeded, Canceled and Failed.
    publicNetworkAccess string
    Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints.
    cluster_resource_id str
    Managed Cluster ARM ID for the private link scope (Required)
    private_endpoint_connections Sequence[PrivateEndpointConnectionResponse]
    The collection of associated Private Endpoint Connections.
    private_link_scope_id str
    The Guid id of the private link scope.
    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. Values will include Provisioning ,Succeeded, Canceled and Failed.
    public_network_access str
    Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints.
    clusterResourceId String
    Managed Cluster ARM ID for the private link scope (Required)
    privateEndpointConnections List<Property Map>
    The collection of associated Private Endpoint Connections.
    privateLinkScopeId String
    The Guid id of the private link scope.
    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. Values will include Provisioning ,Succeeded, Canceled and Failed.
    publicNetworkAccess String
    Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints.

    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.KubernetesConfiguration.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.
    SystemData Pulumi.AzureNative.KubernetesConfiguration.Inputs.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"
    PrivateEndpoint Pulumi.AzureNative.KubernetesConfiguration.Inputs.PrivateEndpointResponse
    The resource of private end point.
    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.
    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"
    PrivateEndpoint PrivateEndpointResponse
    The resource of private end point.
    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.
    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"
    privateEndpoint PrivateEndpointResponse
    The resource of private end point.
    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.
    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"
    privateEndpoint PrivateEndpointResponse
    The resource of private end point.
    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.
    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"
    private_endpoint PrivateEndpointResponse
    The resource of private end point.
    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.
    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"
    privateEndpoint Property Map
    The resource of private end point.

    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
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.37.0 published on Monday, Apr 15, 2024 by Pulumi
    pulumi/pulumi-azure-native