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

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

    Gets an Endpoint resource.

    Uses Azure REST API version 2024-07-01.

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

    Using getEndpoint

    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 getEndpoint(args: GetEndpointArgs, opts?: InvokeOptions): Promise<GetEndpointResult>
    function getEndpointOutput(args: GetEndpointOutputArgs, opts?: InvokeOptions): Output<GetEndpointResult>
    def get_endpoint(endpoint_name: Optional[str] = None,
                     resource_group_name: Optional[str] = None,
                     storage_mover_name: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetEndpointResult
    def get_endpoint_output(endpoint_name: Optional[pulumi.Input[str]] = None,
                     resource_group_name: Optional[pulumi.Input[str]] = None,
                     storage_mover_name: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetEndpointResult]
    func LookupEndpoint(ctx *Context, args *LookupEndpointArgs, opts ...InvokeOption) (*LookupEndpointResult, error)
    func LookupEndpointOutput(ctx *Context, args *LookupEndpointOutputArgs, opts ...InvokeOption) LookupEndpointResultOutput

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

    public static class GetEndpoint 
    {
        public static Task<GetEndpointResult> InvokeAsync(GetEndpointArgs args, InvokeOptions? opts = null)
        public static Output<GetEndpointResult> Invoke(GetEndpointInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetEndpointResult> getEndpoint(GetEndpointArgs args, InvokeOptions options)
    public static Output<GetEndpointResult> getEndpoint(GetEndpointArgs args, InvokeOptions options)
    
    fn::invoke:
      function: azure-native:storagemover:getEndpoint
      arguments:
        # arguments dictionary

    The following arguments are supported:

    EndpointName string
    The name of the Endpoint resource.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    StorageMoverName string
    The name of the Storage Mover resource.
    EndpointName string
    The name of the Endpoint resource.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    StorageMoverName string
    The name of the Storage Mover resource.
    endpointName String
    The name of the Endpoint resource.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    storageMoverName String
    The name of the Storage Mover resource.
    endpointName string
    The name of the Endpoint resource.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    storageMoverName string
    The name of the Storage Mover resource.
    endpoint_name str
    The name of the Endpoint resource.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    storage_mover_name str
    The name of the Storage Mover resource.
    endpointName String
    The name of the Endpoint resource.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    storageMoverName String
    The name of the Storage Mover resource.

    getEndpoint Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Name string
    The name of the resource
    Properties Pulumi.AzureNative.StorageMover.Outputs.AzureStorageBlobContainerEndpointPropertiesResponse | Pulumi.AzureNative.StorageMover.Outputs.AzureStorageSmbFileShareEndpointPropertiesResponse | Pulumi.AzureNative.StorageMover.Outputs.NfsMountEndpointPropertiesResponse | Pulumi.AzureNative.StorageMover.Outputs.SmbMountEndpointPropertiesResponse
    The resource specific properties for the Storage Mover resource.
    SystemData Pulumi.AzureNative.StorageMover.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"
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Name string
    The name of the resource
    Properties AzureStorageBlobContainerEndpointPropertiesResponse | AzureStorageSmbFileShareEndpointPropertiesResponse | NfsMountEndpointPropertiesResponse | SmbMountEndpointPropertiesResponse
    The resource specific properties for the Storage Mover 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"
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    name String
    The name of the resource
    properties AzureStorageBlobContainerEndpointPropertiesResponse | AzureStorageSmbFileShareEndpointPropertiesResponse | NfsMountEndpointPropertiesResponse | SmbMountEndpointPropertiesResponse
    The resource specific properties for the Storage Mover 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"
    azureApiVersion string
    The Azure API version of the resource.
    id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    name string
    The name of the resource
    properties AzureStorageBlobContainerEndpointPropertiesResponse | AzureStorageSmbFileShareEndpointPropertiesResponse | NfsMountEndpointPropertiesResponse | SmbMountEndpointPropertiesResponse
    The resource specific properties for the Storage Mover 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"
    azure_api_version str
    The Azure API version of the resource.
    id str
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    name str
    The name of the resource
    properties AzureStorageBlobContainerEndpointPropertiesResponse | AzureStorageSmbFileShareEndpointPropertiesResponse | NfsMountEndpointPropertiesResponse | SmbMountEndpointPropertiesResponse
    The resource specific properties for the Storage Mover 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"
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    name String
    The name of the resource
    properties Property Map | Property Map | Property Map | Property Map
    The resource specific properties for the Storage Mover 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"

    Supporting Types

    AzureKeyVaultSmbCredentialsResponse

    PasswordUri string
    The Azure Key Vault secret URI which stores the password. Use empty string to clean-up existing value.
    UsernameUri string
    The Azure Key Vault secret URI which stores the username. Use empty string to clean-up existing value.
    PasswordUri string
    The Azure Key Vault secret URI which stores the password. Use empty string to clean-up existing value.
    UsernameUri string
    The Azure Key Vault secret URI which stores the username. Use empty string to clean-up existing value.
    passwordUri String
    The Azure Key Vault secret URI which stores the password. Use empty string to clean-up existing value.
    usernameUri String
    The Azure Key Vault secret URI which stores the username. Use empty string to clean-up existing value.
    passwordUri string
    The Azure Key Vault secret URI which stores the password. Use empty string to clean-up existing value.
    usernameUri string
    The Azure Key Vault secret URI which stores the username. Use empty string to clean-up existing value.
    password_uri str
    The Azure Key Vault secret URI which stores the password. Use empty string to clean-up existing value.
    username_uri str
    The Azure Key Vault secret URI which stores the username. Use empty string to clean-up existing value.
    passwordUri String
    The Azure Key Vault secret URI which stores the password. Use empty string to clean-up existing value.
    usernameUri String
    The Azure Key Vault secret URI which stores the username. Use empty string to clean-up existing value.

    AzureStorageBlobContainerEndpointPropertiesResponse

    BlobContainerName string
    The name of the Storage blob container that is the target destination.
    ProvisioningState string
    The provisioning state of this resource.
    StorageAccountResourceId string
    The Azure Resource ID of the storage account that is the target destination.
    Description string
    A description for the Endpoint.
    BlobContainerName string
    The name of the Storage blob container that is the target destination.
    ProvisioningState string
    The provisioning state of this resource.
    StorageAccountResourceId string
    The Azure Resource ID of the storage account that is the target destination.
    Description string
    A description for the Endpoint.
    blobContainerName String
    The name of the Storage blob container that is the target destination.
    provisioningState String
    The provisioning state of this resource.
    storageAccountResourceId String
    The Azure Resource ID of the storage account that is the target destination.
    description String
    A description for the Endpoint.
    blobContainerName string
    The name of the Storage blob container that is the target destination.
    provisioningState string
    The provisioning state of this resource.
    storageAccountResourceId string
    The Azure Resource ID of the storage account that is the target destination.
    description string
    A description for the Endpoint.
    blob_container_name str
    The name of the Storage blob container that is the target destination.
    provisioning_state str
    The provisioning state of this resource.
    storage_account_resource_id str
    The Azure Resource ID of the storage account that is the target destination.
    description str
    A description for the Endpoint.
    blobContainerName String
    The name of the Storage blob container that is the target destination.
    provisioningState String
    The provisioning state of this resource.
    storageAccountResourceId String
    The Azure Resource ID of the storage account that is the target destination.
    description String
    A description for the Endpoint.

    AzureStorageSmbFileShareEndpointPropertiesResponse

    FileShareName string
    The name of the Azure Storage file share.
    ProvisioningState string
    The provisioning state of this resource.
    StorageAccountResourceId string
    The Azure Resource ID of the storage account.
    Description string
    A description for the Endpoint.
    FileShareName string
    The name of the Azure Storage file share.
    ProvisioningState string
    The provisioning state of this resource.
    StorageAccountResourceId string
    The Azure Resource ID of the storage account.
    Description string
    A description for the Endpoint.
    fileShareName String
    The name of the Azure Storage file share.
    provisioningState String
    The provisioning state of this resource.
    storageAccountResourceId String
    The Azure Resource ID of the storage account.
    description String
    A description for the Endpoint.
    fileShareName string
    The name of the Azure Storage file share.
    provisioningState string
    The provisioning state of this resource.
    storageAccountResourceId string
    The Azure Resource ID of the storage account.
    description string
    A description for the Endpoint.
    file_share_name str
    The name of the Azure Storage file share.
    provisioning_state str
    The provisioning state of this resource.
    storage_account_resource_id str
    The Azure Resource ID of the storage account.
    description str
    A description for the Endpoint.
    fileShareName String
    The name of the Azure Storage file share.
    provisioningState String
    The provisioning state of this resource.
    storageAccountResourceId String
    The Azure Resource ID of the storage account.
    description String
    A description for the Endpoint.

    NfsMountEndpointPropertiesResponse

    Export string
    The directory being exported from the server.
    Host string
    The host name or IP address of the server exporting the file system.
    ProvisioningState string
    The provisioning state of this resource.
    Description string
    A description for the Endpoint.
    NfsVersion string
    The NFS protocol version.
    Export string
    The directory being exported from the server.
    Host string
    The host name or IP address of the server exporting the file system.
    ProvisioningState string
    The provisioning state of this resource.
    Description string
    A description for the Endpoint.
    NfsVersion string
    The NFS protocol version.
    export String
    The directory being exported from the server.
    host String
    The host name or IP address of the server exporting the file system.
    provisioningState String
    The provisioning state of this resource.
    description String
    A description for the Endpoint.
    nfsVersion String
    The NFS protocol version.
    export string
    The directory being exported from the server.
    host string
    The host name or IP address of the server exporting the file system.
    provisioningState string
    The provisioning state of this resource.
    description string
    A description for the Endpoint.
    nfsVersion string
    The NFS protocol version.
    export str
    The directory being exported from the server.
    host str
    The host name or IP address of the server exporting the file system.
    provisioning_state str
    The provisioning state of this resource.
    description str
    A description for the Endpoint.
    nfs_version str
    The NFS protocol version.
    export String
    The directory being exported from the server.
    host String
    The host name or IP address of the server exporting the file system.
    provisioningState String
    The provisioning state of this resource.
    description String
    A description for the Endpoint.
    nfsVersion String
    The NFS protocol version.

    SmbMountEndpointPropertiesResponse

    Host string
    The host name or IP address of the server exporting the file system.
    ProvisioningState string
    The provisioning state of this resource.
    ShareName string
    The name of the SMB share being exported from the server.
    Credentials Pulumi.AzureNative.StorageMover.Inputs.AzureKeyVaultSmbCredentialsResponse
    The Azure Key Vault secret URIs which store the required credentials to access the SMB share.
    Description string
    A description for the Endpoint.
    Host string
    The host name or IP address of the server exporting the file system.
    ProvisioningState string
    The provisioning state of this resource.
    ShareName string
    The name of the SMB share being exported from the server.
    Credentials AzureKeyVaultSmbCredentialsResponse
    The Azure Key Vault secret URIs which store the required credentials to access the SMB share.
    Description string
    A description for the Endpoint.
    host String
    The host name or IP address of the server exporting the file system.
    provisioningState String
    The provisioning state of this resource.
    shareName String
    The name of the SMB share being exported from the server.
    credentials AzureKeyVaultSmbCredentialsResponse
    The Azure Key Vault secret URIs which store the required credentials to access the SMB share.
    description String
    A description for the Endpoint.
    host string
    The host name or IP address of the server exporting the file system.
    provisioningState string
    The provisioning state of this resource.
    shareName string
    The name of the SMB share being exported from the server.
    credentials AzureKeyVaultSmbCredentialsResponse
    The Azure Key Vault secret URIs which store the required credentials to access the SMB share.
    description string
    A description for the Endpoint.
    host str
    The host name or IP address of the server exporting the file system.
    provisioning_state str
    The provisioning state of this resource.
    share_name str
    The name of the SMB share being exported from the server.
    credentials AzureKeyVaultSmbCredentialsResponse
    The Azure Key Vault secret URIs which store the required credentials to access the SMB share.
    description str
    A description for the Endpoint.
    host String
    The host name or IP address of the server exporting the file system.
    provisioningState String
    The provisioning state of this resource.
    shareName String
    The name of the SMB share being exported from the server.
    credentials Property Map
    The Azure Key Vault secret URIs which store the required credentials to access the SMB share.
    description String
    A description for the Endpoint.

    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