1. Packages
  2. Azure Native
  3. API Docs
  4. hybridconnectivity
  5. listEndpointCredentials
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.hybridconnectivity.listEndpointCredentials

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

Gets the endpoint access credentials to the resource.

Uses Azure REST API version 2024-12-01.

Other available API versions: 2023-03-15. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native hybridconnectivity [ApiVersion]. See the version guide for details.

Using listEndpointCredentials

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 listEndpointCredentials(args: ListEndpointCredentialsArgs, opts?: InvokeOptions): Promise<ListEndpointCredentialsResult>
function listEndpointCredentialsOutput(args: ListEndpointCredentialsOutputArgs, opts?: InvokeOptions): Output<ListEndpointCredentialsResult>
Copy
def list_endpoint_credentials(endpoint_name: Optional[str] = None,
                              expiresin: Optional[int] = None,
                              resource_uri: Optional[str] = None,
                              service_name: Optional[Union[str, ServiceName]] = None,
                              opts: Optional[InvokeOptions] = None) -> ListEndpointCredentialsResult
def list_endpoint_credentials_output(endpoint_name: Optional[pulumi.Input[str]] = None,
                              expiresin: Optional[pulumi.Input[int]] = None,
                              resource_uri: Optional[pulumi.Input[str]] = None,
                              service_name: Optional[pulumi.Input[Union[str, ServiceName]]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[ListEndpointCredentialsResult]
Copy
func ListEndpointCredentials(ctx *Context, args *ListEndpointCredentialsArgs, opts ...InvokeOption) (*ListEndpointCredentialsResult, error)
func ListEndpointCredentialsOutput(ctx *Context, args *ListEndpointCredentialsOutputArgs, opts ...InvokeOption) ListEndpointCredentialsResultOutput
Copy

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

public static class ListEndpointCredentials 
{
    public static Task<ListEndpointCredentialsResult> InvokeAsync(ListEndpointCredentialsArgs args, InvokeOptions? opts = null)
    public static Output<ListEndpointCredentialsResult> Invoke(ListEndpointCredentialsInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<ListEndpointCredentialsResult> listEndpointCredentials(ListEndpointCredentialsArgs args, InvokeOptions options)
public static Output<ListEndpointCredentialsResult> listEndpointCredentials(ListEndpointCredentialsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:hybridconnectivity:listEndpointCredentials
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

EndpointName
This property is required.
Changes to this property will trigger replacement.
string
The endpoint name.
ResourceUri
This property is required.
Changes to this property will trigger replacement.
string
The fully qualified Azure Resource manager identifier of the resource.
Expiresin int
The is how long the endpoint access token is valid (in seconds).
ServiceName string | Pulumi.AzureNative.HybridConnectivity.ServiceName
The name of the service. If not provided, the request will by pass the generation of service configuration token
EndpointName
This property is required.
Changes to this property will trigger replacement.
string
The endpoint name.
ResourceUri
This property is required.
Changes to this property will trigger replacement.
string
The fully qualified Azure Resource manager identifier of the resource.
Expiresin int
The is how long the endpoint access token is valid (in seconds).
ServiceName string | ServiceName
The name of the service. If not provided, the request will by pass the generation of service configuration token
endpointName
This property is required.
Changes to this property will trigger replacement.
String
The endpoint name.
resourceUri
This property is required.
Changes to this property will trigger replacement.
String
The fully qualified Azure Resource manager identifier of the resource.
expiresin Integer
The is how long the endpoint access token is valid (in seconds).
serviceName String | ServiceName
The name of the service. If not provided, the request will by pass the generation of service configuration token
endpointName
This property is required.
Changes to this property will trigger replacement.
string
The endpoint name.
resourceUri
This property is required.
Changes to this property will trigger replacement.
string
The fully qualified Azure Resource manager identifier of the resource.
expiresin number
The is how long the endpoint access token is valid (in seconds).
serviceName string | ServiceName
The name of the service. If not provided, the request will by pass the generation of service configuration token
endpoint_name
This property is required.
Changes to this property will trigger replacement.
str
The endpoint name.
resource_uri
This property is required.
Changes to this property will trigger replacement.
str
The fully qualified Azure Resource manager identifier of the resource.
expiresin int
The is how long the endpoint access token is valid (in seconds).
service_name str | ServiceName
The name of the service. If not provided, the request will by pass the generation of service configuration token
endpointName
This property is required.
Changes to this property will trigger replacement.
String
The endpoint name.
resourceUri
This property is required.
Changes to this property will trigger replacement.
String
The fully qualified Azure Resource manager identifier of the resource.
expiresin Number
The is how long the endpoint access token is valid (in seconds).
serviceName String | "SSH" | "WAC"
The name of the service. If not provided, the request will by pass the generation of service configuration token

listEndpointCredentials Result

The following output properties are available:

AccessKey string
Access key for hybrid connection.
HybridConnectionName string
Azure Relay hybrid connection name for the resource.
NamespaceName string
The namespace name.
NamespaceNameSuffix string
The suffix domain name of relay namespace.
ExpiresOn double
The expiration of access key in unix time.
ServiceConfigurationToken string
The token to access the enabled service.
AccessKey string
Access key for hybrid connection.
HybridConnectionName string
Azure Relay hybrid connection name for the resource.
NamespaceName string
The namespace name.
NamespaceNameSuffix string
The suffix domain name of relay namespace.
ExpiresOn float64
The expiration of access key in unix time.
ServiceConfigurationToken string
The token to access the enabled service.
accessKey String
Access key for hybrid connection.
hybridConnectionName String
Azure Relay hybrid connection name for the resource.
namespaceName String
The namespace name.
namespaceNameSuffix String
The suffix domain name of relay namespace.
expiresOn Double
The expiration of access key in unix time.
serviceConfigurationToken String
The token to access the enabled service.
accessKey string
Access key for hybrid connection.
hybridConnectionName string
Azure Relay hybrid connection name for the resource.
namespaceName string
The namespace name.
namespaceNameSuffix string
The suffix domain name of relay namespace.
expiresOn number
The expiration of access key in unix time.
serviceConfigurationToken string
The token to access the enabled service.
access_key str
Access key for hybrid connection.
hybrid_connection_name str
Azure Relay hybrid connection name for the resource.
namespace_name str
The namespace name.
namespace_name_suffix str
The suffix domain name of relay namespace.
expires_on float
The expiration of access key in unix time.
service_configuration_token str
The token to access the enabled service.
accessKey String
Access key for hybrid connection.
hybridConnectionName String
Azure Relay hybrid connection name for the resource.
namespaceName String
The namespace name.
namespaceNameSuffix String
The suffix domain name of relay namespace.
expiresOn Number
The expiration of access key in unix time.
serviceConfigurationToken String
The token to access the enabled service.

Supporting Types

ServiceName

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