Clarifications regarding Azure Storage Sync Service documentation

Appmanager Zohocorp 41 Reputation points
2024-04-12T06:00:53.7533333+00:00

Hi,

I'm trying to retrieve metadata about Azure Storage Sync Service /Azure File Sync using the REST API. While fetching data using the respective namespace 'Microsoft.StorageSync/storageSyncServices' got some properties like provisioningState, storageSyncServiceStatus, incomingTrafficPolicy, lastWorkflowId, lastOperationName, etc. I couldn't locate any documentation that describes these meta data in detail.

  1. Can you please point me to the relevant documentation for the available metrics exposed through the REST API for Azure Storage Sync Service/Azure File Sync?
  2. While fetching meta data through REST API one of the above mentioned meta data metric 'properties.storageSyncServiceStatus' provided the value as 0. So got an confusion whether 'properties.storageSyncServiceStatus' meta data and Azure Monitor metric: Server Online Status or Sync Session Result (provides value as 0/1) mentioned in this documentation under namespace: 'Microsoft.StorageSync/storageSyncServices' is related?
Azure Files
Azure Files
An Azure service that offers file shares in the cloud.
1,166 questions
0 comments

1 answer

Sort by: Most helpful
Most helpful Newest Oldest
  1. Nehruji R 1,896 Reputation points Microsoft Vendor
    2024-04-15T06:59:19.8633333+00:00

    Hello Appmanager Zohocorp,

    Greetings! Welcome to Microsoft Q&A Platform.

    Azure Storage Sync Service provides several metrics that allow you to monitor and analyze its performance and health. These metrics cover various aspects of the service, including sync sessions, server status, and more.

    Metadata Properties: When interacting with Azure Storage Sync Service via the REST API, you’ll encounter several metadata properties.

    Provisioning State: This property indicates the current provisioning state of the storage sync service. It reflects whether the service is being created, updated, or deleted.

    StorageSyncServiceStatus: This property provides information about the overall status of the storage sync service. It can indicate whether the service is healthy, syncing data, or encountering issues.

    IncomingTrafficPolicy: This property defines how incoming traffic (data synchronization) is handled. It may include settings related to bandwidth throttling, prioritization, or other traffic management rules.

    LastWorkflowId: Represents an identifier for the last workflow executed within the service. Workflows could be related to sync operations, configuration changes, or other administrative tasks.

    LastOperationName: Indicates the name of the most recent operation performed on the storage sync service. This could be a sync operation, service configuration change, or other administrative action.

    refer - https://learn.microsoft.com/en-us/azure/storage/file-sync/, https://learn.microsoft.com/en-us/azure/storage/file-sync/file-sync-planning, https://learn.microsoft.com/en-us/azure/azure-monitor/reference/supported-metrics/microsoft-storagesync-storagesyncservices-metrics

    To access these metrics programmatically via the REST API, you can use the FileREST API provided by Azure Files. The FileREST API allows you to perform operations that are specific to Azure Files and provides features not available over SMB or NFS.

    You can create HTTPS requests against the FileREST HTTPS endpoints to retrieve metrics data.

    The properties.storageSyncServiceStatus metadata you encountered likely corresponds to the overall status of the Azure Storage Sync Service. It provides information about whether the service is healthy, syncing data, or encountering issues. The value of 0 you observed could indicate a specific state (e.g., healthy or online) based on the context of your query.

    The Azure Monitor metrics for Azure Storage Sync Service are related to monitoring and tracking its behavior.

    Specifically, the Server Online Status and Sync Session Result metrics are relevant: Server Online Status: This metric typically provides binary values (0 or 1) to indicate whether the server is online (1) or not (0).

    Sync Session Result: This metric may also provide binary values (0 or 1) to indicate the success (1) or failure (0) of sync sessions.

    These metrics are part of the Microsoft.StorageSync/storageSyncServices namespace and can be accessed via the Azure Monitor REST API.

    refer - https://learn.microsoft.com/en-us/rest/api/storageservices/file-service-rest-api for detailed guidance.

    Hope this answer helps! Please let us know if you have any further queries. I’m happy to assist you further.

    Please "Accept the answer” and “up-vote” wherever the information provided helps you, this can be beneficial to other community members.