File Services - Get Service Properties

Referência

Serviço:: Storage Resource Provider

Versão da API:: 2023-05-01

Obtém as propriedades dos serviços de arquivo em contas de armazenamento, incluindo regras CORS (Cross-Origin Resource Sharing).

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default?api-version=2023-05-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
accountName	path	True	string	O nome da conta de armazenamento dentro do grupo de recursos especificado. Os nomes das contas de armazenamento devem ter entre 3 e 24 caracteres e usar apenas números e letras minúsculas. Padrão Regex: `^[a-z0-9]+$`
FileServicesName	path	True	FileServicesName	O nome do serviço de arquivo dentro da conta de armazenamento especificada. Nome do Serviço de Arquivo deve ser "padrão"
resourceGroupName	path	True	string	O nome do grupo de recursos dentro da assinatura do usuário. O nome não diferencia maiúsculas de minúsculas. Padrão Regex: `^[-\w\._\(\)]+$`
subscriptionId	path	True	string	A ID da assinatura de destino.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Respostas

Name	Tipo	Description
200 OK	FileServiceProperties	OK -- retornou as propriedades do serviço de arquivo de uma conta de armazenamento.
Other Status Codes	CloudError	Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

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

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

GetFileServices

Pedido de amostra

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res4410/providers/Microsoft.Storage/storageAccounts/sto8607/fileServices/default?api-version=2023-05-01


/**
 * Samples for FileServices GetServiceProperties.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/examples/FileServicesGet.json
     */
    /**
     * Sample code: GetFileServices.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getFileServices(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.storageAccounts().manager().serviceClient().getFileServices().getServicePropertiesWithResponse("res4410",
            "sto8607", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.storage import StorageManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-storage
# USAGE
    python file_services_get.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = StorageManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="{subscription-id}",
    )

    response = client.file_services.get_service_properties(
        resource_group_name="res4410",
        account_name="sto8607",
    )
    print(response)


# x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/examples/FileServicesGet.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armstorage_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storage/armstorage"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/220ad9c6554fc7d6d10a89bdb441c1e3b36e3285/specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/examples/FileServicesGet.json
func ExampleFileServicesClient_GetServiceProperties() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armstorage.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewFileServicesClient().GetServiceProperties(ctx, "res4410", "sto8607", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.FileServiceProperties = armstorage.FileServiceProperties{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.Storage/storageAccounts/fileServices"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/res4410/providers/Microsoft.Storage/storageAccounts/sto8607/fileServices/default"),
	// 	FileServiceProperties: &armstorage.FileServicePropertiesProperties{
	// 		Cors: &armstorage.CorsRules{
	// 			CorsRules: []*armstorage.CorsRule{
	// 				{
	// 					AllowedHeaders: []*string{
	// 						to.Ptr("x-ms-meta-abc"),
	// 						to.Ptr("x-ms-meta-data*"),
	// 						to.Ptr("x-ms-meta-target*")},
	// 						AllowedMethods: []*armstorage.CorsRuleAllowedMethodsItem{
	// 							to.Ptr(armstorage.CorsRuleAllowedMethodsItemGET),
	// 							to.Ptr(armstorage.CorsRuleAllowedMethodsItemHEAD),
	// 							to.Ptr(armstorage.CorsRuleAllowedMethodsItemPOST),
	// 							to.Ptr(armstorage.CorsRuleAllowedMethodsItemOPTIONS),
	// 							to.Ptr(armstorage.CorsRuleAllowedMethodsItemMERGE),
	// 							to.Ptr(armstorage.CorsRuleAllowedMethodsItemPUT)},
	// 							AllowedOrigins: []*string{
	// 								to.Ptr("http://www.contoso.com"),
	// 								to.Ptr("http://www.fabrikam.com")},
	// 								ExposedHeaders: []*string{
	// 									to.Ptr("x-ms-meta-*")},
	// 									MaxAgeInSeconds: to.Ptr[int32](100),
	// 								},
	// 								{
	// 									AllowedHeaders: []*string{
	// 										to.Ptr("*")},
	// 										AllowedMethods: []*armstorage.CorsRuleAllowedMethodsItem{
	// 											to.Ptr(armstorage.CorsRuleAllowedMethodsItemGET)},
	// 											AllowedOrigins: []*string{
	// 												to.Ptr("*")},
	// 												ExposedHeaders: []*string{
	// 													to.Ptr("*")},
	// 													MaxAgeInSeconds: to.Ptr[int32](2),
	// 												},
	// 												{
	// 													AllowedHeaders: []*string{
	// 														to.Ptr("x-ms-meta-12345675754564*")},
	// 														AllowedMethods: []*armstorage.CorsRuleAllowedMethodsItem{
	// 															to.Ptr(armstorage.CorsRuleAllowedMethodsItemGET),
	// 															to.Ptr(armstorage.CorsRuleAllowedMethodsItemPUT)},
	// 															AllowedOrigins: []*string{
	// 																to.Ptr("http://www.abc23.com"),
	// 																to.Ptr("https://www.fabrikam.com/*")},
	// 																ExposedHeaders: []*string{
	// 																	to.Ptr("x-ms-meta-abc"),
	// 																	to.Ptr("x-ms-meta-data*"),
	// 																	to.Ptr("x-ms-meta-target*")},
	// 																	MaxAgeInSeconds: to.Ptr[int32](2000),
	// 															}},
	// 														},
	// 													},
	// 													SKU: &armstorage.SKU{
	// 														Name: to.Ptr(armstorage.SKUNameStandardGRS),
	// 														Tier: to.Ptr(armstorage.SKUTierStandard),
	// 													},
	// 												}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { StorageManagementClient } = require("@azure/arm-storage");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets the properties of file services in storage accounts, including CORS (Cross-Origin Resource Sharing) rules.
 *
 * @summary Gets the properties of file services in storage accounts, including CORS (Cross-Origin Resource Sharing) rules.
 * x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/examples/FileServicesGet.json
 */
async function getFileServices() {
  const subscriptionId = process.env["STORAGE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["STORAGE_RESOURCE_GROUP"] || "res4410";
  const accountName = "sto8607";
  const credential = new DefaultAzureCredential();
  const client = new StorageManagementClient(credential, subscriptionId);
  const result = await client.fileServices.getServiceProperties(resourceGroupName, accountName);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Storage.Models;
using Azure.ResourceManager.Storage;

// Generated from example definition: specification/storage/resource-manager/Microsoft.Storage/stable/2023-05-01/examples/FileServicesGet.json
// this example is just showing the usage of "FileServices_GetServiceProperties" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://video2.skills-academy.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this FileServiceResource created on azure
// for more information of creating FileServiceResource, please refer to the document of FileServiceResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "res4410";
string accountName = "sto8607";
ResourceIdentifier fileServiceResourceId = FileServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName);
FileServiceResource fileService = client.GetFileServiceResource(fileServiceResourceId);

// invoke the operation
FileServiceResource result = await fileService.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
FileServiceData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Resposta da amostra

Código de estado:: 200

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/res4410/providers/Microsoft.Storage/storageAccounts/sto8607/fileServices/default",
  "name": "default",
  "type": "Microsoft.Storage/storageAccounts/fileServices",
  "properties": {
    "cors": {
      "corsRules": [
        {
          "allowedOrigins": [
            "http://www.contoso.com",
            "http://www.fabrikam.com"
          ],
          "allowedMethods": [
            "GET",
            "HEAD",
            "POST",
            "OPTIONS",
            "MERGE",
            "PUT"
          ],
          "maxAgeInSeconds": 100,
          "exposedHeaders": [
            "x-ms-meta-*"
          ],
          "allowedHeaders": [
            "x-ms-meta-abc",
            "x-ms-meta-data*",
            "x-ms-meta-target*"
          ]
        },
        {
          "allowedOrigins": [
            "*"
          ],
          "allowedMethods": [
            "GET"
          ],
          "maxAgeInSeconds": 2,
          "exposedHeaders": [
            "*"
          ],
          "allowedHeaders": [
            "*"
          ]
        },
        {
          "allowedOrigins": [
            "http://www.abc23.com",
            "https://www.fabrikam.com/*"
          ],
          "allowedMethods": [
            "GET",
            "PUT"
          ],
          "maxAgeInSeconds": 2000,
          "exposedHeaders": [
            "x-ms-meta-abc",
            "x-ms-meta-data*",
            "x-ms-meta-target*"
          ],
          "allowedHeaders": [
            "x-ms-meta-12345675754564*"
          ]
        }
      ]
    }
  },
  "sku": {
    "name": "Standard_GRS",
    "tier": "Standard"
  }
}

Definições

Name	Description
AllowedMethods	Obrigatório se o elemento CorsRule estiver presente. Uma lista de métodos HTTP que podem ser executados pela origem.
CloudError	Uma resposta de erro do serviço de armazenamento.
CloudErrorBody	Uma resposta de erro do serviço de armazenamento.
CorsRule	Especifica uma regra CORS para o serviço Blob.
CorsRules	Define as regras do CORS. Você pode incluir até cinco elementos CorsRule na solicitação.
DeleteRetentionPolicy	As propriedades de serviço para exclusão suave.
FileServiceProperties	As propriedades dos serviços de arquivo na conta de armazenamento.
FileServicesName	O nome do serviço de arquivo dentro da conta de armazenamento especificada. Nome do Serviço de Arquivo deve ser "padrão"
Multichannel	Configuração multicanal. Aplica-se apenas ao Premium FileStorage.
ProtocolSettings	Configurações de protocolo para serviço de arquivo
Sku	O SKU da conta de armazenamento.
SkuName	O nome SKU. Necessário para a criação de conta; opcional para atualização. Observe que, em versões mais antigas, o nome da SKU era chamado accountType.
SkuTier	A camada de SKU. Isso é baseado no nome SKU.
SmbSetting	Configuração para o protocolo SMB

AllowedMethods

Obrigatório se o elemento CorsRule estiver presente. Uma lista de métodos HTTP que podem ser executados pela origem.

Name	Tipo	Description
CONNECT	string
DELETE	string
GET	string
HEAD	string
MERGE	string
OPTIONS	string
PATCH	string
POST	string
PUT	string
TRACE	string

CloudError

Uma resposta de erro do serviço de armazenamento.

Name	Tipo	Description
error	CloudErrorBody	Uma resposta de erro do serviço de armazenamento.

CloudErrorBody

Uma resposta de erro do serviço de armazenamento.

Name	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariantes e destinam-se a ser consumidos programaticamente.
details	CloudErrorBody[]	Uma lista de detalhes adicionais sobre o erro.
message	string	Uma mensagem descrevendo o erro, destinada a ser adequada para exibição em uma interface do usuário.
target	string	O alvo do erro específico. Por exemplo, o nome da propriedade em erro.

CorsRule

Especifica uma regra CORS para o serviço Blob.

Name	Tipo	Description
allowedHeaders	string[]	Obrigatório se o elemento CorsRule estiver presente. Uma lista de cabeçalhos que podem fazer parte da solicitação de origem cruzada.
allowedMethods	AllowedMethods[]	Obrigatório se o elemento CorsRule estiver presente. Uma lista de métodos HTTP que podem ser executados pela origem.
allowedOrigins	string[]	Obrigatório se o elemento CorsRule estiver presente. Uma lista de domínios de origem que serão permitidos via CORS, ou "*" para permitir todos os domínios
exposedHeaders	string[]	Obrigatório se o elemento CorsRule estiver presente. Uma lista de cabeçalhos de resposta para expor aos clientes CORS.
maxAgeInSeconds	integer	Obrigatório se o elemento CorsRule estiver presente. O número de segundos que o cliente/navegador deve armazenar em cache uma resposta de comprovação.

CorsRules

Define as regras do CORS. Você pode incluir até cinco elementos CorsRule na solicitação.

Name	Tipo	Description
corsRules	CorsRule[]	A lista de regras do CORS. Você pode incluir até cinco elementos CorsRule na solicitação.

DeleteRetentionPolicy

As propriedades de serviço para exclusão suave.

Name	Tipo	Description
allowPermanentDelete	boolean	Esta propriedade, quando definida como true, permite a exclusão das versões e instantâneos de blob excluídos suavemente. Esta propriedade não pode ser usada política de restauração de blob. Essa propriedade só se aplica ao serviço de blob e não se aplica a contêineres ou compartilhamento de arquivos.
days	integer	Indica o número de dias em que o item excluído deve ser mantido. O valor mínimo especificado pode ser 1 e o valor máximo pode ser 365.
enabled	boolean	Indica se DeleteRetentionPolicy está habilitado.

FileServiceProperties

As propriedades dos serviços de arquivo na conta de armazenamento.

Name	Tipo	Description
id	string	ID de recurso totalmente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	O nome do recurso
properties.cors	CorsRules	Especifica regras CORS para o serviço de arquivo. Você pode incluir até cinco elementos CorsRule na solicitação. Se nenhum elemento CorsRule for incluído no corpo da solicitação, todas as regras do CORS serão excluídas e o CORS será desabilitado para o serviço de arquivo.
properties.protocolSettings	ProtocolSettings	Configurações de protocolo para serviço de arquivo
properties.shareDeleteRetentionPolicy	DeleteRetentionPolicy	As propriedades do serviço de arquivo para exclusão suave de compartilhamento.
sku	Sku	Nome e camada da Sku.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

FileServicesName

O nome do serviço de arquivo dentro da conta de armazenamento especificada. Nome do Serviço de Arquivo deve ser "padrão"

Name	Tipo	Description
default	string

Multichannel

Configuração multicanal. Aplica-se apenas ao Premium FileStorage.

Name	Tipo	Description
enabled	boolean	Indica se o multicanal está habilitado

ProtocolSettings

Configurações de protocolo para serviço de arquivo

Name	Tipo	Description
smb	SmbSetting	Configuração para o protocolo SMB

Sku

O SKU da conta de armazenamento.

Name	Tipo	Description
name	SkuName	O nome SKU. Necessário para a criação de conta; opcional para atualização. Observe que, em versões mais antigas, o nome da SKU era chamado accountType.
tier	SkuTier	A camada de SKU. Isso é baseado no nome SKU.

SkuName

O nome SKU. Necessário para a criação de conta; opcional para atualização. Observe que, em versões mais antigas, o nome da SKU era chamado accountType.

Name	Tipo	Description
Premium_LRS	string
Premium_ZRS	string
Standard_GRS	string
Standard_GZRS	string
Standard_LRS	string
Standard_RAGRS	string
Standard_RAGZRS	string
Standard_ZRS	string

SkuTier

A camada de SKU. Isso é baseado no nome SKU.

Name	Tipo	Description
Premium	string
Standard	string

SmbSetting

Configuração para o protocolo SMB

Name	Tipo	Description
authenticationMethods	string	Métodos de autenticação SMB suportados pelo servidor. Os valores válidos são NTLMv2, Kerberos. Deve ser passado como uma cadeia de caracteres com delimitador ';'.
channelEncryption	string	Criptografia de canal SMB suportada pelo servidor. Os valores válidos são AES-128-CCM, AES-128-GCM, AES-256-GCM. Deve ser passado como uma cadeia de caracteres com delimitador ';'.
kerberosTicketEncryption	string	Criptografia de tíquete Kerberos suportada pelo servidor. Os valores válidos são RC4-HMAC, AES-256. Deve ser passado como uma cadeia de caracteres com delimitador ';'
multichannel	Multichannel	Configuração multicanal. Aplica-se apenas ao Premium FileStorage.
versions	string	Versões do protocolo SMB suportadas pelo servidor. Os valores válidos são SMB2.1, SMB3.0, SMB3.1.1. Deve ser passado como uma cadeia de caracteres com delimitador ';'.