Caches - List

Retourne tous les caches auxquels l’utilisateur a accès sous un abonnement.

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

Paramètres URI

Name In Required Type Description
subscriptionId
path True
  • string

Informations d’identification d’abonnement qui identifient de manière unique Microsoft Azure abonnement. L’ID d’abonnement fait partie de l’URI pour chaque appel de service.

api-version
query True
  • string

Version d’API client.

Réponses

Name Type Description
200 OK

Liste d’objets cache. Notez que les références d’entité peuvent remplacer des objets de cache complets, comme décrit dans http://docs.oasis-open.org/odata/odata-json-format/v4.01/cs01/odata-json-format-v4.01-cs01.html#sec_EntityReference

Other Status Codes

Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Azure Active Directory le Flow OAuth2.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation emprunter l’identité de votre compte d’utilisateur

Exemples

Caches_List

Sample Request

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

Sample Response

{
  "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": "V5.1.12",
          "firmwareUpdateStatus": "available",
          "firmwareUpdateDeadline": "2019-04-21T18:25:43.511Z",
          "lastFirmwareUpdate": "2019-01-21T18:25:43.511Z",
          "pendingFirmwareVersion": "V5.1.15"
        },
        "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
                }
              ]
            }
          ]
        },
        "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": "",
            "userFileURI": "",
            "ldapServer": "192.0.2.12",
            "ldapBaseDN": "dc=contosoad,dc=contoso,dc=local",
            "encryptLdapConnection": false,
            "requireValidCertificate": false,
            "autoDownloadCertificate": false,
            "caCertificateURI": "",
            "usernameDownloaded": "Yes"
          }
        }
      },
      "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": "V5.1.12",
          "firmwareUpdateStatus": "available",
          "firmwareUpdateDeadline": "2019-04-21T18:25:43.511Z",
          "lastFirmwareUpdate": "2019-01-21T18:25:43.511Z",
          "pendingFirmwareVersion": "V5.1.15"
        },
        "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
                }
              ]
            }
          ]
        },
        "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": "",
            "userFileURI": "",
            "ldapServer": "",
            "ldapBaseDN": "",
            "encryptLdapConnection": false,
            "requireValidCertificate": false,
            "autoDownloadCertificate": false,
            "caCertificateURI": "",
            "usernameDownloaded": "Yes"
          }
        }
      },
      "sku": {
        "name": "Standard_2G"
      }
    }
  ]
}

Définitions

Cache

Instance de cache. Suit Azure Resource Manager normes : https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/resource-api-reference.md

CacheActiveDirectorySettings

Active Directory les paramètres utilisés pour joindre un cache à un domaine.

CacheDirectorySettings

Cache les paramètres des services d’annuaire.

CacheEncryptionSettings

Paramètres de chiffrement du cache.

CacheHealth

Indication de l’intégrité du cache. Fournit plus d’informations sur l’intégrité que celle liée à l’approvisionnement.

CacheIdentity

Propriétés de l’identité du cache.

CacheIdentityType

Type d’identité utilisé pour le cache

CacheNetworkSettings

Mettez en cache les paramètres réseau.

CacheSecuritySettings

Paramètres de sécurité du cache.

CachesListResult

Résultat de la demande de liste des caches. Il contient une liste de caches et un lien URL pour obtenir le jeu de résultats suivant.

CacheUpgradeStatus

Propriétés décrivant l’état de mise à niveau logicielle du cache.

CacheUsernameDownloadSettings

Paramètres pour les groupes étendus nom d’utilisateur et groupe à télécharger.

CloudError

Réponse d’erreur.

CloudErrorBody

Réponse d’erreur.

Condition

Conditions en suspens qui devront être résolues.

createdByType

Type d’identité qui a créé la ressource.

Credentials

Active Directory informations d’identification d’administrateur utilisées pour joindre le cache HPC à un domaine.

DomainJoinedType

True si le cache HPC est joint au domaine Active Directory.

FirmwareStatusType

True si une mise à jour du microprogramme est prête à être installée sur ce cache. Le microprogramme sera automatiquement installé après firmwareUpdateDeadline, s’il n’a pas été déclenché précédemment via l’opération de mise à niveau.

HealthStateType

Liste des États d’intégrité du cache.

KeyVaultKeyReference

Décrit une référence à Key Vault clé.

NfsAccessPolicy

Ensemble de règles décrivant les stratégies d’accès appliquées aux clients NFSv3 du cache.

NfsAccessRule

Règle pour placer des restrictions sur des parties de l’espace de noms de cache présentées aux clients.

NfsAccessRuleAccess

Accès autorisé par cette règle.

NfsAccessRuleScope

Étendue de cette règle. L’étendue et le filtre déterminent les clients qui correspondent à la règle.

ProvisioningStateType

État de provisionnement ARM, consultez https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property

Sku

Référence (SKU) pour le cache.

SourceVault

Décrit un ID de ressource à la source Key Vault.

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

UsernameDownloadedType

Indique si le cache HPC a correctement effectué le téléchargement du nom d’utilisateur.

UsernameSource

Ce paramètre détermine la façon dont le cache obtient les noms de nom d’utilisateur et de groupe pour les clients.

Cache

Instance de cache. Suit Azure Resource Manager normes : https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/resource-api-reference.md

Name Type Description
id
  • string

ID de ressource du cache.

identity

Identité du cache, si elle est configurée.

location
  • string

Chaîne du nom de la région.

name
  • string

Nom du cache.

properties.cacheSizeGB
  • integer

Taille de ce cache, en Go.

properties.directoryServicesSettings

Spécifie les paramètres des services d’annuaire du cache.

properties.encryptionSettings

Spécifie les paramètres de chiffrement du cache.

properties.health

Intégrité du cache.

properties.mountAddresses
  • string[]

Tableau d’adresses IP qui peuvent être utilisées par les clients qui montent ce cache.

properties.networkSettings

Spécifie les paramètres réseau du cache.

properties.provisioningState

État de provisionnement ARM, consultez https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property

properties.securitySettings

Spécifie les paramètres de sécurité du cache.

properties.subnet
  • string

Sous-réseau utilisé pour le cache.

properties.upgradeStatus

État de mise à niveau du cache.

sku

Référence (SKU) pour le cache.

systemData

Métadonnées système relatives à cette ressource.

tags
  • object

Balises de ressource.

type
  • string

Type du cache ; Microsoft. StorageCache/cache

CacheActiveDirectorySettings

Active Directory les paramètres utilisés pour joindre un cache à un domaine.

Name Type Description
cacheNetBiosName
  • string

Nom NetBIOS à affecter au cache HPC lorsqu’il rejoint le domaine Active Directory en tant que serveur. La longueur doit 1-15 caractères de la classe [-0-9A-zA-Z].

credentials

Active Directory informations d’identification d’administrateur utilisées pour joindre le cache HPC à un domaine.

domainJoined

True si le cache HPC est joint au domaine Active Directory.

domainName
  • string

Nom de domaine complet du contrôleur de domaine Active Directory.

domainNetBiosName
  • string

Nom NetBIOS du domaine Active Directory.

primaryDnsIpAddress
  • string

Adresse IP DNS principale utilisée pour résoudre le nom de domaine complet du contrôleur de domaine Active Directory.

secondaryDnsIpAddress
  • string

Adresse IP DNS secondaire utilisée pour résoudre le nom de domaine complet du contrôleur de domaine Active Directory.

CacheDirectorySettings

Cache les paramètres des services d’annuaire.

Name Type Description
activeDirectory

Spécifie les paramètres pour joindre le cache HPC à un domaine Active Directory.

usernameDownload

Spécifie les paramètres pour les groupes étendus. Les groupes étendus permettent aux utilisateurs d’être membres de plus de 16 groupes.

CacheEncryptionSettings

Paramètres de chiffrement du cache.

Name Type Description
keyEncryptionKey

Spécifie l’emplacement de la clé de chiffrement à clé dans Key Vault.

CacheHealth

Indication de l’intégrité du cache. Fournit plus d’informations sur l’intégrité que celle liée à l’approvisionnement.

Name Type Description
conditions

Conditions en suspens qui doivent être examinées et résolues.

state

Liste des États d’intégrité du cache.

statusDescription
  • string

Décrit l’explication de l’État.

CacheIdentity

Propriétés de l’identité du cache.

Name Type Description
principalId
  • string

ID du principal du cache.

tenantId
  • string

ID de locataire associé au cache.

type

Type d’identité utilisé pour le cache

CacheIdentityType

Type d’identité utilisé pour le cache

Name Type Description
None
  • string
SystemAssigned
  • string

CacheNetworkSettings

Mettez en cache les paramètres réseau.

Name Type Description
dnsSearchDomain
  • string

Domaine de recherche DNS

dnsServers
  • string[]

Serveurs DNS à utiliser par le cache. Elle sera définie à partir de la configuration réseau si aucune valeur n’est fournie.

mtu
  • integer

L’unité de transmission maximale IPv4 configurée pour le sous-réseau.

ntpServer
  • string

Adresse IP ou nom de domaine complet du serveur NTP que le cache doit utiliser. La valeur par défaut est time.windows.com.

utilityAddresses
  • string[]

Tableau d’adresses IP supplémentaires utilisées par ce cache.

CacheSecuritySettings

Paramètres de sécurité du cache.

Name Type Description
accessPolicies

Stratégies d’accès NFS définies pour ce cache.

CachesListResult

Résultat de la demande de liste des caches. Il contient une liste de caches et un lien URL pour obtenir le jeu de résultats suivant.

Name Type Description
nextLink
  • string

URL permettant d’obtenir le jeu de résultats de la liste de cache suivant, le cas échéant.

value

Liste des caches.

CacheUpgradeStatus

Propriétés décrivant l’état de mise à niveau logicielle du cache.

Name Type Description
currentFirmwareVersion
  • string

Chaîne de version du microprogramme actuellement installé sur ce cache.

firmwareUpdateDeadline
  • string

Heure à laquelle la mise à jour du microprogramme en attente sera automatiquement installée sur le cache.

firmwareUpdateStatus

True si une mise à jour du microprogramme est prête à être installée sur ce cache. Le microprogramme sera automatiquement installé après firmwareUpdateDeadline, s’il n’a pas été déclenché précédemment via l’opération de mise à niveau.

lastFirmwareUpdate
  • string

Heure de la dernière mise à jour du microprogramme réussie.

pendingFirmwareVersion
  • string

Quand firmwareUpdateAvailable a la valeur true, ce champ contient la chaîne de version de la mise à jour.

CacheUsernameDownloadSettings

Paramètres pour les groupes étendus nom d’utilisateur et groupe à télécharger.

Name Type Description
autoDownloadCertificate
  • boolean

Détermine si le certificat doit être téléchargé automatiquement. Cela s’applique à « caCertificateURI » uniquement si « requireValidCertificate » a la valeur true.

caCertificateURI
  • string

URI du certificat d’autorité de certification pour valider la connexion sécurisée LDAP. Ce champ doit être renseigné lorsque « requireValidCertificate » a la valeur true.

credentials

Le cas échéant, il s’agit des informations d’identification pour la connexion LDAP sécurisée.

encryptLdapConnection
  • boolean

Indique si la connexion LDAP doit être chiffrée.

extendedGroups
  • boolean

Indique si les groupes étendus sont activés.

groupFileURI
  • string

URI du fichier contenant les informations de groupe (au format de fichier/etc/Group). Ce champ doit être rempli lorsque « usernameSource » a la valeur « file ».

ldapBaseDN
  • string

Nom unique de base du domaine LDAP.

ldapServer
  • string

Nom de domaine complet ou adresse IP du serveur LDAP à utiliser.

requireValidCertificate
  • boolean

Détermine si les certificats doivent être validés par une autorité de certification. Si la valeur est true, caCertificateURI doit être fourni.

userFileURI
  • string

URI du fichier contenant les informations utilisateur (au format de fichier/etc/passwd). Ce champ doit être rempli lorsque « usernameSource » a la valeur « file ».

usernameDownloaded

Indique si le cache HPC a correctement effectué le téléchargement du nom d’utilisateur.

usernameSource

Ce paramètre détermine la façon dont le cache obtient les noms de nom d’utilisateur et de groupe pour les clients.

CloudError

Réponse d’erreur.

Name Type Description
error

Corps de l’erreur.

CloudErrorBody

Réponse d’erreur.

Name Type Description
code
  • string

Identificateur de l'erreur. Les codes sont invariants et sont destinés à être consommés par programmation.

details

Liste de détails supplémentaires sur l’erreur.

message
  • string

Message décrivant l’erreur, destiné à être adapté à l’affichage dans une interface utilisateur.

target
  • string

Cible de l’erreur particulière. Par exemple, le nom de la propriété dans erreur.

Condition

Conditions en suspens qui devront être résolues.

Name Type Description
message
  • string

Problème nécessitant une attention particulière.

timestamp
  • string

Heure à laquelle la condition a été levée.

createdByType

Type d’identité qui a créé la ressource.

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

Credentials

Active Directory informations d’identification d’administrateur utilisées pour joindre le cache HPC à un domaine.

Name Type Description
password
  • string

Mot de passe en texte brut de l’administrateur de domaine Active Directory. Cette valeur est stockée chiffrée et n’est pas retournée en réponse.

username
  • string

Nom d’utilisateur de l’administrateur de domaine Active Directory. Cette valeur est stockée chiffrée et n’est pas retournée en réponse.

DomainJoinedType

True si le cache HPC est joint au domaine Active Directory.

Name Type Description
Error
  • string
No
  • string
Yes
  • string

FirmwareStatusType

True si une mise à jour du microprogramme est prête à être installée sur ce cache. Le microprogramme sera automatiquement installé après firmwareUpdateDeadline, s’il n’a pas été déclenché précédemment via l’opération de mise à niveau.

Name Type Description
available
  • string
unavailable
  • string

HealthStateType

Liste des États d’intégrité du cache.

Name Type Description
Degraded
  • string
Down
  • string
Flushing
  • string
Healthy
  • string
Stopped
  • string
Stopping
  • string
Transitioning
  • string
Unknown
  • string
Upgrading
  • string

KeyVaultKeyReference

Décrit une référence à Key Vault clé.

Name Type Description
keyUrl
  • string

URL faisant référence à une clé de chiffrement à clé dans Key Vault.

sourceVault

Décrit un ID de ressource à la source Key Vault.

NfsAccessPolicy

Ensemble de règles décrivant les stratégies d’accès appliquées aux clients NFSv3 du cache.

Name Type Description
accessRules

Ensemble de règles décrivant les accès client autorisés dans le cadre de cette stratégie.

name
  • string

Nom identifiant cette stratégie. Les noms de stratégie d’accès ne respectent pas la casse.

NfsAccessRule

Règle pour placer des restrictions sur des parties de l’espace de noms de cache présentées aux clients.

Name Type Description
access

Accès autorisé par cette règle.

anonymousGID
  • string

Valeur GID qui remplace 0 quand rootSquash a la valeur true. Cela utilise la valeur de anonymousUID si elle n’est pas fournie.

anonymousUID
  • string

Valeur UID qui remplace 0 quand rootSquash a la valeur true. 65534 sera utilisé s’il n’est pas fourni.

filter
  • string

Filtre appliqué à l’étendue de cette règle. Le format du filtre dépend de son étendue. la portée’default’correspond à tous les clients et n’a pas de valeur de filtre. l’étendue « réseau » accepte un filtre au format CIDR (par exemple, 10.99.1.0/24). « Host » prend comme filtre une adresse IP ou un nom de domaine complet. Si un client ne correspond à aucune règle de filtre et qu’il n’existe pas de règle par défaut, l’accès est refusé.

rootSquash
  • boolean

Mappez les accès racine à anonymousUID et anonymousGID.

scope

Étendue de cette règle. L’étendue et le filtre déterminent les clients qui correspondent à la règle.

submountAccess
  • boolean

Pour la stratégie par défaut, autorisez l’accès aux sous-répertoires sous l’exportation racine. Si cette valeur est définie sur non, les clients peuvent uniquement monter le chemin d’accès « / ». Si la valeur est oui, les clients peuvent monter un chemin d’accès plus profond, comme « /a/b ».

suid
  • boolean

Autorisez la sémantique SUID.

NfsAccessRuleAccess

Accès autorisé par cette règle.

Name Type Description
no
  • string
ro
  • string
rw
  • string

NfsAccessRuleScope

Étendue de cette règle. L’étendue et le filtre déterminent les clients qui correspondent à la règle.

Name Type Description
default
  • string
host
  • string
network
  • string

ProvisioningStateType

État de provisionnement ARM, consultez https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property

Name Type Description
Cancelled
  • string
Creating
  • string
Deleting
  • string
Failed
  • string
Succeeded
  • string
Updating
  • string

Sku

Référence (SKU) pour le cache.

Name Type Description
name
  • string

Nom de la référence (SKU) pour ce cache.

SourceVault

Décrit un ID de ressource à la source Key Vault.

Name Type Description
id
  • string

ID de ressource.

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

Name Type Description
createdAt
  • string

Horodatage de la création de ressources (UTC).

createdBy
  • string

Identité qui a créé la ressource.

createdByType

Type d’identité qui a créé la ressource.

lastModifiedAt
  • string

Horodateur de la dernière modification de la ressource (UTC)

lastModifiedBy
  • string

Identité qui a modifié la ressource pour la dernière fois.

lastModifiedByType

Type d’identité qui a modifié la ressource pour la dernière fois.

UsernameDownloadedType

Indique si le cache HPC a correctement effectué le téléchargement du nom d’utilisateur.

Name Type Description
Error
  • string
No
  • string
Yes
  • string

UsernameSource

Ce paramètre détermine la façon dont le cache obtient les noms de nom d’utilisateur et de groupe pour les clients.

Name Type Description
AD
  • string
File
  • string
LDAP
  • string
None
  • string