2022-10-21
▼ ▲ beyondcorp.organizations.locations.subscriptions.list
Flat Path: v1alpha/organizations/{organizationsId}/locations/{locationsId}/subscriptions
Parameters:
parent
Required: Yes
Description: Required. The resource name of Subscription using the form: `organizations/{organization_id}/locations/{location}`
Type: string
Location: path
Pattern: ^organizations/[^/]+/locations/[^/]+$
pageSize
Location: query
Format: int32
Type: integer
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
Type: string
Description: Optional. The next_page_token value returned from a previous ListSubscriptionsRequest, if any.
Location: query
HTTP Method: GET
Path: v1alpha/{+parent}/subscriptions
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
Description: Lists Subscriptions in a given organization and location.
▼ ▲ beyondcorp.organizations.locations.subscriptions.get
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Type: string
Pattern: ^organizations/[^/]+/locations/[^/]+/subscriptions/[^/]+$
Description: Required. The resource name of Subscription using the form: `organizations/{organization_id}/locations/{location}/subscriptions/{subscription_id}`
Location: path
Required: Yes
Description: Gets details of a single Subscription.
Flat Path: v1alpha/organizations/{organizationsId}/locations/{locationsId}/subscriptions/{subscriptionsId}
Parameter Order: name
HTTP Method: GET
Path: v1alpha/{+name}
▼ ▲ beyondcorp.organizations.locations.subscriptions.create
Flat Path: v1alpha/organizations/{organizationsId}/locations/{locationsId}/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
Parameter Order: parent
Path: v1alpha/{+parent}/subscriptions
HTTP Method: POST
Parameters:
parent
Pattern: ^organizations/[^/]+/locations/[^/]+$
Required: Yes
Type: string
Location: path
Description: Required. The resource name of the subscription location using the form: `organizations/{organization_id}/locations/{location}`
▼ ▲ beyondcorp.projects.locations.netConnections.list
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Description: Lists NetConnections in a given project and location.
Path: v1alpha/{+parent}/netConnections
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/netConnections
Parameter Order: parent
Parameters:
orderBy
Location: query
Type: string
Description: Optional. Specifies the ordering of results. See [Sorting order](https://cloud.google.com/apis/design/design_patterns#sorting_order) for more information.
filter
Description: Optional. A filter specifying constraints of a list operation.
Location: query
Type: string
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
Type: integer
Location: query
pageToken
Location: query
Type: string
Description: Optional. The next_page_token value returned from a previous ListNetConnectionsRequest, if any.
parent
Description: Required. The resource name of the NetConnection location using the form: `projects/{project_id}/locations/{location_id}`
Location: path
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
▼ ▲ beyondcorp.projects.locations.netConnections.get
Path: v1alpha/{+name}
Parameters:
name
Description: Required. BeyondCorp NetConnection name using the form: `projects/{project_id}/locations/{location_id}/netConnections/{net_connection_id}`
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/netConnections/[^/]+$
Required: Yes
HTTP Method: GET
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/netConnections/{netConnectionsId}
Parameter Order: name
Description: Gets details of a single NetConnection.
▼ ▲ beyondcorp.projects.locations.netConnections.create
Path: v1alpha/{+parent}/netConnections
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Creates a new NetConnection in a given project and location.
HTTP Method: POST
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/netConnections
Parameters:
parent
Location: path
Description: Required. The resource project name of the NetConnection location using the form: `projects/{project_id}/locations/{location_id}`
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
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
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).
netConnectionId
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.
Location: query
Type: string
Parameter Order: parent
▼ ▲ beyondcorp.projects.locations.netConnections.delete
Parameter Order: name
Path: v1alpha/{+name}
Description: Deletes a single NetConnection.
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/netConnections/{netConnectionsId}
HTTP Method: DELETE
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/netConnections/[^/]+$
Location: path
Type: string
Required: Yes
Description: Required. BeyondCorp Connector name using the form: `projects/{project_id}/locations/{location_id}/netConnections/{net_connection_id}`
validateOnly
Type: boolean
Description: Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.
Location: query
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 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).
▼ ▲ beyondcorp.projects.locations.netConnections.patch
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+name}
Parameter Order: name
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/netConnections/{netConnectionsId}
Parameters:
name
Required: Yes
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/netConnections/[^/]+$
Description: Required. Unique resource name of the NetConnection. The name is ignored when creating a NetConnection.
updateMask
Location: query
Format: google-fieldmask
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`
Type: string
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 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).
allowMissing
Type: boolean
Description: Optional. If set as true, will create the resource if it is not found.
Location: query
validateOnly
Description: Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.
Location: query
Type: boolean
Description: Updates the parameters of a single NetConnection.
HTTP Method: PATCH