network_monitoring_providers

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

Overview

Name	network_monitoring_providers
Type	Resource
Id	google.networkmanagement.network_monitoring_providers

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Output only. Identifier. Name of the resource. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}
createTime	string (google-datetime)	Output only. The time the NetworkMonitoringProvider was created.
errors	array	Output only. The list of error messages detected for the NetworkMonitoringProvider.
providerType	string	Required. Type of the NetworkMonitoringProvider. (PROVIDER_TYPE_UNSPECIFIED, EXTERNAL)
providerUri	string	Output only. Link to the provider's UI.
state	string	Output only. State of the NetworkMonitoringProvider. (STATE_UNSPECIFIED, ACTIVATING, ACTIVE, SUSPENDING, SUSPENDED, DELETING, DELETED)
updateTime	string (google-datetime)	Output only. The time the NetworkMonitoringProvider was updated.

list

Name	Datatype	Description
name	string	Output only. Identifier. Name of the resource. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider}
createTime	string (google-datetime)	Output only. The time the NetworkMonitoringProvider was created.
errors	array	Output only. The list of error messages detected for the NetworkMonitoringProvider.
providerType	string	Required. Type of the NetworkMonitoringProvider. (PROVIDER_TYPE_UNSPECIFIED, EXTERNAL)
providerUri	string	Output only. Link to the provider's UI.
state	string	Output only. State of the NetworkMonitoringProvider. (STATE_UNSPECIFIED, ACTIVATING, ACTIVE, SUSPENDING, SUSPENDED, DELETING, DELETED)
updateTime	string (google-datetime)	Output only. The time the NetworkMonitoringProvider was updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, networkMonitoringProvidersId		Gets the NetworkMonitoringProvider resource.
list	select	projectsId, locationsId	pageSize, pageToken	Lists NetworkMonitoringProviders for a given project and location.
create	insert	projectsId, locationsId	networkMonitoringProviderId	Creates a NetworkMonitoringProvider resource.
delete	delete	projectsId, locationsId, networkMonitoringProvidersId	force	Deletes a NetworkMonitoringProvider resource and all of its child resources.
generate_monitoring_point_config	exec	projectsId, locationsId, networkMonitoringProvidersId	privateConnectivityEnabled	Generates Monitoring Point configuration of a NetworkMonitoringProvider resource.
generate_provider_access_token	exec	projectsId, locationsId, networkMonitoringProvidersId	gcpAccessToken	Generates a provider access token for a given Google access token. Provider access token is a short-lived token that is used to access resources in the provider's platform.

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
locationsId	string
networkMonitoringProvidersId	string
projectsId	string
force	boolean
gcpAccessToken	string
networkMonitoringProviderId	string
pageSize	integer (int32)
pageToken	string
privateConnectivityEnabled	boolean

SELECT examples

get

Gets the NetworkMonitoringProvider resource.

SELECT
name,
createTime,
errors,
providerType,
providerUri,
state,
updateTime
FROM google.networkmanagement.network_monitoring_providers
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND networkMonitoringProvidersId = '{{ networkMonitoringProvidersId }}' -- required
;

list

Lists NetworkMonitoringProviders for a given project and location.

SELECT
name,
createTime,
errors,
providerType,
providerUri,
state,
updateTime
FROM google.networkmanagement.network_monitoring_providers
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;

INSERT examples

create

Creates a NetworkMonitoringProvider resource.

INSERT INTO google.networkmanagement.network_monitoring_providers (
data__providerType,
projectsId,
locationsId,
networkMonitoringProviderId
)
SELECT 
'{{ providerType }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ networkMonitoringProviderId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: network_monitoring_providers
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the network_monitoring_providers resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the network_monitoring_providers resource.
  - name: providerType
    value: "{{ providerType }}"
    description: |
      Required. Type of the NetworkMonitoringProvider.
    valid_values: ['PROVIDER_TYPE_UNSPECIFIED', 'EXTERNAL']
  - name: networkMonitoringProviderId
    value: "{{ networkMonitoringProviderId }}"

DELETE examples

delete

Deletes a NetworkMonitoringProvider resource and all of its child resources.

DELETE FROM google.networkmanagement.network_monitoring_providers
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND networkMonitoringProvidersId = '{{ networkMonitoringProvidersId }}' --required
AND force = '{{ force }}'
;

Lifecycle Methods

generate_monitoring_point_config

Generates Monitoring Point configuration of a NetworkMonitoringProvider resource.

EXEC google.networkmanagement.network_monitoring_providers.generate_monitoring_point_config 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@networkMonitoringProvidersId='{{ networkMonitoringProvidersId }}' --required, 
@privateConnectivityEnabled={{ privateConnectivityEnabled }}
;

generate_provider_access_token

Generates a provider access token for a given Google access token. Provider access token is a short-lived token that is used to access resources in the provider's platform.

EXEC google.networkmanagement.network_monitoring_providers.generate_provider_access_token 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@networkMonitoringProvidersId='{{ networkMonitoringProvidersId }}' --required, 
@gcpAccessToken='{{ gcpAccessToken }}'
;