management_servers

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

Overview

Name	management_servers
Type	Resource
Id	google.backupdr.management_servers

Fields

Name	Datatype	Description
name	string	Output only. Identifier. The resource name.
description	string	Optional. The description of the ManagementServer instance (2048 characters or less).
baProxyUri	array	Output only. The hostname or ip address of the exposed AGM endpoints, used by BAs to connect to BA proxy.
createTime	string	Output only. The time when the instance was created.
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	ManagementURI for the Management Server resource.
networks	array	Required. VPC networks to which the ManagementServer instance is connected. For this version, only a single network is supported.
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	Output only. The time when the instance was updated.
workforceIdentityBasedManagementUri	object	ManagementURI depending on the Workforce Identity i.e. either 1p or 3p.
workforceIdentityBasedOauth2ClientId	object	OAuth Client ID depending on the Workforce Identity i.e. either 1p or 3p,

Methods

Name	Accessible by	Required Params	Description
get	SELECT	locationsId, managementServersId, projectsId	Gets details of a single ManagementServer.
list	SELECT	locationsId, projectsId	Lists ManagementServers in a given project and location.
create	INSERT	locationsId, projectsId	Creates a new ManagementServer in a given project and location.
delete	DELETE	locationsId, managementServersId, projectsId	Deletes a single ManagementServer.

SELECT examples

Lists ManagementServers in a given project and location.

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

INSERT example

Use the following StackQL query and manifest file to create a new management_servers resource.

All Properties

/*+ create */
INSERT INTO google.backupdr.management_servers (
locationsId,
projectsId,
description,
labels,
type,
networks,
etag
)
SELECT 
'{{ locationsId }}',
'{{ projectsId }}',
'{{ description }}',
'{{ labels }}',
'{{ type }}',
'{{ networks }}',
'{{ etag }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: description
      value: string
    - name: labels
      value: object
    - name: createTime
      value: string
    - name: updateTime
      value: string
    - name: type
      value: string
    - name: managementUri
      value:
        - name: webUi
          value: string
        - name: api
          value: string
    - name: workforceIdentityBasedManagementUri
      value:
        - name: firstPartyManagementUri
          value: string
        - name: thirdPartyManagementUri
          value: string
    - name: state
      value: string
    - name: networks
      value:
        - - name: network
            value: string
          - name: peeringMode
            value: string
    - name: etag
      value: string
    - name: oauth2ClientId
      value: string
    - name: workforceIdentityBasedOauth2ClientId
      value:
        - name: firstPartyOauth2ClientId
          value: string
        - name: thirdPartyOauth2ClientId
          value: string
    - name: baProxyUri
      value:
        - string
    - name: satisfiesPzs
      value: boolean
    - name: satisfiesPzi
      value: boolean

DELETE example

Deletes the specified management_servers resource.

/*+ delete */
DELETE FROM google.backupdr.management_servers
WHERE locationsId = '{{ locationsId }}'
AND managementServersId = '{{ managementServersId }}'
AND projectsId = '{{ projectsId }}';