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

Request successful. The operation returns a SecurityPartnerProvider resource.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the Security Partner Provider.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list_by_resource_group

Success. The operation returns a list of SecurityPartnerProvider resources.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the Security Partner Provider.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list

Success. The operation returns a list of SecurityPartnerProvider resources.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the Security Partner Provider.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Methods

The following methods are available for this resource:

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

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
resourceGroupName	string	The name of the resource group.
securityPartnerProviderName	string	The name of the Security Partner Provider.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Gets the specified Security Partner Provider.

SELECT
id,
name,
etag,
properties,
systemData,
type
FROM azure.network.security_partner_providers
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND securityPartnerProviderName = '{{ securityPartnerProviderName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_resource_group

Lists all Security Partner Providers in a resource group.

SELECT
id,
name,
etag,
properties,
systemData,
type
FROM azure.network.security_partner_providers
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list

Gets all the Security Partner Providers in a subscription.

SELECT
id,
name,
etag,
properties,
systemData,
type
FROM azure.network.security_partner_providers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates the specified Security Partner Provider.

INSERT INTO azure.network.security_partner_providers (
data__properties,
resourceGroupName,
securityPartnerProviderName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ securityPartnerProviderName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
etag,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: security_partner_providers
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the security_partner_providers resource.
    - name: securityPartnerProviderName
      value: string
      description: Required parameter for the security_partner_providers resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the security_partner_providers resource.
    - name: properties
      value: object
      description: |
        Properties of the Security Partner Provider.

DELETE examples

delete

Deletes the specified Security Partner Provider.

DELETE FROM azure.network.security_partner_providers
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND securityPartnerProviderName = '{{ securityPartnerProviderName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

Lifecycle Methods

update_tags

Updates tags of a Security Partner Provider resource.

EXEC azure.network.security_partner_providers.update_tags 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@securityPartnerProviderName='{{ securityPartnerProviderName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"tags": "{{ tags }}"
}'
;