publishers

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

Overview

Name	publishers
Type	Resource
Id	azure_extras.hybrid_network.publishers

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
identity	object	The managed identity of the publisher, if configured.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The provisioning state of the publisher resource. Known values are: "Unknown", "Succeeded", "Accepted", "Deleting", "Failed", "Canceled", "Deleted", and "Converging".
scope	string	The publisher scope. Known values are: "Unknown" and "Private".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
identity	object	The managed identity of the publisher, if configured.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The provisioning state of the publisher resource. Known values are: "Unknown", "Succeeded", "Accepted", "Deleting", "Failed", "Canceled", "Deleted", and "Converging".
scope	string	The publisher scope. Known values are: "Unknown" and "Private".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
identity	object	The managed identity of the publisher, if configured.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The provisioning state of the publisher resource. Known values are: "Unknown", "Succeeded", "Accepted", "Deleting", "Failed", "Canceled", "Deleted", and "Converging".
scope	string	The publisher scope. Known values are: "Unknown" and "Private".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
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	resource_group_name, publisher_name, subscription_id		Gets information about the specified publisher.
list_by_resource_group	select	resource_group_name, subscription_id		Lists all the publishers in a resource group.
list_by_subscription	select	subscription_id		Lists all the publishers in a subscription.
create_or_update	insert	resource_group_name, publisher_name, subscription_id, location		Creates or updates a publisher.
update	update	resource_group_name, publisher_name, subscription_id		Update a publisher resource.
create_or_update	replace	resource_group_name, publisher_name, subscription_id, location		Creates or updates a publisher.
delete	delete	resource_group_name, publisher_name, subscription_id		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
publisher_name	string	The name of the publisher. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets information about the specified publisher.

SELECT
id,
name,
identity,
location,
provisioningState,
scope,
systemData,
tags,
type
FROM azure_extras.hybrid_network.publishers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND publisher_name = '{{ publisher_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Lists all the publishers in a resource group.

SELECT
id,
name,
identity,
location,
provisioningState,
scope,
systemData,
tags,
type
FROM azure_extras.hybrid_network.publishers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Lists all the publishers in a subscription.

SELECT
id,
name,
identity,
location,
provisioningState,
scope,
systemData,
tags,
type
FROM azure_extras.hybrid_network.publishers
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a publisher.

INSERT INTO azure_extras.hybrid_network.publishers (
tags,
location,
properties,
identity,
resource_group_name,
publisher_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ identity }}',
'{{ resource_group_name }}',
'{{ publisher_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: publishers
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the publishers resource.
  - name: publisher_name
    value: "{{ publisher_name }}"
    description: Required parameter for the publishers resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the publishers resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      Publisher properties.
    value:
      provisioningState: "{{ provisioningState }}"
      scope: "{{ scope }}"
  - name: identity
    description: |
      The managed identity of the publisher, if configured.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"

UPDATE examples

update

Update a publisher resource.

UPDATE azure_extras.hybrid_network.publishers
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND publisher_name = '{{ publisher_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Creates or updates a publisher.

REPLACE azure_extras.hybrid_network.publishers
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND publisher_name = '{{ publisher_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes the specified publisher.

DELETE FROM azure_extras.hybrid_network.publishers
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND publisher_name = '{{ publisher_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;