security_monitoring_conditions

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

Overview

Name	security_monitoring_conditions
Type	Resource
Id	google.apigee.security_monitoring_conditions

Fields

The following fields are returned by SELECT queries:

organizations_security_monitoring_conditions_get

Name	Datatype	Description
name	string	Identifier. Name of the security monitoring condition resource. Format: organizations/{org}/securityMonitoringConditions/{security_monitoring_condition}
apiHubGateway	string	Optional. The API Hub gateway monitored by the security monitoring condition. This should only be set if risk_assessment_type is API_HUB. Format: projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}
createTime	string (google-datetime)	Output only. The time of the security monitoring condition creation.
include	object	Include only these resources. (id: GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestResourceArray)
includeAllResources	object	Include all resources under the scope. (id: GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestIncludeAll)
profile	string	Required. ID of security profile of the security monitoring condition.
riskAssessmentType	string	Optional. The risk assessment type of the security monitoring condition. Defaults to ADVANCED_API_SECURITY. (RISK_ASSESSMENT_TYPE_UNSPECIFIED, APIGEE, API_HUB)
scope	string	Optional. Scope of the security monitoring condition. When RiskAssessmentType is APIGEE, the scope should be set to the environment of the resources. When RiskAssessmentType is API_HUB, the scope should not be set.
totalDeployedResources	integer (int32)	Output only. Total number of deployed resources within scope.
totalMonitoredResources	integer (int32)	Output only. Total number of monitored resources within this condition.
updateTime	string (google-datetime)	Output only. The time of the security monitoring condition update.

organizations_security_monitoring_conditions_list

Name	Datatype	Description
name	string	Identifier. Name of the security monitoring condition resource. Format: organizations/{org}/securityMonitoringConditions/{security_monitoring_condition}
apiHubGateway	string	Optional. The API Hub gateway monitored by the security monitoring condition. This should only be set if risk_assessment_type is API_HUB. Format: projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}
createTime	string (google-datetime)	Output only. The time of the security monitoring condition creation.
include	object	Include only these resources. (id: GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestResourceArray)
includeAllResources	object	Include all resources under the scope. (id: GoogleCloudApigeeV1BatchComputeSecurityAssessmentResultsRequestIncludeAll)
profile	string	Required. ID of security profile of the security monitoring condition.
riskAssessmentType	string	Optional. The risk assessment type of the security monitoring condition. Defaults to ADVANCED_API_SECURITY. (RISK_ASSESSMENT_TYPE_UNSPECIFIED, APIGEE, API_HUB)
scope	string	Optional. Scope of the security monitoring condition. When RiskAssessmentType is APIGEE, the scope should be set to the environment of the resources. When RiskAssessmentType is API_HUB, the scope should not be set.
totalDeployedResources	integer (int32)	Output only. Total number of deployed resources within scope.
totalMonitoredResources	integer (int32)	Output only. Total number of monitored resources within this condition.
updateTime	string (google-datetime)	Output only. The time of the security monitoring condition update.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
organizations_security_monitoring_conditions_get	select	organizationsId, securityMonitoringConditionsId	riskAssessmentType	Get a security monitoring condition.
organizations_security_monitoring_conditions_list	select	organizationsId	pageToken, pageSize, riskAssessmentType, filter	List security monitoring conditions.
organizations_security_monitoring_conditions_create	insert	organizationsId	securityMonitoringConditionId	Create a security monitoring condition.
organizations_security_monitoring_conditions_patch	update	organizationsId, securityMonitoringConditionsId	updateMask	Update a security monitoring condition.
organizations_security_monitoring_conditions_delete	delete	organizationsId, securityMonitoringConditionsId	riskAssessmentType	Delete a security monitoring condition.

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
organizationsId	string
securityMonitoringConditionsId	string
filter	string
pageSize	integer (int32)
pageToken	string
riskAssessmentType	string
securityMonitoringConditionId	string
updateMask	string (google-fieldmask)

SELECT examples

organizations_security_monitoring_conditions_get

Get a security monitoring condition.

SELECT
name,
apiHubGateway,
createTime,
include,
includeAllResources,
profile,
riskAssessmentType,
scope,
totalDeployedResources,
totalMonitoredResources,
updateTime
FROM google.apigee.security_monitoring_conditions
WHERE organizationsId = '{{ organizationsId }}' -- required
AND securityMonitoringConditionsId = '{{ securityMonitoringConditionsId }}' -- required
AND riskAssessmentType = '{{ riskAssessmentType }}'
;

organizations_security_monitoring_conditions_list

List security monitoring conditions.

SELECT
name,
apiHubGateway,
createTime,
include,
includeAllResources,
profile,
riskAssessmentType,
scope,
totalDeployedResources,
totalMonitoredResources,
updateTime
FROM google.apigee.security_monitoring_conditions
WHERE organizationsId = '{{ organizationsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}'
AND riskAssessmentType = '{{ riskAssessmentType }}'
AND filter = '{{ filter }}'
;

INSERT examples

organizations_security_monitoring_conditions_create

Create a security monitoring condition.

INSERT INTO google.apigee.security_monitoring_conditions (
data__profile,
data__name,
data__scope,
data__include,
data__riskAssessmentType,
data__apiHubGateway,
data__includeAllResources,
organizationsId,
securityMonitoringConditionId
)
SELECT 
'{{ profile }}',
'{{ name }}',
'{{ scope }}',
'{{ include }}',
'{{ riskAssessmentType }}',
'{{ apiHubGateway }}',
'{{ includeAllResources }}',
'{{ organizationsId }}',
'{{ securityMonitoringConditionId }}'
RETURNING
name,
apiHubGateway,
createTime,
include,
includeAllResources,
profile,
riskAssessmentType,
scope,
totalDeployedResources,
totalMonitoredResources,
updateTime
;

Manifest

# Description fields are for documentation purposes
- name: security_monitoring_conditions
props:
  - name: organizationsId
    value: "{{ organizationsId }}"
    description: Required parameter for the security_monitoring_conditions resource.
  - name: profile
    value: "{{ profile }}"
    description: |
      Required. ID of security profile of the security monitoring condition.
  - name: name
    value: "{{ name }}"
    description: |
      Identifier. Name of the security monitoring condition resource. Format: organizations/{org}/securityMonitoringConditions/{security_monitoring_condition}
  - name: scope
    value: "{{ scope }}"
    description: |
      Optional. Scope of the security monitoring condition. When RiskAssessmentType is APIGEE, the scope should be set to the environment of the resources. When RiskAssessmentType is API_HUB, the scope should not be set.
  - name: include
    description: |
      Include only these resources.
    value:
      resources:
        - type: "{{ type }}"
          name: "{{ name }}"
  - name: riskAssessmentType
    value: "{{ riskAssessmentType }}"
    description: |
      Optional. The risk assessment type of the security monitoring condition. Defaults to ADVANCED_API_SECURITY.
    valid_values: ['RISK_ASSESSMENT_TYPE_UNSPECIFIED', 'APIGEE', 'API_HUB']
  - name: apiHubGateway
    value: "{{ apiHubGateway }}"
    description: |
      Optional. The API Hub gateway monitored by the security monitoring condition. This should only be set if risk_assessment_type is API_HUB. Format: `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
  - name: includeAllResources
    value: "{{ includeAllResources }}"
    description: |
      Include all resources under the scope.
  - name: securityMonitoringConditionId
    value: "{{ securityMonitoringConditionId }}"

UPDATE examples

organizations_security_monitoring_conditions_patch

Update a security monitoring condition.

UPDATE google.apigee.security_monitoring_conditions
SET 
data__profile = '{{ profile }}',
data__name = '{{ name }}',
data__scope = '{{ scope }}',
data__include = '{{ include }}',
data__riskAssessmentType = '{{ riskAssessmentType }}',
data__apiHubGateway = '{{ apiHubGateway }}',
data__includeAllResources = '{{ includeAllResources }}'
WHERE 
organizationsId = '{{ organizationsId }}' --required
AND securityMonitoringConditionsId = '{{ securityMonitoringConditionsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
apiHubGateway,
createTime,
include,
includeAllResources,
profile,
riskAssessmentType,
scope,
totalDeployedResources,
totalMonitoredResources,
updateTime;

DELETE examples

organizations_security_monitoring_conditions_delete

Delete a security monitoring condition.

DELETE FROM google.apigee.security_monitoring_conditions
WHERE organizationsId = '{{ organizationsId }}' --required
AND securityMonitoringConditionsId = '{{ securityMonitoringConditionsId }}' --required
AND riskAssessmentType = '{{ riskAssessmentType }}'
;