REST Resource: projects.locations.managementServers

Resource: ManagementServer

ManagementServer describes a single BackupDR ManagementServer instance.

JSON representation 
{
  "name": string,
  "description": string,
  "labels": {
    string: string,
    ...
  },
  "createTime": string,
  "updateTime": string,
  "type": enum (InstanceType),
  "managementUri": {
    object (ManagementURI)
  },
  "workforceIdentityBasedManagementUri": {
    object (WorkforceIdentityBasedManagementURI)
  },
  "state": enum (InstanceState),
  "networks": [
    {
      object (NetworkConfig)
    }
  ],
  "etag": string,
  "oauth2ClientId": string,
  "workforceIdentityBasedOauth2ClientId": {
    object (WorkforceIdentityBasedOAuth2ClientID)
  },
  "baProxyUri": [
    string
  ],
  "satisfiesPzs": boolean,
  "satisfiesPzi": boolean
}
Fields
name

string

Output only. Identifier. The resource name.
description

string

Optional. The description of the ManagementServer instance (2048 characters or less).
labels

map (key: string, value: string)

Optional. Resource labels to represent user provided metadata. Labels currently defined: 1. migrate_from_go=<false|true> If set to true, the MS is created in migration ready mode.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
createTime

string (Timestamp format)

Output only. The time when the instance was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Output only. The time when the instance was updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
type

enum (InstanceType)

Optional. The type of the ManagementServer resource.
managementUri

object (ManagementURI)

Output only. The hostname or ip address of the exposed AGM endpoints, used by clients to connect to AGM/RD graphical user interface and APIs.
workforceIdentityBasedManagementUri

object (WorkforceIdentityBasedManagementURI)

Output only. The hostnames of the exposed AGM endpoints for both types of user i.e. 1p and 3p, used to connect AGM/RM UI.
state

enum (InstanceState)

Output only. The ManagementServer state.
networks[]

object (NetworkConfig)

Optional. VPC networks to which the ManagementServer instance is connected. For this version, only a single network is supported. This field is optional if MS is created without PSA
etag

string

Optional. Server specified ETag for the ManagementServer resource to prevent simultaneous updates from overwiting each other.
oauth2ClientId

string

Output only. The OAuth 2.0 client id is required to make API calls to the BackupDR instance API of this ManagementServer. This is the value that should be provided in the 'aud' field of the OIDC ID Token (see openid specification https://openid.net/specs/openid-connect-core-1_0.html#IDToken).
workforceIdentityBasedOauth2ClientId

object (WorkforceIdentityBasedOAuth2ClientID)

Output only. The OAuth client IDs for both types of user i.e. 1p and 3p.
baProxyUri[]

string

Output only. The hostname or ip address of the exposed AGM endpoints, used by BAs to connect to BA proxy.
satisfiesPzs

boolean

Output only. Reserved for future use.
satisfiesPzi

boolean

Output only. Reserved for future use.

InstanceType

Type of backup service resource.

Enums
INSTANCE_TYPE_UNSPECIFIED Instance type is not mentioned.
BACKUP_RESTORE Instance for backup and restore management (i.e., AGM).

ManagementURI

ManagementURI for the Management Server resource.

JSON representation 
{
  "webUi": string,
  "api": string
}
Fields
webUi

string

Output only. The ManagementServer AGM/RD WebUI URL.
api

string

Output only. The ManagementServer AGM/RD API URL.

WorkforceIdentityBasedManagementURI

ManagementURI depending on the Workforce Identity i.e. either 1p or 3p.

JSON representation 
{
  "firstPartyManagementUri": string,
  "thirdPartyManagementUri": string
}
Fields
firstPartyManagementUri

string

Output only. First party Management URI for Google Identities.
thirdPartyManagementUri

string

Output only. Third party Management URI for External Identity Providers.

InstanceState

State of Management server instance.

Enums
INSTANCE_STATE_UNSPECIFIED State not set.
CREATING The instance is being created.
READY The instance has been created and is fully usable.
UPDATING The instance configuration is being updated. Certain kinds of updates may cause the instance to become unusable while the update is in progress.
DELETING The instance is being deleted.
REPAIRING The instance is being repaired and may be unstable.
MAINTENANCE Maintenance is being performed on this instance.
ERROR The instance is experiencing an issue and might be unusable. You can get further details from the statusMessage field of Instance resource.

NetworkConfig

Network configuration for ManagementServer instance.

JSON representation 
{
  "network": string,
  "peeringMode": enum (PeeringMode)
}
Fields
network

string

Optional. The resource name of the Google Compute Engine VPC network to which the ManagementServer instance is connected.
peeringMode

enum (PeeringMode)

Optional. The network connect mode of the ManagementServer instance. For this version, only PRIVATE_SERVICE_ACCESS is supported.

PeeringMode

VPC peering modes supported by Cloud BackupDR.

Enums
PEERING_MODE_UNSPECIFIED Peering mode not set.
PRIVATE_SERVICE_ACCESS Connect using Private Service Access to the Management Server. Private services access provides an IP address range for multiple Google Cloud services, including Cloud BackupDR.

WorkforceIdentityBasedOAuth2ClientID

OAuth Client ID depending on the Workforce Identity i.e. either 1p or 3p,

JSON representation 
{
  "firstPartyOauth2ClientId": string,
  "thirdPartyOauth2ClientId": string
}
Fields
firstPartyOauth2ClientId

string

Output only. First party OAuth Client ID for Google Identities.
thirdPartyOauth2ClientId

string

Output only. Third party OAuth Client ID for External Identity Providers.

Methods

create

 Creates a new ManagementServer in a given project and location.

delete

 Deletes a single ManagementServer.

get

 Gets details of a single ManagementServer.

getIamPolicy

 Gets the access control policy for a resource.

list

 Lists ManagementServers in a given project and location.

setIamPolicy

 Sets the access control policy on the specified resource.

testIamPermissions

 Returns permissions that a caller has on the specified resource.