Publishers - List By Subscription

Service:

Hybrid Network

API Version:

2023-09-01

Lists all the publishers in a subscription.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.HybridNetwork/publishers?api-version=2023-09-01

URI Parameters

Name	In	Required	Type	Description
subscriptionId	path	True	string minLength: 1	The ID of the target subscription.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	PublisherListResult	Request is successful. The operation returns a list of publisher resources.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

List all publisher resources in a subscription

Sample request

HTTP

GET https://management.azure.com/subscriptions/subid/providers/Microsoft.HybridNetwork/publishers?api-version=2023-09-01

Sample response

Status code:

200

{
  "value": [
    {
      "name": "TestPublisher",
      "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/TestPublisher",
      "type": "Microsoft.HybridNetwork/publishers",
      "location": "eastus",
      "properties": {
        "provisioningState": "Succeeded",
        "scope": "Public"
      }
    },
    {
      "name": "TestPublisher2",
      "id": "/subscriptions/subid/resourcegroups/rg/providers/Microsoft.HybridNetwork/publishers/TestPublisher2",
      "type": "Microsoft.HybridNetwork/publishers",
      "location": "eastus",
      "properties": {
        "provisioningState": "Succeeded",
        "scope": "Public"
      }
    }
  ]
}

Definitions

Name	Description
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ManagedServiceIdentity	Managed service identity (system assigned and/or user assigned identities)
ManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
ProvisioningState	The current provisioning state.
Publisher	publisher resource.
PublisherListResult	A list of publishers.
PublisherPropertiesFormat	publisher properties.
PublisherScope	Publisher Scope.
systemData	Metadata pertaining to creation and last modification of the resource.
UserAssignedIdentity	User assigned identity properties

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

ManagedServiceIdentity

Object

Managed service identity (system assigned and/or user assigned identities)

Name	Type	Description
principalId	string (uuid)	The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId	string (uuid)	The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type	ManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
userAssignedIdentities	<string,  UserAssignedIdentity>	User-Assigned Identities The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

ManagedServiceIdentityType

Enumeration

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

Value	Description
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

ProvisioningState

Enumeration

The current provisioning state.

Value	Description
Unknown
Succeeded
Accepted
Deleting
Failed
Canceled
Deleted
Converging

Publisher

Object

publisher resource.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity	The managed identity of the publisher, if configured.
location	string	The geo-location where the resource lives
name	string	The name of the resource
properties	PublisherPropertiesFormat	Publisher properties.
systemData	systemData	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"

PublisherListResult

Object

A list of publishers.

Name	Type	Description
nextLink	string	The URL to get the next set of results.
value	Publisher[]	A list of publishers.

PublisherPropertiesFormat

Object

publisher properties.

Name	Type	Description
provisioningState	ProvisioningState	The provisioning state of the publisher resource.
scope	PublisherScope	The publisher scope.

PublisherScope

Enumeration

Publisher Scope.

Value	Description
Unknown
Private

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

UserAssignedIdentity

Object

User assigned identity properties

Name	Type	Description
clientId	string (uuid)	The client ID of the assigned identity.
principalId	string (uuid)	The principal ID of the assigned identity.