Vault Extended Info - Get

Service:

Recovery Services

API Version:

2025-02-01

Get the vault extended info.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/extendedInformation/vaultExtendedInfo?api-version=2025-02-01

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string minLength: 1	The ID of the target subscription.
vaultName	path	True	string	The name of the recovery services vault.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	VaultExtendedInfoResource	OK
Other Status Codes	CloudError	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	impersonate your user account.

Examples

Get ExtendedInfo of Resource

Sample request

HTTP

GET https://management.azure.com/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.RecoveryServices/vaults/swaggerExample/extendedInformation/vaultExtendedInfo?api-version=2025-02-01

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.recoveryservices import RecoveryServicesClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-recoveryservices
# USAGE
    python get_vault_extended_info.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 = RecoveryServicesClient(
        credential=DefaultAzureCredential(),
        subscription_id="77777777-b0c6-47a2-b37c-d8e65a629c18",
    )

    response = client.vault_extended_info.get(
        resource_group_name="Default-RecoveryServices-ResourceGroup",
        vault_name="swaggerExample",
    )
    print(response)


# x-ms-original-file: specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2025-02-01/examples/GETVaultExtendedInfo.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

Sample response

Status code:

200

{
  "name": "vaultExtendedInfo",
  "etag": "f0d0260b-b92d-4458-ba0a-32c6cdabacb7",
  "properties": {
    "integrityKey": "J09wzS27fnJ+Wjot7xO5wA==",
    "algorithm": "None"
  },
  "id": "/subscriptions/77777777-b0c6-47a2-b37c-d8e65a629c18/resourceGroups/Default-RecoveryServices-ResourceGroup/providers/Microsoft.RecoveryServices/vaults/swaggerExample/extendedInformation/vaultExtendedInfo",
  "type": "Microsoft.RecoveryServices/vaults/extendedInformation"
}

Definitions

Name	Description
CloudError	CloudError
Error	The resource management error response.
ErrorAdditionalInfo	The resource management error additional info.
VaultExtendedInfoResource	Vault extended information.

CloudError

Object

CloudError

Name	Type	Description
error	Error	The resource management error response.

Error

Object

The resource management error response.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	Error[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

VaultExtendedInfoResource

Object

Vault extended information.

Name	Type	Description
etag	string	Optional ETag.
id	string	Resource Id represents the complete path to the resource.
name	string	Resource name associated with the resource.
properties.algorithm	string	Algorithm for Vault ExtendedInfo
properties.encryptionKey	string	Encryption key.
properties.encryptionKeyThumbprint	string	Encryption key thumbprint.
properties.integrityKey	string	Integrity key.
type	string	Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...