Microsoft.FileShares (preview:2025-06-01)

2025/07/29 • 16 new methods

Operations_List (new)
Description :  List the operations for the provider
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.FileShares/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FileShares_ListBySubscription (new)
Description :  List FileShare resources by subscription ID
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.FileShares/fileShares
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The FileShare items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
mountName:
{
Description: The name of the file share as seen by the end user when mounting the share, such as in a URI or UNC format in their operating system. ,
Required: False ,
}
string ,
hostName:
{
Description: The host name of the file share. ,
Required: False ,
}
string ,
mediaTier:
{
Description: The storage media tier of the file share. ,
Enum:
{
SSD: SSD media tier. ,
}
,
Required: False ,
}
enum ,
redundancy:
{
Description: The chosen redundancy level of the file share. ,
Enum:
{
Local: Local redundancy. ,
Zone: Zone redundancy. ,
}
,
Required: False ,
}
enum ,
protocol:
{
Description: The file sharing protocol for this file share. ,
Enum:
{
NFS: NFS protocol. ,
}
,
Required: False ,
}
enum ,
provisionedStorageGiB:
{
Description: The provisioned storage size of the share in GiB (1 GiB is 1024^3 bytes or 1073741824 bytes). A component of the file share's bill is the provisioned storage, regardless of the amount of used storage. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedStorageNextAllowedDowngrade:
{
Description: A date/time value that specifies when the provisioned storage for the file share is permitted to be reduced. ,
Format: date-time ,
Required: False ,
}
string ,
provisionedIOPerSec:
{
Description: The provisioned IO / sec of the share. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedIOPerSecNextAllowedDowngrade:
{
Description: A date/time value that specifies when the provisioned IOPS for the file share is permitted to be reduced. ,
Format: date-time ,
Required: False ,
}
string ,
provisionedThroughputMiBPerSec:
{
Description: The provisioned throughput / sec of the share. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedThroughputNextAllowedDowngrade:
{
Description: A date/time value that specifies when the provisioned throughput for the file share is permitted to be reduced. ,
Format: date-time ,
Required: False ,
}
string ,
includedBurstIOPerSec:
{
Description: Burst IOPS are extra buffer IOPS enabling you to consume more than your provisioned IOPS for a short period of time, depending on the burst credits available for your share. ,
Format: int32 ,
Required: False ,
}
integer ,
maxBurstIOPerSecCredits:
{
Description: Max burst IOPS credits shows the maximum number of burst credits the share can have at the current IOPS provisioning level. ,
Format: int64 ,
Required: False ,
}
integer ,
nfsProtocolProperties:
{
Description: Protocol settings specific NFS. ,
Required: False ,
}
{
rootSquash:
{
Description: Root squash defines how root users on clients are mapped to the NFS share. ,
Enum:
{
NoRootSquash: No root squash. ,
RootSquash: Root squash. ,
AllSquash: All squash. ,
}
,
Required: False ,
}
enum ,
}
,
publicAccessProperties:
{
Description: The set of properties for control public access. ,
Required: False ,
}
{
allowedSubnets:
{
Description: The allowed set of subnets when access is restricted. ,
Required: False ,
}
[
string ,
]
,
}
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The operation is provisioning. ,
Updating: The operation is updating. ,
Deleting: The operation is deleting. ,
Accepted: The operation is accepted. ,
Created: The resource has been created. ,
TransientFailure: The operation is in a transient failure state. ,
Creating: The resource is being created. ,
Patching: The resource is being patched. ,
Posting: The resource is being posted. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Gets or sets allow or disallow public network access to azure managed file share ,
Enum:
{
Enabled: The public network access is enabled ,
Disabled: The public network access is disabled ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: The list of associated private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FileShares_CheckNameAvailability (new)
Description :  Implements local CheckNameAvailability operations
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.FileShares/locations/{location}/checkNameAvailability
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
body:
{
Description: The CheckAvailability request ,
Required: True ,
}
{
name:
{
Description: The name of the resource for which availability needs to be checked. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
nameAvailable:
{
Description: Indicates if the resource name is available. ,
Required: False ,
}
boolean ,
reason:
{
Description: The reason why the given name is not available. ,
Enum:
{
Invalid: No description available. ,
AlreadyExists: No description available. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: Detailed reason why the given name is available. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FileShare_GetLimits (new)
Description :  Get file shares limits.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.FileShares/locations/{location}/getLimits
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the file share limits. ,
Required: True ,
}
{
limits:
{
Description: The limits for the file share. ,
Required: True ,
}
{
maxFileShares:
{
Description: The maximum number of file shares that can be created. ,
Format: int32 ,
Required: True ,
}
integer ,
maxFileShareSnapshots:
{
Description: The maximum number of snapshots allowed per file share. ,
Format: int32 ,
Required: True ,
}
integer ,
maxFileShareSubnets:
{
Description: The maximum number of subnets that can be associated with a file share. ,
Format: int32 ,
Required: True ,
}
integer ,
maxFileSharePrivateEndpointConnections:
{
Description: The maximum number of private endpoint connections allowed for a file share. ,
Format: int32 ,
Required: True ,
}
integer ,
minProvisionedStorageGiB:
{
Description: The minimum provisioned storage in GiB for a file share. ,
Format: int32 ,
Required: True ,
}
integer ,
maxProvisionedStorageGiB:
{
Description: The maximum provisioned storage in GiB for a file share. ,
Format: int32 ,
Required: True ,
}
integer ,
minProvisionedIOPerSec:
{
Description: The minimum provisioned IOPS (Input/Output Operations Per Second) for a file share. ,
Format: int32 ,
Required: True ,
}
integer ,
maxProvisionedIOPerSec:
{
Description: The maximum provisioned IOPS (Input/Output Operations Per Second) for a file share. ,
Format: int32 ,
Required: True ,
}
integer ,
minProvisionedThroughputMiBPerSec:
{
Description: The minimum provisioned throughput in MiB/s for a file share. ,
Format: int32 ,
Required: True ,
}
integer ,
maxProvisionedThroughputMiBPerSec:
{
Description: The maximum provisioned throughput in MiB/s for a file share. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
provisioningConstants:
{
Description: The provisioning constants for the file share. ,
Required: True ,
}
{
baseIOPerSec:
{
Description: Base IO per second. ,
Format: int32 ,
Required: True ,
}
integer ,
scalarIOPerSec:
{
Description: Scalar IO per second. ,
Format: double ,
Required: True ,
}
number ,
baseThroughputMiBPerSec:
{
Description: Base throughput in MiB per second. ,
Format: int32 ,
Required: True ,
}
integer ,
scalarThroughputMiBPerSec:
{
Description: Scalar throughput in MiB per second. ,
Format: double ,
Required: True ,
}
number ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FileShare_GetProvisioningRecommendation (new)
Description :  Get file shares provisioning parameters recommendation.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.FileShares/locations/{location}/getProvisioningRecommendation
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
body:
{
Description: The request body ,
Required: True ,
}
{
properties:
{
Description: The properties of the file share provisioning recommendation input. ,
Required: True ,
}
{
provisionedStorageGiB:
{
Description: The desired provisioned storage size of the share in GiB. Will be use to calculate the values of remaining provisioning parameters. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the file share provisioning recommendation output. ,
Required: True ,
}
{
provisionedIOPerSec:
{
Description: The recommended value of provisioned IO / sec of the share. ,
Format: int32 ,
Required: True ,
}
integer ,
provisionedThroughputMiBPerSec:
{
Description: The recommended value of provisioned throughput / sec of the share. ,
Format: int32 ,
Required: True ,
}
integer ,
availableRedundancyOptions:
{
Description: Redundancy options for the share. ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FileShare_GetUsageData (new)
Description :  Get file shares usage data.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.FileShares/locations/{location}/getUsageData
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The name of the Azure region. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the file share usage data. ,
Required: True ,
}
{
liveShares:
{
Description: File share usage data for active file shares. ,
Required: True ,
}
{
fileShareCount:
{
Description: The number of active file shares. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FileShares_ListByParent (new)
Description :  List FileShare resources by resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.FileShares/fileShares
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The FileShare items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
mountName:
{
Description: The name of the file share as seen by the end user when mounting the share, such as in a URI or UNC format in their operating system. ,
Required: False ,
}
string ,
hostName:
{
Description: The host name of the file share. ,
Required: False ,
}
string ,
mediaTier:
{
Description: The storage media tier of the file share. ,
Enum:
{
SSD: SSD media tier. ,
}
,
Required: False ,
}
enum ,
redundancy:
{
Description: The chosen redundancy level of the file share. ,
Enum:
{
Local: Local redundancy. ,
Zone: Zone redundancy. ,
}
,
Required: False ,
}
enum ,
protocol:
{
Description: The file sharing protocol for this file share. ,
Enum:
{
NFS: NFS protocol. ,
}
,
Required: False ,
}
enum ,
provisionedStorageGiB:
{
Description: The provisioned storage size of the share in GiB (1 GiB is 1024^3 bytes or 1073741824 bytes). A component of the file share's bill is the provisioned storage, regardless of the amount of used storage. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedStorageNextAllowedDowngrade:
{
Description: A date/time value that specifies when the provisioned storage for the file share is permitted to be reduced. ,
Format: date-time ,
Required: False ,
}
string ,
provisionedIOPerSec:
{
Description: The provisioned IO / sec of the share. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedIOPerSecNextAllowedDowngrade:
{
Description: A date/time value that specifies when the provisioned IOPS for the file share is permitted to be reduced. ,
Format: date-time ,
Required: False ,
}
string ,
provisionedThroughputMiBPerSec:
{
Description: The provisioned throughput / sec of the share. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedThroughputNextAllowedDowngrade:
{
Description: A date/time value that specifies when the provisioned throughput for the file share is permitted to be reduced. ,
Format: date-time ,
Required: False ,
}
string ,
includedBurstIOPerSec:
{
Description: Burst IOPS are extra buffer IOPS enabling you to consume more than your provisioned IOPS for a short period of time, depending on the burst credits available for your share. ,
Format: int32 ,
Required: False ,
}
integer ,
maxBurstIOPerSecCredits:
{
Description: Max burst IOPS credits shows the maximum number of burst credits the share can have at the current IOPS provisioning level. ,
Format: int64 ,
Required: False ,
}
integer ,
nfsProtocolProperties:
{
Description: Protocol settings specific NFS. ,
Required: False ,
}
{
rootSquash:
{
Description: Root squash defines how root users on clients are mapped to the NFS share. ,
Enum:
{
NoRootSquash: No root squash. ,
RootSquash: Root squash. ,
AllSquash: All squash. ,
}
,
Required: False ,
}
enum ,
}
,
publicAccessProperties:
{
Description: The set of properties for control public access. ,
Required: False ,
}
{
allowedSubnets:
{
Description: The allowed set of subnets when access is restricted. ,
Required: False ,
}
[
string ,
]
,
}
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The operation is provisioning. ,
Updating: The operation is updating. ,
Deleting: The operation is deleting. ,
Accepted: The operation is accepted. ,
Created: The resource has been created. ,
TransientFailure: The operation is in a transient failure state. ,
Creating: The resource is being created. ,
Patching: The resource is being patched. ,
Posting: The resource is being posted. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Gets or sets allow or disallow public network access to azure managed file share ,
Enum:
{
Enabled: The public network access is enabled ,
Disabled: The public network access is disabled ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: The list of associated private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FileShares_Get (new)
Description :  Get a FileShare
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.FileShares/fileShares/{resourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The resource name of the file share, as seen by the administrator through Azure Resource Manager. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
mountName:
{
Description: The name of the file share as seen by the end user when mounting the share, such as in a URI or UNC format in their operating system. ,
Required: False ,
}
string ,
hostName:
{
Description: The host name of the file share. ,
Required: False ,
}
string ,
mediaTier:
{
Description: The storage media tier of the file share. ,
Enum:
{
SSD: SSD media tier. ,
}
,
Required: False ,
}
enum ,
redundancy:
{
Description: The chosen redundancy level of the file share. ,
Enum:
{
Local: Local redundancy. ,
Zone: Zone redundancy. ,
}
,
Required: False ,
}
enum ,
protocol:
{
Description: The file sharing protocol for this file share. ,
Enum:
{
NFS: NFS protocol. ,
}
,
Required: False ,
}
enum ,
provisionedStorageGiB:
{
Description: The provisioned storage size of the share in GiB (1 GiB is 1024^3 bytes or 1073741824 bytes). A component of the file share's bill is the provisioned storage, regardless of the amount of used storage. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedStorageNextAllowedDowngrade:
{
Description: A date/time value that specifies when the provisioned storage for the file share is permitted to be reduced. ,
Format: date-time ,
Required: False ,
}
string ,
provisionedIOPerSec:
{
Description: The provisioned IO / sec of the share. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedIOPerSecNextAllowedDowngrade:
{
Description: A date/time value that specifies when the provisioned IOPS for the file share is permitted to be reduced. ,
Format: date-time ,
Required: False ,
}
string ,
provisionedThroughputMiBPerSec:
{
Description: The provisioned throughput / sec of the share. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedThroughputNextAllowedDowngrade:
{
Description: A date/time value that specifies when the provisioned throughput for the file share is permitted to be reduced. ,
Format: date-time ,
Required: False ,
}
string ,
includedBurstIOPerSec:
{
Description: Burst IOPS are extra buffer IOPS enabling you to consume more than your provisioned IOPS for a short period of time, depending on the burst credits available for your share. ,
Format: int32 ,
Required: False ,
}
integer ,
maxBurstIOPerSecCredits:
{
Description: Max burst IOPS credits shows the maximum number of burst credits the share can have at the current IOPS provisioning level. ,
Format: int64 ,
Required: False ,
}
integer ,
nfsProtocolProperties:
{
Description: Protocol settings specific NFS. ,
Required: False ,
}
{
rootSquash:
{
Description: Root squash defines how root users on clients are mapped to the NFS share. ,
Enum:
{
NoRootSquash: No root squash. ,
RootSquash: Root squash. ,
AllSquash: All squash. ,
}
,
Required: False ,
}
enum ,
}
,
publicAccessProperties:
{
Description: The set of properties for control public access. ,
Required: False ,
}
{
allowedSubnets:
{
Description: The allowed set of subnets when access is restricted. ,
Required: False ,
}
[
string ,
]
,
}
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The operation is provisioning. ,
Updating: The operation is updating. ,
Deleting: The operation is deleting. ,
Accepted: The operation is accepted. ,
Created: The resource has been created. ,
TransientFailure: The operation is in a transient failure state. ,
Creating: The resource is being created. ,
Patching: The resource is being patched. ,
Posting: The resource is being posted. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Gets or sets allow or disallow public network access to azure managed file share ,
Enum:
{
Enabled: The public network access is enabled ,
Disabled: The public network access is disabled ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: The list of associated private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FileShares_CreateOrUpdate (new)
Description :  Create or update a file share.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.FileShares/fileShares/{resourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The resource name of the file share, as seen by the administrator through Azure Resource Manager. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
mountName:
{
Description: The name of the file share as seen by the end user when mounting the share, such as in a URI or UNC format in their operating system. ,
Required: False ,
}
string ,
hostName:
{
Description: The host name of the file share. ,
Required: False ,
}
string ,
mediaTier:
{
Description: The storage media tier of the file share. ,
Enum:
{
SSD: SSD media tier. ,
}
,
Required: False ,
}
enum ,
redundancy:
{
Description: The chosen redundancy level of the file share. ,
Enum:
{
Local: Local redundancy. ,
Zone: Zone redundancy. ,
}
,
Required: False ,
}
enum ,
protocol:
{
Description: The file sharing protocol for this file share. ,
Enum:
{
NFS: NFS protocol. ,
}
,
Required: False ,
}
enum ,
provisionedStorageGiB:
{
Description: The provisioned storage size of the share in GiB (1 GiB is 1024^3 bytes or 1073741824 bytes). A component of the file share's bill is the provisioned storage, regardless of the amount of used storage. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedStorageNextAllowedDowngrade:
{
Description: A date/time value that specifies when the provisioned storage for the file share is permitted to be reduced. ,
Format: date-time ,
Required: False ,
}
string ,
provisionedIOPerSec:
{
Description: The provisioned IO / sec of the share. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedIOPerSecNextAllowedDowngrade:
{
Description: A date/time value that specifies when the provisioned IOPS for the file share is permitted to be reduced. ,
Format: date-time ,
Required: False ,
}
string ,
provisionedThroughputMiBPerSec:
{
Description: The provisioned throughput / sec of the share. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedThroughputNextAllowedDowngrade:
{
Description: A date/time value that specifies when the provisioned throughput for the file share is permitted to be reduced. ,
Format: date-time ,
Required: False ,
}
string ,
includedBurstIOPerSec:
{
Description: Burst IOPS are extra buffer IOPS enabling you to consume more than your provisioned IOPS for a short period of time, depending on the burst credits available for your share. ,
Format: int32 ,
Required: False ,
}
integer ,
maxBurstIOPerSecCredits:
{
Description: Max burst IOPS credits shows the maximum number of burst credits the share can have at the current IOPS provisioning level. ,
Format: int64 ,
Required: False ,
}
integer ,
nfsProtocolProperties:
{
Description: Protocol settings specific NFS. ,
Required: False ,
}
{
rootSquash:
{
Description: Root squash defines how root users on clients are mapped to the NFS share. ,
Enum:
{
NoRootSquash: No root squash. ,
RootSquash: Root squash. ,
AllSquash: All squash. ,
}
,
Required: False ,
}
enum ,
}
,
publicAccessProperties:
{
Description: The set of properties for control public access. ,
Required: False ,
}
{
allowedSubnets:
{
Description: The allowed set of subnets when access is restricted. ,
Required: False ,
}
[
string ,
]
,
}
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The operation is provisioning. ,
Updating: The operation is updating. ,
Deleting: The operation is deleting. ,
Accepted: The operation is accepted. ,
Created: The resource has been created. ,
TransientFailure: The operation is in a transient failure state. ,
Creating: The resource is being created. ,
Patching: The resource is being patched. ,
Posting: The resource is being posted. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Gets or sets allow or disallow public network access to azure managed file share ,
Enum:
{
Enabled: The public network access is enabled ,
Disabled: The public network access is disabled ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: The list of associated private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
mountName:
{
Description: The name of the file share as seen by the end user when mounting the share, such as in a URI or UNC format in their operating system. ,
Required: False ,
}
string ,
hostName:
{
Description: The host name of the file share. ,
Required: False ,
}
string ,
mediaTier:
{
Description: The storage media tier of the file share. ,
Enum:
{
SSD: SSD media tier. ,
}
,
Required: False ,
}
enum ,
redundancy:
{
Description: The chosen redundancy level of the file share. ,
Enum:
{
Local: Local redundancy. ,
Zone: Zone redundancy. ,
}
,
Required: False ,
}
enum ,
protocol:
{
Description: The file sharing protocol for this file share. ,
Enum:
{
NFS: NFS protocol. ,
}
,
Required: False ,
}
enum ,
provisionedStorageGiB:
{
Description: The provisioned storage size of the share in GiB (1 GiB is 1024^3 bytes or 1073741824 bytes). A component of the file share's bill is the provisioned storage, regardless of the amount of used storage. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedStorageNextAllowedDowngrade:
{
Description: A date/time value that specifies when the provisioned storage for the file share is permitted to be reduced. ,
Format: date-time ,
Required: False ,
}
string ,
provisionedIOPerSec:
{
Description: The provisioned IO / sec of the share. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedIOPerSecNextAllowedDowngrade:
{
Description: A date/time value that specifies when the provisioned IOPS for the file share is permitted to be reduced. ,
Format: date-time ,
Required: False ,
}
string ,
provisionedThroughputMiBPerSec:
{
Description: The provisioned throughput / sec of the share. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedThroughputNextAllowedDowngrade:
{
Description: A date/time value that specifies when the provisioned throughput for the file share is permitted to be reduced. ,
Format: date-time ,
Required: False ,
}
string ,
includedBurstIOPerSec:
{
Description: Burst IOPS are extra buffer IOPS enabling you to consume more than your provisioned IOPS for a short period of time, depending on the burst credits available for your share. ,
Format: int32 ,
Required: False ,
}
integer ,
maxBurstIOPerSecCredits:
{
Description: Max burst IOPS credits shows the maximum number of burst credits the share can have at the current IOPS provisioning level. ,
Format: int64 ,
Required: False ,
}
integer ,
nfsProtocolProperties:
{
Description: Protocol settings specific NFS. ,
Required: False ,
}
{
rootSquash:
{
Description: Root squash defines how root users on clients are mapped to the NFS share. ,
Enum:
{
NoRootSquash: No root squash. ,
RootSquash: Root squash. ,
AllSquash: All squash. ,
}
,
Required: False ,
}
enum ,
}
,
publicAccessProperties:
{
Description: The set of properties for control public access. ,
Required: False ,
}
{
allowedSubnets:
{
Description: The allowed set of subnets when access is restricted. ,
Required: False ,
}
[
string ,
]
,
}
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The operation is provisioning. ,
Updating: The operation is updating. ,
Deleting: The operation is deleting. ,
Accepted: The operation is accepted. ,
Created: The resource has been created. ,
TransientFailure: The operation is in a transient failure state. ,
Creating: The resource is being created. ,
Patching: The resource is being patched. ,
Posting: The resource is being posted. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Gets or sets allow or disallow public network access to azure managed file share ,
Enum:
{
Enabled: The public network access is enabled ,
Disabled: The public network access is disabled ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: The list of associated private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: File share resource ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
mountName:
{
Description: The name of the file share as seen by the end user when mounting the share, such as in a URI or UNC format in their operating system. ,
Required: False ,
}
string ,
hostName:
{
Description: The host name of the file share. ,
Required: False ,
}
string ,
mediaTier:
{
Description: The storage media tier of the file share. ,
Enum:
{
SSD: SSD media tier. ,
}
,
Required: False ,
}
enum ,
redundancy:
{
Description: The chosen redundancy level of the file share. ,
Enum:
{
Local: Local redundancy. ,
Zone: Zone redundancy. ,
}
,
Required: False ,
}
enum ,
protocol:
{
Description: The file sharing protocol for this file share. ,
Enum:
{
NFS: NFS protocol. ,
}
,
Required: False ,
}
enum ,
provisionedStorageGiB:
{
Description: The provisioned storage size of the share in GiB (1 GiB is 1024^3 bytes or 1073741824 bytes). A component of the file share's bill is the provisioned storage, regardless of the amount of used storage. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedStorageNextAllowedDowngrade:
{
Description: A date/time value that specifies when the provisioned storage for the file share is permitted to be reduced. ,
Format: date-time ,
Required: False ,
}
string ,
provisionedIOPerSec:
{
Description: The provisioned IO / sec of the share. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedIOPerSecNextAllowedDowngrade:
{
Description: A date/time value that specifies when the provisioned IOPS for the file share is permitted to be reduced. ,
Format: date-time ,
Required: False ,
}
string ,
provisionedThroughputMiBPerSec:
{
Description: The provisioned throughput / sec of the share. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedThroughputNextAllowedDowngrade:
{
Description: A date/time value that specifies when the provisioned throughput for the file share is permitted to be reduced. ,
Format: date-time ,
Required: False ,
}
string ,
includedBurstIOPerSec:
{
Description: Burst IOPS are extra buffer IOPS enabling you to consume more than your provisioned IOPS for a short period of time, depending on the burst credits available for your share. ,
Format: int32 ,
Required: False ,
}
integer ,
maxBurstIOPerSecCredits:
{
Description: Max burst IOPS credits shows the maximum number of burst credits the share can have at the current IOPS provisioning level. ,
Format: int64 ,
Required: False ,
}
integer ,
nfsProtocolProperties:
{
Description: Protocol settings specific NFS. ,
Required: False ,
}
{
rootSquash:
{
Description: Root squash defines how root users on clients are mapped to the NFS share. ,
Enum:
{
NoRootSquash: No root squash. ,
RootSquash: Root squash. ,
AllSquash: All squash. ,
}
,
Required: False ,
}
enum ,
}
,
publicAccessProperties:
{
Description: The set of properties for control public access. ,
Required: False ,
}
{
allowedSubnets:
{
Description: The allowed set of subnets when access is restricted. ,
Required: False ,
}
[
string ,
]
,
}
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The operation is provisioning. ,
Updating: The operation is updating. ,
Deleting: The operation is deleting. ,
Accepted: The operation is accepted. ,
Created: The resource has been created. ,
TransientFailure: The operation is in a transient failure state. ,
Creating: The resource is being created. ,
Patching: The resource is being patched. ,
Posting: The resource is being posted. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Gets or sets allow or disallow public network access to azure managed file share ,
Enum:
{
Enabled: The public network access is enabled ,
Disabled: The public network access is disabled ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: The list of associated private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FileShares_Update (new)
Description :  Update a FileShare
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.FileShares/fileShares/{resourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The resource name of the file share, as seen by the administrator through Azure Resource Manager. ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisionedStorageGiB:
{
Description: The provisioned storage size of the share in GiB (1 GiB is 1024^3 bytes or 1073741824 bytes). A component of the file share's bill is the provisioned storage, regardless of the amount of used storage. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedIOPerSec:
{
Description: The provisioned IO / sec of the share. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedThroughputMiBPerSec:
{
Description: The provisioned throughput / sec of the share. ,
Format: int32 ,
Required: False ,
}
integer ,
nfsProtocolProperties:
{
Description: Protocol settings specific NFS. ,
Required: False ,
}
{
rootSquash:
{
Description: Root squash defines how root users on clients are mapped to the NFS share. ,
Enum:
{
NoRootSquash: No root squash. ,
RootSquash: Root squash. ,
AllSquash: All squash. ,
}
,
Required: False ,
}
enum ,
}
,
publicAccessProperties:
{
Description: The set of properties for control public access. ,
Required: False ,
}
{
allowedSubnets:
{
Description: The allowed set of subnets when access is restricted. ,
Required: False ,
}
[
string ,
]
,
}
,
publicNetworkAccess:
{
Description: Gets or sets allow or disallow public network access to azure managed file share ,
Enum:
{
Enabled: The public network access is enabled ,
Disabled: The public network access is disabled ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
mountName:
{
Description: The name of the file share as seen by the end user when mounting the share, such as in a URI or UNC format in their operating system. ,
Required: False ,
}
string ,
hostName:
{
Description: The host name of the file share. ,
Required: False ,
}
string ,
mediaTier:
{
Description: The storage media tier of the file share. ,
Enum:
{
SSD: SSD media tier. ,
}
,
Required: False ,
}
enum ,
redundancy:
{
Description: The chosen redundancy level of the file share. ,
Enum:
{
Local: Local redundancy. ,
Zone: Zone redundancy. ,
}
,
Required: False ,
}
enum ,
protocol:
{
Description: The file sharing protocol for this file share. ,
Enum:
{
NFS: NFS protocol. ,
}
,
Required: False ,
}
enum ,
provisionedStorageGiB:
{
Description: The provisioned storage size of the share in GiB (1 GiB is 1024^3 bytes or 1073741824 bytes). A component of the file share's bill is the provisioned storage, regardless of the amount of used storage. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedStorageNextAllowedDowngrade:
{
Description: A date/time value that specifies when the provisioned storage for the file share is permitted to be reduced. ,
Format: date-time ,
Required: False ,
}
string ,
provisionedIOPerSec:
{
Description: The provisioned IO / sec of the share. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedIOPerSecNextAllowedDowngrade:
{
Description: A date/time value that specifies when the provisioned IOPS for the file share is permitted to be reduced. ,
Format: date-time ,
Required: False ,
}
string ,
provisionedThroughputMiBPerSec:
{
Description: The provisioned throughput / sec of the share. ,
Format: int32 ,
Required: False ,
}
integer ,
provisionedThroughputNextAllowedDowngrade:
{
Description: A date/time value that specifies when the provisioned throughput for the file share is permitted to be reduced. ,
Format: date-time ,
Required: False ,
}
string ,
includedBurstIOPerSec:
{
Description: Burst IOPS are extra buffer IOPS enabling you to consume more than your provisioned IOPS for a short period of time, depending on the burst credits available for your share. ,
Format: int32 ,
Required: False ,
}
integer ,
maxBurstIOPerSecCredits:
{
Description: Max burst IOPS credits shows the maximum number of burst credits the share can have at the current IOPS provisioning level. ,
Format: int64 ,
Required: False ,
}
integer ,
nfsProtocolProperties:
{
Description: Protocol settings specific NFS. ,
Required: False ,
}
{
rootSquash:
{
Description: Root squash defines how root users on clients are mapped to the NFS share. ,
Enum:
{
NoRootSquash: No root squash. ,
RootSquash: Root squash. ,
AllSquash: All squash. ,
}
,
Required: False ,
}
enum ,
}
,
publicAccessProperties:
{
Description: The set of properties for control public access. ,
Required: False ,
}
{
allowedSubnets:
{
Description: The allowed set of subnets when access is restricted. ,
Required: False ,
}
[
string ,
]
,
}
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: The operation is provisioning. ,
Updating: The operation is updating. ,
Deleting: The operation is deleting. ,
Accepted: The operation is accepted. ,
Created: The resource has been created. ,
TransientFailure: The operation is in a transient failure state. ,
Creating: The resource is being created. ,
Patching: The resource is being patched. ,
Posting: The resource is being posted. ,
}
,
Required: False ,
}
enum ,
publicNetworkAccess:
{
Description: Gets or sets allow or disallow public network access to azure managed file share ,
Enum:
{
Enabled: The public network access is enabled ,
Disabled: The public network access is disabled ,
}
,
Required: False ,
}
enum ,
privateEndpointConnections:
{
Description: The list of associated private endpoint connections. ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupIds:
{
Description: The group ids for the private endpoint resource. ,
Required: False ,
}
[
string ,
]
,
privateEndpoint:
{
Description: The private endpoint resource. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for private endpoint. ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FileShares_Delete (new)
Description :  Delete a FileShare
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.FileShares/fileShares/{resourceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The resource name of the file share, as seen by the administrator through Azure Resource Manager. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FileShareSnapshot_List (new)
Description :  List FileShareSnapshot by FileShare.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.FileShares/fileShares/{resourceName}/fileShareSnapshots
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The resource name of the file share, as seen by the administrator through Azure Resource Manager. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The FileShareSnapshot items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
snapshotTime:
{
Description: The FileShareSnapshot time in UTC in string representation ,
Required: False ,
}
string ,
initiatorId:
{
Description: The initiator of the FileShareSnapshot. This is a user-defined value. ,
Required: False ,
}
string ,
metadata:
{
Description: The metadata ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FileShareSnapshot_Get (new)
Description :  Get a FileShareSnapshot
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.FileShares/fileShares/{resourceName}/fileShareSnapshots/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The resource name of the file share, as seen by the administrator through Azure Resource Manager. ,
Required: True ,
}
string ,
name:
{
Description: The name of the FileShareSnapshot ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
snapshotTime:
{
Description: The FileShareSnapshot time in UTC in string representation ,
Required: False ,
}
string ,
initiatorId:
{
Description: The initiator of the FileShareSnapshot. This is a user-defined value. ,
Required: False ,
}
string ,
metadata:
{
Description: The metadata ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FileShareSnapshot_CreateOrUpdate (new)
Description :  Create a FileShareSnapshot.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.FileShares/fileShares/{resourceName}/fileShareSnapshots/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The resource name of the file share, as seen by the administrator through Azure Resource Manager. ,
Required: True ,
}
string ,
name:
{
Description: The name of the FileShareSnapshot ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
snapshotTime:
{
Description: The FileShareSnapshot time in UTC in string representation ,
Required: False ,
}
string ,
initiatorId:
{
Description: The initiator of the FileShareSnapshot. This is a user-defined value. ,
Required: False ,
}
string ,
metadata:
{
Description: The metadata ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FileShareSnapshot_Update (new)
Description :  Update a FileShareSnapshot.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.FileShares/fileShares/{resourceName}/fileShareSnapshots/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The resource name of the file share, as seen by the administrator through Azure Resource Manager. ,
Required: True ,
}
string ,
name:
{
Description: The name of the FileShareSnapshot ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
metadata:
{
Description: The metadata ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
snapshotTime:
{
Description: The FileShareSnapshot time in UTC in string representation ,
Required: False ,
}
string ,
initiatorId:
{
Description: The initiator of the FileShareSnapshot. This is a user-defined value. ,
Required: False ,
}
string ,
metadata:
{
Description: The metadata ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FileShareSnapshot_Delete (new)
Description :  Delete a FileShareSnapshot.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.FileShares/fileShares/{resourceName}/fileShareSnapshots/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
resourceName:
{
Description: The resource name of the file share, as seen by the administrator through Azure Resource Manager. ,
Required: True ,
}
string ,
name:
{
Description: The name of the FileShareSnapshot ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}