你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Caches - List

服务:: Storagecache

API 版本:: 2026-01-01

返回用户在订阅下有权访问的所有缓存。

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.StorageCache/caches?api-version=2026-01-01

URI 参数

名称	在	必需	类型	说明
subscriptionId	path	True	string minLength: 1	目标订阅的 ID。
api-version	query	True	string minLength: 1	要用于此操作的 API 版本。

响应

名称	类型	说明
200 OK	CachesListResult	缓存对象的列表。请注意，实体引用可能会替换完整的缓存对象，如 http://docs.oasis-open.org/odata/odata-json-format/v4.01/cs01/odata-json-format-v4.01-cs01.html#sec_EntityReference
Other Status Codes	CloudError	描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流程。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Caches_List

示例请求

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/caches?api-version=2026-01-01

package armstoragecache_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storagecache/armstoragecache/v4"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/3ca2244e6becf79bdd1198e9d66f0e8e8d3a0977/specification/storagecache/resource-manager/Microsoft.StorageCache/StorageCache/stable/2026-01-01/examples/Caches_List.json
func ExampleCachesClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armstoragecache.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewCachesClient().NewListPager(nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.CachesListResult = armstoragecache.CachesListResult{
		// 	Value: []*armstoragecache.Cache{
		// 		{
		// 			Name: to.Ptr("sc1"),
		// 			Type: to.Ptr("Microsoft.StorageCache/Cache"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc1"),
		// 			Location: to.Ptr("westus"),
		// 			Properties: &armstoragecache.CacheProperties{
		// 				CacheSizeGB: to.Ptr[int32](3072),
		// 				DirectoryServicesSettings: &armstoragecache.CacheDirectorySettings{
		// 					ActiveDirectory: &armstoragecache.CacheActiveDirectorySettings{
		// 						CacheNetBiosName: to.Ptr("contosoSmb"),
		// 						DomainJoined: to.Ptr(armstoragecache.DomainJoinedTypeYes),
		// 						DomainName: to.Ptr("contosoAd.contoso.local"),
		// 						DomainNetBiosName: to.Ptr("contosoAd"),
		// 						PrimaryDNSIPAddress: to.Ptr("192.0.2.10"),
		// 						SecondaryDNSIPAddress: to.Ptr("192.0.2.11"),
		// 					},
		// 					UsernameDownload: &armstoragecache.CacheUsernameDownloadSettings{
		// 						AutoDownloadCertificate: to.Ptr(false),
		// 						CaCertificateURI: to.Ptr("http://contoso.net/cacert.pem"),
		// 						EncryptLdapConnection: to.Ptr(false),
		// 						ExtendedGroups: to.Ptr(true),
		// 						GroupFileURI: to.Ptr("http://contoso.net/group.file"),
		// 						LdapBaseDN: to.Ptr("dc=contosoad,dc=contoso,dc=local"),
		// 						LdapServer: to.Ptr("192.0.2.12"),
		// 						RequireValidCertificate: to.Ptr(false),
		// 						UserFileURI: to.Ptr("http://contoso.net/passwd.file"),
		// 						UsernameDownloaded: to.Ptr(armstoragecache.UsernameDownloadedTypeYes),
		// 						UsernameSource: to.Ptr(armstoragecache.UsernameSourceLDAP),
		// 					},
		// 				},
		// 				EncryptionSettings: &armstoragecache.CacheEncryptionSettings{
		// 					KeyEncryptionKey: &armstoragecache.KeyVaultKeyReference{
		// 						KeyURL: to.Ptr("https://keyvault-cmk.vault.azure.net/keys/key2048/test"),
		// 						SourceVault: &armstoragecache.KeyVaultKeyReferenceSourceVault{
		// 							ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.KeyVault/vaults/keyvault-cmk"),
		// 						},
		// 					},
		// 				},
		// 				Health: &armstoragecache.CacheHealth{
		// 					Conditions: []*armstoragecache.Condition{
		// 						{
		// 							Message: to.Ptr("Cannot contact DNS server"),
		// 							Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-04-21T18:25:43.511Z"); return t}()),
		// 					}},
		// 					State: to.Ptr(armstoragecache.HealthStateTypeTransitioning),
		// 					StatusDescription: to.Ptr("Cache is being created."),
		// 				},
		// 				MountAddresses: []*string{
		// 					to.Ptr("192.168.1.1"),
		// 					to.Ptr("192.168.1.2")},
		// 					NetworkSettings: &armstoragecache.CacheNetworkSettings{
		// 						DNSSearchDomain: to.Ptr("contoso.com"),
		// 						DNSServers: []*string{
		// 							to.Ptr("10.1.22.33"),
		// 							to.Ptr("10.1.12.33")},
		// 							Mtu: to.Ptr[int32](1500),
		// 							NtpServer: to.Ptr("time.contoso.com"),
		// 						},
		// 						PrimingJobs: []*armstoragecache.PrimingJob{
		// 						},
		// 						ProvisioningState: to.Ptr(armstoragecache.ProvisioningStateTypeSucceeded),
		// 						SecuritySettings: &armstoragecache.CacheSecuritySettings{
		// 							AccessPolicies: []*armstoragecache.NfsAccessPolicy{
		// 								{
		// 									Name: to.Ptr("default"),
		// 									AccessRules: []*armstoragecache.NfsAccessRule{
		// 										{
		// 											Access: to.Ptr(armstoragecache.NfsAccessRuleAccessRw),
		// 											RootSquash: to.Ptr(false),
		// 											Scope: to.Ptr(armstoragecache.NfsAccessRuleScopeDefault),
		// 											SubmountAccess: to.Ptr(true),
		// 											Suid: to.Ptr(false),
		// 									}},
		// 							}},
		// 						},
		// 						SpaceAllocation: []*armstoragecache.StorageTargetSpaceAllocation{
		// 							{
		// 								Name: to.Ptr("st1"),
		// 								AllocationPercentage: to.Ptr[int32](25),
		// 							},
		// 							{
		// 								Name: to.Ptr("st2"),
		// 								AllocationPercentage: to.Ptr[int32](50),
		// 							},
		// 							{
		// 								Name: to.Ptr("st3"),
		// 								AllocationPercentage: to.Ptr[int32](25),
		// 						}},
		// 						Subnet: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/sub1"),
		// 						UpgradeSettings: &armstoragecache.CacheUpgradeSettings{
		// 							ScheduledTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-04-26T18:25:43.511Z"); return t}()),
		// 							UpgradeScheduleEnabled: to.Ptr(true),
		// 						},
		// 						UpgradeStatus: &armstoragecache.CacheUpgradeStatus{
		// 							CurrentFirmwareVersion: to.Ptr("2022.08.1"),
		// 							FirmwareUpdateDeadline: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-04-21T18:25:43.511Z"); return t}()),
		// 							FirmwareUpdateStatus: to.Ptr(armstoragecache.FirmwareStatusTypeAvailable),
		// 							LastFirmwareUpdate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-01-21T18:25:43.511Z"); return t}()),
		// 							PendingFirmwareVersion: to.Ptr("2022.08.1"),
		// 						},
		// 					},
		// 					SKU: &armstoragecache.CacheSKU{
		// 						Name: to.Ptr("Standard_2G"),
		// 					},
		// 					SystemData: &armstoragecache.SystemData{
		// 						CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
		// 						CreatedBy: to.Ptr("user1"),
		// 						CreatedByType: to.Ptr(armstoragecache.CreatedByTypeUser),
		// 						LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-02T17:18:19.123Z"); return t}()),
		// 						LastModifiedBy: to.Ptr("user2"),
		// 						LastModifiedByType: to.Ptr(armstoragecache.CreatedByTypeUser),
		// 					},
		// 					Tags: map[string]*string{
		// 						"Dept": to.Ptr("Contoso"),
		// 					},
		// 				},
		// 				{
		// 					Name: to.Ptr("sc2"),
		// 					Type: to.Ptr("Microsoft.StorageCache/Cache"),
		// 					ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc2"),
		// 					Location: to.Ptr("westus"),
		// 					Properties: &armstoragecache.CacheProperties{
		// 						CacheSizeGB: to.Ptr[int32](3072),
		// 						DirectoryServicesSettings: &armstoragecache.CacheDirectorySettings{
		// 							ActiveDirectory: &armstoragecache.CacheActiveDirectorySettings{
		// 								CacheNetBiosName: to.Ptr("contosoSmb"),
		// 								DomainJoined: to.Ptr(armstoragecache.DomainJoinedTypeYes),
		// 								DomainName: to.Ptr("contosoAd.contoso.local"),
		// 								DomainNetBiosName: to.Ptr("contosoAd"),
		// 								PrimaryDNSIPAddress: to.Ptr("192.0.2.10"),
		// 								SecondaryDNSIPAddress: to.Ptr("192.0.2.11"),
		// 							},
		// 							UsernameDownload: &armstoragecache.CacheUsernameDownloadSettings{
		// 								AutoDownloadCertificate: to.Ptr(false),
		// 								CaCertificateURI: to.Ptr("http://contoso.net/cacert.pem"),
		// 								EncryptLdapConnection: to.Ptr(false),
		// 								ExtendedGroups: to.Ptr(true),
		// 								GroupFileURI: to.Ptr("http://contoso.net/group.file"),
		// 								LdapBaseDN: to.Ptr(""),
		// 								LdapServer: to.Ptr(""),
		// 								RequireValidCertificate: to.Ptr(false),
		// 								UserFileURI: to.Ptr("http://contoso.net/passwd.file"),
		// 								UsernameDownloaded: to.Ptr(armstoragecache.UsernameDownloadedTypeYes),
		// 								UsernameSource: to.Ptr(armstoragecache.UsernameSourceAD),
		// 							},
		// 						},
		// 						EncryptionSettings: &armstoragecache.CacheEncryptionSettings{
		// 							KeyEncryptionKey: &armstoragecache.KeyVaultKeyReference{
		// 								KeyURL: to.Ptr("https://keyvault-cmk.vault.azure.net/keys/key2048/test"),
		// 								SourceVault: &armstoragecache.KeyVaultKeyReferenceSourceVault{
		// 									ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.KeyVault/vaults/keyvault-cmk"),
		// 								},
		// 							},
		// 						},
		// 						Health: &armstoragecache.CacheHealth{
		// 							Conditions: []*armstoragecache.Condition{
		// 								{
		// 									Message: to.Ptr("Cannot contact DNS server"),
		// 									Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-04-21T18:25:43.511Z"); return t}()),
		// 							}},
		// 							State: to.Ptr(armstoragecache.HealthStateTypeTransitioning),
		// 							StatusDescription: to.Ptr("Cache is being created."),
		// 						},
		// 						MountAddresses: []*string{
		// 							to.Ptr("192.168.1.1"),
		// 							to.Ptr("192.168.1.2")},
		// 							NetworkSettings: &armstoragecache.CacheNetworkSettings{
		// 								DNSSearchDomain: to.Ptr("contoso.com"),
		// 								DNSServers: []*string{
		// 									to.Ptr("10.1.22.33"),
		// 									to.Ptr("10.1.12.33")},
		// 									Mtu: to.Ptr[int32](1500),
		// 									NtpServer: to.Ptr("time.contoso.com"),
		// 								},
		// 								PrimingJobs: []*armstoragecache.PrimingJob{
		// 									{
		// 										PrimingJobDetails: to.Ptr("Files: Cached=635, Failed=0, Excluded=80, Data=346030 bytes, Directories: Cached=1003, Failed=0, Excluded=0"),
		// 										PrimingJobID: to.Ptr("00000000000_0000000000"),
		// 										PrimingJobName: to.Ptr("contosoJob1"),
		// 										PrimingJobPercentComplete: to.Ptr[float64](100),
		// 										PrimingJobState: to.Ptr(armstoragecache.PrimingJobStateComplete),
		// 										PrimingJobStatus: to.Ptr("success"),
		// 									},
		// 									{
		// 										PrimingJobDetails: to.Ptr(""),
		// 										PrimingJobID: to.Ptr("11111111111_1111111111"),
		// 										PrimingJobName: to.Ptr("contosoJob2"),
		// 										PrimingJobPercentComplete: to.Ptr[float64](0),
		// 										PrimingJobState: to.Ptr(armstoragecache.PrimingJobStateQueued),
		// 										PrimingJobStatus: to.Ptr(""),
		// 								}},
		// 								ProvisioningState: to.Ptr(armstoragecache.ProvisioningStateTypeSucceeded),
		// 								SecuritySettings: &armstoragecache.CacheSecuritySettings{
		// 									AccessPolicies: []*armstoragecache.NfsAccessPolicy{
		// 										{
		// 											Name: to.Ptr("default"),
		// 											AccessRules: []*armstoragecache.NfsAccessRule{
		// 												{
		// 													Access: to.Ptr(armstoragecache.NfsAccessRuleAccessRw),
		// 													RootSquash: to.Ptr(false),
		// 													Scope: to.Ptr(armstoragecache.NfsAccessRuleScopeDefault),
		// 													SubmountAccess: to.Ptr(true),
		// 													Suid: to.Ptr(false),
		// 											}},
		// 									}},
		// 								},
		// 								SpaceAllocation: []*armstoragecache.StorageTargetSpaceAllocation{
		// 								},
		// 								Subnet: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/sub2"),
		// 								UpgradeSettings: &armstoragecache.CacheUpgradeSettings{
		// 									ScheduledTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-04-26T18:25:43.511Z"); return t}()),
		// 									UpgradeScheduleEnabled: to.Ptr(true),
		// 								},
		// 								UpgradeStatus: &armstoragecache.CacheUpgradeStatus{
		// 									CurrentFirmwareVersion: to.Ptr("2022.08.1"),
		// 									FirmwareUpdateDeadline: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-04-21T18:25:43.511Z"); return t}()),
		// 									FirmwareUpdateStatus: to.Ptr(armstoragecache.FirmwareStatusTypeAvailable),
		// 									LastFirmwareUpdate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-01-21T18:25:43.511Z"); return t}()),
		// 									PendingFirmwareVersion: to.Ptr("2022.08.1"),
		// 								},
		// 								Zones: []*string{
		// 									to.Ptr("1")},
		// 								},
		// 								SKU: &armstoragecache.CacheSKU{
		// 									Name: to.Ptr("Standard_2G"),
		// 								},
		// 								SystemData: &armstoragecache.SystemData{
		// 									CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-01T17:18:19.123Z"); return t}()),
		// 									CreatedBy: to.Ptr("user1"),
		// 									CreatedByType: to.Ptr(armstoragecache.CreatedByTypeUser),
		// 									LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-01-02T17:18:19.123Z"); return t}()),
		// 									LastModifiedBy: to.Ptr("user2"),
		// 									LastModifiedByType: to.Ptr(armstoragecache.CreatedByTypeUser),
		// 								},
		// 								Tags: map[string]*string{
		// 									"Dept": to.Ptr("Contoso"),
		// 								},
		// 						}},
		// 					}
	}
}

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

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

/**
 * This sample demonstrates how to Returns all caches the user has access to under a subscription.
 *
 * @summary Returns all caches the user has access to under a subscription.
 * x-ms-original-file: specification/storagecache/resource-manager/Microsoft.StorageCache/StorageCache/stable/2026-01-01/examples/Caches_List.json
 */
async function cachesList() {
  const subscriptionId =
    process.env["STORAGECACHE_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const credential = new DefaultAzureCredential();
  const client = new StorageCacheManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.caches.list()) {
    resArray.push(item);
  }
  console.log(resArray);
}

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.Resources;
using Azure.ResourceManager.StorageCache.Models;
using Azure.ResourceManager.StorageCache;

// Generated from example definition: specification/storagecache/resource-manager/Microsoft.StorageCache/StorageCache/stable/2026-01-01/examples/Caches_List.json
// this example is just showing the usage of "Caches_List" 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 SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
await foreach (StorageCacheResource item in subscriptionResource.GetStorageCachesAsync())
{
    // the variable item 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
    StorageCacheData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

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

示例响应

状态代码:: 200

{
  "value": [
    {
      "tags": {
        "Dept": "Contoso"
      },
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc1",
      "location": "westus",
      "name": "sc1",
      "type": "Microsoft.StorageCache/Cache",
      "systemData": {
        "createdBy": "user1",
        "createdByType": "User",
        "createdAt": "2020-01-01T17:18:19.1234567Z",
        "lastModifiedBy": "user2",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
      },
      "properties": {
        "cacheSizeGB": 3072,
        "health": {
          "state": "Transitioning",
          "statusDescription": "Cache is being created.",
          "conditions": [
            {
              "timestamp": "2021-04-21T18:25:43.511Z",
              "message": "Cannot contact DNS server"
            }
          ]
        },
        "mountAddresses": [
          "192.168.1.1",
          "192.168.1.2"
        ],
        "provisioningState": "Succeeded",
        "subnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/sub1",
        "upgradeStatus": {
          "currentFirmwareVersion": "2022.08.1",
          "firmwareUpdateStatus": "available",
          "firmwareUpdateDeadline": "2019-04-21T18:25:43.511Z",
          "lastFirmwareUpdate": "2019-01-21T18:25:43.511Z",
          "pendingFirmwareVersion": "2022.08.1"
        },
        "networkSettings": {
          "mtu": 1500,
          "dnsServers": [
            "10.1.22.33",
            "10.1.12.33"
          ],
          "dnsSearchDomain": "contoso.com",
          "ntpServer": "time.contoso.com"
        },
        "securitySettings": {
          "accessPolicies": [
            {
              "name": "default",
              "accessRules": [
                {
                  "scope": "default",
                  "access": "rw",
                  "suid": false,
                  "submountAccess": true,
                  "rootSquash": false
                }
              ]
            }
          ]
        },
        "upgradeSettings": {
          "upgradeScheduleEnabled": true,
          "scheduledTime": "2022-04-26T18:25:43.511Z"
        },
        "encryptionSettings": {
          "keyEncryptionKey": {
            "keyUrl": "https://keyvault-cmk.vault.azure.net/keys/key2048/test",
            "sourceVault": {
              "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.KeyVault/vaults/keyvault-cmk"
            }
          }
        },
        "directoryServicesSettings": {
          "activeDirectory": {
            "primaryDnsIpAddress": "192.0.2.10",
            "secondaryDnsIpAddress": "192.0.2.11",
            "domainName": "contosoAd.contoso.local",
            "domainNetBiosName": "contosoAd",
            "cacheNetBiosName": "contosoSmb",
            "domainJoined": "Yes"
          },
          "usernameDownload": {
            "extendedGroups": true,
            "usernameSource": "LDAP",
            "groupFileURI": "http://contoso.net/group.file",
            "userFileURI": "http://contoso.net/passwd.file",
            "ldapServer": "192.0.2.12",
            "ldapBaseDN": "dc=contosoad,dc=contoso,dc=local",
            "encryptLdapConnection": false,
            "requireValidCertificate": false,
            "autoDownloadCertificate": false,
            "caCertificateURI": "http://contoso.net/cacert.pem",
            "usernameDownloaded": "Yes"
          }
        },
        "primingJobs": [],
        "spaceAllocation": [
          {
            "name": "st1",
            "allocationPercentage": 25
          },
          {
            "name": "st2",
            "allocationPercentage": 50
          },
          {
            "name": "st3",
            "allocationPercentage": 25
          }
        ]
      },
      "sku": {
        "name": "Standard_2G"
      }
    },
    {
      "tags": {
        "Dept": "Contoso"
      },
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc2",
      "location": "westus",
      "name": "sc2",
      "type": "Microsoft.StorageCache/Cache",
      "systemData": {
        "createdBy": "user1",
        "createdByType": "User",
        "createdAt": "2020-01-01T17:18:19.1234567Z",
        "lastModifiedBy": "user2",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
      },
      "properties": {
        "cacheSizeGB": 3072,
        "health": {
          "state": "Transitioning",
          "statusDescription": "Cache is being created.",
          "conditions": [
            {
              "timestamp": "2021-04-21T18:25:43.511Z",
              "message": "Cannot contact DNS server"
            }
          ]
        },
        "mountAddresses": [
          "192.168.1.1",
          "192.168.1.2"
        ],
        "provisioningState": "Updating",
        "subnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/sub2",
        "upgradeStatus": {
          "currentFirmwareVersion": "2022.08.1",
          "firmwareUpdateStatus": "available",
          "firmwareUpdateDeadline": "2019-04-21T18:25:43.511Z",
          "lastFirmwareUpdate": "2019-01-21T18:25:43.511Z",
          "pendingFirmwareVersion": "2022.08.1"
        },
        "networkSettings": {
          "mtu": 1500,
          "dnsServers": [
            "10.1.22.33",
            "10.1.12.33"
          ],
          "dnsSearchDomain": "contoso.com",
          "ntpServer": "time.contoso.com"
        },
        "securitySettings": {
          "accessPolicies": [
            {
              "name": "default",
              "accessRules": [
                {
                  "scope": "default",
                  "access": "rw",
                  "suid": false,
                  "submountAccess": true,
                  "rootSquash": false
                }
              ]
            }
          ]
        },
        "upgradeSettings": {
          "upgradeScheduleEnabled": true,
          "scheduledTime": "2022-04-26T18:25:43.511Z"
        },
        "encryptionSettings": {
          "keyEncryptionKey": {
            "keyUrl": "https://keyvault-cmk.vault.azure.net/keys/key2048/test",
            "sourceVault": {
              "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.KeyVault/vaults/keyvault-cmk"
            }
          }
        },
        "directoryServicesSettings": {
          "activeDirectory": {
            "primaryDnsIpAddress": "192.0.2.10",
            "secondaryDnsIpAddress": "192.0.2.11",
            "domainName": "contosoAd.contoso.local",
            "domainNetBiosName": "contosoAd",
            "cacheNetBiosName": "contosoSmb",
            "domainJoined": "Yes"
          },
          "usernameDownload": {
            "extendedGroups": true,
            "usernameSource": "AD",
            "groupFileURI": "http://contoso.net/group.file",
            "userFileURI": "http://contoso.net/passwd.file",
            "ldapServer": "",
            "ldapBaseDN": "",
            "encryptLdapConnection": false,
            "requireValidCertificate": false,
            "autoDownloadCertificate": false,
            "caCertificateURI": "http://contoso.net/cacert.pem",
            "usernameDownloaded": "Yes"
          }
        },
        "primingJobs": [
          {
            "primingJobName": "contosoJob1",
            "primingJobId": "00000000000_0000000000",
            "primingJobState": "Complete",
            "primingJobStatus": "success",
            "primingJobDetails": "Files: Cached=635, Failed=0, Excluded=80, Data=346030 bytes, Directories: Cached=1003, Failed=0, Excluded=0",
            "primingJobPercentComplete": 100
          },
          {
            "primingJobName": "contosoJob2",
            "primingJobId": "11111111111_1111111111",
            "primingJobState": "Queued",
            "primingJobStatus": "",
            "primingJobDetails": "",
            "primingJobPercentComplete": 0
          }
        ],
        "spaceAllocation": [],
        "zones": [
          "1"
        ]
      },
      "sku": {
        "name": "Standard_2G"
      }
    }
  ]
}

定义

名称	说明
Cache	缓存实例。遵循 Azure 资源管理器标准：https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/resource-api-reference.md
CacheActiveDirectorySettings	用于将缓存加入域的 Active Directory 设置。
CacheDirectorySettings	缓存目录服务设置。
CacheEncryptionSettings	缓存加密设置。
CacheHealth	指示缓存运行状况。提供有关运行状况的详细信息，而不仅仅是与预配相关的运行状况。
CacheIdentity	缓存标识属性。
CacheIdentityType	用于缓存的标识类型
CacheNetworkSettings	缓存网络设置。
CacheSecuritySettings	缓存安全设置。
CachesListResult	列出缓存的请求的结果。它包含缓存列表和 URL 链接，用于获取下一组结果。
CacheUpgradeSettings	缓存升级设置。
CacheUpgradeStatus	描述缓存的软件升级状态的属性。
CacheUsernameDownloadSettings	扩展组用户名和组下载的设置。
CloudError	错误响应。
CloudErrorBody	错误响应。
Condition	需要解决的未完成条件。
createdByType	创建资源的标识的类型。
Credentials	用于将 HPC 缓存加入域的 Active Directory 管理员凭据。
DomainJoinedType	如果 HPC 缓存已加入 Active Directory 域，则为 True。
FirmwareStatusType	如果已准备好在此缓存上安装固件更新，则为 True。如果未通过升级作提前触发固件，则固件将在 firmwareUpdateDeadline 之后自动安装。
HealthStateType	缓存运行状况状态列表。关闭是指集群没有响应。降级是指它正常运行但有一些警报。创建或删除时进行转换。当在将来的版本中添加新值时，将在旧的 API 版本中返回未知。 WaitingForKey 是指创建者正在等待系统分配的标识被授予对加密设置中加密密钥的访问权限。
KeyVaultKeyReference	描述对密钥保管库密钥的引用。
NfsAccessPolicy	描述应用于缓存 NFSv3 客户端的访问策略的一组规则。
NfsAccessRule	针对提供给客户端的缓存命名空间部分施加限制的规则。
NfsAccessRuleAccess	此规则允许的访问。
NfsAccessRuleScope	此规则的范围。范围和筛选器确定哪些客户端与规则匹配。
PrimingJob	启动作业实例。
PrimingJobState	启动作的状态。
ProvisioningStateType	ARM 预配状态，请参阅 https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property
Sku	缓存的 SKU。
SourceVault	描述源密钥保管库的资源 ID。
StorageTargetSpaceAllocation	存储目标空间分配属性。
systemData	与创建和上次修改资源相关的元数据。
UserAssignedIdentities	一个字典，其中每个密钥是用户分配的标识资源 ID，并且每个密钥的值都是空字典。
UsernameDownloadedType	指示 HPC 缓存是否成功执行了用户名下载。
UsernameSource	此设置确定缓存如何获取客户端的用户名和组名称。

Cache

对象

缓存实例。遵循 Azure 资源管理器标准：https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/resource-api-reference.md

名称	类型	说明
id	string	缓存的资源 ID。
identity	CacheIdentity	缓存的标识（如果已配置）。
location	string	区域名称字符串。
name	string pattern: ^[-0-9a-zA-Z_]{1,80}$	缓存的名称。
properties.cacheSizeGB	integer (int32)	此缓存的大小（以 GB 为单位）。
properties.directoryServicesSettings	CacheDirectorySettings	指定缓存的目录服务设置。
properties.encryptionSettings	CacheEncryptionSettings	指定缓存的加密设置。
properties.health	CacheHealth	缓存的运行状况。
properties.mountAddresses	string[]	挂载此缓存的客户端可以使用的 IPv4 地址数组。
properties.networkSettings	CacheNetworkSettings	指定缓存的网络设置。
properties.primingJobs	PrimingJob[]	指定缓存中定义的启动作业。
properties.provisioningState	ProvisioningStateType	ARM 预配状态，请参阅 https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property
properties.securitySettings	CacheSecuritySettings	指定缓存的安全设置。
properties.spaceAllocation	StorageTargetSpaceAllocation[]	指定缓存中每个存储目标的空间分配百分比。
properties.subnet	string	用于缓存的子网。
properties.upgradeSettings	CacheUpgradeSettings	升级缓存的设置。
properties.upgradeStatus	CacheUpgradeStatus	缓存的升级状态。
properties.zones	string[]	资源的可用性区域。此字段应仅包含数组中的单个元素。
sku	Sku	缓存的 SKU。
systemData	systemData	与此资源相关的系统元数据。
tags	object	资源标记。
type	string	缓存类型;Microsoft.StorageCache/缓存

CacheActiveDirectorySettings

对象

用于将缓存加入域的 Active Directory 设置。

名称	类型	说明
cacheNetBiosName	string pattern: ^[-0-9a-zA-Z]{1,15}$	将 Active Directory 域作为服务器加入时要分配给 HPC 缓存的 NetBIOS 名称。长度必须来自类 [-0-9a-zA-Z] 的 1-15 个字符。
credentials	Credentials	用于将 HPC 缓存加入域的 Active Directory 管理员凭据。
domainJoined	DomainJoinedType	如果 HPC 缓存已加入 Active Directory 域，则为 True。
domainName	string	Active Directory 域控制器的完全限定域名。
domainNetBiosName	string	Active Directory 域的 NetBIOS 名称。
primaryDnsIpAddress	string	用于解析 Active Directory 域控制器完全限定域名的主 DNS IP 地址。
secondaryDnsIpAddress	string	用于解析 Active Directory 域控制器的完全限定域名的辅助 DNS IP 地址。

CacheDirectorySettings

对象

缓存目录服务设置。

名称	类型	说明
activeDirectory	CacheActiveDirectorySettings	指定用于将 HPC 缓存加入 Active Directory 域的设置。
usernameDownload	CacheUsernameDownloadSettings	指定扩展组的设置。扩展组允许用户成为 16 个以上的组的成员。

CacheEncryptionSettings

对象

缓存加密设置。

名称	类型	说明
keyEncryptionKey	KeyVaultKeyReference	指定密钥加密密钥在密钥保管库中的位置。
rotationToLatestKeyVersionEnabled	boolean	指定服务是否会自动轮换到密钥保管库中最新版本的密钥。

CacheHealth

对象

指示缓存运行状况。提供有关运行状况的详细信息，而不仅仅是与预配相关的运行状况。

名称	类型	说明
conditions	Condition[]	需要调查和解决的未决情况。
state	HealthStateType	缓存运行状况状态列表。关闭是指集群没有响应。降级是指它正常运行但有一些警报。创建或删除时进行转换。当在将来的版本中添加新值时，将在旧的 API 版本中返回未知。 WaitingForKey 是指创建者正在等待系统分配的标识被授予对加密设置中加密密钥的访问权限。
statusDescription	string	描述状态的解释。

CacheIdentity

对象

缓存标识属性。

名称	类型	说明
principalId	string	缓存的系统分配标识的主体 ID。
tenantId	string	与缓存关联的租户 ID。
type	CacheIdentityType	用于缓存的标识类型
userAssignedIdentities	UserAssignedIdentities	一个字典，其中每个密钥是用户分配的标识资源 ID，并且每个密钥的值都是空字典。

CacheIdentityType

枚举

用于缓存的标识类型

值	说明
SystemAssigned
UserAssigned
SystemAssigned, UserAssigned
None

CacheNetworkSettings

对象

缓存网络设置。

名称	类型	默认值	说明
dnsSearchDomain	string		DNS 搜索域
dnsServers	string[]		要使用的缓存的 DNS 服务器。如果未提供任何值，则会从网络配置设置它。
mtu	integer (int32) minimum: 576 maximum: 1500	1500	为子网配置的 IPv4 最大传输单元。
ntpServer	string	time.windows.com	供缓存使用的 NTP 服务器 IP 地址或 FQDN。默认值为 time.windows.com。
utilityAddresses	string[]		此缓存使用的其他 IP 地址数组。

CacheSecuritySettings

对象

缓存安全设置。

名称	类型	说明
accessPolicies	NfsAccessPolicy[]	为此缓存定义的 NFS 访问策略。

CachesListResult

对象

列出缓存的请求的结果。它包含缓存列表和 URL 链接，用于获取下一组结果。

名称	类型	说明
nextLink	string	URL 以获取下一组缓存列表结果（如果有）。
value	Cache[]	缓存列表。

CacheUpgradeSettings

对象

缓存升级设置。

名称	类型	说明
scheduledTime	string (date-time)	如果 upgradeScheduleEnabled 为 true，此字段将保留用户选择的升级时间。在用户选择的时间，固件更新将自动安装在缓存中。
upgradeScheduleEnabled	boolean	如此如果用户选择在现在和 firmwareUpdateDeadline 之间选择安装时间。否则，如果之前未通过升级操作触发，则固件将自动安装在 firmwareUpdateDeadline 之后。

CacheUpgradeStatus

对象

描述缓存的软件升级状态的属性。

名称	类型	说明
currentFirmwareVersion	string	当前安装在此缓存上的固件的版本字符串。
firmwareUpdateDeadline	string (date-time)	挂起的固件更新将自动安装到缓存上的时间。
firmwareUpdateStatus	FirmwareStatusType	如果已准备好在此缓存上安装固件更新，则为 True。如果未通过升级作提前触发固件，则固件将在 firmwareUpdateDeadline 之后自动安装。
lastFirmwareUpdate	string (date-time)	上次成功固件更新的时间。
pendingFirmwareVersion	string	当 firmwareUpdateAvailable 为 true 时，此字段保存更新的版本字符串。

CacheUsernameDownloadSettings

对象

扩展组用户名和组下载的设置。

名称	类型	默认值	说明
autoDownloadCertificate	boolean	False	确定是否应自动下载证书。仅当“requireValidCertificateate”为 true 时，这才适用于“caCertificateURI”。
caCertificateURI	string		用于验证 LDAP 安全连接的 CA 证书的 URI。当“requireValidCertificate”设置为 true 时，必须填充此字段。
credentials	Credentials		存在时，这些是安全 LDAP 连接的凭据。
encryptLdapConnection	boolean	False	是否应加密 LDAP 连接。
extendedGroups	boolean		是否启用扩展组。
groupFileURI	string		包含组信息的文件的 URI（采用 /etc/group 文件格式）。当“usernameSource”设置为“File”时，必须填充此字段。
ldapBaseDN	string		LDAP 域的基本可分辨名称。
ldapServer	string		要使用的 LDAP 服务器的完全限定域名或 IP 地址。
requireValidCertificate	boolean	False	确定证书是否必须由证书颁发机构验证。如果为 true，则必须提供 caCertificateURI。
userFileURI	string		包含用户信息的文件的 URI（采用 /etc/passwd 文件格式）。当“usernameSource”设置为“File”时，必须填充此字段。
usernameDownloaded	UsernameDownloadedType		指示 HPC 缓存是否成功执行了用户名下载。
usernameSource	UsernameSource	None	此设置确定缓存如何获取客户端的用户名和组名称。

CloudError

对象

错误响应。

名称	类型	说明
error	CloudErrorBody	错误的正文。

CloudErrorBody

对象

错误响应。

名称	类型	说明
code	string	错误的标识符。代码是固定的，旨在以编程方式使用。
details	CloudErrorBody[]	有关错误的其他详细信息的列表。
message	string	描述错误的消息，旨在适合在用户界面中显示。
target	string	特定错误的目标。例如，错误属性的名称。

Condition

对象

需要解决的未完成条件。

名称	类型	说明
message	string	需要注意的问题。
timestamp	string (date-time)	条件被提出的时间。

createdByType

枚举

创建资源的标识的类型。

值	说明
User
Application
ManagedIdentity
Key

Credentials

对象

用于将 HPC 缓存加入域的 Active Directory 管理员凭据。

名称	类型	说明
password	string	Active Directory 域管理员的纯文本密码。此值是加密的，不会在响应时返回。
username	string	Active Directory 域管理员的用户名。此值是加密的，不会在响应时返回。

DomainJoinedType

枚举

如果 HPC 缓存已加入 Active Directory 域，则为 True。

值	说明
Yes
No
Error

FirmwareStatusType

枚举

如果已准备好在此缓存上安装固件更新，则为 True。如果未通过升级作提前触发固件，则固件将在 firmwareUpdateDeadline 之后自动安装。

值	说明
available
unavailable

HealthStateType

枚举

缓存运行状况状态列表。关闭是指集群没有响应。降级是指它正常运行但有一些警报。创建或删除时进行转换。当在将来的版本中添加新值时，将在旧的 API 版本中返回未知。 WaitingForKey 是指创建者正在等待系统分配的标识被授予对加密设置中加密密钥的访问权限。

值	说明
Unknown
Healthy
Degraded
Down
Transitioning
Stopping
Stopped
Upgrading
Flushing
WaitingForKey
StartFailed
UpgradeFailed

KeyVaultKeyReference

对象

描述对密钥保管库密钥的引用。

名称	类型	说明
keyUrl	string	引用密钥保管库中的密钥加密密钥的 URL。
sourceVault	SourceVault	描述源密钥保管库的资源 ID。

NfsAccessPolicy

对象

描述应用于缓存 NFSv3 客户端的访问策略的一组规则。

名称	类型	说明
accessRules	NfsAccessRule[]	描述在此策略下允许的客户端访问的规则集。
name	string	标识此策略的名称。访问策略名称不区分大小写。

NfsAccessRule

对象

针对提供给客户端的缓存命名空间部分施加限制的规则。

名称	类型	说明
access	NfsAccessRuleAccess	此规则允许的访问。
anonymousGID	string	当 rootSquash 为 true 时替换 0 的 GID 值。如果未提供，则将使用 anonymousUID 的值。
anonymousUID	string	当 rootSquash 为 true 时替换 0 的 UID 值。如果未提供，将使用 65534。
filter	string	应用于此规则的范围的筛选器。筛选器的格式取决于其范围。 “default”范围匹配所有客户端，并且没有筛选器值。 “network”范围采用 CIDR 格式的筛选器（例如 10.99.1.0/24）。 “host”采用 IP 地址或完全限定的域名作为筛选器。如果客户端与任何筛选器规则不匹配，并且没有默认规则，则拒绝访问。
rootSquash	boolean	将根访问权限映射到 anonymousUID 和 anonymousGID。
scope	NfsAccessRuleScope	此规则的范围。范围和筛选器确定哪些客户端与规则匹配。
submountAccess	boolean	对于默认策略，允许访问根导出下的子目录。如果设置为“否”，客户端只能装载路径“/”。如果设置为“是”，客户端可以装载更深层的路径，例如“/a/b”。
suid	boolean	允许 SUID 语义。

NfsAccessRuleAccess

枚举

此规则允许的访问。

值	说明
no
ro
rw

NfsAccessRuleScope

枚举

此规则的范围。范围和筛选器确定哪些客户端与规则匹配。

值	说明
default
network
host

PrimingJob

对象

启动作业实例。

名称	类型	说明
primingJobDetails	string	作业详细信息或错误信息（如果有）。
primingJobId	string pattern: ^[-0-9a-zA-Z_]{1,80}$	启动作业的唯一标识符。
primingJobName	string pattern: ^[-0-9a-zA-Z_]{1,80}$	启动作业名称。
primingJobPercentComplete	number (double) minimum: 0 maximum: 100	启动作业的当前进度（以百分比表示）。
primingJobState	PrimingJobState	启动作的状态。
primingJobStatus	string	启动作业的状态代码。
primingManifestUrl	string	要下载的启动清单文件的 URL。此文件必须可从 HPC 缓存读取。当文件位于 Azure Blob 存储中时，URL 应包含授予对 blob 的读取权限的共享访问签名（SAS）。

PrimingJobState

枚举

启动作的状态。

值	说明
Queued
Running
Paused
Complete

ProvisioningStateType

枚举

ARM 预配状态，请参阅 https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property

值	说明
Succeeded
Failed
Canceled
Creating
Deleting
Updating

Sku

对象

缓存的 SKU。

名称	类型	说明
name	string	此缓存的 SKU 名称。

SourceVault

对象

描述源密钥保管库的资源 ID。

名称	类型	说明
id	string	资源 ID。

StorageTargetSpaceAllocation

对象

存储目标空间分配属性。

名称	类型	说明
allocationPercentage	integer (int32) minimum: 1 maximum: 100	为此存储目标分配的缓存空间百分比
name	string pattern: ^[-0-9a-zA-Z_]{1,80}$	存储目标的名称。

systemData

对象

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	资源上次修改的时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。

UserAssignedIdentities

对象

一个字典，其中每个密钥是用户分配的标识资源 ID，并且每个密钥的值都是空字典。

名称	类型	说明

UsernameDownloadedType

枚举

指示 HPC 缓存是否成功执行了用户名下载。

值	说明
Yes
No
Error

UsernameSource

枚举

此设置确定缓存如何获取客户端的用户名和组名称。

值	说明
AD
LDAP
File
None