management_servers

Creates, updates, deletes, gets or lists a management_servers resource.

Overview

Name	`management_servers`
Type	Resource
Id	`google.backupdr.management_servers`

Fields

The following fields are returned by SELECT queries:

get
list

Successful response

Name	Datatype	Description
`name`	`string`	Output only. Identifier. The resource name.
`baProxyUri`	`array`	Output only. The hostname or ip address of the exposed AGM endpoints, used by BAs to connect to BA proxy.
`createTime`	`string (google-datetime)`	Output only. The time when the instance was created.
`description`	`string`	Optional. The description of the ManagementServer instance (2048 characters or less).
`etag`	`string`	Optional. Server specified ETag for the ManagementServer resource to prevent simultaneous updates from overwiting each other.
`labels`	`object`	Optional. Resource labels to represent user provided metadata. Labels currently defined: 1. migrate_from_go= If set to true, the MS is created in migration ready mode.
`managementUri`	`object`	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. (id: ManagementURI)
`networks`	`array`	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
`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).
`satisfiesPzi`	`boolean`	Output only. Reserved for future use.
`satisfiesPzs`	`boolean`	Output only. Reserved for future use.
`state`	`string`	Output only. The ManagementServer state.
`type`	`string`	Optional. The type of the ManagementServer resource.
`updateTime`	`string (google-datetime)`	Output only. The time when the instance was updated.
`workforceIdentityBasedManagementUri`	`object`	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. (id: WorkforceIdentityBasedManagementURI)
`workforceIdentityBasedOauth2ClientId`	`object`	Output only. The OAuth client IDs for both types of user i.e. 1p and 3p. (id: WorkforceIdentityBasedOAuth2ClientID)

Successful response

Name	Datatype	Description
`name`	`string`	Output only. Identifier. The resource name.
`baProxyUri`	`array`	Output only. The hostname or ip address of the exposed AGM endpoints, used by BAs to connect to BA proxy.
`createTime`	`string (google-datetime)`	Output only. The time when the instance was created.
`description`	`string`	Optional. The description of the ManagementServer instance (2048 characters or less).
`etag`	`string`	Optional. Server specified ETag for the ManagementServer resource to prevent simultaneous updates from overwiting each other.
`labels`	`object`	Optional. Resource labels to represent user provided metadata. Labels currently defined: 1. migrate_from_go= If set to true, the MS is created in migration ready mode.
`managementUri`	`object`	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. (id: ManagementURI)
`networks`	`array`	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
`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).
`satisfiesPzi`	`boolean`	Output only. Reserved for future use.
`satisfiesPzs`	`boolean`	Output only. Reserved for future use.
`state`	`string`	Output only. The ManagementServer state.
`type`	`string`	Optional. The type of the ManagementServer resource.
`updateTime`	`string (google-datetime)`	Output only. The time when the instance was updated.
`workforceIdentityBasedManagementUri`	`object`	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. (id: WorkforceIdentityBasedManagementURI)
`workforceIdentityBasedOauth2ClientId`	`object`	Output only. The OAuth client IDs for both types of user i.e. 1p and 3p. (id: WorkforceIdentityBasedOAuth2ClientID)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get`	`select`	`projectsId`, `locationsId`, `managementServersId`		Gets details of a single ManagementServer.
`list`	`select`	`projectsId`, `locationsId`	`pageSize`, `pageToken`, `filter`, `orderBy`	Lists ManagementServers in a given project and location.
`create`	`insert`	`projectsId`, `locationsId`	`managementServerId`, `requestId`	Creates a new ManagementServer in a given project and location.
`delete`	`delete`	`projectsId`, `locationsId`, `managementServersId`	`requestId`	Deletes a single ManagementServer.
`ms_compliance_metadata`	`exec`	`projectsId`, `locationsId`		Returns the Assured Workloads compliance metadata for a given project.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`locationsId`	`string`
`managementServersId`	`string`
`projectsId`	`string`
`filter`	`string`
`managementServerId`	`string`
`orderBy`	`string`
`pageSize`	`integer (int32)`
`pageToken`	`string`
`requestId`	`string`

`SELECT` examples

get
list

Gets details of a single ManagementServer.

SELECT
name,
baProxyUri,
createTime,
description,
etag,
labels,
managementUri,
networks,
oauth2ClientId,
satisfiesPzi,
satisfiesPzs,
state,
type,
updateTime,
workforceIdentityBasedManagementUri,
workforceIdentityBasedOauth2ClientId
FROM google.backupdr.management_servers
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND managementServersId = '{{ managementServersId }}' -- required;

Lists ManagementServers in a given project and location.

SELECT
name,
baProxyUri,
createTime,
description,
etag,
labels,
managementUri,
networks,
oauth2ClientId,
satisfiesPzi,
satisfiesPzs,
state,
type,
updateTime,
workforceIdentityBasedManagementUri,
workforceIdentityBasedOauth2ClientId
FROM google.backupdr.management_servers
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';

`INSERT` examples

create
Manifest

Creates a new ManagementServer in a given project and location.

INSERT INTO google.backupdr.management_servers (
data__description,
data__labels,
data__type,
data__networks,
data__etag,
projectsId,
locationsId,
managementServerId,
requestId
)
SELECT 
'{{ description }}',
'{{ labels }}',
'{{ type }}',
'{{ networks }}',
'{{ etag }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ managementServerId }}',
'{{ requestId }}'
RETURNING
name,
done,
error,
metadata,
response
;

# Description fields are for documentation purposes
- name: management_servers
  props:
    - name: projectsId
      value: string
      description: Required parameter for the management_servers resource.
    - name: locationsId
      value: string
      description: Required parameter for the management_servers resource.
    - name: description
      value: string
      description: >
        Optional. The description of the ManagementServer instance (2048 characters or less).
        
    - name: labels
      value: object
      description: >
        Optional. Resource labels to represent user provided metadata. Labels currently defined: 1. migrate_from_go= If set to true, the MS is created in migration ready mode.
        
    - name: type
      value: string
      description: >
        Optional. The type of the ManagementServer resource.
        
      valid_values: ['INSTANCE_TYPE_UNSPECIFIED', 'BACKUP_RESTORE']
    - name: networks
      value: array
      description: >
        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
        
    - name: etag
      value: string
      description: >
        Optional. Server specified ETag for the ManagementServer resource to prevent simultaneous updates from overwiting each other.
        
    - name: managementServerId
      value: string
    - name: requestId
      value: string

`DELETE` examples

delete

Deletes a single ManagementServer.

DELETE FROM google.backupdr.management_servers
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND managementServersId = '{{ managementServersId }}' --required
AND requestId = '{{ requestId }}';

Lifecycle Methods

ms_compliance_metadata

Returns the Assured Workloads compliance metadata for a given project.

EXEC google.backupdr.management_servers.ms_compliance_metadata 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required 
@@json=
'{
"projectId": "{{ projectId }}"
}';

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

DELETE examples​

Lifecycle Methods​