1. Packages
  2. Azure Native
  3. API Docs
  4. storagesync
  5. getCloudEndpoint
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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

azure-native.storagesync.getCloudEndpoint

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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

Get a given CloudEndpoint.

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 getCloudEndpoint

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 getCloudEndpoint(args: GetCloudEndpointArgs, opts?: InvokeOptions): Promise<GetCloudEndpointResult>
function getCloudEndpointOutput(args: GetCloudEndpointOutputArgs, opts?: InvokeOptions): Output<GetCloudEndpointResult>
Copy
def get_cloud_endpoint(cloud_endpoint_name: Optional[str] = None,
                       resource_group_name: Optional[str] = None,
                       storage_sync_service_name: Optional[str] = None,
                       sync_group_name: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetCloudEndpointResult
def get_cloud_endpoint_output(cloud_endpoint_name: Optional[pulumi.Input[str]] = None,
                       resource_group_name: Optional[pulumi.Input[str]] = None,
                       storage_sync_service_name: Optional[pulumi.Input[str]] = None,
                       sync_group_name: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetCloudEndpointResult]
Copy
func LookupCloudEndpoint(ctx *Context, args *LookupCloudEndpointArgs, opts ...InvokeOption) (*LookupCloudEndpointResult, error)
func LookupCloudEndpointOutput(ctx *Context, args *LookupCloudEndpointOutputArgs, opts ...InvokeOption) LookupCloudEndpointResultOutput
Copy

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

public static class GetCloudEndpoint 
{
    public static Task<GetCloudEndpointResult> InvokeAsync(GetCloudEndpointArgs args, InvokeOptions? opts = null)
    public static Output<GetCloudEndpointResult> Invoke(GetCloudEndpointInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetCloudEndpointResult> getCloudEndpoint(GetCloudEndpointArgs args, InvokeOptions options)
public static Output<GetCloudEndpointResult> getCloudEndpoint(GetCloudEndpointArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:storagesync:getCloudEndpoint
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

CloudEndpointName
This property is required.
Changes to this property will trigger replacement.
string
Name of Cloud Endpoint object.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
StorageSyncServiceName
This property is required.
Changes to this property will trigger replacement.
string
Name of Storage Sync Service resource.
SyncGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of Sync Group resource.
CloudEndpointName
This property is required.
Changes to this property will trigger replacement.
string
Name of Cloud Endpoint object.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
StorageSyncServiceName
This property is required.
Changes to this property will trigger replacement.
string
Name of Storage Sync Service resource.
SyncGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of Sync Group resource.
cloudEndpointName
This property is required.
Changes to this property will trigger replacement.
String
Name of Cloud Endpoint object.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
storageSyncServiceName
This property is required.
Changes to this property will trigger replacement.
String
Name of Storage Sync Service resource.
syncGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of Sync Group resource.
cloudEndpointName
This property is required.
Changes to this property will trigger replacement.
string
Name of Cloud Endpoint object.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
storageSyncServiceName
This property is required.
Changes to this property will trigger replacement.
string
Name of Storage Sync Service resource.
syncGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of Sync Group resource.
cloud_endpoint_name
This property is required.
Changes to this property will trigger replacement.
str
Name of Cloud Endpoint object.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
storage_sync_service_name
This property is required.
Changes to this property will trigger replacement.
str
Name of Storage Sync Service resource.
sync_group_name
This property is required.
Changes to this property will trigger replacement.
str
Name of Sync Group resource.
cloudEndpointName
This property is required.
Changes to this property will trigger replacement.
String
Name of Cloud Endpoint object.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
storageSyncServiceName
This property is required.
Changes to this property will trigger replacement.
String
Name of Storage Sync Service resource.
syncGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of Sync Group resource.

getCloudEndpoint Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
BackupEnabled string
Backup Enabled
ChangeEnumerationStatus Pulumi.AzureNative.StorageSync.Outputs.CloudEndpointChangeEnumerationStatusResponse
Cloud endpoint change enumeration status
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Name string
The name of the resource
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"
AzureFileShareName string
Azure file share name
FriendlyName string
Friendly Name
LastOperationName string
Resource Last Operation Name
LastWorkflowId string
CloudEndpoint lastWorkflowId
PartnershipId string
Partnership Id
ProvisioningState string
CloudEndpoint Provisioning State
StorageAccountResourceId string
Storage Account Resource Id
StorageAccountTenantId string
Storage Account Tenant Id
AzureApiVersion string
The Azure API version of the resource.
BackupEnabled string
Backup Enabled
ChangeEnumerationStatus CloudEndpointChangeEnumerationStatusResponse
Cloud endpoint change enumeration status
Id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Name string
The name of the 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"
AzureFileShareName string
Azure file share name
FriendlyName string
Friendly Name
LastOperationName string
Resource Last Operation Name
LastWorkflowId string
CloudEndpoint lastWorkflowId
PartnershipId string
Partnership Id
ProvisioningState string
CloudEndpoint Provisioning State
StorageAccountResourceId string
Storage Account Resource Id
StorageAccountTenantId string
Storage Account Tenant Id
azureApiVersion String
The Azure API version of the resource.
backupEnabled String
Backup Enabled
changeEnumerationStatus CloudEndpointChangeEnumerationStatusResponse
Cloud endpoint change enumeration status
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name String
The name of the 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"
azureFileShareName String
Azure file share name
friendlyName String
Friendly Name
lastOperationName String
Resource Last Operation Name
lastWorkflowId String
CloudEndpoint lastWorkflowId
partnershipId String
Partnership Id
provisioningState String
CloudEndpoint Provisioning State
storageAccountResourceId String
Storage Account Resource Id
storageAccountTenantId String
Storage Account Tenant Id
azureApiVersion string
The Azure API version of the resource.
backupEnabled string
Backup Enabled
changeEnumerationStatus CloudEndpointChangeEnumerationStatusResponse
Cloud endpoint change enumeration status
id string
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name string
The name of the 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"
azureFileShareName string
Azure file share name
friendlyName string
Friendly Name
lastOperationName string
Resource Last Operation Name
lastWorkflowId string
CloudEndpoint lastWorkflowId
partnershipId string
Partnership Id
provisioningState string
CloudEndpoint Provisioning State
storageAccountResourceId string
Storage Account Resource Id
storageAccountTenantId string
Storage Account Tenant Id
azure_api_version str
The Azure API version of the resource.
backup_enabled str
Backup Enabled
change_enumeration_status CloudEndpointChangeEnumerationStatusResponse
Cloud endpoint change enumeration status
id str
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name str
The name of the 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"
azure_file_share_name str
Azure file share name
friendly_name str
Friendly Name
last_operation_name str
Resource Last Operation Name
last_workflow_id str
CloudEndpoint lastWorkflowId
partnership_id str
Partnership Id
provisioning_state str
CloudEndpoint Provisioning State
storage_account_resource_id str
Storage Account Resource Id
storage_account_tenant_id str
Storage Account Tenant Id
azureApiVersion String
The Azure API version of the resource.
backupEnabled String
Backup Enabled
changeEnumerationStatus Property Map
Cloud endpoint change enumeration status
id String
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name String
The name of the 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"
azureFileShareName String
Azure file share name
friendlyName String
Friendly Name
lastOperationName String
Resource Last Operation Name
lastWorkflowId String
CloudEndpoint lastWorkflowId
partnershipId String
Partnership Id
provisioningState String
CloudEndpoint Provisioning State
storageAccountResourceId String
Storage Account Resource Id
storageAccountTenantId String
Storage Account Tenant Id

Supporting Types

CloudEndpointChangeEnumerationActivityResponse

DeletesProgressPercent This property is required. int
Progress percentage for processing deletes. This is done separately from the rest of the enumeration run
LastUpdatedTimestamp This property is required. string
Last updated timestamp
MinutesRemaining This property is required. int
Estimate of time remaining for the enumeration run
OperationState This property is required. string
Change enumeration operation state
ProcessedDirectoriesCount This property is required. double
Count of directories processed
ProcessedFilesCount This property is required. double
Count of files processed
ProgressPercent This property is required. int
Progress percentage for change enumeration run, excluding processing of deletes
StartedTimestamp This property is required. string
Timestamp when change enumeration started
StatusCode This property is required. int
When non-zero, indicates an issue that is delaying change enumeration
TotalCountsState This property is required. string
Change enumeration total counts state
TotalDirectoriesCount This property is required. double
Total count of directories enumerated
TotalFilesCount This property is required. double
Total count of files enumerated
TotalSizeBytes This property is required. double
Total enumerated size in bytes
DeletesProgressPercent This property is required. int
Progress percentage for processing deletes. This is done separately from the rest of the enumeration run
LastUpdatedTimestamp This property is required. string
Last updated timestamp
MinutesRemaining This property is required. int
Estimate of time remaining for the enumeration run
OperationState This property is required. string
Change enumeration operation state
ProcessedDirectoriesCount This property is required. float64
Count of directories processed
ProcessedFilesCount This property is required. float64
Count of files processed
ProgressPercent This property is required. int
Progress percentage for change enumeration run, excluding processing of deletes
StartedTimestamp This property is required. string
Timestamp when change enumeration started
StatusCode This property is required. int
When non-zero, indicates an issue that is delaying change enumeration
TotalCountsState This property is required. string
Change enumeration total counts state
TotalDirectoriesCount This property is required. float64
Total count of directories enumerated
TotalFilesCount This property is required. float64
Total count of files enumerated
TotalSizeBytes This property is required. float64
Total enumerated size in bytes
deletesProgressPercent This property is required. Integer
Progress percentage for processing deletes. This is done separately from the rest of the enumeration run
lastUpdatedTimestamp This property is required. String
Last updated timestamp
minutesRemaining This property is required. Integer
Estimate of time remaining for the enumeration run
operationState This property is required. String
Change enumeration operation state
processedDirectoriesCount This property is required. Double
Count of directories processed
processedFilesCount This property is required. Double
Count of files processed
progressPercent This property is required. Integer
Progress percentage for change enumeration run, excluding processing of deletes
startedTimestamp This property is required. String
Timestamp when change enumeration started
statusCode This property is required. Integer
When non-zero, indicates an issue that is delaying change enumeration
totalCountsState This property is required. String
Change enumeration total counts state
totalDirectoriesCount This property is required. Double
Total count of directories enumerated
totalFilesCount This property is required. Double
Total count of files enumerated
totalSizeBytes This property is required. Double
Total enumerated size in bytes
deletesProgressPercent This property is required. number
Progress percentage for processing deletes. This is done separately from the rest of the enumeration run
lastUpdatedTimestamp This property is required. string
Last updated timestamp
minutesRemaining This property is required. number
Estimate of time remaining for the enumeration run
operationState This property is required. string
Change enumeration operation state
processedDirectoriesCount This property is required. number
Count of directories processed
processedFilesCount This property is required. number
Count of files processed
progressPercent This property is required. number
Progress percentage for change enumeration run, excluding processing of deletes
startedTimestamp This property is required. string
Timestamp when change enumeration started
statusCode This property is required. number
When non-zero, indicates an issue that is delaying change enumeration
totalCountsState This property is required. string
Change enumeration total counts state
totalDirectoriesCount This property is required. number
Total count of directories enumerated
totalFilesCount This property is required. number
Total count of files enumerated
totalSizeBytes This property is required. number
Total enumerated size in bytes
deletes_progress_percent This property is required. int
Progress percentage for processing deletes. This is done separately from the rest of the enumeration run
last_updated_timestamp This property is required. str
Last updated timestamp
minutes_remaining This property is required. int
Estimate of time remaining for the enumeration run
operation_state This property is required. str
Change enumeration operation state
processed_directories_count This property is required. float
Count of directories processed
processed_files_count This property is required. float
Count of files processed
progress_percent This property is required. int
Progress percentage for change enumeration run, excluding processing of deletes
started_timestamp This property is required. str
Timestamp when change enumeration started
status_code This property is required. int
When non-zero, indicates an issue that is delaying change enumeration
total_counts_state This property is required. str
Change enumeration total counts state
total_directories_count This property is required. float
Total count of directories enumerated
total_files_count This property is required. float
Total count of files enumerated
total_size_bytes This property is required. float
Total enumerated size in bytes
deletesProgressPercent This property is required. Number
Progress percentage for processing deletes. This is done separately from the rest of the enumeration run
lastUpdatedTimestamp This property is required. String
Last updated timestamp
minutesRemaining This property is required. Number
Estimate of time remaining for the enumeration run
operationState This property is required. String
Change enumeration operation state
processedDirectoriesCount This property is required. Number
Count of directories processed
processedFilesCount This property is required. Number
Count of files processed
progressPercent This property is required. Number
Progress percentage for change enumeration run, excluding processing of deletes
startedTimestamp This property is required. String
Timestamp when change enumeration started
statusCode This property is required. Number
When non-zero, indicates an issue that is delaying change enumeration
totalCountsState This property is required. String
Change enumeration total counts state
totalDirectoriesCount This property is required. Number
Total count of directories enumerated
totalFilesCount This property is required. Number
Total count of files enumerated
totalSizeBytes This property is required. Number
Total enumerated size in bytes

CloudEndpointChangeEnumerationStatusResponse

Activity This property is required. Pulumi.AzureNative.StorageSync.Inputs.CloudEndpointChangeEnumerationActivityResponse
Change enumeration activity
LastEnumerationStatus This property is required. Pulumi.AzureNative.StorageSync.Inputs.CloudEndpointLastChangeEnumerationStatusResponse
Status of last completed change enumeration
LastUpdatedTimestamp This property is required. string
Last updated timestamp
Activity This property is required. CloudEndpointChangeEnumerationActivityResponse
Change enumeration activity
LastEnumerationStatus This property is required. CloudEndpointLastChangeEnumerationStatusResponse
Status of last completed change enumeration
LastUpdatedTimestamp This property is required. string
Last updated timestamp
activity This property is required. CloudEndpointChangeEnumerationActivityResponse
Change enumeration activity
lastEnumerationStatus This property is required. CloudEndpointLastChangeEnumerationStatusResponse
Status of last completed change enumeration
lastUpdatedTimestamp This property is required. String
Last updated timestamp
activity This property is required. CloudEndpointChangeEnumerationActivityResponse
Change enumeration activity
lastEnumerationStatus This property is required. CloudEndpointLastChangeEnumerationStatusResponse
Status of last completed change enumeration
lastUpdatedTimestamp This property is required. string
Last updated timestamp
activity This property is required. CloudEndpointChangeEnumerationActivityResponse
Change enumeration activity
last_enumeration_status This property is required. CloudEndpointLastChangeEnumerationStatusResponse
Status of last completed change enumeration
last_updated_timestamp This property is required. str
Last updated timestamp
activity This property is required. Property Map
Change enumeration activity
lastEnumerationStatus This property is required. Property Map
Status of last completed change enumeration
lastUpdatedTimestamp This property is required. String
Last updated timestamp

CloudEndpointLastChangeEnumerationStatusResponse

CompletedTimestamp This property is required. string
Timestamp when change enumeration completed
NamespaceDirectoriesCount This property is required. double
Count of directories in the namespace
NamespaceFilesCount This property is required. double
Count of files in the namespace
NamespaceSizeBytes This property is required. double
Namespace size in bytes
NextRunTimestamp This property is required. string
Timestamp of when change enumeration is expected to run again
StartedTimestamp This property is required. string
Timestamp when change enumeration started
CompletedTimestamp This property is required. string
Timestamp when change enumeration completed
NamespaceDirectoriesCount This property is required. float64
Count of directories in the namespace
NamespaceFilesCount This property is required. float64
Count of files in the namespace
NamespaceSizeBytes This property is required. float64
Namespace size in bytes
NextRunTimestamp This property is required. string
Timestamp of when change enumeration is expected to run again
StartedTimestamp This property is required. string
Timestamp when change enumeration started
completedTimestamp This property is required. String
Timestamp when change enumeration completed
namespaceDirectoriesCount This property is required. Double
Count of directories in the namespace
namespaceFilesCount This property is required. Double
Count of files in the namespace
namespaceSizeBytes This property is required. Double
Namespace size in bytes
nextRunTimestamp This property is required. String
Timestamp of when change enumeration is expected to run again
startedTimestamp This property is required. String
Timestamp when change enumeration started
completedTimestamp This property is required. string
Timestamp when change enumeration completed
namespaceDirectoriesCount This property is required. number
Count of directories in the namespace
namespaceFilesCount This property is required. number
Count of files in the namespace
namespaceSizeBytes This property is required. number
Namespace size in bytes
nextRunTimestamp This property is required. string
Timestamp of when change enumeration is expected to run again
startedTimestamp This property is required. string
Timestamp when change enumeration started
completed_timestamp This property is required. str
Timestamp when change enumeration completed
namespace_directories_count This property is required. float
Count of directories in the namespace
namespace_files_count This property is required. float
Count of files in the namespace
namespace_size_bytes This property is required. float
Namespace size in bytes
next_run_timestamp This property is required. str
Timestamp of when change enumeration is expected to run again
started_timestamp This property is required. str
Timestamp when change enumeration started
completedTimestamp This property is required. String
Timestamp when change enumeration completed
namespaceDirectoriesCount This property is required. Number
Count of directories in the namespace
namespaceFilesCount This property is required. Number
Count of files in the namespace
namespaceSizeBytes This property is required. Number
Namespace size in bytes
nextRunTimestamp This property is required. String
Timestamp of when change enumeration is expected to run again
startedTimestamp This property is required. String
Timestamp when change enumeration started

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
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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi