Blob Inventory Policies - Get

Layanan:

Storage Resource Provider

Versi API:

2024-01-01

Mendapatkan kebijakan inventori blob yang terkait dengan akun penyimpanan yang ditentukan.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
accountName	path	True	string minLength: 3 maxLength: 24 pattern: ^[a-z0-9]+$	Nama akun penyimpanan dalam grup sumber daya yang ditentukan. Panjang nama akun penyimpanan harus antara 3 dan 24 karakter dan hanya menggunakan angka dan huruf kecil.
blobInventoryPolicyName	path	True	BlobInventoryPolicyName	Nama kebijakan inventaris blob akun penyimpanan. Seharusnya selalu 'default'
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+$	Nama grup sumber daya dalam langganan pengguna. Nama tidak sensitif terhadap penggunaan huruf besar atau kecil.
subscriptionId	path	True	string minLength: 1	ID langganan target.
api-version	query	True	string minLength: 1	Versi API yang digunakan untuk operasi ini.

Respons

Nama	Jenis	Deskripsi
200 OK	BlobInventoryPolicy	OK -- Dapatkan kebijakan inventori blob dengan sukses.
Other Status Codes	CloudError	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

StorageAccountGetBlobInventoryPolicy

Permintaan sampel

HTTP

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

Java

import com.azure.resourcemanager.storage.models.BlobInventoryPolicyName;

/**
 * Samples for BlobInventoryPolicies Get.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2024-01-01/examples/
     * StorageAccountGetBlobInventoryPolicy.json
     */
    /**
     * Sample code: StorageAccountGetBlobInventoryPolicy.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void storageAccountGetBlobInventoryPolicy(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.storageAccounts().manager().serviceClient().getBlobInventoryPolicies().getWithResponse("res7687",
            "sto9699", BlobInventoryPolicyName.DEFAULT, 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 storage_account_get_blob_inventory_policy.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_inventory_policies.get(
        resource_group_name="res7687",
        account_name="sto9699",
        blob_inventory_policy_name="default",
    )
    print(response)


# x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2024-01-01/examples/StorageAccountGetBlobInventoryPolicy.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/86c6306649b02e542117adb46c61e8019dbd78e9/specification/storage/resource-manager/Microsoft.Storage/stable/2024-01-01/examples/StorageAccountGetBlobInventoryPolicy.json
func ExampleBlobInventoryPoliciesClient_Get() {
	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.NewBlobInventoryPoliciesClient().Get(ctx, "res7687", "sto9699", armstorage.BlobInventoryPolicyNameDefault, 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.BlobInventoryPolicy = armstorage.BlobInventoryPolicy{
	// 	Name: to.Ptr("DefaultInventoryPolicy"),
	// 	Type: to.Ptr("Microsoft.Storage/storageAccounts/inventoryPolicies"),
	// 	ID: to.Ptr("/subscriptions/{subscription-id}/resourceGroups/res7687/providers/Microsoft.Storage/storageAccounts/sto9699/inventoryPolicies/default"),
	// 	Properties: &armstorage.BlobInventoryPolicyProperties{
	// 		LastModifiedTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-10-05T02:53:39.093Z"); return t}()),
	// 		Policy: &armstorage.BlobInventoryPolicySchema{
	// 			Type: to.Ptr(armstorage.InventoryRuleTypeInventory),
	// 			Enabled: to.Ptr(true),
	// 			Rules: []*armstorage.BlobInventoryPolicyRule{
	// 				{
	// 					Name: to.Ptr("inventoryPolicyRule1"),
	// 					Definition: &armstorage.BlobInventoryPolicyDefinition{
	// 						Format: to.Ptr(armstorage.FormatCSV),
	// 						Filters: &armstorage.BlobInventoryPolicyFilter{
	// 							BlobTypes: []*string{
	// 								to.Ptr("blockBlob"),
	// 								to.Ptr("appendBlob"),
	// 								to.Ptr("pageBlob")},
	// 								IncludeBlobVersions: to.Ptr(true),
	// 								IncludeSnapshots: to.Ptr(true),
	// 								PrefixMatch: []*string{
	// 									to.Ptr("inventoryprefix1"),
	// 									to.Ptr("inventoryprefix2")},
	// 								},
	// 								ObjectType: to.Ptr(armstorage.ObjectTypeBlob),
	// 								Schedule: to.Ptr(armstorage.ScheduleDaily),
	// 								SchemaFields: []*string{
	// 									to.Ptr("Name"),
	// 									to.Ptr("Creation-Time"),
	// 									to.Ptr("Last-Modified"),
	// 									to.Ptr("Content-Length"),
	// 									to.Ptr("Content-MD5"),
	// 									to.Ptr("BlobType"),
	// 									to.Ptr("AccessTier"),
	// 									to.Ptr("AccessTierChangeTime"),
	// 									to.Ptr("Snapshot"),
	// 									to.Ptr("VersionId"),
	// 									to.Ptr("IsCurrentVersion"),
	// 									to.Ptr("Metadata")},
	// 								},
	// 								Destination: to.Ptr("container1"),
	// 								Enabled: to.Ptr(true),
	// 						}},
	// 					},
	// 				},
	// 			}
}

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 blob inventory policy associated with the specified storage account.
 *
 * @summary Gets the blob inventory policy associated with the specified storage account.
 * x-ms-original-file: specification/storage/resource-manager/Microsoft.Storage/stable/2024-01-01/examples/StorageAccountGetBlobInventoryPolicy.json
 */
async function storageAccountGetBlobInventoryPolicy() {
  const subscriptionId = process.env["STORAGE_SUBSCRIPTION_ID"] || "{subscription-id}";
  const resourceGroupName = process.env["STORAGE_RESOURCE_GROUP"] || "res7687";
  const accountName = "sto9699";
  const blobInventoryPolicyName = "default";
  const credential = new DefaultAzureCredential();
  const client = new StorageManagementClient(credential, subscriptionId);
  const result = await client.blobInventoryPolicies.get(
    resourceGroupName,
    accountName,
    blobInventoryPolicyName,
  );
  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/StorageAccountGetBlobInventoryPolicy.json
// this example is just showing the usage of "BlobInventoryPolicies_Get" 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 BlobInventoryPolicyResource created on azure
// for more information of creating BlobInventoryPolicyResource, please refer to the document of BlobInventoryPolicyResource
string subscriptionId = "{subscription-id}";
string resourceGroupName = "res7687";
string accountName = "sto9699";
BlobInventoryPolicyName blobInventoryPolicyName = BlobInventoryPolicyName.Default;
ResourceIdentifier blobInventoryPolicyResourceId = BlobInventoryPolicyResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName, blobInventoryPolicyName);
BlobInventoryPolicyResource blobInventoryPolicy = client.GetBlobInventoryPolicyResource(blobInventoryPolicyResourceId);

// invoke the operation
BlobInventoryPolicyResource result = await blobInventoryPolicy.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
BlobInventoryPolicyData 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

Respon sampel

Kode status:

200

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/res7687/providers/Microsoft.Storage/storageAccounts/sto9699/inventoryPolicies/default",
  "name": "DefaultInventoryPolicy",
  "type": "Microsoft.Storage/storageAccounts/inventoryPolicies",
  "properties": {
    "policy": {
      "enabled": true,
      "type": "Inventory",
      "rules": [
        {
          "enabled": true,
          "name": "inventoryPolicyRule1",
          "destination": "container1",
          "definition": {
            "filters": {
              "blobTypes": [
                "blockBlob",
                "appendBlob",
                "pageBlob"
              ],
              "prefixMatch": [
                "inventoryprefix1",
                "inventoryprefix2"
              ],
              "includeSnapshots": true,
              "includeBlobVersions": true
            },
            "format": "Csv",
            "schedule": "Daily",
            "objectType": "Blob",
            "schemaFields": [
              "Name",
              "Creation-Time",
              "Last-Modified",
              "Content-Length",
              "Content-MD5",
              "BlobType",
              "AccessTier",
              "AccessTierChangeTime",
              "Snapshot",
              "VersionId",
              "IsCurrentVersion",
              "Metadata"
            ]
          }
        }
      ]
    },
    "lastModifiedTime": "2020-10-05T02:53:39.0932539Z"
  }
}

Definisi

Nama	Deskripsi
BlobInventoryCreationTime	Properti ini menentukan kondisi pemfilteran berbasis waktu pembuatan. Parameter skema Blob Inventory 'Creation-Time' wajib dilakukan dengan filter ini.
BlobInventoryPolicy	Kebijakan inventaris blob akun penyimpanan.
BlobInventoryPolicyDefinition	Objek yang menentukan aturan inventaris blob.
BlobInventoryPolicyFilter	Objek yang menentukan kondisi filter aturan inventaris blob. Untuk 'Blob' definition.objectType semua properti filter berlaku, 'blobTypes' diperlukan dan yang lain bersifat opsional. Untuk 'Container' definition.objectType hanya prefixMatch yang berlaku dan bersifat opsional.
BlobInventoryPolicyName	Nama kebijakan inventaris blob akun penyimpanan. Seharusnya selalu 'default'
BlobInventoryPolicyRule	Objek yang membungkus aturan inventaris blob. Setiap aturan didefinisikan secara unik berdasarkan nama.
BlobInventoryPolicySchema	Aturan kebijakan inventori blob akun penyimpanan.
CloudError	Respons kesalahan dari layanan Penyimpanan.
CloudErrorBody	Respons kesalahan dari layanan Penyimpanan.
createdByType	Jenis identitas yang membuat sumber daya.
format	Ini adalah bidang yang diperlukan, ini menentukan format untuk file inventarisi.
InventoryRuleType	Nilai yang valid adalah Inventory
objectType	Ini adalah bidang yang diperlukan. Bidang ini menentukan cakupan inventori yang dibuat baik di tingkat blob atau kontainer.
schedule	Ini adalah bidang yang diperlukan. Bidang ini digunakan untuk menjadwalkan pembentukan inventarisi.
systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

BlobInventoryCreationTime

Objek

Properti ini menentukan kondisi pemfilteran berbasis waktu pembuatan. Parameter skema Blob Inventory 'Creation-Time' wajib dilakukan dengan filter ini.

Nama	Jenis	Deskripsi
lastNDays	integer (int32) minimum: 1 maximum: 36500	Saat mengatur kebijakan akan memfilter objek yang dibuat dalam N hari terakhir. Di mana N adalah nilai bilangan bulat antara 1 hingga 36500.

BlobInventoryPolicy

Objek

Kebijakan inventaris blob akun penyimpanan.

Nama	Jenis	Deskripsi
id	string	ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nama sumber daya
properties.lastModifiedTime	string (date-time)	Mengembalikan tanggal dan waktu terakhir yang dimodifikasi dari kebijakan inventori blob.
properties.policy	BlobInventoryPolicySchema	Objek kebijakan inventori blob akun penyimpanan. Ini terdiri dari aturan kebijakan.
systemData	systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.
type	string	Jenis sumber daya. Misalnya, "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

BlobInventoryPolicyDefinition

Objek

Objek yang menentukan aturan inventaris blob.

Nama	Jenis	Deskripsi
filters	BlobInventoryPolicyFilter	Objek yang menentukan set filter.
format	format	Ini adalah bidang yang diperlukan, ini menentukan format untuk file inventarisi.
objectType	objectType	Ini adalah bidang yang diperlukan. Bidang ini menentukan cakupan inventori yang dibuat baik di tingkat blob atau kontainer.
schedule	schedule	Ini adalah bidang yang diperlukan. Bidang ini digunakan untuk menjadwalkan pembentukan inventarisi.
schemaFields	string[]	Ini adalah bidang yang diperlukan. Bidang ini menentukan bidang dan properti objek yang akan disertakan dalam inventori. Nilai bidang Skema 'Nama' selalu diperlukan. Nilai yang valid untuk bidang ini untuk 'Blob' definition.objectType meliputi 'Name, Creation-Time, Last-Modified, Content-Length, Content-MD5, BlobType, AccessTier, AccessTierChangeTime, AccessTierInferred, Tag, Expiry-Time, hdi_isfolder, Owner, Group, Permissions, Acl, Snapshot, VersionId, IsCurrentVersion, Metadata, LastAccessTime, Tags, Etag, ContentType, ContentEncoding, ContentLanguage, ContentCRC64, CacheControl, ContentDisposition, LeaseStatus, LeaseState, LeaseDuration, ServerEncrypted, Deleted, DeletionId, DeletedTime, RemainingRetentionDays, ImmutabilityPolicyUntilDate, ImmutabilityPolicyMode, LegalHold, CopyId, CopyStatus, CopySource, CopyProgress, CopyCompletionTime, CopyStatusDescription, CustomerProvidedKeySha256, RehydratePriority, ArchiveStatus, XmsBlobSequenceNumber, EncryptionScope, IncrementalCopy, TagCount'. Untuk nilai bidang skema jenis objek Blob 'DeletedTime' hanya berlaku untuk akun yang diaktifkan Hns. Nilai yang valid untuk 'Container' definition.objectType mencakup 'Name, Last-Modified, Metadata, LeaseStatus, LeaseState, LeaseDuration, PublicAccess, HasImmutabilityPolicy, HasLegalHold, Etag, DefaultEncryptionScope, DenyEncryptionScopeOverride, ImmutableStorageWithVersioningEnabled, Deleted, Version, DeletedTime, RemainingRetentionDays'. Nilai bidang skema 'Expiry-Time, hdi_isfolder, Owner, Group, Permissions, Acl, DeletionId' hanya valid untuk akun yang diaktifkan Hns. Nilai bidang skema 'Tag, TagCount' hanya valid untuk akun Non-Hns.

BlobInventoryPolicyFilter

Objek

Objek yang menentukan kondisi filter aturan inventaris blob. Untuk 'Blob' definition.objectType semua properti filter berlaku, 'blobTypes' diperlukan dan yang lain bersifat opsional. Untuk 'Container' definition.objectType hanya prefixMatch yang berlaku dan bersifat opsional.

Nama	Jenis	Deskripsi
blobTypes	string[]	Sebuah larik nilai enum yang telah ditentukan sebelumnya. Nilai yang valid termasuk blockBlob, appendBlob, pageBlob. Akun Hns tidak mendukung pageBlobs. Bidang ini diperlukan ketika properti definition.objectType diatur ke 'Blob'.
creationTime	BlobInventoryCreationTime	Properti ini digunakan untuk memfilter objek berdasarkan waktu pembuatan objek
excludePrefix	string[]	Array string dengan maksimum 10 awalan blob yang akan dikecualikan dari inventaris.
includeBlobVersions	boolean	Menyertakan versi blob dalam inventaris blob saat nilai diatur ke true. Nilai definition.schemaFields 'VersionId dan IsCurrentVersion' diperlukan jika properti ini diatur ke true, jika tidak, properti tersebut harus dikecualikan.
includeDeleted	boolean	Untuk 'Container' definition.objectType, definition.schemaFields harus menyertakan 'Dihapus, Versi, DeletedTime, dan RemainingRetentionDays'. Untuk akun penyimpanan berkemampuan 'Blob' definition.objectType dan HNS, definition.schemaFields harus menyertakan 'DeletionId, DeletedTime, dan RemainingRetentionDays' dan untuk akun yang dinonaktifkan Hns, definition.schemaFields harus menyertakan 'Deleted dan RemainingRetentionDays', selain itu harus dikecualikan.
includeSnapshots	boolean	Menyertakan rekam jepret blob dalam inventori blob saat nilai diatur ke true. Nilai definition.schemaFields 'Snapshot' diperlukan jika properti ini diatur ke true, jika tidak, itu harus dikecualikan.
prefixMatch	string[]	Array string dengan maksimum 10 awalan blob yang akan disertakan dalam inventaris.

BlobInventoryPolicyName

Enumeration

Nama kebijakan inventaris blob akun penyimpanan. Seharusnya selalu 'default'

Nilai	Deskripsi
default

BlobInventoryPolicyRule

Objek

Objek yang membungkus aturan inventaris blob. Setiap aturan didefinisikan secara unik berdasarkan nama.

Nama	Jenis	Deskripsi
definition	BlobInventoryPolicyDefinition	Objek yang menentukan aturan kebijakan inventaris blob.
destination	string	Nama kontainer tempat file inventori blob disimpan. Harus dibuat sebelumnya.
enabled	boolean	Aturan diaktifkan saat diatur ke true.
name	string	Nama aturan dapat berisi kombinasi karakter alfa numerik apa pun. Nama aturan sensitif terhadap huruf besar/kecil. Itu harus unik dalam sebuah kebijakan.

BlobInventoryPolicySchema

Objek

Aturan kebijakan inventori blob akun penyimpanan.

Nama	Jenis	Deskripsi
destination	string	Properti yang tidak digunakan lagi dari API versi 2021-04-01 dan seterusnya, nama kontainer tujuan yang diperlukan harus ditentukan di tingkat aturan 'policy.rule.destination'
enabled	boolean	Kebijakan diaktifkan jika diatur ke true.
rules	BlobInventoryPolicyRule[]	Aturan kebijakan inventori blob akun penyimpanan. Aturan diterapkan saat diaktifkan.
type	InventoryRuleType	Nilai yang valid adalah Inventory

CloudError

Objek

Respons kesalahan dari layanan Penyimpanan.

Nama	Jenis	Deskripsi
error	CloudErrorBody	Respons kesalahan dari layanan Penyimpanan.

CloudErrorBody

Objek

Respons kesalahan dari layanan Penyimpanan.

Nama	Jenis	Deskripsi
code	string	Pengidentifikasi untuk kesalahan. Kode invarian dan dimaksudkan untuk dikonsumsi secara terprogram.
details	CloudErrorBody[]	Daftar detail tambahan tentang kesalahan.
message	string	Pesan yang menjelaskan kesalahan, dimaksudkan agar cocok untuk ditampilkan di antarmuka pengguna.
target	string	Target kesalahan tertentu. Misalnya, nama properti dalam kesalahan.

createdByType

Enumeration

Jenis identitas yang membuat sumber daya.

Nilai	Deskripsi
User
Application
ManagedIdentity
Key

format

Enumeration

Ini adalah bidang yang diperlukan, ini menentukan format untuk file inventarisi.

Nilai	Deskripsi
Csv
Parquet

InventoryRuleType

Enumeration

Nilai yang valid adalah Inventory

Nilai	Deskripsi
Inventory

objectType

Enumeration

Ini adalah bidang yang diperlukan. Bidang ini menentukan cakupan inventori yang dibuat baik di tingkat blob atau kontainer.

Nilai	Deskripsi
Blob
Container

schedule

Enumeration

Ini adalah bidang yang diperlukan. Bidang ini digunakan untuk menjadwalkan pembentukan inventarisi.

Nilai	Deskripsi
Daily
Weekly

systemData

Objek

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama	Jenis	Deskripsi
createdAt	string (date-time)	Tanda waktu pembuatan sumber daya (UTC).
createdBy	string	Identitas yang membuat sumber daya.
createdByType	createdByType	Jenis identitas yang membuat sumber daya.
lastModifiedAt	string (date-time)	Tanda waktu modifikasi terakhir sumber daya (UTC)
lastModifiedBy	string	Identitas yang terakhir mengubah sumber daya.
lastModifiedByType	createdByType	Jenis identitas yang terakhir memodifikasi sumber daya.