Obtener las propiedades del servicio de archivos

Artículo
07/19/2023

La Get File Service Properties operación obtiene propiedades para el FileService recurso mediante la API FileREST. Aunque esta API es totalmente compatible, es una API de administración heredada. En su lugar, se recomienda usar Servicios de archivos: Obtener propiedades del servicio, que proporciona el proveedor de recursos de almacenamiento (Microsoft.Storage). Para obtener más información sobre la interacción mediante programación con el FileService recurso mediante el proveedor de recursos de almacenamiento, consulte Operaciones en el recurso FileService.

Disponibilidad del protocolo

Protocolo de recurso compartido de archivos habilitado	Disponible
SMB
NFS

Request

La solicitud Get File Service Properties se puede especificar como sigue. Se recomienda usar HTTPS. Reemplace <account-name> por el nombre de la cuenta de almacenamiento:

Método	URI de solicitud	Versión de HTTP
GET	`https://<account-name>.file.core.windows.net/?restype=service&comp=properties`	HTTP/1.1

Nota

El URI siempre debe incluir un carácter de barra diagonal (/) para separar el nombre de host de la ruta de acceso y las partes de consulta del URI. En esta operación, la parte de ruta de acceso del URI está vacía.

Parámetros del identificador URI

Parámetro de URI	Descripción
`restype=service&comp=properties`	Necesario. Es necesaria la combinación de ambas cadenas de consulta para establecer las propiedades del servicio de almacenamiento.
`timeout`	Opcional. El parámetro `timeout` se expresa en segundos. Para obtener más información, consulte Establecimiento de tiempos de espera para las operaciones del servicio de archivos.

Encabezados de solicitud

En la tabla siguiente se describen los encabezados de solicitud requeridos y opcionales.

Encabezado de solicitud	Descripción
`Authorization`	Necesario. Especifica el esquema de autorización, el nombre de la cuenta de almacenamiento y la firma. Para obtener más información, vea Autorización de solicitudes a Azure Storage.
`Date` o `x-ms-date`	Necesario. Especifica la hora universal coordinada (UTC) de la solicitud. Para obtener más información, vea Autorización de solicitudes a Azure Storage.
`x-ms-version`	Necesario para todas las solicitudes autorizadas. Especifica la versión de la operación que se utiliza para esta solicitud. Esta operación solo está disponible en la versión 2015-02-21 y posteriores. Para recuperar las propiedades de métricas del servicio File, debe especificar la versión 2015-04-05 o posterior. Para obtener más información, vea Versiones de los servicios de Azure Storage.
`x-ms-client-request-id`	Opcional. Proporciona un valor opaco generado por el cliente con un límite de caracteres de 1 kibibyte (KiB) que se registra en los registros de Azure Storage Analytics cuando se configura el registro. Se recomienda encarecidamente usar este encabezado para correlacionar las actividades del lado cliente con las solicitudes que recibe el servidor. Para obtener más información, consulte Supervisión de Azure Files.

Cuerpo de la solicitud

Ninguno.

Response

La respuesta incluye un código de estado HTTP, un conjunto de encabezados de respuesta y un cuerpo de respuesta.

status code

Una operación correcta devuelve el código de estado 200 Correcto.

Encabezados de respuesta

La respuesta para esta operación incluye los encabezados siguientes. La respuesta también puede incluir otros encabezados HTTP estándar. Todos los encabezados estándar se ajustan a la especificación del protocolo HTTP/1.1.

Encabezado de respuesta	Descripción
`x-ms-request-id`	Identifica de forma única una solicitud que se realiza en el servicio.
`x-ms-version`	Especifica la versión de la operación que se usa para la respuesta. Para obtener más información, vea Versiones de los servicios de Azure Storage.
`x-ms-client-request-id`	Se puede usar para solucionar problemas de solicitudes y sus respuestas correspondientes. El valor de este encabezado es igual al valor del `x-ms-client-request-id` encabezado si está presente en la solicitud y el valor no contiene más de 1024 caracteres ASCII visibles. Si el `x-ms-client-request-id` encabezado no está presente en la solicitud, no está presente en la respuesta.

Response body

El formato del cuerpo de la respuesta para la versión 2020-02-10 es el siguiente:

<?xml version="1.0" encoding="utf-8"?>  
<StorageServiceProperties>  
    <HourMetrics>  
        <Version>version-number</Version>  
        <Enabled>true|false</Enabled>  
        <IncludeAPIs>true|false</IncludeAPIs>  
        <RetentionPolicy>  
            <Enabled>true|false</Enabled>  
            <Days>number-of-days</Days>  
        </RetentionPolicy>  
    </HourMetrics>  
    <MinuteMetrics>  
        <Version>version-number</Version>  
        <Enabled>true|false</Enabled>  
        <IncludeAPIs>true|false</IncludeAPIs>  
        <RetentionPolicy>  
            <Enabled>true|false</Enabled>  
            <Days>number-of-days</Days>  
        </RetentionPolicy>  
    </MinuteMetrics>  
    <Cors>  
        <CorsRule>  
            <AllowedOrigins>comma-separated-list-of-allowed-origins</AllowedOrigins>  
            <AllowedMethods>comma-separated-list-of-HTTP-verb</AllowedMethods>  
            <MaxAgeInSeconds>max-caching-age-in-seconds</MaxAgeInSeconds>  
            <ExposedHeaders>comma-seperated-list-of-response-headers</ExposedHeaders>  
            <AllowedHeaders>comma-seperated-list-of-request-headers</AllowedHeaders>  
        </CorsRule>  
    </Cors>
    <ShareDeleteRetentionPolicy>
        <Enabled>true|false</Enabled>
        <Days>integer-value</Days>
    </ShareDeleteRetentionPolicy>
    <ProtocolSettings>
        <SMB>
            <Multichannel>
                <Enabled>true|false</Enabled>
            </Multichannel>
            <Versions>comma-separated-list-of-smb-versions</Versions>
            <AuthenticationMethods>comma-separated-list-of-auth-methods</AuthenticationMethod>
            <KerberosTicketEncryption>csv-of-kerb-encryption-algorithms</KerberosTicketEncryption>
            <ChannelEncryption>csv-of-smb-encryption-algorithms</ChannelEncryption>
        </SMB>
    </ProtocolSettings>
</StorageServiceProperties>

Los elementos del cuerpo de respuesta se describen en la tabla siguiente:

Nombre	Descripción
`HourMetrics`	Agrupa la configuración de Storage Analytics`HourMetrics`. La `HourMetrics` configuración proporciona un resumen de las estadísticas de solicitud, agrupadas por API en agregados por hora.
`MinuteMetrics`	Agrupa la configuración de Storage Analytics`MinuteMetrics`. La `MinuteMetrics` configuración proporciona estadísticas de solicitud para cada minuto.
`Version`	La versión de Storage Analytics que está actualmente en uso.
`Enabled`	Indica si las métricas están habilitadas para el servicio File.
`IncludeAPIs`	Indica si las métricas generan estadísticas de resumen para las operaciones de API a las que se ha llamado.
`RetentionPolicy/Enabled`	Indica si una directiva de retención está habilitada para el servicio de archivos.
`RetentionPolicy/Days`	Indica el número de días durante los que se conservan los datos de métricas. Todos los datos anteriores a este valor se eliminan de la mejor manera posible.
`Cors`	Agrupa todas las reglas de uso compartido de recursos entre orígenes (CORS).
`CorsRule`	Agrupa los valores de una regla de CORS.
`AllowedOrigins`	Lista delimitada por comas de dominios de origen que se permiten mediante CORS, o “*” si se permiten todos los dominios.
`ExposedHeaders`	Lista delimitada por comas de encabezados de respuesta para exponer a los clientes de CORS.
`MaxAgeInSeconds`	Número de segundos que el cliente o explorador debe almacenar en caché una respuesta preparatoria.
`AllowedHeaders`	Lista separada por comas de encabezados que pueden formar parte de la solicitud entre orígenes.
`AllowedMethods`	Lista delimitada por comas de los métodos HTTP que puede ejecutar el origen. Para Azure Files, los métodos permitidos son DELETE, GET, HEAD, MERGE, POST, OPTIONS y PUT.
`ShareDeleteRetentionPolicy`	Las propiedades de eliminación temporal de los recursos compartidos de archivos de Azure en esta cuenta de almacenamiento.
`Days`	Indica el número de días que se debe conservar el recurso compartido de archivos de Azure (eliminado temporalmente). El valor mínimo especificado puede ser 1 y el valor máximo es 365.
`Enabled`	Indica si la cuenta de almacenamiento tiene habilitada la eliminación temporal para Azure Files.
`ProtocolSettings`	Agrupa la configuración de los protocolos del sistema de archivos.
`SMB`	Agrupa la configuración del bloque de mensajes del servidor (SMB).
`Multichannel`	Contiene la configuración de SMB multicanal. Esta configuración tiene una propiedad: habilitada o deshabilitada.
`Version`	Disponible a partir de la versión 2020-04-08. Lista separada por comas de las versiones de SMB permitidas. Valores posibles: `SMB2.1`, `SMB3.0` y `SMB3.1.1`. Si `Version` no se especifica, el valor predeterminado es que todas las versiones están habilitadas. Sin embargo, SMB 2.1 solo está disponible si la propiedad de `require secure transit` la cuenta de almacenamiento está deshabilitada, ya que SMB 2.1 no admite el cifrado.
`AuthenticationMethods`	Disponible a partir de la versión 2020-04-08. Lista separada por comas de métodos de autenticación permitidos. Valores posibles: `NTLMv2`, `Kerberos`. Si `AuthenticationMethods` no se especifica , el valor predeterminado es que se permiten todos los métodos de autenticación.
`KerberosTicketEncryption`	Disponible a partir de la versión 2020-04-08. Lista separada por comas de algoritmos de cifrado de vales Kerberos permitidos. Valores posibles: `RC4-HMAC` y `AES-256`. Si `KerberosTicketEncryption` no se especifica , el valor predeterminado es que se admiten todos los algoritmos de cifrado de vales kerberos.
`ChannelEncryption`	Disponible a partir de la versión 2020-04-08. Lista separada por comas de protocolos de cifrado de canales SMB permitidos. Valores posibles: `AES-128-CCM`, `AES-128-GCM` y `AES-256-GCM`. Si `ChannelEncryption` no se especifica, el valor predeterminado es que se admiten todos los valores de cifrado de canal. Si la propiedad de la cuenta de `require secure transit` almacenamiento está deshabilitada, también se permite el acceso SMB sin cifrar.

Authorization

Solo el propietario de la cuenta de almacenamiento puede llamar a esta operación.

Solicitud y respuesta de ejemplo

El siguiente URI de ejemplo realiza una solicitud para obtener las propiedades del servicio de archivos para una cuenta de almacenamiento denominada myaccount:

Método	Resolución	Protocolo
GET	`https://myaccount.file.core.windows.net/?restype=service&comp=properties`	HTTP/1.1

La solicitud se envía con los encabezados siguientes:

x-ms-version: 2020-02-10  
x-ms-date: <date>  
Authorization: SharedKey  
myaccount:Z1lTLDwtq5o1UYQluucdsXk6/iB7YxEu0m6VofAEkUE=  
Host: myaccount.file.core.windows.net

Una vez enviada la solicitud, se devuelve la respuesta siguiente:

HTTP/1.1 200 OK  
Content-Length: 1020  
Content-Type: application/xml  
Date: <date>  
Server: Windows-Azure-File/1.0 Microsoft-HTTPAPI/2.0  
x-ms-request-id: cb939a31-0cc6-49bb-9fe5-3327691f2a30  
x-ms-version: 2015-04-05

La respuesta incluye el cuerpo XML siguiente.

<?xml version="1.0" encoding="utf-8"?>  
<StorageServiceProperties>  
    <HourMetrics>  
        <Version>1.0</Version>  
        <Enabled>true</Enabled>  
        <IncludeAPIs>false</IncludeAPIs>  
        <RetentionPolicy>  
            <Enabled>true</Enabled>  
            <Days>7</Days>  
        </RetentionPolicy>  
    </HourMetrics>  
    <MinuteMetrics>  
        <Version>1.0</Version>  
        <Enabled>true</Enabled>  
        <IncludeAPIs>true</IncludeAPIs>  
        <RetentionPolicy>  
            <Enabled>true</Enabled>  
            <Days>7</Days>  
        </RetentionPolicy>  
    </MinuteMetrics>  
    <Cors>  
        <CorsRule>  
            <AllowedOrigins>http://www.fabrikam.com,http://www.contoso.com</AllowedOrigins>  
            <AllowedMethods>GET,PUT</AllowedMethods>  
            <MaxAgeInSeconds>500</MaxAgeInSeconds>  
            <ExposedHeaders>x-ms-meta-data*,x-ms-meta-customheader</ExposedHeaders>  
            <AllowedHeaders>x-ms-meta-target*,x-ms-meta-customheader</AllowedHeaders>  
        </CorsRule>  
    </Cors>
    <ShareDeleteRetentionPolicy>
        <Enabled>true</Enabled>
        <Days>7</Days>
    </ShareDeleteRetentionPolicy>
    <ProtocolSettings>
        <SMB>
            <Multichannel>
                <Enabled>true</Enabled>
            </Multichannel>
            <Versions>SMB3.1.1</Versions>
            <AuthenticationMethods>Kerberos</AuthenticationMethods>
            <KerberosTicketEncryption>AES-256</KerberosTicketEncryption>
            <ChannelEncryption>AES-256-GCM</ChannelEncryption>
        </SMB>
    </ProtocolSettings>
</StorageServiceProperties>

Comentarios

Para obtener información detallada sobre las reglas de CORS y la lógica de evaluación, consulte Compatibilidad de CORS con los servicios de Azure Storage.

Para más información, consulte Storage Analytics.