Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
98 changes: 49 additions & 49 deletions mmv1/products/beyondcorp/AppConnection.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,133 +12,133 @@
# limitations under the License.

---
name: 'AppConnection'
description:
"A BeyondCorp AppConnection resource represents a BeyondCorp protected
AppConnection to a remote application.\nIt creates all the necessary GCP
components needed for creating a BeyondCorp protected AppConnection.
\nMultiple connectors can be authorised for a single AppConnection.\n"
name: AppConnection
description: "A BeyondCorp AppConnection resource represents a BeyondCorp protected AppConnection to a remote application.\nIt creates all the necessary GCP components needed for creating a BeyondCorp protected AppConnection. \nMultiple connectors can be authorised for a single AppConnection.\n"
references:
guides:
'Official Documentation': 'https://cloud.google.com/beyondcorp-enterprise/docs/enable-app-connector'
api: 'https://cloud.google.com/beyondcorp/docs/reference/rest#rest-resource:-v1.projects.locations.appconnections'
Official Documentation: https://cloud.google.com/beyondcorp-enterprise/docs/enable-app-connector
api: https://cloud.google.com/beyondcorp/docs/reference/rest#rest-resource:-v1.projects.locations.appconnections
docs:
base_url: 'projects/{{project}}/locations/{{region}}/appConnections'
self_link: 'projects/{{project}}/locations/{{region}}/appConnections/{{name}}'
create_url: 'projects/{{project}}/locations/{{region}}/appConnections?app_connection_id={{name}}'
update_verb: 'PATCH'
base_url: projects/{{project}}/locations/{{region}}/appConnections
self_link: projects/{{project}}/locations/{{region}}/appConnections/{{name}}
create_url: projects/{{project}}/locations/{{region}}/appConnections?app_connection_id={{name}}
update_mask: true
update_verb: PATCH
timeouts:
insert_minutes: 30
update_minutes: 30
delete_minutes: 30
autogen_async: true
async:
actions: ['create', 'delete', 'update']
type: 'OpAsync'
type: OpAsync
operation:
base_url: '{{op_id}}'
timeouts:
insert_minutes: 30
update_minutes: 30
delete_minutes: 30
base_url: '{{op_id}}'
actions: [create, delete, update]
result:
resource_inside_response: true
custom_code:
autogen_async: true
include_in_tgc_next: true
examples:
- name: 'beyondcorp_app_connection_basic'
primary_resource_id: 'app_connection'
vars:
account_id: 'my-account'
app_connector_name: 'my-app-connector'
app_connection_name: 'my-app-connection'
- name: 'beyondcorp_app_connection_full'
primary_resource_id: 'app_connection'
vars:
account_id: 'my-account'
app_gateway_name: 'my-app-gateway'
app_connector_name: 'my-app-connector'
app_connection_name: 'my-app-connection'
display_name: 'some display name'
test_vars_overrides:
# for backward compatible
display_name: '"some display name" + randomSuffix'
custom_code:
samples:
- name: beyondcorp_app_connection_basic
primary_resource_id: app_connection
steps:
- name: beyondcorp_app_connection_basic
resource_id_vars:
account_id: my-account
app_connector_name: my-app-connector
app_connection_name: my-app-connection
- name: beyondcorp_app_connection_full
primary_resource_id: app_connection
steps:
- name: beyondcorp_app_connection_full
resource_id_vars:
account_id: my-account
app_gateway_name: my-app-gateway
app_connector_name: my-app-connector
app_connection_name: my-app-connection
display_name: some display name
test_vars_overrides:
# for backward compatible
display_name: '"some display name" + randomSuffix'
parameters:
properties:
- name: 'name'
- name: name
type: String
description: |
ID of the AppConnection.
url_param_only: true
required: true
immutable: true
- name: 'region'
- name: region
type: String
description: |
The region of the AppConnection.
url_param_only: true
immutable: true
- name: 'displayName'
- name: displayName
type: String
description: |
An arbitrary user-provided name for the AppConnection.
- name: 'labels'
- name: labels
type: KeyValueLabels
description: |
Resource labels to represent user provided metadata.
- name: 'type'
- name: type
type: String
description: |
The type of network connectivity used by the AppConnection. Refer
to https://cloud.google.com/beyondcorp/docs/reference/rest/v1/projects.locations.appConnections#type
for a list of possible values.
immutable: true
- name: 'applicationEndpoint'
- name: applicationEndpoint
type: NestedObject
description: |
Address of the remote application endpoint for the BeyondCorp AppConnection.
required: true
properties:
- name: 'host'
- name: host
type: String
description: |
Hostname or IP address of the remote application endpoint.
required: true
- name: 'port'
- name: port
type: Integer
description: |
Port of the remote application endpoint.
required: true
- name: 'connectors'
- name: connectors
type: Array
description: |
List of AppConnectors that are authorised to be associated with this AppConnection
item_type:
type: String
- name: 'gateway'
- name: gateway
type: NestedObject
description: |
Gateway used by the AppConnection.
default_from_api: true
properties:
- name: 'appGateway'
- name: appGateway
type: String
description: |
AppGateway name in following format: projects/{project_id}/locations/{locationId}/appgateways/{gateway_id}.
required: true
- name: 'type'
- name: type
type: String
description: |
The type of hosting used by the gateway. Refer to
https://cloud.google.com/beyondcorp/docs/reference/rest/v1/projects.locations.appConnections#Type_1
for a list of possible values.
- name: 'uri'
- name: uri
type: String
description: |
Server-defined URI for this resource.
output: true
- name: 'ingressPort'
- name: ingressPort
type: Integer
description: |
Ingress port reserved on the gateways for this AppConnection, if not specified or zero, the default port is 19443.
Expand Down
106 changes: 53 additions & 53 deletions mmv1/products/beyondcorp/AppGateway.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,122 +12,122 @@
# limitations under the License.

---
name: 'AppGateway'
description: "A BeyondCorp AppGateway resource represents a BeyondCorp protected
AppGateway to a remote application. It creates \nall the necessary GCP
components needed for creating a BeyondCorp protected AppGateway. Multiple
connectors can be \n\
authorised for a single AppGateway.\n"
name: AppGateway
description: "A BeyondCorp AppGateway resource represents a BeyondCorp protected AppGateway to a remote application. It creates \nall the necessary GCP components needed for creating a BeyondCorp protected AppGateway. Multiple connectors can be \nauthorised for a single AppGateway.\n"
references:
guides:
'Official Documentation': 'https://cloud.google.com/beyondcorp-enterprise/docs/enable-app-connector'
api: 'https://cloud.google.com/beyondcorp/docs/reference/rest#rest-resource:-v1.projects.locations.appgateways'
Official Documentation: https://cloud.google.com/beyondcorp-enterprise/docs/enable-app-connector
api: https://cloud.google.com/beyondcorp/docs/reference/rest#rest-resource:-v1.projects.locations.appgateways
docs:
base_url: 'projects/{{project}}/locations/{{region}}/appGateways'
self_link: 'projects/{{project}}/locations/{{region}}/appGateways/{{name}}'
create_url: 'projects/{{project}}/locations/{{region}}/appGateways?app_gateway_id={{name}}'
base_url: projects/{{project}}/locations/{{region}}/appGateways
# This resources is not updatable
immutable: true
self_link: projects/{{project}}/locations/{{region}}/appGateways/{{name}}
create_url: projects/{{project}}/locations/{{region}}/appGateways?app_gateway_id={{name}}
timeouts:
insert_minutes: 40
update_minutes: 40
delete_minutes: 40
autogen_async: true
async:
actions: ['create', 'delete', 'update']
type: 'OpAsync'
type: OpAsync
operation:
base_url: '{{op_id}}'
timeouts:
insert_minutes: 40
update_minutes: 40
delete_minutes: 40
base_url: '{{op_id}}'
actions: [create, delete, update]
result:
resource_inside_response: true
custom_code:
include_in_tgc_next: true
schema_version: 1
state_upgraders: true
examples:
- name: 'beyondcorp_app_gateway_basic'
primary_resource_id: 'app_gateway'
vars:
app_gateway_name: 'my-app-gateway'
- name: 'beyondcorp_app_gateway_full'
primary_resource_id: 'app_gateway'
vars:
app_gateway_name: 'my-app-gateway'
display_name: 'some display name'
test_vars_overrides:
# for backward compatible
display_name: '"some display name" + randomSuffix'
autogen_async: true
include_in_tgc_next: true
custom_code:
samples:
- name: beyondcorp_app_gateway_basic
primary_resource_id: app_gateway
steps:
- name: beyondcorp_app_gateway_basic
resource_id_vars:
app_gateway_name: my-app-gateway
- name: beyondcorp_app_gateway_full
primary_resource_id: app_gateway
steps:
- name: beyondcorp_app_gateway_full
resource_id_vars:
app_gateway_name: my-app-gateway
display_name: some display name
test_vars_overrides:
# for backward compatible
display_name: '"some display name" + randomSuffix'
parameters:
properties:
- name: 'name'
- name: name
type: String
description: |
ID of the AppGateway.
url_param_only: true
required: true
immutable: true
- name: 'region'
- name: region
type: String
description: |
The region of the AppGateway.
url_param_only: true
immutable: true
- name: 'type'
- name: type
type: Enum
description: |
The type of network connectivity used by the AppGateway.
default_value: "TYPE_UNSPECIFIED"
default_value: TYPE_UNSPECIFIED
enum_values:
- 'TYPE_UNSPECIFIED'
- 'TCP_PROXY'
- name: 'hostType'
- TYPE_UNSPECIFIED
- TCP_PROXY
- name: hostType
type: Enum
description: |
The type of hosting used by the AppGateway.
default_value: "HOST_TYPE_UNSPECIFIED"
default_value: HOST_TYPE_UNSPECIFIED
enum_values:
- 'HOST_TYPE_UNSPECIFIED'
- 'GCP_REGIONAL_MIG'
- name: 'displayName'
- HOST_TYPE_UNSPECIFIED
- GCP_REGIONAL_MIG
- name: displayName
type: String
description: |
An arbitrary user-provided name for the AppGateway.
- name: 'labels'
- name: labels
type: KeyValueLabels
description: |
Resource labels to represent user provided metadata.
- name: 'state'
- name: state
type: Enum
description: |
Represents the different states of a AppGateway.
output: true
enum_values:
- 'STATE_UNSPECIFIED'
- 'CREATING'
- 'CREATED'
- 'UPDATING'
- 'DELETING'
- 'DOWN'
- name: 'uri'
- STATE_UNSPECIFIED
- CREATING
- CREATED
- UPDATING
- DELETING
- DOWN
- name: uri
type: String
description: |
Server-defined URI for this resource.
output: true
- name: 'allocatedConnections'
- name: allocatedConnections
type: NestedObject
description: |
A list of connections allocated for the Gateway.
output: true
properties:
- name: 'pscUri'
- name: pscUri
type: String
description: |
The PSC uri of an allocated connection.
- name: 'ingressPort'
- name: ingressPort
type: Integer
description: |
The ingress port of an allocated connection.
Loading
Loading