publishers

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

Overview

Name	publishers
Type	Resource
Id	azure.hybrid_network.publishers

Fields

The following fields are returned by SELECT queries:

get

Request is successful. The operation returns the resulting publisher resource.

Name	Datatype	Description
identity	object	The managed identity of the publisher, if configured.
location	string	The geo-location where the resource lives
properties	object	Publisher properties.
tags	object	Resource tags.

list_by_resource_group

Request is successful. The operation returns a list of publisher resources.

Name	Datatype	Description
identity	object	The managed identity of the publisher, if configured.
location	string	The geo-location where the resource lives
properties	object	Publisher properties.
tags	object	Resource tags.

list_by_subscription

Request is successful. The operation returns a list of publisher resources.

Name	Datatype	Description
identity	object	The managed identity of the publisher, if configured.
location	string	The geo-location where the resource lives
properties	object	Publisher properties.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, publisherName, subscriptionId		Gets information about the specified publisher.
list_by_resource_group	select	resourceGroupName, subscriptionId		Lists all the publishers in a resource group.
list_by_subscription	select	subscriptionId		Lists all the publishers in a subscription.
create_or_update	insert	resourceGroupName, publisherName, subscriptionId		Creates or updates a publisher.
update	update	resourceGroupName, publisherName, subscriptionId		Update a publisher resource.
delete	delete	resourceGroupName, publisherName, subscriptionId		Deletes the specified publisher.

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
publisherName	string	The name of the publisher.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Gets information about the specified publisher.

SELECT
identity,
location,
properties,
tags
FROM azure.hybrid_network.publishers
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND publisherName = '{{ publisherName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_resource_group

Lists all the publishers in a resource group.

SELECT
identity,
location,
properties,
tags
FROM azure.hybrid_network.publishers
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_subscription

Lists all the publishers in a subscription.

SELECT
identity,
location,
properties,
tags
FROM azure.hybrid_network.publishers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates a publisher.

INSERT INTO azure.hybrid_network.publishers (
data__properties,
data__identity,
data__tags,
data__location,
resourceGroupName,
publisherName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ identity }}',
'{{ tags }}',
'{{ location }}',
'{{ resourceGroupName }}',
'{{ publisherName }}',
'{{ subscriptionId }}'
RETURNING
identity,
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: publishers
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the publishers resource.
    - name: publisherName
      value: string
      description: Required parameter for the publishers resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the publishers resource.
    - name: properties
      value: object
      description: |
        Publisher properties.
    - name: identity
      value: object
      description: |
        The managed identity of the publisher, if configured.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

Update a publisher resource.

UPDATE azure.hybrid_network.publishers
SET 
data__tags = '{{ tags }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND publisherName = '{{ publisherName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
identity,
location,
properties,
tags;

DELETE examples

delete

Deletes the specified publisher.

DELETE FROM azure.hybrid_network.publishers
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND publisherName = '{{ publisherName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;