Share via

Aad Properties - Get

Service:
Recovery Services - Backup
API Version:
2023-01-15

Fetches the AAD properties from target region BCM stamp.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.RecoveryServices/locations/{azureRegion}/backupAadProperties?api-version=2023-01-15
With optional parameters: 
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.RecoveryServices/locations/{azureRegion}/backupAadProperties?api-version=2023-01-15&$filter={$filter}

URI Parameters

Name In Required Type Description
azureRegion
 path True

string

Azure region to hit Api
subscriptionId
 path True

string

The subscription Id.
api-version
 query True

string

Client Api Version.
$filter
 query

string

OData filter options.

Responses

Name Type Description
200 OK

AADPropertiesResource

OK
Other Status Codes

NewErrorResponse

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 AAD Properties for authentication in the third region

Sample request

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.RecoveryServices/locations/southeastasia/backupAadProperties?api-version=2023-01-15

Sample response

Status code:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000",
  "properties": {
    "tenantId": "33e01921-4d64-4f8c-a055-5bdaffd5e33d",
    "audience": "https://RecoveryServices/IaasCoord/aadmgmt/ecy",
    "servicePrincipalObjectId": "07e0a67b-cba3-4fcf-a58c-b670d5ced06d"
  }
}

Definitions

Name Description
AADProperties
AADPropertiesResource
Error

The error object.
ErrorAdditionalInfo

The resource management error additional info.
NewErrorResponse

The resource management error response.

AADProperties

Object
Name Type Description
audience

string

authority

string

servicePrincipalClientId

string

servicePrincipalObjectId

string

tenantId

string

AADPropertiesResource

Object
Name Type Description
eTag

string

Optional ETag.
id

string

Resource Id represents the complete path to the resource.
location

string

Resource location.
name

string

Resource name associated with the resource.
properties

AADProperties

AADPropertiesResource properties
tags

object

Resource tags.
type

string

Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...

Error

Object

The error object.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.
code

string

The error code.
details

NewErrorResponse[]

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.

NewErrorResponse

Object

The resource management error response.

Name Type Description
error

Error

The error object.