2022-10-23
▼ ▲ beyondcorp.projects.locations.netConnections.get
Parameters:
name
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/netConnections/[^/]+$
Location: path
Description: Required. BeyondCorp NetConnection name using the form: `projects/{project_id}/locations/{location_id}/netConnections/{net_connection_id}`
Path: v1alpha/{+name}
Parameter Order: name
HTTP Method: GET
Description: Gets details of a single NetConnection.
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/netConnections/{netConnectionsId}
▼ ▲ beyondcorp.projects.locations.netConnections.patch
Parameters:
validateOnly
Description: Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.
Type: boolean
Location: query
allowMissing
Description: Optional. If set as true, will create the resource if it is not found.
Type: boolean
Location: query
name
Location: path
Description: Required. Unique resource name of the NetConnection. The name is ignored when creating a NetConnection.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/netConnections/[^/]+$
Required: Yes
requestId
Location: query
Type: string
Description: Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
updateMask
Format: google-fieldmask
Type: string
Location: query
Description: Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from [BeyondCorp.NetConnection]: * `labels` * `display_name`
Parameter Order: name
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/netConnections/{netConnectionsId}
Path: v1alpha/{+name}
HTTP Method: PATCH
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates the parameters of a single NetConnection.
▼ ▲ beyondcorp.projects.locations.netConnections.create
Path: v1alpha/{+parent}/netConnections
HTTP Method: POST
Parameter Order: parent
Parameters:
netConnectionId
Type: string
Location: query
Description: Optional. User-settable NetConnection resource ID. * Must start with a letter. * Must contain between 4-63 characters from `/a-z-/`. * Must end with a number or a letter.
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Location: path
Description: Required. The resource project name of the NetConnection location using the form: `projects/{project_id}/locations/{location_id}`
Type: string
validateOnly
Location: query
Type: boolean
Description: Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.
requestId
Location: query
Description: Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Type: string
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/netConnections
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates a new NetConnection in a given project and location.
▼ ▲ beyondcorp.projects.locations.netConnections.list
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/netConnections
Path: v1alpha/{+parent}/netConnections
Parameter Order: parent
HTTP Method: GET
Description: Lists NetConnections in a given project and location.
Parameters:
pageSize
Description: Optional. The maximum number of items to return. If not specified, a default value of 50 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more instances left to be queried.
Format: int32
Location: query
Type: integer
filter
Description: Optional. A filter specifying constraints of a list operation.
Type: string
Location: query
parent
Required: Yes
Type: string
Location: path
Description: Required. The resource name of the NetConnection location using the form: `projects/{project_id}/locations/{location_id}`
Pattern: ^projects/[^/]+/locations/[^/]+$
pageToken
Type: string
Location: query
Description: Optional. The next_page_token value returned from a previous ListNetConnectionsRequest, if any.
orderBy
Location: query
Description: Optional. Specifies the ordering of results. See [Sorting order](https://cloud.google.com/apis/design/design_patterns#sorting_order) for more information.
Type: string
▼ ▲ beyondcorp.projects.locations.netConnections.delete
Description: Deletes a single NetConnection.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Path: v1alpha/{+name}
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/netConnections/{netConnectionsId}
Parameters:
validateOnly
Description: Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.
Type: boolean
Location: query
requestId
Type: string
Location: query
Description: Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
name
Location: path
Description: Required. BeyondCorp Connector name using the form: `projects/{project_id}/locations/{location_id}/netConnections/{net_connection_id}`
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/netConnections/[^/]+$
Required: Yes
HTTP Method: DELETE
▼ ▲ beyondcorp.organizations.locations.subscriptions.create
Parameters:
parent
Required: Yes
Pattern: ^organizations/[^/]+/locations/[^/]+$
Description: Required. The resource name of the subscription location using the form: `organizations/{organization_id}/locations/{location}`
Type: string
Location: path
Path: v1alpha/{+parent}/subscriptions
Description: Creates a new BeyondCorp Enterprise Subscription in a given organization. Location will always be global as BeyondCorp subscriptions are per organization.
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Flat Path: v1alpha/organizations/{organizationsId}/locations/{locationsId}/subscriptions
Parameter Order: parent
▼ ▲ beyondcorp.organizations.locations.subscriptions.list
Path: v1alpha/{+parent}/subscriptions
Parameters:
pageSize
Type: integer
Format: int32
Location: query
Description: Optional. The maximum number of items to return. If not specified, a default value of 50 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more instances left to be queried.
pageToken
Location: query
Type: string
Description: Optional. The next_page_token value returned from a previous ListSubscriptionsRequest, if any.
parent
Type: string
Required: Yes
Location: path
Description: Required. The resource name of Subscription using the form: `organizations/{organization_id}/locations/{location}`
Pattern: ^organizations/[^/]+/locations/[^/]+$
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists Subscriptions in a given organization and location.
Flat Path: v1alpha/organizations/{organizationsId}/locations/{locationsId}/subscriptions
HTTP Method: GET
Parameter Order: parent
▼ ▲ beyondcorp.organizations.locations.subscriptions.get
Flat Path: v1alpha/organizations/{organizationsId}/locations/{locationsId}/subscriptions/{subscriptionsId}
Parameter Order: name
Path: v1alpha/{+name}
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Required: Yes
Description: Required. The resource name of Subscription using the form: `organizations/{organization_id}/locations/{location}/subscriptions/{subscription_id}`
Location: path
Pattern: ^organizations/[^/]+/locations/[^/]+/subscriptions/[^/]+$
Type: string
Description: Gets details of a single Subscription.