1. Packages
  2. Azure Native
  3. API Docs
  4. hybridcompute
  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.34.0 published on Thursday, Mar 28, 2024 by Pulumi

azure-native.hybridcompute.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.34.0 published on Thursday, Mar 28, 2024 by Pulumi

    Returns a Azure Arc PrivateLinkScope. Azure REST API version: 2022-12-27.

    Other available API versions: 2020-08-15-preview, 2023-06-20-preview, 2023-10-03-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:hybridcompute: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
    Azure resource Id
    Location string
    Resource location
    Name string
    Azure resource name
    Properties Pulumi.AzureNative.HybridCompute.Outputs.HybridComputePrivateLinkScopePropertiesResponse
    Properties that define a Azure Arc PrivateLinkScope resource.
    SystemData Pulumi.AzureNative.HybridCompute.Outputs.SystemDataResponse
    The system meta data relating to this resource.
    Type string
    Azure resource type
    Tags Dictionary<string, string>
    Resource tags
    Id string
    Azure resource Id
    Location string
    Resource location
    Name string
    Azure resource name
    Properties HybridComputePrivateLinkScopePropertiesResponse
    Properties that define a Azure Arc PrivateLinkScope resource.
    SystemData SystemDataResponse
    The system meta data relating to this resource.
    Type string
    Azure resource type
    Tags map[string]string
    Resource tags
    id String
    Azure resource Id
    location String
    Resource location
    name String
    Azure resource name
    properties HybridComputePrivateLinkScopePropertiesResponse
    Properties that define a Azure Arc PrivateLinkScope resource.
    systemData SystemDataResponse
    The system meta data relating to this resource.
    type String
    Azure resource type
    tags Map<String,String>
    Resource tags
    id string
    Azure resource Id
    location string
    Resource location
    name string
    Azure resource name
    properties HybridComputePrivateLinkScopePropertiesResponse
    Properties that define a Azure Arc PrivateLinkScope resource.
    systemData SystemDataResponse
    The system meta data relating to this resource.
    type string
    Azure resource type
    tags {[key: string]: string}
    Resource tags
    id str
    Azure resource Id
    location str
    Resource location
    name str
    Azure resource name
    properties HybridComputePrivateLinkScopePropertiesResponse
    Properties that define a Azure Arc PrivateLinkScope resource.
    system_data SystemDataResponse
    The system meta data relating to this resource.
    type str
    Azure resource type
    tags Mapping[str, str]
    Resource tags
    id String
    Azure resource Id
    location String
    Resource location
    name String
    Azure resource name
    properties Property Map
    Properties that define a Azure Arc PrivateLinkScope resource.
    systemData Property Map
    The system meta data relating to this resource.
    type String
    Azure resource type
    tags Map<String>
    Resource tags

    Supporting Types

    HybridComputePrivateLinkScopePropertiesResponse

    PrivateEndpointConnections List<Pulumi.AzureNative.HybridCompute.Inputs.PrivateEndpointConnectionDataModelResponse>
    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.
    PrivateEndpointConnections []PrivateEndpointConnectionDataModelResponse
    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.
    privateEndpointConnections List<PrivateEndpointConnectionDataModelResponse>
    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.
    privateEndpointConnections PrivateEndpointConnectionDataModelResponse[]
    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.
    private_endpoint_connections Sequence[PrivateEndpointConnectionDataModelResponse]
    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.
    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.

    PrivateEndpointConnectionDataModelResponse

    Id string
    The ARM Resource Id of the Private Endpoint.
    Name string
    The Name of the Private Endpoint.
    Type string
    Azure resource type
    Properties Pulumi.AzureNative.HybridCompute.Inputs.PrivateEndpointConnectionPropertiesResponse
    The Private Endpoint Connection properties.
    Id string
    The ARM Resource Id of the Private Endpoint.
    Name string
    The Name of the Private Endpoint.
    Type string
    Azure resource type
    Properties PrivateEndpointConnectionPropertiesResponse
    The Private Endpoint Connection properties.
    id String
    The ARM Resource Id of the Private Endpoint.
    name String
    The Name of the Private Endpoint.
    type String
    Azure resource type
    properties PrivateEndpointConnectionPropertiesResponse
    The Private Endpoint Connection properties.
    id string
    The ARM Resource Id of the Private Endpoint.
    name string
    The Name of the Private Endpoint.
    type string
    Azure resource type
    properties PrivateEndpointConnectionPropertiesResponse
    The Private Endpoint Connection properties.
    id str
    The ARM Resource Id of the Private Endpoint.
    name str
    The Name of the Private Endpoint.
    type str
    Azure resource type
    properties PrivateEndpointConnectionPropertiesResponse
    The Private Endpoint Connection properties.
    id String
    The ARM Resource Id of the Private Endpoint.
    name String
    The Name of the Private Endpoint.
    type String
    Azure resource type
    properties Property Map
    The Private Endpoint Connection properties.

    PrivateEndpointConnectionPropertiesResponse

    GroupIds List<string>
    List of group IDs.
    ProvisioningState string
    State of the private endpoint connection.
    PrivateEndpoint Pulumi.AzureNative.HybridCompute.Inputs.PrivateEndpointPropertyResponse
    Private endpoint which the connection belongs to.
    PrivateLinkServiceConnectionState Pulumi.AzureNative.HybridCompute.Inputs.PrivateLinkServiceConnectionStatePropertyResponse
    Connection state of the private endpoint connection.
    GroupIds []string
    List of group IDs.
    ProvisioningState string
    State of the private endpoint connection.
    PrivateEndpoint PrivateEndpointPropertyResponse
    Private endpoint which the connection belongs to.
    PrivateLinkServiceConnectionState PrivateLinkServiceConnectionStatePropertyResponse
    Connection state of the private endpoint connection.
    groupIds List<String>
    List of group IDs.
    provisioningState String
    State of the private endpoint connection.
    privateEndpoint PrivateEndpointPropertyResponse
    Private endpoint which the connection belongs to.
    privateLinkServiceConnectionState PrivateLinkServiceConnectionStatePropertyResponse
    Connection state of the private endpoint connection.
    groupIds string[]
    List of group IDs.
    provisioningState string
    State of the private endpoint connection.
    privateEndpoint PrivateEndpointPropertyResponse
    Private endpoint which the connection belongs to.
    privateLinkServiceConnectionState PrivateLinkServiceConnectionStatePropertyResponse
    Connection state of the private endpoint connection.
    group_ids Sequence[str]
    List of group IDs.
    provisioning_state str
    State of the private endpoint connection.
    private_endpoint PrivateEndpointPropertyResponse
    Private endpoint which the connection belongs to.
    private_link_service_connection_state PrivateLinkServiceConnectionStatePropertyResponse
    Connection state of the private endpoint connection.
    groupIds List<String>
    List of group IDs.
    provisioningState String
    State of the private endpoint connection.
    privateEndpoint Property Map
    Private endpoint which the connection belongs to.
    privateLinkServiceConnectionState Property Map
    Connection state of the private endpoint connection.

    PrivateEndpointPropertyResponse

    Id string
    Resource id of the private endpoint.
    Id string
    Resource id of the private endpoint.
    id String
    Resource id of the private endpoint.
    id string
    Resource id of the private endpoint.
    id str
    Resource id of the private endpoint.
    id String
    Resource id of the private endpoint.

    PrivateLinkServiceConnectionStatePropertyResponse

    ActionsRequired string
    The actions required for private link service connection.
    Description string
    The private link service connection description.
    Status string
    The private link service connection status.
    ActionsRequired string
    The actions required for private link service connection.
    Description string
    The private link service connection description.
    Status string
    The private link service connection status.
    actionsRequired String
    The actions required for private link service connection.
    description String
    The private link service connection description.
    status String
    The private link service connection status.
    actionsRequired string
    The actions required for private link service connection.
    description string
    The private link service connection description.
    status string
    The private link service connection status.
    actions_required str
    The actions required for private link service connection.
    description str
    The private link service connection description.
    status str
    The private link service connection status.
    actionsRequired String
    The actions required for private link service connection.
    description String
    The private link service connection description.
    status String
    The private link service connection status.

    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.34.0 published on Thursday, Mar 28, 2024 by Pulumi