security_partner_providers

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

Overview

Name	security_partner_providers
Type	Resource
Id	azure.network.security_partner_providers

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
connectionStatus	string	The connection status with the Security Partner Provider. Known values are: "Unknown", "PartiallyConnected", "Connected", and "NotConnected". (Unknown, PartiallyConnected, Connected, NotConnected)
etag	string	A unique read-only string that changes whenever the resource is updated.
location	string	Resource location.
provisioningState	string	The provisioning state of the Security Partner Provider resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
securityProviderName	string	The security provider name. Known values are: "ZScaler", "IBoss", and "Checkpoint". (ZScaler, IBoss, Checkpoint)
tags	object	Resource tags.
type	string	Resource type.
virtualHub	object	Reference to another subresource.

list_by_resource_group

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
connectionStatus	string	The connection status with the Security Partner Provider. Known values are: "Unknown", "PartiallyConnected", "Connected", and "NotConnected". (Unknown, PartiallyConnected, Connected, NotConnected)
etag	string	A unique read-only string that changes whenever the resource is updated.
location	string	Resource location.
provisioningState	string	The provisioning state of the Security Partner Provider resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
securityProviderName	string	The security provider name. Known values are: "ZScaler", "IBoss", and "Checkpoint". (ZScaler, IBoss, Checkpoint)
tags	object	Resource tags.
type	string	Resource type.
virtualHub	object	Reference to another subresource.

list

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
connectionStatus	string	The connection status with the Security Partner Provider. Known values are: "Unknown", "PartiallyConnected", "Connected", and "NotConnected". (Unknown, PartiallyConnected, Connected, NotConnected)
etag	string	A unique read-only string that changes whenever the resource is updated.
location	string	Resource location.
provisioningState	string	The provisioning state of the Security Partner Provider resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
securityProviderName	string	The security provider name. Known values are: "ZScaler", "IBoss", and "Checkpoint". (ZScaler, IBoss, Checkpoint)
tags	object	Resource tags.
type	string	Resource type.
virtualHub	object	Reference to another subresource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, security_partner_provider_name, subscription_id		Gets the specified Security Partner Provider.
list_by_resource_group	select	resource_group_name, subscription_id		Lists all Security Partner Providers in a resource group.
list	select	subscription_id		Gets all the Security Partner Providers in a subscription.
create_or_update	insert	resource_group_name, security_partner_provider_name, subscription_id		Creates or updates the specified Security Partner Provider.
update_tags	update	resource_group_name, security_partner_provider_name, subscription_id		Updates tags of a Security Partner Provider resource.
create_or_update	replace	resource_group_name, security_partner_provider_name, subscription_id		Creates or updates the specified Security Partner Provider.
delete	delete	resource_group_name, security_partner_provider_name, subscription_id		Deletes the specified Security Partner Provider.

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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
security_partner_provider_name	string	The name of the Security Partner Provider. Required.
subscription_id	string

SELECT examples

get

Gets the specified Security Partner Provider.

SELECT
id,
name,
connectionStatus,
etag,
location,
provisioningState,
securityProviderName,
tags,
type,
virtualHub
FROM azure.network.security_partner_providers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND security_partner_provider_name = '{{ security_partner_provider_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Lists all Security Partner Providers in a resource group.

SELECT
id,
name,
connectionStatus,
etag,
location,
provisioningState,
securityProviderName,
tags,
type,
virtualHub
FROM azure.network.security_partner_providers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets all the Security Partner Providers in a subscription.

SELECT
id,
name,
connectionStatus,
etag,
location,
provisioningState,
securityProviderName,
tags,
type,
virtualHub
FROM azure.network.security_partner_providers
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates the specified Security Partner Provider.

INSERT INTO azure.network.security_partner_providers (
id,
location,
tags,
properties,
resource_group_name,
security_partner_provider_name,
subscription_id
)
SELECT 
'{{ id }}',
'{{ location }}',
'{{ tags }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ security_partner_provider_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: security_partner_providers
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the security_partner_providers resource.
  - name: security_partner_provider_name
    value: "{{ security_partner_provider_name }}"
    description: Required parameter for the security_partner_providers resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the security_partner_providers resource.
  - name: id
    value: "{{ id }}"
    description: |
      Resource ID.
  - name: location
    value: "{{ location }}"
    description: |
      Resource location.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: properties
    description: |
      Properties of the Security Partner Provider.
    value:
      provisioningState: "{{ provisioningState }}"
      securityProviderName: "{{ securityProviderName }}"
      connectionStatus: "{{ connectionStatus }}"
      virtualHub:
        id: "{{ id }}"

UPDATE examples

update_tags

Updates tags of a Security Partner Provider resource.

UPDATE azure.network.security_partner_providers
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND security_partner_provider_name = '{{ security_partner_provider_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
location,
properties,
tags,
type;

REPLACE examples

create_or_update

Creates or updates the specified Security Partner Provider.

REPLACE azure.network.security_partner_providers
SET 
id = '{{ id }}',
location = '{{ location }}',
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND security_partner_provider_name = '{{ security_partner_provider_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
location,
properties,
tags,
type;

DELETE examples

delete

Deletes the specified Security Partner Provider.

DELETE FROM azure.network.security_partner_providers
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND security_partner_provider_name = '{{ security_partner_provider_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;