Microsoft.NetApp (stable:2024-09-01)

2025/02/11 • 1 updated methods

Accounts_GetChangeKeyVaultInformation (updated)
Description :  Contains data from encryption.keyVaultProperties as well as information about which private endpoint is used by each encryption sibling set. Response from this endpoint can be modified and used as request body for POST request.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Accounts_GetChangeKeyVaultInformation",
  "$responses": {
    "@added_ec3c3fdec4fe48968641337740ac5ad5": {
      "200": {
        "Description": "Result of getKeyVaultStatus with information about how volumes under NetApp account are encrypted.",
        "Type": "object",
        "$properties": [
          {
            "#name": "properties",
            "Description": "Represents the properties of the getKeyVaultStatus.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "keyVaultUri",
                "Description": "The URI of the key vault/managed HSM that should be used for encryption.",
                "Format": "uri",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "keyName",
                "Description": "The name of the key that should be used for encryption.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "keyVaultResourceId",
                "Description": "Azure resource ID of the key vault/managed HSM that should be used for encryption.",
                "Format": "arm-id",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "keyVaultPrivateEndpoints",
                "Description": "Pairs of virtual network ID and private endpoint ID. Every virtual network that has volumes encrypted with customer-managed keys needs its own key vault private endpoint.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "Pairs of virtual network ID and private endpoint ID. Every virtual network that has volumes encrypted with customer-managed keys needs its own key vault private endpoint.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "virtualNetworkId",
                      "Description": "Identifier for the virtual network id",
                      "Format": "arm-id",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "privateEndpointId",
                      "Description": "Identifier of the private endpoint to reach the Azure Key Vault",
                      "Format": "arm-id",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/getKeyVaultStatus
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the NetApp account ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Represents the properties of the getKeyVaultStatus. ,
Required: False ,
}
{
keyVaultUri:
{
Description: The URI of the key vault/managed HSM that should be used for encryption. ,
Format: uri ,
Required: False ,
}
string ,
keyName:
{
Description: The name of the key that should be used for encryption. ,
Required: False ,
}
string ,
keyVaultResourceId:
{
Description: Azure resource ID of the key vault/managed HSM that should be used for encryption. ,
Format: arm-id ,
Required: False ,
}
string ,
keyVaultPrivateEndpoints:
{
Description: Pairs of virtual network ID and private endpoint ID. Every virtual network that has volumes encrypted with customer-managed keys needs its own key vault private endpoint. ,
Required: False ,
}
[
{
virtualNetworkId:
{
Description: Identifier for the virtual network id ,
Format: arm-id ,
Required: False ,
}
string ,
privateEndpointId:
{
Description: Identifier of the private endpoint to reach the Azure Key Vault ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}