Blob Services - Get Service Properties

Servicio:

Storage Resource Provider

Versión de la API:

2024-01-01

Obtiene las propiedades del servicio Blob de una cuenta de almacenamiento, incluidas las propiedades de las reglas de Uso compartido de recursos entre orígenes y análisis de Storage.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
accountName	path	True	string minLength: 3 maxLength: 24 pattern: ^[a-z0-9]+$	Nombre de la cuenta de almacenamiento dentro del grupo de recursos especificado. Los nombres de cuenta de almacenamiento deben tener entre 3 y 24 caracteres de longitud y usar solo números y letras minúsculas.
BlobServicesName	path	True	BlobServicesName	Nombre del servicio de blobs dentro de la cuenta de almacenamiento especificada. El nombre de Blob Service debe ser 'default'
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+$	Nombre del grupo de recursos dentro de la suscripción del usuario. El nombre distingue mayúsculas de minúsculas.
subscriptionId	path	True	string minLength: 1	Identificador de la suscripción de destino.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Respuestas

Nombre	Tipo	Description
200 OK	BlobServiceProperties	Correcto: devolvió las propiedades de Blob service de una cuenta de almacenamiento.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

GetBlobServices

Solicitud de ejemplo

HTTP

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

Java

/**
 * Samples for BlobServices GetServiceProperties.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/storage/resource-manager/Microsoft.Storage/stable/2024-01-01/examples/BlobServicesGet.json
     */
    /**
     * Sample code: GetBlobServices.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getBlobServices(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.storageAccounts().manager().serviceClient().getBlobServices().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

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.storage import StorageManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-storage
# USAGE
    python blob_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.blob_services.get_service_properties(
        resource_group_name="res4410",
        account_name="sto8607",
    )
    print(response)


# x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2024-01-01/examples/BlobServicesGet.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

Go

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/97ee23a6db6078abcbec7b75bf9af8c503e9bb8b/specification/storage/resource-manager/Microsoft.Storage/stable/2024-01-01/examples/BlobServicesGet.json
func ExampleBlobServicesClient_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.NewBlobServicesClient().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.BlobServiceProperties = armstorage.BlobServiceProperties{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.Storage/storageAccounts/blobServices"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/res4410/providers/Microsoft.Storage/storageAccounts/sto8607/blobServices/default"),
	// 	BlobServiceProperties: &armstorage.BlobServicePropertiesProperties{
	// 		ChangeFeed: &armstorage.ChangeFeed{
	// 			Enabled: to.Ptr(true),
	// 			RetentionInDays: to.Ptr[int32](7),
	// 		},
	// 		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),
	// 															}},
	// 														},
	// 														DefaultServiceVersion: to.Ptr("2017-07-29"),
	// 														DeleteRetentionPolicy: &armstorage.DeleteRetentionPolicy{
	// 															Days: to.Ptr[int32](300),
	// 															Enabled: to.Ptr(true),
	// 														},
	// 														IsVersioningEnabled: to.Ptr(true),
	// 													},
	// 													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

JavaScript

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

/**
 * This sample demonstrates how to Gets the properties of a storage account’s Blob service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.
 *
 * @summary Gets the properties of a storage account’s Blob service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.
 * x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2024-01-01/examples/BlobServicesGet.json
 */
async function getBlobServices() {
  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.blobServices.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

dotnet

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/2024-01-01/examples/BlobServicesGet.json
// this example is just showing the usage of "BlobServices_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://learn.microsoft.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 BlobServiceResource created on azure
// for more information of creating BlobServiceResource, please refer to the document of BlobServiceResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "res4410";
string accountName = "sto8607";
ResourceIdentifier blobServiceResourceId = BlobServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName);
BlobServiceResource blobService = client.GetBlobServiceResource(blobServiceResourceId);

// invoke the operation
BlobServiceResource result = await blobService.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
BlobServiceData 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

Respuesta de muestra

status code:

200

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/res4410/providers/Microsoft.Storage/storageAccounts/sto8607/blobServices/default",
  "name": "default",
  "type": "Microsoft.Storage/storageAccounts/blobServices",
  "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*"
          ]
        }
      ]
    },
    "defaultServiceVersion": "2017-07-29",
    "deleteRetentionPolicy": {
      "enabled": true,
      "days": 300
    },
    "isVersioningEnabled": true,
    "changeFeed": {
      "enabled": true,
      "retentionInDays": 7
    }
  },
  "sku": {
    "name": "Standard_GRS",
    "tier": "Standard"
  }
}

Definiciones

Nombre	Description
AllowedMethods	Obligatorio si el elemento CorsRule está presente. Lista de métodos HTTP que el origen permite ejecutar.
BlobServiceProperties	Propiedades de Blob service de una cuenta de almacenamiento.
BlobServicesName	Nombre del servicio de blobs dentro de la cuenta de almacenamiento especificada. El nombre de Blob Service debe ser 'default'
ChangeFeed	Propiedades de Blob service para eventos de fuente de cambios.
CorsRule	Especifica una regla de CORS para Blob service.
CorsRules	Establece las reglas de CORS. Puede incluir hasta cinco elementos CorsRule en la solicitud.
DeleteRetentionPolicy	Propiedades del servicio para la eliminación temporal.
LastAccessTimeTrackingPolicy	Las propiedades de Blob Service para la directiva de seguimiento basada en hora de último acceso.
name	Nombre de la directiva. El valor válido es AccessTimeTracking. Este campo es actualmente de solo lectura
RestorePolicyProperties	Las propiedades de Blob Service para la directiva de restauración de blobs
Sku	SKU de la cuenta de almacenamiento.
SkuName	Nombre de la SKU. Necesario para la creación de cuentas; opcional para la actualización. Tenga en cuenta que en versiones anteriores, el nombre de la SKU se llamó accountType.
SkuTier	Nivel de SKU. Esto se basa en el nombre de la SKU.

AllowedMethods

Enumeración

Obligatorio si el elemento CorsRule está presente. Lista de métodos HTTP que el origen permite ejecutar.

Valor	Description
CONNECT
DELETE
GET
HEAD
MERGE
OPTIONS
PATCH
POST
PUT
TRACE

BlobServiceProperties

Object

Propiedades de Blob service de una cuenta de almacenamiento.

Nombre	Tipo	Description
id	string	Identificador de recurso completo para el recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nombre del recurso
properties.automaticSnapshotPolicyEnabled	boolean	En desuso en favor de la propiedad isVersioningEnabled.
properties.changeFeed	ChangeFeed	Propiedades de Blob service para eventos de fuente de cambios.
properties.containerDeleteRetentionPolicy	DeleteRetentionPolicy	Las propiedades de Blob Service para la eliminación temporal del contenedor.
properties.cors	CorsRules	Especifica reglas DE CORS para Blob service. Puede incluir hasta cinco elementos CorsRule en la solicitud. Si no se incluyen elementos CorsRule en el cuerpo de la solicitud, se eliminarán todas las reglas de CORS y CORS se deshabilitará para Blob service.
properties.defaultServiceVersion	string	DefaultServiceVersion indica la versión predeterminada que se va a usar para las solicitudes a Blob service si no se especifica la versión de una solicitud entrante. Los valores posibles incluyen la versión 2008-10-27 y todas las versiones más recientes.
properties.deleteRetentionPolicy	DeleteRetentionPolicy	Las propiedades de Blob Service para la eliminación temporal de blobs.
properties.isVersioningEnabled	boolean	El control de versiones está habilitado si se establece en true.
properties.lastAccessTimeTrackingPolicy	LastAccessTimeTrackingPolicy	La propiedad blob service para configurar la directiva de seguimiento basada en la hora de último acceso.
properties.restorePolicy	RestorePolicyProperties	Las propiedades de Blob Service para la directiva de restauración de blobs.
sku	Sku	Nombre y nivel de SKU.
type	string	Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

BlobServicesName

Enumeración

Nombre del servicio de blobs dentro de la cuenta de almacenamiento especificada. El nombre de Blob Service debe ser 'default'

Valor	Description
default

ChangeFeed

Object

Propiedades de Blob service para eventos de fuente de cambios.

Nombre	Tipo	Description
enabled	boolean	Indica si el registro de eventos de fuente de cambios está habilitado para Blob service.
retentionInDays	integer (int32) minimum: 1 maximum: 146000	Indica la duración de la retención changeFeed en días. El valor mínimo es 1 día y el valor máximo es 146000 días (400 años). Un valor NULL indica una retención infinita de la fuente de cambios.

CorsRule

Object

Especifica una regla de CORS para Blob service.

Nombre	Tipo	Description
allowedHeaders	string[]	Obligatorio si el elemento CorsRule está presente. Lista de encabezados que pueden formar parte de la solicitud entre orígenes.
allowedMethods	AllowedMethods[]	Obligatorio si el elemento CorsRule está presente. Lista de métodos HTTP que el origen permite ejecutar.
allowedOrigins	string[]	Obligatorio si el elemento CorsRule está presente. Una lista de dominios de origen que se permitirán a través de CORS o "*" para permitir todos los dominios
exposedHeaders	string[]	Obligatorio si el elemento CorsRule está presente. Lista de encabezados de respuesta que se van a exponer a los clientes CORS.
maxAgeInSeconds	integer	Obligatorio si el elemento CorsRule está presente. Número de segundos que el cliente o explorador debe almacenar en caché una respuesta preparatoria.

CorsRules

Object

Establece las reglas de CORS. Puede incluir hasta cinco elementos CorsRule en la solicitud.

Nombre	Tipo	Description
corsRules	CorsRule[]	Lista de reglas de CORS. Puede incluir hasta cinco elementos CorsRule en la solicitud.

DeleteRetentionPolicy

Object

Propiedades del servicio para la eliminación temporal.

Nombre	Tipo	Description
allowPermanentDelete	boolean	Esta propiedad cuando se establece en true permite la eliminación de las versiones y instantáneas del blob eliminado temporalmente. Esta propiedad no se puede usar la directiva de restauración de blobs. Esta propiedad solo se aplica a Blob Service y no se aplica a contenedores o recursos compartidos de archivos.
days	integer minimum: 1 maximum: 365	Indica el número de días que se debe conservar el elemento eliminado. El valor mínimo especificado puede ser 1 y el valor máximo puede ser 365.
enabled	boolean	Indica si DeleteRetentionPolicy está habilitado.

LastAccessTimeTrackingPolicy

Object

Las propiedades de Blob Service para la directiva de seguimiento basada en hora de último acceso.

Nombre	Tipo	Description
blobType	string[]	Matriz de tipos de blobs admitidos predefinidos. Solo blockBlob es el valor admitido. Este campo es actualmente de solo lectura
enable	boolean	Cuando se establece en true, se habilita el seguimiento basado en la hora del último acceso.
name	name	Nombre de la directiva. El valor válido es AccessTimeTracking. Este campo es actualmente de solo lectura
trackingGranularityInDays	integer (int32)	El campo especifica la granularidad de seguimiento de objetos de blob en días, normalmente la frecuencia con la que se debe realizar el seguimiento del objeto de blob. Este campo es actualmente de solo lectura con el valor 1

name

Enumeración

Nombre de la directiva. El valor válido es AccessTimeTracking. Este campo es actualmente de solo lectura

Valor	Description
AccessTimeTracking

RestorePolicyProperties

Object

Las propiedades de Blob Service para la directiva de restauración de blobs

Nombre	Tipo	Description
days	integer minimum: 1 maximum: 365	cuánto tiempo se puede restaurar este blob. Debe ser grande que cero y menor que DeleteRetentionPolicy.days.
enabled	boolean	La restauración de blobs está habilitada si se establece en true.
lastEnabledTime	string (date-time)	En desuso en favor de la propiedad minRestoreTime.
minRestoreTime	string (date-time)	Devuelve la fecha y hora mínimas en que se puede iniciar la restauración.

Sku

Object

SKU de la cuenta de almacenamiento.

Nombre	Tipo	Description
name	SkuName	Nombre de la SKU. Necesario para la creación de cuentas; opcional para la actualización. Tenga en cuenta que en versiones anteriores, el nombre de la SKU se llamó accountType.
tier	SkuTier	Nivel de SKU. Esto se basa en el nombre de la SKU.

SkuName

Enumeración

Nombre de la SKU. Necesario para la creación de cuentas; opcional para la actualización. Tenga en cuenta que en versiones anteriores, el nombre de la SKU se llamó accountType.

Valor	Description
PremiumV2_LRS
PremiumV2_ZRS
Premium_LRS
Premium_ZRS
StandardV2_GRS
StandardV2_GZRS
StandardV2_LRS
StandardV2_ZRS
Standard_GRS
Standard_GZRS
Standard_LRS
Standard_RAGRS
Standard_RAGZRS
Standard_ZRS

SkuTier

Enumeración

Nivel de SKU. Esto se basa en el nombre de la SKU.

Valor	Description
Premium
Standard