Compartilhar via


File Shares - Update

Atualiza as propriedades de compartilhamento conforme especificado no corpo da solicitação. As propriedades não mencionadas na solicitação não serão alteradas. A atualização falhará se o compartilhamento especificado ainda não existir.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares/{shareName}?api-version=2025-06-01

Parâmetros de URI

Nome Em Obrigatório Tipo Description
accountName
path True

string

minLength: 3
maxLength: 24
pattern: ^[a-z0-9]+$

O nome da conta de armazenamento dentro do grupo de recursos especificado. Os nomes da conta de armazenamento devem ter entre 3 e 24 caracteres, usar números e apenas letras minúsculas.

resourceGroupName
path True

string

minLength: 1
maxLength: 90

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

shareName
path True

string

minLength: 3
maxLength: 63

O nome do compartilhamento de arquivos na conta de armazenamento especificada. Os nomes de compartilhamento de arquivos devem ter entre 3 e 63 caracteres e usar apenas números, letras minúsculas e traço (-). Cada caractere de traço (-) deve ser imediatamente precedido e seguido por uma letra ou número.

subscriptionId
path True

string (uuid)

A ID da assinatura de destino. O valor deve ser uma UUID.

api-version
query True

string

minLength: 1

A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome Tipo Description
properties.accessTier

ShareAccessTier

Camada de acesso para compartilhamento específico. A conta gpV2 pode escolher entre TransactionOptimized (padrão), Hot e Cool. A conta FileStorage pode escolher Premium.

properties.enabledProtocols

EnabledProtocols

O protocolo de autenticação usado para o compartilhamento de arquivos. Só pode ser especificado ao criar um compartilhamento.

properties.fileSharePaidBursting

FileSharePropertiesFileSharePaidBursting

Propriedades de Intermitência Paga do Compartilhamento de Arquivos.

properties.metadata

object

Um par nome-valor a ser associado ao compartilhamento como metadados.

properties.provisionedBandwidthMibps

integer (int32)

A largura de banda provisionada do compartilhamento, em mebibytes por segundo. Essa propriedade é apenas para compartilhamentos de arquivos criados no tipo de conta Files Provisioned v2. Consulte a resposta da API GetFileServiceUsage para obter o valor mínimo e máximo permitido para largura de banda provisionada.

properties.provisionedIops

integer (int32)

O IOPS provisionado do compartilhamento. Essa propriedade é apenas para compartilhamentos de arquivos criados no tipo de conta Files Provisioned v2. Consulte a resposta da API GetFileServiceUsage para obter o valor mínimo e máximo permitido para IOPS provisionado.

properties.rootSquash

RootSquashType

A propriedade é somente para compartilhamento NFS. O padrão é NoRootSquash.

properties.shareQuota

integer (int32)

O tamanho provisionado do compartilhamento, em gibibytes. Deve ser maior que 0 e menor ou igual a 5 TB (5120). Para Compartilhamentos de Arquivos Grandes, o tamanho máximo é 102400. Para compartilhamentos de arquivos criados em arquivos provisionados tipo de conta v2, consulte a resposta da API GetFileServiceUsage para o tamanho mínimo e máximo de armazenamento provisionado permitido.

properties.signedIdentifiers

SignedIdentifier[]

Lista de políticas de acesso armazenadas especificadas no compartilhamento.

Respostas

Nome Tipo Description
200 OK

FileShare

A operação do Azure foi concluída com êxito.

Other Status Codes

CloudError

Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

UpdateShareAcls
UpdateSharePaidBursting
UpdateShareProvisionedV2
UpdateShares

UpdateShareAcls

Solicitação de exemplo

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/fileServices/default/shares/share6185?api-version=2025-06-01

{
  "properties": {
    "signedIdentifiers": [
      {
        "accessPolicy": {
          "expiryTime": "2021-05-01T08:49:37.0000000Z",
          "permission": "rwd",
          "startTime": "2021-04-01T08:49:37.0000000Z"
        },
        "id": "MTIzNDU2Nzg5MDEyMzQ1Njc4OTAxMjM0NTY3ODkwMTI"
      }
    ]
  }
}

Resposta de exemplo

{
  "name": "share6185",
  "type": "Microsoft.Storage/storageAccounts/fileServices/shares",
  "id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/fileServices/default/shares/share6185",
  "properties": {
    "signedIdentifiers": [
      {
        "accessPolicy": {
          "expiryTime": "2021-05-01T08:49:37.0000000Z",
          "permission": "rwd",
          "startTime": "2021-04-01T08:49:37.0000000Z"
        },
        "id": "MTIzNDU2Nzg5MDEyMzQ1Njc4OTAxMjM0NTY3ODkwMTI"
      }
    ]
  }
}

UpdateSharePaidBursting

Solicitação de exemplo

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/fileServices/default/shares/share6185?api-version=2025-06-01

{
  "properties": {
    "fileSharePaidBursting": {
      "paidBurstingEnabled": true,
      "paidBurstingMaxBandwidthMibps": 10340,
      "paidBurstingMaxIops": 102400
    }
  }
}

Resposta de exemplo

{
  "name": "share6185",
  "type": "Microsoft.Storage/storageAccounts/fileServices/shares",
  "id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/fileServices/default/shares/share6185",
  "properties": {
    "fileSharePaidBursting": {
      "paidBurstingEnabled": true,
      "paidBurstingMaxBandwidthMibps": 10340,
      "paidBurstingMaxIops": 102400
    }
  }
}

UpdateShareProvisionedV2

Solicitação de exemplo

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/fileServices/default/shares/share6185?api-version=2025-06-01

{
  "properties": {
    "provisionedBandwidthMibps": 200,
    "provisionedIops": 5000,
    "shareQuota": 100
  }
}

Resposta de exemplo

{
  "name": "share6185",
  "type": "Microsoft.Storage/storageAccounts/fileServices/shares",
  "id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/fileServices/default/shares/share6185",
  "properties": {
    "includedBurstIops": 15000,
    "maxBurstCreditsForIops": 36000000,
    "nextAllowedProvisionedBandwidthDowngradeTime": "Fri, 25 Oct 2024 01:48:09 GMT",
    "nextAllowedProvisionedIopsDowngradeTime": "Fri, 25 Oct 2024 01:48:09 GMT",
    "nextAllowedQuotaDowngradeTime": "Sat, 26 Oct 2024 01:50:50 GMT",
    "provisionedBandwidthMibps": 200,
    "provisionedIops": 5000,
    "shareQuota": 100
  }
}

UpdateShares

Solicitação de exemplo

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/fileServices/default/shares/share6185?api-version=2025-06-01

{
  "properties": {
    "metadata": {
      "type": "image"
    }
  }
}

Resposta de exemplo

{
  "name": "share6185",
  "type": "Microsoft.Storage/storageAccounts/fileServices/shares",
  "id": "/subscriptions/{subscription-id}/resourceGroups/res3376/providers/Microsoft.Storage/storageAccounts/sto328/fileServices/default/shares/share6185",
  "properties": {
    "metadata": {
      "type": "image"
    }
  }
}

Definições

Nome Description
AccessPolicy
CloudError

Uma resposta de erro do serviço de Armazenamento.

CloudErrorBody

Uma resposta de erro do serviço de Armazenamento.

EnabledProtocols

O protocolo de autenticação usado para o compartilhamento de arquivos. Só pode ser especificado ao criar um compartilhamento.

FileShare

Propriedades do compartilhamento de arquivos, incluindo ID, nome do recurso, tipo de recurso, Etag.

FileSharePropertiesFileSharePaidBursting

Propriedades de Intermitência Paga do Compartilhamento de Arquivos.

LeaseDuration

Especifica se a concessão de um contêiner é de duração infinita ou fixa, somente quando o contêiner é concedido.

LeaseState

Estado de concessão do contêiner.

LeaseStatus

O status de concessão do contêiner.

RootSquashType

A propriedade é somente para compartilhamento NFS. O padrão é NoRootSquash.

ShareAccessTier

Camada de acesso para compartilhamento específico. A conta gpV2 pode escolher entre TransactionOptimized (padrão), Hot e Cool. A conta FileStorage pode escolher Premium.

SignedIdentifier

AccessPolicy

Nome Tipo Description
expiryTime

string (date-time)

Hora de expiração da política de acesso

permission

string

Lista de permissões abreviadas.

startTime

string (date-time)

Hora de início da política de acesso

CloudError

Uma resposta de erro do serviço de Armazenamento.

Nome Tipo Description
error

CloudErrorBody

Uma resposta de erro do serviço de Armazenamento.

CloudErrorBody

Uma resposta de erro do serviço de Armazenamento.

Nome Tipo Description
code

string

Um identificador para o erro. Os códigos são invariáveis e devem ser consumidos programaticamente.

details

CloudErrorBody[]

Uma lista de detalhes adicionais sobre o erro.

message

string

Uma mensagem que descreve o erro, destinada a ser adequada para exibição em uma interface do usuário.

target

string

O destino do erro específico. Por exemplo, o nome da propriedade em erro.

EnabledProtocols

O protocolo de autenticação usado para o compartilhamento de arquivos. Só pode ser especificado ao criar um compartilhamento.

Valor Description
SMB
NFS

FileShare

Propriedades do compartilhamento de arquivos, incluindo ID, nome do recurso, tipo de recurso, Etag.

Nome Tipo Description
etag

string

Etag de recurso.

id

string

ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

O nome do recurso

properties.accessTier

ShareAccessTier

Camada de acesso para compartilhamento específico. A conta gpV2 pode escolher entre TransactionOptimized (padrão), Hot e Cool. A conta FileStorage pode escolher Premium.

properties.accessTierChangeTime

string (date-time)

Indica a hora da última modificação para a camada de acesso de compartilhamento.

properties.accessTierStatus

string

Indica se há uma transição pendente para a camada de acesso.

properties.deleted

boolean

Indica se o compartilhamento foi excluído.

properties.deletedTime

string (date-time)

A hora excluída se o compartilhamento foi excluído.

properties.enabledProtocols

EnabledProtocols

O protocolo de autenticação usado para o compartilhamento de arquivos. Só pode ser especificado ao criar um compartilhamento.

properties.fileSharePaidBursting

FileSharePropertiesFileSharePaidBursting

Propriedades de Intermitência Paga do Compartilhamento de Arquivos.

properties.includedBurstIops

integer (int32)

O IOPS de intermitência calculado do compartilhamento. Essa propriedade é apenas para compartilhamentos de arquivos criados no tipo de conta Files Provisioned v2.

properties.lastModifiedTime

string (date-time)

Retorna a data e a hora em que o compartilhamento foi modificado pela última vez.

properties.leaseDuration

LeaseDuration

Especifica se o arrendamento de uma ação é de duração infinita ou fixa, somente quando a ação é arrendada.

properties.leaseState

LeaseState

Estado de locação da ação.

properties.leaseStatus

LeaseStatus

O status de concessão da ação.

properties.maxBurstCreditsForIops

integer (int64)

O máximo de créditos de intermitência calculados para o compartilhamento. Essa propriedade é apenas para compartilhamentos de arquivos criados no tipo de conta Files Provisioned v2.

properties.metadata

object

Um par nome-valor a ser associado ao compartilhamento como metadados.

properties.nextAllowedProvisionedBandwidthDowngradeTime

string (date-time-rfc7231)

Retorna o próximo tempo de downgrade de largura de banda provisionada permitido para o compartilhamento. Essa propriedade é apenas para compartilhamentos de arquivos criados no tipo de conta Files Provisioned v2.

properties.nextAllowedProvisionedIopsDowngradeTime

string (date-time-rfc7231)

Retorna o próximo tempo de downgrade de IOPS provisionadas permitido para o compartilhamento. Essa propriedade é apenas para compartilhamentos de arquivos criados no tipo de conta Files Provisioned v2.

properties.nextAllowedQuotaDowngradeTime

string (date-time-rfc7231)

Retorna o próximo tempo de downgrade do tamanho de armazenamento provisionado permitido para o compartilhamento. Essa propriedade é apenas para compartilhamentos de arquivos criados no tipo de conta Arquivos provisionados v1 SSD e Arquivos provisionados v2

properties.provisionedBandwidthMibps

integer (int32)

A largura de banda provisionada do compartilhamento, em mebibytes por segundo. Essa propriedade é apenas para compartilhamentos de arquivos criados no tipo de conta Files Provisioned v2. Consulte a resposta da API GetFileServiceUsage para obter o valor mínimo e máximo permitido para largura de banda provisionada.

properties.provisionedIops

integer (int32)

O IOPS provisionado do compartilhamento. Essa propriedade é apenas para compartilhamentos de arquivos criados no tipo de conta Files Provisioned v2. Consulte a resposta da API GetFileServiceUsage para obter o valor mínimo e máximo permitido para IOPS provisionado.

properties.remainingRetentionDays

integer (int32)

Dias de retenção restantes para o compartilhamento que foi excluído de forma reversível.

properties.rootSquash

RootSquashType

A propriedade é somente para compartilhamento NFS. O padrão é NoRootSquash.

properties.shareQuota

integer (int32)

O tamanho provisionado do compartilhamento, em gibibytes. Deve ser maior que 0 e menor ou igual a 5 TB (5120). Para Compartilhamentos de Arquivos Grandes, o tamanho máximo é 102400. Para compartilhamentos de arquivos criados em arquivos provisionados tipo de conta v2, consulte a resposta da API GetFileServiceUsage para o tamanho mínimo e máximo de armazenamento provisionado permitido.

properties.shareUsageBytes

integer (int64)

O tamanho aproximado dos dados armazenados no compartilhamento. Observe que esse valor pode não incluir todos os arquivos criados ou redimensionados recentemente.

properties.signedIdentifiers

SignedIdentifier[]

Lista de políticas de acesso armazenadas especificadas no compartilhamento.

properties.snapshotTime

string (date-time)

Hora de criação do instantâneo de compartilhamento retornado na resposta de compartilhamentos de lista com "instantâneos" de parâmetro de expansão.

properties.version

string

A versão do compartilhamento.

type

string

O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

FileSharePropertiesFileSharePaidBursting

Propriedades de Intermitência Paga do Compartilhamento de Arquivos.

Nome Tipo Description
paidBurstingEnabled

boolean

Indica se o estouro pago está habilitado para o compartilhamento. Essa propriedade é apenas para compartilhamentos de arquivos criados no tipo de conta SSD Files Provisioned v1.

paidBurstingMaxBandwidthMibps

integer (int32)

A largura de banda máxima paga para o compartilhamento, em mebibytes por segundo. Essa propriedade é apenas para compartilhamentos de arquivos criados no tipo de conta SSD Files Provisioned v1. O valor máximo permitido é 10340, que é a largura de banda máxima permitida para um compartilhamento.

paidBurstingMaxIops

integer (int32)

O IOPS de intermitência máximo pago para o compartilhamento. Essa propriedade é apenas para compartilhamentos de arquivos criados no tipo de conta SSD Files Provisioned v1. O valor máximo permitido é 102400, que é o IOPS máximo permitido para um compartilhamento.

LeaseDuration

Especifica se a concessão de um contêiner é de duração infinita ou fixa, somente quando o contêiner é concedido.

Valor Description
Infinite
Fixed

LeaseState

Estado de concessão do contêiner.

Valor Description
Available
Leased
Expired
Breaking
Broken

LeaseStatus

O status de concessão do contêiner.

Valor Description
Locked
Unlocked

RootSquashType

A propriedade é somente para compartilhamento NFS. O padrão é NoRootSquash.

Valor Description
NoRootSquash
RootSquash
AllSquash

ShareAccessTier

Camada de acesso para compartilhamento específico. A conta gpV2 pode escolher entre TransactionOptimized (padrão), Hot e Cool. A conta FileStorage pode escolher Premium.

Valor Description
TransactionOptimized
Hot
Cool
Premium

SignedIdentifier

Nome Tipo Description
accessPolicy

AccessPolicy

Política de acesso

id

string

Um identificador exclusivo da política de acesso armazenada.