Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. storagesync
  5. getRegisteredServer
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.storagesync.getRegisteredServer

Explore with Pulumi AI

azure-native logo
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 given registered server.

    Uses Azure REST API version 2022-09-01.

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

    Using getRegisteredServer

    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 getRegisteredServer(args: GetRegisteredServerArgs, opts?: InvokeOptions): Promise<GetRegisteredServerResult>
function getRegisteredServerOutput(args: GetRegisteredServerOutputArgs, opts?: InvokeOptions): Output<GetRegisteredServerResult>
    def get_registered_server(resource_group_name: Optional[str] = None,
                          server_id: Optional[str] = None,
                          storage_sync_service_name: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetRegisteredServerResult
def get_registered_server_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                          server_id: Optional[pulumi.Input[str]] = None,
                          storage_sync_service_name: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetRegisteredServerResult]
    func LookupRegisteredServer(ctx *Context, args *LookupRegisteredServerArgs, opts ...InvokeOption) (*LookupRegisteredServerResult, error)
func LookupRegisteredServerOutput(ctx *Context, args *LookupRegisteredServerOutputArgs, opts ...InvokeOption) LookupRegisteredServerResultOutput

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

    public static class GetRegisteredServer 
{
    public static Task<GetRegisteredServerResult> InvokeAsync(GetRegisteredServerArgs args, InvokeOptions? opts = null)
    public static Output<GetRegisteredServerResult> Invoke(GetRegisteredServerInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetRegisteredServerResult> getRegisteredServer(GetRegisteredServerArgs args, InvokeOptions options)
public static Output<GetRegisteredServerResult> getRegisteredServer(GetRegisteredServerArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:storagesync:getRegisteredServer
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ServerId string
    GUID identifying the on-premises server.
    StorageSyncServiceName string
    Name of Storage Sync Service resource.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    ServerId string
    GUID identifying the on-premises server.
    StorageSyncServiceName string
    Name of Storage Sync Service resource.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    serverId String
    GUID identifying the on-premises server.
    storageSyncServiceName String
    Name of Storage Sync Service resource.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    serverId string
    GUID identifying the on-premises server.
    storageSyncServiceName string
    Name of Storage Sync Service resource.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    server_id str
    GUID identifying the on-premises server.
    storage_sync_service_name str
    Name of Storage Sync Service resource.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    serverId String
    GUID identifying the on-premises server.
    storageSyncServiceName String
    Name of Storage Sync Service resource.

    getRegisteredServer Result

    The following output properties are available:

    ActiveAuthType string
    Server auth type.
    AgentVersionExpirationDate string
    Registered Server Agent Version Expiration Date
    AgentVersionStatus string
    Registered Server Agent Version Status
    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}"
    Identity bool
    Apply server with newly discovered ApplicationId if available.
    Name string
    The name of the resource
    ServerName string
    Server name
    SystemData Pulumi.AzureNative.StorageSync.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"
    AgentVersion string
    Registered Server Agent Version
    ApplicationId string
    Server Application Id
    ClusterId string
    Registered Server clusterId
    ClusterName string
    Registered Server clusterName
    DiscoveryEndpointUri string
    Resource discoveryEndpointUri
    FriendlyName string
    Friendly Name
    LastHeartBeat string
    Registered Server last heart beat
    LastOperationName string
    Resource Last Operation Name
    LastWorkflowId string
    Registered Server lastWorkflowId
    LatestApplicationId string
    Latest Server Application Id discovered from the server. It is not yet applied.
    ManagementEndpointUri string
    Management Endpoint Uri
    MonitoringConfiguration string
    Monitoring Configuration
    MonitoringEndpointUri string
    Telemetry Endpoint Uri
    ProvisioningState string
    Registered Server Provisioning State
    ResourceLocation string
    Resource Location
    ServerCertificate string
    Registered Server Certificate
    ServerId string
    Registered Server serverId
    ServerManagementErrorCode int
    Registered Server Management Error Code
    ServerOSVersion string
    Registered Server OS Version
    ServerRole string
    Registered Server serverRole
    ServiceLocation string
    Service Location
    StorageSyncServiceUid string
    Registered Server storageSyncServiceUid
    ActiveAuthType string
    Server auth type.
    AgentVersionExpirationDate string
    Registered Server Agent Version Expiration Date
    AgentVersionStatus string
    Registered Server Agent Version Status
    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}"
    Identity bool
    Apply server with newly discovered ApplicationId if available.
    Name string
    The name of the resource
    ServerName string
    Server name
    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"
    AgentVersion string
    Registered Server Agent Version
    ApplicationId string
    Server Application Id
    ClusterId string
    Registered Server clusterId
    ClusterName string
    Registered Server clusterName
    DiscoveryEndpointUri string
    Resource discoveryEndpointUri
    FriendlyName string
    Friendly Name
    LastHeartBeat string
    Registered Server last heart beat
    LastOperationName string
    Resource Last Operation Name
    LastWorkflowId string
    Registered Server lastWorkflowId
    LatestApplicationId string
    Latest Server Application Id discovered from the server. It is not yet applied.
    ManagementEndpointUri string
    Management Endpoint Uri
    MonitoringConfiguration string
    Monitoring Configuration
    MonitoringEndpointUri string
    Telemetry Endpoint Uri
    ProvisioningState string
    Registered Server Provisioning State
    ResourceLocation string
    Resource Location
    ServerCertificate string
    Registered Server Certificate
    ServerId string
    Registered Server serverId
    ServerManagementErrorCode int
    Registered Server Management Error Code
    ServerOSVersion string
    Registered Server OS Version
    ServerRole string
    Registered Server serverRole
    ServiceLocation string
    Service Location
    StorageSyncServiceUid string
    Registered Server storageSyncServiceUid
    activeAuthType String
    Server auth type.
    agentVersionExpirationDate String
    Registered Server Agent Version Expiration Date
    agentVersionStatus String
    Registered Server Agent Version Status
    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}"
    identity Boolean
    Apply server with newly discovered ApplicationId if available.
    name String
    The name of the resource
    serverName String
    Server name
    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"
    agentVersion String
    Registered Server Agent Version
    applicationId String
    Server Application Id
    clusterId String
    Registered Server clusterId
    clusterName String
    Registered Server clusterName
    discoveryEndpointUri String
    Resource discoveryEndpointUri
    friendlyName String
    Friendly Name
    lastHeartBeat String
    Registered Server last heart beat
    lastOperationName String
    Resource Last Operation Name
    lastWorkflowId String
    Registered Server lastWorkflowId
    latestApplicationId String
    Latest Server Application Id discovered from the server. It is not yet applied.
    managementEndpointUri String
    Management Endpoint Uri
    monitoringConfiguration String
    Monitoring Configuration
    monitoringEndpointUri String
    Telemetry Endpoint Uri
    provisioningState String
    Registered Server Provisioning State
    resourceLocation String
    Resource Location
    serverCertificate String
    Registered Server Certificate
    serverId String
    Registered Server serverId
    serverManagementErrorCode Integer
    Registered Server Management Error Code
    serverOSVersion String
    Registered Server OS Version
    serverRole String
    Registered Server serverRole
    serviceLocation String
    Service Location
    storageSyncServiceUid String
    Registered Server storageSyncServiceUid
    activeAuthType string
    Server auth type.
    agentVersionExpirationDate string
    Registered Server Agent Version Expiration Date
    agentVersionStatus string
    Registered Server Agent Version Status
    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}"
    identity boolean
    Apply server with newly discovered ApplicationId if available.
    name string
    The name of the resource
    serverName string
    Server name
    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"
    agentVersion string
    Registered Server Agent Version
    applicationId string
    Server Application Id
    clusterId string
    Registered Server clusterId
    clusterName string
    Registered Server clusterName
    discoveryEndpointUri string
    Resource discoveryEndpointUri
    friendlyName string
    Friendly Name
    lastHeartBeat string
    Registered Server last heart beat
    lastOperationName string
    Resource Last Operation Name
    lastWorkflowId string
    Registered Server lastWorkflowId
    latestApplicationId string
    Latest Server Application Id discovered from the server. It is not yet applied.
    managementEndpointUri string
    Management Endpoint Uri
    monitoringConfiguration string
    Monitoring Configuration
    monitoringEndpointUri string
    Telemetry Endpoint Uri
    provisioningState string
    Registered Server Provisioning State
    resourceLocation string
    Resource Location
    serverCertificate string
    Registered Server Certificate
    serverId string
    Registered Server serverId
    serverManagementErrorCode number
    Registered Server Management Error Code
    serverOSVersion string
    Registered Server OS Version
    serverRole string
    Registered Server serverRole
    serviceLocation string
    Service Location
    storageSyncServiceUid string
    Registered Server storageSyncServiceUid
    active_auth_type str
    Server auth type.
    agent_version_expiration_date str
    Registered Server Agent Version Expiration Date
    agent_version_status str
    Registered Server Agent Version Status
    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}"
    identity bool
    Apply server with newly discovered ApplicationId if available.
    name str
    The name of the resource
    server_name str
    Server name
    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"
    agent_version str
    Registered Server Agent Version
    application_id str
    Server Application Id
    cluster_id str
    Registered Server clusterId
    cluster_name str
    Registered Server clusterName
    discovery_endpoint_uri str
    Resource discoveryEndpointUri
    friendly_name str
    Friendly Name
    last_heart_beat str
    Registered Server last heart beat
    last_operation_name str
    Resource Last Operation Name
    last_workflow_id str
    Registered Server lastWorkflowId
    latest_application_id str
    Latest Server Application Id discovered from the server. It is not yet applied.
    management_endpoint_uri str
    Management Endpoint Uri
    monitoring_configuration str
    Monitoring Configuration
    monitoring_endpoint_uri str
    Telemetry Endpoint Uri
    provisioning_state str
    Registered Server Provisioning State
    resource_location str
    Resource Location
    server_certificate str
    Registered Server Certificate
    server_id str
    Registered Server serverId
    server_management_error_code int
    Registered Server Management Error Code
    server_os_version str
    Registered Server OS Version
    server_role str
    Registered Server serverRole
    service_location str
    Service Location
    storage_sync_service_uid str
    Registered Server storageSyncServiceUid
    activeAuthType String
    Server auth type.
    agentVersionExpirationDate String
    Registered Server Agent Version Expiration Date
    agentVersionStatus String
    Registered Server Agent Version Status
    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}"
    identity Boolean
    Apply server with newly discovered ApplicationId if available.
    name String
    The name of the resource
    serverName String
    Server name
    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"
    agentVersion String
    Registered Server Agent Version
    applicationId String
    Server Application Id
    clusterId String
    Registered Server clusterId
    clusterName String
    Registered Server clusterName
    discoveryEndpointUri String
    Resource discoveryEndpointUri
    friendlyName String
    Friendly Name
    lastHeartBeat String
    Registered Server last heart beat
    lastOperationName String
    Resource Last Operation Name
    lastWorkflowId String
    Registered Server lastWorkflowId
    latestApplicationId String
    Latest Server Application Id discovered from the server. It is not yet applied.
    managementEndpointUri String
    Management Endpoint Uri
    monitoringConfiguration String
    Monitoring Configuration
    monitoringEndpointUri String
    Telemetry Endpoint Uri
    provisioningState String
    Registered Server Provisioning State
    resourceLocation String
    Resource Location
    serverCertificate String
    Registered Server Certificate
    serverId String
    Registered Server serverId
    serverManagementErrorCode Number
    Registered Server Management Error Code
    serverOSVersion String
    Registered Server OS Version
    serverRole String
    Registered Server serverRole
    serviceLocation String
    Service Location
    storageSyncServiceUid String
    Registered Server storageSyncServiceUid

    Supporting Types

    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 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