app_connections

Creates, updates, deletes, gets or lists an app_connections resource.

Overview

Name	app_connections
Type	Resource
Id	google.beyondcorp.app_connections

Fields

The following fields are returned by SELECT queries:

projects_locations_app_connections_get

Successful response

Name	Datatype	Description
name	string	Required. Unique resource name of the AppConnection. The name is ignored when creating a AppConnection.
applicationEndpoint	object	Required. Address of the remote application endpoint for the BeyondCorp AppConnection. (id: GoogleCloudBeyondcorpAppconnectionsV1AppConnectionApplicationEndpoint)
connectors	array	Optional. List of [google.cloud.beyondcorp.v1main.Connector.name] that are authorised to be associated with this AppConnection.
createTime	string (google-datetime)	Output only. Timestamp when the resource was created.
displayName	string	Optional. An arbitrary user-provided name for the AppConnection. Cannot exceed 64 characters.
gateway	object	Optional. Gateway used by the AppConnection. (id: GoogleCloudBeyondcorpAppconnectionsV1AppConnectionGateway)
labels	object	Optional. Resource labels to represent user provided metadata.
satisfiesPzi	boolean	Output only. Reserved for future use.
satisfiesPzs	boolean	Output only. Reserved for future use.
state	string	Output only. The current state of the AppConnection.
type	string	Required. The type of network connectivity used by the AppConnection.
uid	string	Output only. A unique identifier for the instance generated by the system.
updateTime	string (google-datetime)	Output only. Timestamp when the resource was last modified.

projects_locations_app_connections_list

Successful response

Name	Datatype	Description
name	string	Required. Unique resource name of the AppConnection. The name is ignored when creating a AppConnection.
applicationEndpoint	object	Required. Address of the remote application endpoint for the BeyondCorp AppConnection. (id: GoogleCloudBeyondcorpAppconnectionsV1AppConnectionApplicationEndpoint)
connectors	array	Optional. List of [google.cloud.beyondcorp.v1main.Connector.name] that are authorised to be associated with this AppConnection.
createTime	string (google-datetime)	Output only. Timestamp when the resource was created.
displayName	string	Optional. An arbitrary user-provided name for the AppConnection. Cannot exceed 64 characters.
gateway	object	Optional. Gateway used by the AppConnection. (id: GoogleCloudBeyondcorpAppconnectionsV1AppConnectionGateway)
labels	object	Optional. Resource labels to represent user provided metadata.
satisfiesPzi	boolean	Output only. Reserved for future use.
satisfiesPzs	boolean	Output only. Reserved for future use.
state	string	Output only. The current state of the AppConnection.
type	string	Required. The type of network connectivity used by the AppConnection.
uid	string	Output only. A unique identifier for the instance generated by the system.
updateTime	string (google-datetime)	Output only. Timestamp when the resource was last modified.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_app_connections_get	select	projectsId, locationsId, appConnectionsId		Gets details of a single AppConnection.
projects_locations_app_connections_list	select	projectsId, locationsId	pageSize, pageToken, filter, orderBy	Lists AppConnections in a given project and location.
projects_locations_app_connections_create	insert	projectsId, locationsId	appConnectionId, requestId, validateOnly	Creates a new AppConnection in a given project and location.
projects_locations_app_connections_patch	update	projectsId, locationsId, appConnectionsId	updateMask, requestId, validateOnly, allowMissing	Updates the parameters of a single AppConnection.
projects_locations_app_connections_delete	delete	projectsId, locationsId, appConnectionsId	requestId, validateOnly	Deletes a single AppConnection.
projects_locations_app_connections_resolve	exec	projectsId, locationsId	appConnectorId, pageSize, pageToken	Resolves AppConnections details for a given AppConnector. An internal method called by a connector to find AppConnections to connect to.

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
appConnectionsId	string
locationsId	string
projectsId	string
allowMissing	boolean
appConnectionId	string
appConnectorId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
requestId	string
updateMask	string (google-fieldmask)
validateOnly	boolean

SELECT examples

projects_locations_app_connections_get

Gets details of a single AppConnection.

SELECT
name,
applicationEndpoint,
connectors,
createTime,
displayName,
gateway,
labels,
satisfiesPzi,
satisfiesPzs,
state,
type,
uid,
updateTime
FROM google.beyondcorp.app_connections
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND appConnectionsId = '{{ appConnectionsId }}' -- required;

projects_locations_app_connections_list

Lists AppConnections in a given project and location.

SELECT
name,
applicationEndpoint,
connectors,
createTime,
displayName,
gateway,
labels,
satisfiesPzi,
satisfiesPzs,
state,
type,
uid,
updateTime
FROM google.beyondcorp.app_connections
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';

INSERT examples

projects_locations_app_connections_create

Creates a new AppConnection in a given project and location.

INSERT INTO google.beyondcorp.app_connections (
data__name,
data__labels,
data__displayName,
data__type,
data__applicationEndpoint,
data__connectors,
data__gateway,
projectsId,
locationsId,
appConnectionId,
requestId,
validateOnly
)
SELECT 
'{{ name }}',
'{{ labels }}',
'{{ displayName }}',
'{{ type }}',
'{{ applicationEndpoint }}',
'{{ connectors }}',
'{{ gateway }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ appConnectionId }}',
'{{ requestId }}',
'{{ validateOnly }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: app_connections
  props:
    - name: projectsId
      value: string
      description: Required parameter for the app_connections resource.
    - name: locationsId
      value: string
      description: Required parameter for the app_connections resource.
    - name: name
      value: string
      description: >
        Required. Unique resource name of the AppConnection. The name is ignored when creating a AppConnection.
        
    - name: labels
      value: object
      description: >
        Optional. Resource labels to represent user provided metadata.
        
    - name: displayName
      value: string
      description: >
        Optional. An arbitrary user-provided name for the AppConnection. Cannot exceed 64 characters.
        
    - name: type
      value: string
      description: >
        Required. The type of network connectivity used by the AppConnection.
        
      valid_values: ['TYPE_UNSPECIFIED', 'TCP_PROXY']
    - name: applicationEndpoint
      value: object
      description: >
        Required. Address of the remote application endpoint for the BeyondCorp AppConnection.
        
    - name: connectors
      value: array
      description: >
        Optional. List of [google.cloud.beyondcorp.v1main.Connector.name] that are authorised to be associated with this AppConnection.
        
    - name: gateway
      value: object
      description: >
        Optional. Gateway used by the AppConnection.
        
    - name: appConnectionId
      value: string
    - name: requestId
      value: string
    - name: validateOnly
      value: boolean

UPDATE examples

projects_locations_app_connections_patch

Updates the parameters of a single AppConnection.

UPDATE google.beyondcorp.app_connections
SET 
data__name = '{{ name }}',
data__labels = '{{ labels }}',
data__displayName = '{{ displayName }}',
data__type = '{{ type }}',
data__applicationEndpoint = '{{ applicationEndpoint }}',
data__connectors = '{{ connectors }}',
data__gateway = '{{ gateway }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND appConnectionsId = '{{ appConnectionsId }}' --required
AND updateMask = '{{ updateMask}}'
AND requestId = '{{ requestId}}'
AND validateOnly = {{ validateOnly}}
AND allowMissing = {{ allowMissing}}
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

projects_locations_app_connections_delete

Deletes a single AppConnection.

DELETE FROM google.beyondcorp.app_connections
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND appConnectionsId = '{{ appConnectionsId }}' --required
AND requestId = '{{ requestId }}'
AND validateOnly = '{{ validateOnly }}';

Lifecycle Methods

projects_locations_app_connections_resolve

Resolves AppConnections details for a given AppConnector. An internal method called by a connector to find AppConnections to connect to.

EXEC google.beyondcorp.app_connections.projects_locations_app_connections_resolve 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@appConnectorId='{{ appConnectorId }}', 
@pageSize='{{ pageSize }}', 
@pageToken='{{ pageToken }}';