Microsoft.IoTOperations (stable:2025-04-01)

2025/03/14 • 35 new methods

Operations_List (new)
Description :  List the operations for the provider
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.IoTOperations/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Instance_ListBySubscription (new)
Description :  List InstanceResource resources by subscription ID
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.IoTOperations/instances
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The InstanceResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
description:
{
Description: Detailed description of the Instance. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Resource is getting provisioned. ,
Updating: Resource is Updating. ,
Deleting: Resource is Deleting. ,
Accepted: Resource has been Accepted. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The Azure IoT Operations version. ,
Required: False ,
}
string ,
schemaRegistryRef:
{
Description: The reference to the Schema Registry for this AIO Instance. ,
Required: True ,
}
{
resourceId:
{
Description: The resource ID of the Schema Registry. ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
features:
{
Description: The features of the AIO Instance. ,
Required: False ,
}
object ,
}
,
extendedLocation:
{
Description: Edge location of the resource. ,
Required: True ,
}
{
name:
{
Description: The name of the extended location. ,
Required: True ,
}
string ,
type:
{
Description: Type of ExtendedLocation. ,
Enum:
{
CustomLocation: CustomLocation type ,
}
,
Required: True ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Instance_ListByResourceGroup (new)
Description :  List InstanceResource resources by resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The InstanceResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
description:
{
Description: Detailed description of the Instance. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Resource is getting provisioned. ,
Updating: Resource is Updating. ,
Deleting: Resource is Deleting. ,
Accepted: Resource has been Accepted. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The Azure IoT Operations version. ,
Required: False ,
}
string ,
schemaRegistryRef:
{
Description: The reference to the Schema Registry for this AIO Instance. ,
Required: True ,
}
{
resourceId:
{
Description: The resource ID of the Schema Registry. ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
features:
{
Description: The features of the AIO Instance. ,
Required: False ,
}
object ,
}
,
extendedLocation:
{
Description: Edge location of the resource. ,
Required: True ,
}
{
name:
{
Description: The name of the extended location. ,
Required: True ,
}
string ,
type:
{
Description: Type of ExtendedLocation. ,
Enum:
{
CustomLocation: CustomLocation type ,
}
,
Required: True ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Instance_Get (new)
Description :  Get a InstanceResource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
instanceName:
{
Description: Name of instance. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
description:
{
Description: Detailed description of the Instance. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Resource is getting provisioned. ,
Updating: Resource is Updating. ,
Deleting: Resource is Deleting. ,
Accepted: Resource has been Accepted. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The Azure IoT Operations version. ,
Required: False ,
}
string ,
schemaRegistryRef:
{
Description: The reference to the Schema Registry for this AIO Instance. ,
Required: True ,
}
{
resourceId:
{
Description: The resource ID of the Schema Registry. ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
features:
{
Description: The features of the AIO Instance. ,
Required: False ,
}
object ,
}
,
extendedLocation:
{
Description: Edge location of the resource. ,
Required: True ,
}
{
name:
{
Description: The name of the extended location. ,
Required: True ,
}
string ,
type:
{
Description: Type of ExtendedLocation. ,
Enum:
{
CustomLocation: CustomLocation type ,
}
,
Required: True ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Instance_CreateOrUpdate (new)
Description :  Create a InstanceResource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
instanceName:
{
Description: Name of instance. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
description:
{
Description: Detailed description of the Instance. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Resource is getting provisioned. ,
Updating: Resource is Updating. ,
Deleting: Resource is Deleting. ,
Accepted: Resource has been Accepted. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The Azure IoT Operations version. ,
Required: False ,
}
string ,
schemaRegistryRef:
{
Description: The reference to the Schema Registry for this AIO Instance. ,
Required: True ,
}
{
resourceId:
{
Description: The resource ID of the Schema Registry. ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
features:
{
Description: The features of the AIO Instance. ,
Required: False ,
}
object ,
}
,
extendedLocation:
{
Description: Edge location of the resource. ,
Required: True ,
}
{
name:
{
Description: The name of the extended location. ,
Required: True ,
}
string ,
type:
{
Description: Type of ExtendedLocation. ,
Enum:
{
CustomLocation: CustomLocation type ,
}
,
Required: True ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
description:
{
Description: Detailed description of the Instance. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Resource is getting provisioned. ,
Updating: Resource is Updating. ,
Deleting: Resource is Deleting. ,
Accepted: Resource has been Accepted. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The Azure IoT Operations version. ,
Required: False ,
}
string ,
schemaRegistryRef:
{
Description: The reference to the Schema Registry for this AIO Instance. ,
Required: True ,
}
{
resourceId:
{
Description: The resource ID of the Schema Registry. ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
features:
{
Description: The features of the AIO Instance. ,
Required: False ,
}
object ,
}
,
extendedLocation:
{
Description: Edge location of the resource. ,
Required: True ,
}
{
name:
{
Description: The name of the extended location. ,
Required: True ,
}
string ,
type:
{
Description: Type of ExtendedLocation. ,
Enum:
{
CustomLocation: CustomLocation type ,
}
,
Required: True ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: A Instance resource is a logical container for a set of child resources. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
description:
{
Description: Detailed description of the Instance. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Resource is getting provisioned. ,
Updating: Resource is Updating. ,
Deleting: Resource is Deleting. ,
Accepted: Resource has been Accepted. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The Azure IoT Operations version. ,
Required: False ,
}
string ,
schemaRegistryRef:
{
Description: The reference to the Schema Registry for this AIO Instance. ,
Required: True ,
}
{
resourceId:
{
Description: The resource ID of the Schema Registry. ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
features:
{
Description: The features of the AIO Instance. ,
Required: False ,
}
object ,
}
,
extendedLocation:
{
Description: Edge location of the resource. ,
Required: True ,
}
{
name:
{
Description: The name of the extended location. ,
Required: True ,
}
string ,
type:
{
Description: Type of ExtendedLocation. ,
Enum:
{
CustomLocation: CustomLocation type ,
}
,
Required: True ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Instance_Update (new)
Description :  Update a InstanceResource
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
instanceName:
{
Description: Name of instance. ,
Required: True ,
}
string ,
properties:
{
Description: The resource properties to be updated. ,
Required: True ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
description:
{
Description: Detailed description of the Instance. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Resource is getting provisioned. ,
Updating: Resource is Updating. ,
Deleting: Resource is Deleting. ,
Accepted: Resource has been Accepted. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: The Azure IoT Operations version. ,
Required: False ,
}
string ,
schemaRegistryRef:
{
Description: The reference to the Schema Registry for this AIO Instance. ,
Required: True ,
}
{
resourceId:
{
Description: The resource ID of the Schema Registry. ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
features:
{
Description: The features of the AIO Instance. ,
Required: False ,
}
object ,
}
,
extendedLocation:
{
Description: Edge location of the resource. ,
Required: True ,
}
{
name:
{
Description: The name of the extended location. ,
Required: True ,
}
string ,
type:
{
Description: Type of ExtendedLocation. ,
Enum:
{
CustomLocation: CustomLocation type ,
}
,
Required: True ,
}
enum ,
}
,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Instance_Delete (new)
Description :  Delete a InstanceResource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
instanceName:
{
Description: Name of instance. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Broker_ListByResourceGroup (new)
Description :  List BrokerResource resources by InstanceResource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/brokers
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
instanceName:
{
Description: Name of instance. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The BrokerResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
advanced:
{
Description: Advanced settings of Broker. ,
Required: False ,
}
{
clients:
{
Description: Configurations related to All Clients. ,
Required: False ,
}
{
maxSessionExpirySeconds:
{
Description: Upper bound of Session Expiry Interval, in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxMessageExpirySeconds:
{
Description: Upper bound of Message Expiry Interval, in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPacketSizeBytes:
{
Description: Max message size for a packet in Bytes. ,
Format: int32 ,
Required: False ,
}
integer ,
subscriberQueueLimit:
{
Description: The limit on the number of queued messages for a subscriber. ,
Required: False ,
}
{
length:
{
Description: The maximum length of the queue before messages start getting dropped. ,
Format: int64 ,
Required: False ,
}
integer ,
strategy:
{
Description: The strategy to use for dropping messages from the queue. ,
Enum:
{
None: Messages are never dropped. ,
DropOldest: The oldest message is dropped. ,
}
,
Required: False ,
}
enum ,
}
,
maxReceiveMaximum:
{
Description: Upper bound of Receive Maximum that a client can request in the CONNECT packet. ,
Format: int32 ,
Required: False ,
}
integer ,
maxKeepAliveSeconds:
{
Description: Upper bound of a client's Keep Alive, in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
encryptInternalTraffic:
{
Description: The setting to enable or disable encryption of internal Traffic. ,
Enum:
{
Enabled: Enabled is equivalent to True ,
Disabled: Disabled is equivalent to False. ,
}
,
Required: False ,
}
enum ,
internalCerts:
{
Description: Certificate rotation and private key configuration. ,
Required: False ,
}
{
duration:
{
Description: Lifetime of certificate. Must be specified using a Go time.Duration format (h|m|s). E.g. 240h for 240 hours and 45m for 45 minutes. ,
Required: True ,
}
string ,
renewBefore:
{
Description: When to begin renewing certificate. Must be specified using a Go time.Duration format (h|m|s). E.g. 240h for 240 hours and 45m for 45 minutes. ,
Required: True ,
}
string ,
privateKey:
{
Description: Configuration of certificate private key. ,
Required: True ,
}
{
algorithm:
{
Description: algorithm for private key. ,
Enum:
{
Ec256: Algorithm - ec256. ,
Ec384: Algorithm - ec384. ,
Ec521: Algorithm - ec521. ,
Ed25519: Algorithm - ed25519. ,
Rsa2048: Algorithm - rsa2048. ,
Rsa4096: Algorithm - rsa4096. ,
Rsa8192: Algorithm - rsa8192. ,
}
,
Required: True ,
}
enum ,
rotationPolicy:
{
Description: cert-manager private key rotationPolicy. ,
Enum:
{
Always: Rotation Policy - Always. ,
Never: Rotation Policy - Never. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
cardinality:
{
Description: The cardinality details of the broker. ,
Required: False ,
}
{
backendChain:
{
Description: The backend broker desired properties ,
Required: True ,
}
{
partitions:
{
Description: The desired number of physical backend partitions. ,
Format: int32 ,
Required: True ,
}
integer ,
redundancyFactor:
{
Description: The desired numbers of backend replicas (pods) in a physical partition. ,
Format: int32 ,
Required: True ,
}
integer ,
workers:
{
Description: Number of logical backend workers per replica (pod). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
frontend:
{
Description: The frontend desired properties ,
Required: True ,
}
{
replicas:
{
Description: The desired number of frontend instances (pods). ,
Format: int32 ,
Required: True ,
}
integer ,
workers:
{
Description: Number of logical frontend workers per instance (pod). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
diagnostics:
{
Description: Spec defines the desired identities of Broker diagnostics settings. ,
Required: False ,
}
{
logs:
{
Description: Diagnostic log settings for the resource. ,
Required: False ,
}
{
level:
{
Description: The log level. Examples - 'debug', 'info', 'warn', 'error', 'trace'. ,
Required: False ,
}
string ,
}
,
metrics:
{
Description: The metrics settings for the resource. ,
Required: False ,
}
{
prometheusPort:
{
Description: The prometheus port to expose the metrics. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
selfCheck:
{
Description: The self check properties. ,
Required: False ,
}
{
mode:
{
Description: The toggle to enable/disable self check. ,
Enum:
{
Enabled: Enabled is equivalent to True ,
Disabled: Disabled is equivalent to False. ,
}
,
Required: False ,
}
enum ,
intervalSeconds:
{
Description: The self check interval. ,
Format: int32 ,
Required: False ,
}
integer ,
timeoutSeconds:
{
Description: The timeout for self check. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
traces:
{
Description: The trace properties. ,
Required: False ,
}
{
mode:
{
Description: The toggle to enable/disable traces. ,
Enum:
{
Enabled: Enabled is equivalent to True ,
Disabled: Disabled is equivalent to False. ,
}
,
Required: False ,
}
enum ,
cacheSizeMegabytes:
{
Description: The cache size in megabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
selfTracing:
{
Description: The self tracing properties. ,
Required: False ,
}
{
mode:
{
Description: The toggle to enable/disable self tracing. ,
Enum:
{
Enabled: Enabled is equivalent to True ,
Disabled: Disabled is equivalent to False. ,
}
,
Required: False ,
}
enum ,
intervalSeconds:
{
Description: The self tracing interval. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
spanChannelCapacity:
{
Description: The span channel capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
diskBackedMessageBuffer:
{
Description: Settings of Disk Backed Message Buffer. ,
Required: False ,
}
{
maxSize:
{
Description: The max size of the message buffer on disk. If a PVC template is specified using one of ephemeralVolumeClaimSpec or persistentVolumeClaimSpec, then this size is used as the request and limit sizes of that template. If neither ephemeralVolumeClaimSpec nor persistentVolumeClaimSpec are specified, then an emptyDir volume is mounted with this size as its limit. See for details. ,
Required: True ,
}
string ,
ephemeralVolumeClaimSpec:
{
Description: Use the specified persistent volume claim template to mount a "generic ephemeral volume" for the message buffer. See for details. ,
Required: False ,
}
{
volumeName:
{
Description: VolumeName is the binding reference to the PersistentVolume backing this claim. ,
Required: False ,
}
string ,
volumeMode:
{
Description: volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. This is a beta feature. ,
Required: False ,
}
string ,
storageClassName:
{
Description: Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 ,
Required: False ,
}
string ,
accessModes:
{
Description: AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 ,
Required: False ,
}
[
string ,
]
,
dataSource:
{
Description: This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field. ,
Required: False ,
}
{
apiGroup:
{
Description: APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. ,
Required: False ,
}
string ,
kind:
{
Description: Kind is the type of resource being referenced ,
Required: True ,
}
string ,
name:
{
Description: Name is the name of resource being referenced ,
Required: True ,
}
string ,
}
,
dataSourceRef:
{
Description: Specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: * While DataSource only allows two specific types of objects, DataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While DataSource ignores disallowed values (dropping them), DataSourceRef preserves all values, and generates an error if a disallowed value is specified. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. ,
Required: False ,
}
{
apiGroup:
{
Description: APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. ,
Required: False ,
}
string ,
kind:
{
Description: Kind is the type of resource being referenced ,
Required: True ,
}
string ,
name:
{
Description: Name is the name of resource being referenced ,
Required: True ,
}
string ,
namespace:
{
Description: Namespace is the namespace of the resource being referenced. This field is required when the resource has a namespace. ,
Required: False ,
}
string ,
}
,
resources:
{
Description: Resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources ,
Required: False ,
}
{
limits:
{
Description: Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ ,
Required: False ,
}
object ,
requests:
{
Description: Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ ,
Required: False ,
}
object ,
}
,
selector:
{
Description: A label query over volumes to consider for binding. ,
Required: False ,
}
{
matchExpressions:
{
Description: MatchExpressions is a list of label selector requirements. The requirements are ANDed. ,
Required: False ,
}
[
{
key:
{
Description: key is the label key that the selector applies to. ,
Required: True ,
}
string ,
operator:
{
Description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. ,
Enum:
{
In: In operator. ,
NotIn: NotIn operator. ,
Exists: Exists operator. ,
DoesNotExist: DoesNotExist operator. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
matchLabels:
{
Description: MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. ,
Required: False ,
}
object ,
}
,
}
,
persistentVolumeClaimSpec:
{
Description: Use the specified persistent volume claim template to mount a persistent volume for the message buffer. ,
Required: False ,
}
{
volumeName:
{
Description: VolumeName is the binding reference to the PersistentVolume backing this claim. ,
Required: False ,
}
string ,
volumeMode:
{
Description: volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. This is a beta feature. ,
Required: False ,
}
string ,
storageClassName:
{
Description: Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 ,
Required: False ,
}
string ,
accessModes:
{
Description: AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 ,
Required: False ,
}
[
string ,
]
,
dataSource:
{
Description: This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field. ,
Required: False ,
}
{
apiGroup:
{
Description: APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. ,
Required: False ,
}
string ,
kind:
{
Description: Kind is the type of resource being referenced ,
Required: True ,
}
string ,
name:
{
Description: Name is the name of resource being referenced ,
Required: True ,
}
string ,
}
,
dataSourceRef:
{
Description: Specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: * While DataSource only allows two specific types of objects, DataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While DataSource ignores disallowed values (dropping them), DataSourceRef preserves all values, and generates an error if a disallowed value is specified. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. ,
Required: False ,
}
{
apiGroup:
{
Description: APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. ,
Required: False ,
}
string ,
kind:
{
Description: Kind is the type of resource being referenced ,
Required: True ,
}
string ,
name:
{
Description: Name is the name of resource being referenced ,
Required: True ,
}
string ,
namespace:
{
Description: Namespace is the namespace of the resource being referenced. This field is required when the resource has a namespace. ,
Required: False ,
}
string ,
}
,
resources:
{
Description: Resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources ,
Required: False ,
}
{
limits:
{
Description: Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ ,
Required: False ,
}
object ,
requests:
{
Description: Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ ,
Required: False ,
}
object ,
}
,
selector:
{
Description: A label query over volumes to consider for binding. ,
Required: False ,
}
{
matchExpressions:
{
Description: MatchExpressions is a list of label selector requirements. The requirements are ANDed. ,
Required: False ,
}
[
{
key:
{
Description: key is the label key that the selector applies to. ,
Required: True ,
}
string ,
operator:
{
Description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. ,
Enum:
{
In: In operator. ,
NotIn: NotIn operator. ,
Exists: Exists operator. ,
DoesNotExist: DoesNotExist operator. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
matchLabels:
{
Description: MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. ,
Required: False ,
}
object ,
}
,
}
,
}
,
generateResourceLimits:
{
Description: This setting controls whether Kubernetes CPU resource limits are requested. Increasing the number of replicas or workers proportionally increases the amount of CPU resources requested. If this setting is enabled and there are insufficient CPU resources, an error will be emitted. ,
Required: False ,
}
{
cpu:
{
Description: The toggle to enable/disable cpu resource limits. ,
Enum:
{
Enabled: Enabled is equivalent to True ,
Disabled: Disabled is equivalent to False. ,
}
,
Required: False ,
}
enum ,
}
,
memoryProfile:
{
Description: Memory profile of Broker. ,
Enum:
{
Tiny: Tiny memory profile. ,
Low: Low memory profile. ,
Medium: Medium memory profile. ,
High: High memory profile. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Resource is getting provisioned. ,
Updating: Resource is Updating. ,
Deleting: Resource is Deleting. ,
Accepted: Resource has been Accepted. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: Edge location of the resource. ,
Required: True ,
}
{
name:
{
Description: The name of the extended location. ,
Required: True ,
}
string ,
type:
{
Description: Type of ExtendedLocation. ,
Enum:
{
CustomLocation: CustomLocation type ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Broker_Get (new)
Description :  Get a BrokerResource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/brokers/{brokerName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
instanceName:
{
Description: Name of instance. ,
Required: True ,
}
string ,
brokerName:
{
Description: Name of broker. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
advanced:
{
Description: Advanced settings of Broker. ,
Required: False ,
}
{
clients:
{
Description: Configurations related to All Clients. ,
Required: False ,
}
{
maxSessionExpirySeconds:
{
Description: Upper bound of Session Expiry Interval, in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxMessageExpirySeconds:
{
Description: Upper bound of Message Expiry Interval, in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPacketSizeBytes:
{
Description: Max message size for a packet in Bytes. ,
Format: int32 ,
Required: False ,
}
integer ,
subscriberQueueLimit:
{
Description: The limit on the number of queued messages for a subscriber. ,
Required: False ,
}
{
length:
{
Description: The maximum length of the queue before messages start getting dropped. ,
Format: int64 ,
Required: False ,
}
integer ,
strategy:
{
Description: The strategy to use for dropping messages from the queue. ,
Enum:
{
None: Messages are never dropped. ,
DropOldest: The oldest message is dropped. ,
}
,
Required: False ,
}
enum ,
}
,
maxReceiveMaximum:
{
Description: Upper bound of Receive Maximum that a client can request in the CONNECT packet. ,
Format: int32 ,
Required: False ,
}
integer ,
maxKeepAliveSeconds:
{
Description: Upper bound of a client's Keep Alive, in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
encryptInternalTraffic:
{
Description: The setting to enable or disable encryption of internal Traffic. ,
Enum:
{
Enabled: Enabled is equivalent to True ,
Disabled: Disabled is equivalent to False. ,
}
,
Required: False ,
}
enum ,
internalCerts:
{
Description: Certificate rotation and private key configuration. ,
Required: False ,
}
{
duration:
{
Description: Lifetime of certificate. Must be specified using a Go time.Duration format (h|m|s). E.g. 240h for 240 hours and 45m for 45 minutes. ,
Required: True ,
}
string ,
renewBefore:
{
Description: When to begin renewing certificate. Must be specified using a Go time.Duration format (h|m|s). E.g. 240h for 240 hours and 45m for 45 minutes. ,
Required: True ,
}
string ,
privateKey:
{
Description: Configuration of certificate private key. ,
Required: True ,
}
{
algorithm:
{
Description: algorithm for private key. ,
Enum:
{
Ec256: Algorithm - ec256. ,
Ec384: Algorithm - ec384. ,
Ec521: Algorithm - ec521. ,
Ed25519: Algorithm - ed25519. ,
Rsa2048: Algorithm - rsa2048. ,
Rsa4096: Algorithm - rsa4096. ,
Rsa8192: Algorithm - rsa8192. ,
}
,
Required: True ,
}
enum ,
rotationPolicy:
{
Description: cert-manager private key rotationPolicy. ,
Enum:
{
Always: Rotation Policy - Always. ,
Never: Rotation Policy - Never. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
cardinality:
{
Description: The cardinality details of the broker. ,
Required: False ,
}
{
backendChain:
{
Description: The backend broker desired properties ,
Required: True ,
}
{
partitions:
{
Description: The desired number of physical backend partitions. ,
Format: int32 ,
Required: True ,
}
integer ,
redundancyFactor:
{
Description: The desired numbers of backend replicas (pods) in a physical partition. ,
Format: int32 ,
Required: True ,
}
integer ,
workers:
{
Description: Number of logical backend workers per replica (pod). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
frontend:
{
Description: The frontend desired properties ,
Required: True ,
}
{
replicas:
{
Description: The desired number of frontend instances (pods). ,
Format: int32 ,
Required: True ,
}
integer ,
workers:
{
Description: Number of logical frontend workers per instance (pod). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
diagnostics:
{
Description: Spec defines the desired identities of Broker diagnostics settings. ,
Required: False ,
}
{
logs:
{
Description: Diagnostic log settings for the resource. ,
Required: False ,
}
{
level:
{
Description: The log level. Examples - 'debug', 'info', 'warn', 'error', 'trace'. ,
Required: False ,
}
string ,
}
,
metrics:
{
Description: The metrics settings for the resource. ,
Required: False ,
}
{
prometheusPort:
{
Description: The prometheus port to expose the metrics. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
selfCheck:
{
Description: The self check properties. ,
Required: False ,
}
{
mode:
{
Description: The toggle to enable/disable self check. ,
Enum:
{
Enabled: Enabled is equivalent to True ,
Disabled: Disabled is equivalent to False. ,
}
,
Required: False ,
}
enum ,
intervalSeconds:
{
Description: The self check interval. ,
Format: int32 ,
Required: False ,
}
integer ,
timeoutSeconds:
{
Description: The timeout for self check. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
traces:
{
Description: The trace properties. ,
Required: False ,
}
{
mode:
{
Description: The toggle to enable/disable traces. ,
Enum:
{
Enabled: Enabled is equivalent to True ,
Disabled: Disabled is equivalent to False. ,
}
,
Required: False ,
}
enum ,
cacheSizeMegabytes:
{
Description: The cache size in megabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
selfTracing:
{
Description: The self tracing properties. ,
Required: False ,
}
{
mode:
{
Description: The toggle to enable/disable self tracing. ,
Enum:
{
Enabled: Enabled is equivalent to True ,
Disabled: Disabled is equivalent to False. ,
}
,
Required: False ,
}
enum ,
intervalSeconds:
{
Description: The self tracing interval. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
spanChannelCapacity:
{
Description: The span channel capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
diskBackedMessageBuffer:
{
Description: Settings of Disk Backed Message Buffer. ,
Required: False ,
}
{
maxSize:
{
Description: The max size of the message buffer on disk. If a PVC template is specified using one of ephemeralVolumeClaimSpec or persistentVolumeClaimSpec, then this size is used as the request and limit sizes of that template. If neither ephemeralVolumeClaimSpec nor persistentVolumeClaimSpec are specified, then an emptyDir volume is mounted with this size as its limit. See for details. ,
Required: True ,
}
string ,
ephemeralVolumeClaimSpec:
{
Description: Use the specified persistent volume claim template to mount a "generic ephemeral volume" for the message buffer. See for details. ,
Required: False ,
}
{
volumeName:
{
Description: VolumeName is the binding reference to the PersistentVolume backing this claim. ,
Required: False ,
}
string ,
volumeMode:
{
Description: volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. This is a beta feature. ,
Required: False ,
}
string ,
storageClassName:
{
Description: Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 ,
Required: False ,
}
string ,
accessModes:
{
Description: AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 ,
Required: False ,
}
[
string ,
]
,
dataSource:
{
Description: This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field. ,
Required: False ,
}
{
apiGroup:
{
Description: APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. ,
Required: False ,
}
string ,
kind:
{
Description: Kind is the type of resource being referenced ,
Required: True ,
}
string ,
name:
{
Description: Name is the name of resource being referenced ,
Required: True ,
}
string ,
}
,
dataSourceRef:
{
Description: Specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: * While DataSource only allows two specific types of objects, DataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While DataSource ignores disallowed values (dropping them), DataSourceRef preserves all values, and generates an error if a disallowed value is specified. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. ,
Required: False ,
}
{
apiGroup:
{
Description: APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. ,
Required: False ,
}
string ,
kind:
{
Description: Kind is the type of resource being referenced ,
Required: True ,
}
string ,
name:
{
Description: Name is the name of resource being referenced ,
Required: True ,
}
string ,
namespace:
{
Description: Namespace is the namespace of the resource being referenced. This field is required when the resource has a namespace. ,
Required: False ,
}
string ,
}
,
resources:
{
Description: Resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources ,
Required: False ,
}
{
limits:
{
Description: Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ ,
Required: False ,
}
object ,
requests:
{
Description: Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ ,
Required: False ,
}
object ,
}
,
selector:
{
Description: A label query over volumes to consider for binding. ,
Required: False ,
}
{
matchExpressions:
{
Description: MatchExpressions is a list of label selector requirements. The requirements are ANDed. ,
Required: False ,
}
[
{
key:
{
Description: key is the label key that the selector applies to. ,
Required: True ,
}
string ,
operator:
{
Description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. ,
Enum:
{
In: In operator. ,
NotIn: NotIn operator. ,
Exists: Exists operator. ,
DoesNotExist: DoesNotExist operator. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
matchLabels:
{
Description: MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. ,
Required: False ,
}
object ,
}
,
}
,
persistentVolumeClaimSpec:
{
Description: Use the specified persistent volume claim template to mount a persistent volume for the message buffer. ,
Required: False ,
}
{
volumeName:
{
Description: VolumeName is the binding reference to the PersistentVolume backing this claim. ,
Required: False ,
}
string ,
volumeMode:
{
Description: volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. This is a beta feature. ,
Required: False ,
}
string ,
storageClassName:
{
Description: Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 ,
Required: False ,
}
string ,
accessModes:
{
Description: AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 ,
Required: False ,
}
[
string ,
]
,
dataSource:
{
Description: This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field. ,
Required: False ,
}
{
apiGroup:
{
Description: APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. ,
Required: False ,
}
string ,
kind:
{
Description: Kind is the type of resource being referenced ,
Required: True ,
}
string ,
name:
{
Description: Name is the name of resource being referenced ,
Required: True ,
}
string ,
}
,
dataSourceRef:
{
Description: Specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: * While DataSource only allows two specific types of objects, DataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While DataSource ignores disallowed values (dropping them), DataSourceRef preserves all values, and generates an error if a disallowed value is specified. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. ,
Required: False ,
}
{
apiGroup:
{
Description: APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. ,
Required: False ,
}
string ,
kind:
{
Description: Kind is the type of resource being referenced ,
Required: True ,
}
string ,
name:
{
Description: Name is the name of resource being referenced ,
Required: True ,
}
string ,
namespace:
{
Description: Namespace is the namespace of the resource being referenced. This field is required when the resource has a namespace. ,
Required: False ,
}
string ,
}
,
resources:
{
Description: Resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources ,
Required: False ,
}
{
limits:
{
Description: Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ ,
Required: False ,
}
object ,
requests:
{
Description: Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ ,
Required: False ,
}
object ,
}
,
selector:
{
Description: A label query over volumes to consider for binding. ,
Required: False ,
}
{
matchExpressions:
{
Description: MatchExpressions is a list of label selector requirements. The requirements are ANDed. ,
Required: False ,
}
[
{
key:
{
Description: key is the label key that the selector applies to. ,
Required: True ,
}
string ,
operator:
{
Description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. ,
Enum:
{
In: In operator. ,
NotIn: NotIn operator. ,
Exists: Exists operator. ,
DoesNotExist: DoesNotExist operator. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
matchLabels:
{
Description: MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. ,
Required: False ,
}
object ,
}
,
}
,
}
,
generateResourceLimits:
{
Description: This setting controls whether Kubernetes CPU resource limits are requested. Increasing the number of replicas or workers proportionally increases the amount of CPU resources requested. If this setting is enabled and there are insufficient CPU resources, an error will be emitted. ,
Required: False ,
}
{
cpu:
{
Description: The toggle to enable/disable cpu resource limits. ,
Enum:
{
Enabled: Enabled is equivalent to True ,
Disabled: Disabled is equivalent to False. ,
}
,
Required: False ,
}
enum ,
}
,
memoryProfile:
{
Description: Memory profile of Broker. ,
Enum:
{
Tiny: Tiny memory profile. ,
Low: Low memory profile. ,
Medium: Medium memory profile. ,
High: High memory profile. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Resource is getting provisioned. ,
Updating: Resource is Updating. ,
Deleting: Resource is Deleting. ,
Accepted: Resource has been Accepted. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: Edge location of the resource. ,
Required: True ,
}
{
name:
{
Description: The name of the extended location. ,
Required: True ,
}
string ,
type:
{
Description: Type of ExtendedLocation. ,
Enum:
{
CustomLocation: CustomLocation type ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Broker_CreateOrUpdate (new)
Description :  Create a BrokerResource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/brokers/{brokerName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
instanceName:
{
Description: Name of instance. ,
Required: True ,
}
string ,
brokerName:
{
Description: Name of broker. ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
advanced:
{
Description: Advanced settings of Broker. ,
Required: False ,
}
{
clients:
{
Description: Configurations related to All Clients. ,
Required: False ,
}
{
maxSessionExpirySeconds:
{
Description: Upper bound of Session Expiry Interval, in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxMessageExpirySeconds:
{
Description: Upper bound of Message Expiry Interval, in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPacketSizeBytes:
{
Description: Max message size for a packet in Bytes. ,
Format: int32 ,
Required: False ,
}
integer ,
subscriberQueueLimit:
{
Description: The limit on the number of queued messages for a subscriber. ,
Required: False ,
}
{
length:
{
Description: The maximum length of the queue before messages start getting dropped. ,
Format: int64 ,
Required: False ,
}
integer ,
strategy:
{
Description: The strategy to use for dropping messages from the queue. ,
Enum:
{
None: Messages are never dropped. ,
DropOldest: The oldest message is dropped. ,
}
,
Required: False ,
}
enum ,
}
,
maxReceiveMaximum:
{
Description: Upper bound of Receive Maximum that a client can request in the CONNECT packet. ,
Format: int32 ,
Required: False ,
}
integer ,
maxKeepAliveSeconds:
{
Description: Upper bound of a client's Keep Alive, in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
encryptInternalTraffic:
{
Description: The setting to enable or disable encryption of internal Traffic. ,
Enum:
{
Enabled: Enabled is equivalent to True ,
Disabled: Disabled is equivalent to False. ,
}
,
Required: False ,
}
enum ,
internalCerts:
{
Description: Certificate rotation and private key configuration. ,
Required: False ,
}
{
duration:
{
Description: Lifetime of certificate. Must be specified using a Go time.Duration format (h|m|s). E.g. 240h for 240 hours and 45m for 45 minutes. ,
Required: True ,
}
string ,
renewBefore:
{
Description: When to begin renewing certificate. Must be specified using a Go time.Duration format (h|m|s). E.g. 240h for 240 hours and 45m for 45 minutes. ,
Required: True ,
}
string ,
privateKey:
{
Description: Configuration of certificate private key. ,
Required: True ,
}
{
algorithm:
{
Description: algorithm for private key. ,
Enum:
{
Ec256: Algorithm - ec256. ,
Ec384: Algorithm - ec384. ,
Ec521: Algorithm - ec521. ,
Ed25519: Algorithm - ed25519. ,
Rsa2048: Algorithm - rsa2048. ,
Rsa4096: Algorithm - rsa4096. ,
Rsa8192: Algorithm - rsa8192. ,
}
,
Required: True ,
}
enum ,
rotationPolicy:
{
Description: cert-manager private key rotationPolicy. ,
Enum:
{
Always: Rotation Policy - Always. ,
Never: Rotation Policy - Never. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
cardinality:
{
Description: The cardinality details of the broker. ,
Required: False ,
}
{
backendChain:
{
Description: The backend broker desired properties ,
Required: True ,
}
{
partitions:
{
Description: The desired number of physical backend partitions. ,
Format: int32 ,
Required: True ,
}
integer ,
redundancyFactor:
{
Description: The desired numbers of backend replicas (pods) in a physical partition. ,
Format: int32 ,
Required: True ,
}
integer ,
workers:
{
Description: Number of logical backend workers per replica (pod). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
frontend:
{
Description: The frontend desired properties ,
Required: True ,
}
{
replicas:
{
Description: The desired number of frontend instances (pods). ,
Format: int32 ,
Required: True ,
}
integer ,
workers:
{
Description: Number of logical frontend workers per instance (pod). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
diagnostics:
{
Description: Spec defines the desired identities of Broker diagnostics settings. ,
Required: False ,
}
{
logs:
{
Description: Diagnostic log settings for the resource. ,
Required: False ,
}
{
level:
{
Description: The log level. Examples - 'debug', 'info', 'warn', 'error', 'trace'. ,
Required: False ,
}
string ,
}
,
metrics:
{
Description: The metrics settings for the resource. ,
Required: False ,
}
{
prometheusPort:
{
Description: The prometheus port to expose the metrics. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
selfCheck:
{
Description: The self check properties. ,
Required: False ,
}
{
mode:
{
Description: The toggle to enable/disable self check. ,
Enum:
{
Enabled: Enabled is equivalent to True ,
Disabled: Disabled is equivalent to False. ,
}
,
Required: False ,
}
enum ,
intervalSeconds:
{
Description: The self check interval. ,
Format: int32 ,
Required: False ,
}
integer ,
timeoutSeconds:
{
Description: The timeout for self check. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
traces:
{
Description: The trace properties. ,
Required: False ,
}
{
mode:
{
Description: The toggle to enable/disable traces. ,
Enum:
{
Enabled: Enabled is equivalent to True ,
Disabled: Disabled is equivalent to False. ,
}
,
Required: False ,
}
enum ,
cacheSizeMegabytes:
{
Description: The cache size in megabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
selfTracing:
{
Description: The self tracing properties. ,
Required: False ,
}
{
mode:
{
Description: The toggle to enable/disable self tracing. ,
Enum:
{
Enabled: Enabled is equivalent to True ,
Disabled: Disabled is equivalent to False. ,
}
,
Required: False ,
}
enum ,
intervalSeconds:
{
Description: The self tracing interval. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
spanChannelCapacity:
{
Description: The span channel capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
diskBackedMessageBuffer:
{
Description: Settings of Disk Backed Message Buffer. ,
Required: False ,
}
{
maxSize:
{
Description: The max size of the message buffer on disk. If a PVC template is specified using one of ephemeralVolumeClaimSpec or persistentVolumeClaimSpec, then this size is used as the request and limit sizes of that template. If neither ephemeralVolumeClaimSpec nor persistentVolumeClaimSpec are specified, then an emptyDir volume is mounted with this size as its limit. See for details. ,
Required: True ,
}
string ,
ephemeralVolumeClaimSpec:
{
Description: Use the specified persistent volume claim template to mount a "generic ephemeral volume" for the message buffer. See for details. ,
Required: False ,
}
{
volumeName:
{
Description: VolumeName is the binding reference to the PersistentVolume backing this claim. ,
Required: False ,
}
string ,
volumeMode:
{
Description: volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. This is a beta feature. ,
Required: False ,
}
string ,
storageClassName:
{
Description: Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 ,
Required: False ,
}
string ,
accessModes:
{
Description: AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 ,
Required: False ,
}
[
string ,
]
,
dataSource:
{
Description: This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field. ,
Required: False ,
}
{
apiGroup:
{
Description: APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. ,
Required: False ,
}
string ,
kind:
{
Description: Kind is the type of resource being referenced ,
Required: True ,
}
string ,
name:
{
Description: Name is the name of resource being referenced ,
Required: True ,
}
string ,
}
,
dataSourceRef:
{
Description: Specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: * While DataSource only allows two specific types of objects, DataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While DataSource ignores disallowed values (dropping them), DataSourceRef preserves all values, and generates an error if a disallowed value is specified. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. ,
Required: False ,
}
{
apiGroup:
{
Description: APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. ,
Required: False ,
}
string ,
kind:
{
Description: Kind is the type of resource being referenced ,
Required: True ,
}
string ,
name:
{
Description: Name is the name of resource being referenced ,
Required: True ,
}
string ,
namespace:
{
Description: Namespace is the namespace of the resource being referenced. This field is required when the resource has a namespace. ,
Required: False ,
}
string ,
}
,
resources:
{
Description: Resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources ,
Required: False ,
}
{
limits:
{
Description: Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ ,
Required: False ,
}
object ,
requests:
{
Description: Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ ,
Required: False ,
}
object ,
}
,
selector:
{
Description: A label query over volumes to consider for binding. ,
Required: False ,
}
{
matchExpressions:
{
Description: MatchExpressions is a list of label selector requirements. The requirements are ANDed. ,
Required: False ,
}
[
{
key:
{
Description: key is the label key that the selector applies to. ,
Required: True ,
}
string ,
operator:
{
Description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. ,
Enum:
{
In: In operator. ,
NotIn: NotIn operator. ,
Exists: Exists operator. ,
DoesNotExist: DoesNotExist operator. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
matchLabels:
{
Description: MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. ,
Required: False ,
}
object ,
}
,
}
,
persistentVolumeClaimSpec:
{
Description: Use the specified persistent volume claim template to mount a persistent volume for the message buffer. ,
Required: False ,
}
{
volumeName:
{
Description: VolumeName is the binding reference to the PersistentVolume backing this claim. ,
Required: False ,
}
string ,
volumeMode:
{
Description: volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. This is a beta feature. ,
Required: False ,
}
string ,
storageClassName:
{
Description: Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 ,
Required: False ,
}
string ,
accessModes:
{
Description: AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 ,
Required: False ,
}
[
string ,
]
,
dataSource:
{
Description: This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field. ,
Required: False ,
}
{
apiGroup:
{
Description: APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. ,
Required: False ,
}
string ,
kind:
{
Description: Kind is the type of resource being referenced ,
Required: True ,
}
string ,
name:
{
Description: Name is the name of resource being referenced ,
Required: True ,
}
string ,
}
,
dataSourceRef:
{
Description: Specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: * While DataSource only allows two specific types of objects, DataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While DataSource ignores disallowed values (dropping them), DataSourceRef preserves all values, and generates an error if a disallowed value is specified. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. ,
Required: False ,
}
{
apiGroup:
{
Description: APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. ,
Required: False ,
}
string ,
kind:
{
Description: Kind is the type of resource being referenced ,
Required: True ,
}
string ,
name:
{
Description: Name is the name of resource being referenced ,
Required: True ,
}
string ,
namespace:
{
Description: Namespace is the namespace of the resource being referenced. This field is required when the resource has a namespace. ,
Required: False ,
}
string ,
}
,
resources:
{
Description: Resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources ,
Required: False ,
}
{
limits:
{
Description: Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ ,
Required: False ,
}
object ,
requests:
{
Description: Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ ,
Required: False ,
}
object ,
}
,
selector:
{
Description: A label query over volumes to consider for binding. ,
Required: False ,
}
{
matchExpressions:
{
Description: MatchExpressions is a list of label selector requirements. The requirements are ANDed. ,
Required: False ,
}
[
{
key:
{
Description: key is the label key that the selector applies to. ,
Required: True ,
}
string ,
operator:
{
Description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. ,
Enum:
{
In: In operator. ,
NotIn: NotIn operator. ,
Exists: Exists operator. ,
DoesNotExist: DoesNotExist operator. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
matchLabels:
{
Description: MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. ,
Required: False ,
}
object ,
}
,
}
,
}
,
generateResourceLimits:
{
Description: This setting controls whether Kubernetes CPU resource limits are requested. Increasing the number of replicas or workers proportionally increases the amount of CPU resources requested. If this setting is enabled and there are insufficient CPU resources, an error will be emitted. ,
Required: False ,
}
{
cpu:
{
Description: The toggle to enable/disable cpu resource limits. ,
Enum:
{
Enabled: Enabled is equivalent to True ,
Disabled: Disabled is equivalent to False. ,
}
,
Required: False ,
}
enum ,
}
,
memoryProfile:
{
Description: Memory profile of Broker. ,
Enum:
{
Tiny: Tiny memory profile. ,
Low: Low memory profile. ,
Medium: Medium memory profile. ,
High: High memory profile. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Resource is getting provisioned. ,
Updating: Resource is Updating. ,
Deleting: Resource is Deleting. ,
Accepted: Resource has been Accepted. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: Edge location of the resource. ,
Required: True ,
}
{
name:
{
Description: The name of the extended location. ,
Required: True ,
}
string ,
type:
{
Description: Type of ExtendedLocation. ,
Enum:
{
CustomLocation: CustomLocation type ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
advanced:
{
Description: Advanced settings of Broker. ,
Required: False ,
}
{
clients:
{
Description: Configurations related to All Clients. ,
Required: False ,
}
{
maxSessionExpirySeconds:
{
Description: Upper bound of Session Expiry Interval, in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxMessageExpirySeconds:
{
Description: Upper bound of Message Expiry Interval, in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPacketSizeBytes:
{
Description: Max message size for a packet in Bytes. ,
Format: int32 ,
Required: False ,
}
integer ,
subscriberQueueLimit:
{
Description: The limit on the number of queued messages for a subscriber. ,
Required: False ,
}
{
length:
{
Description: The maximum length of the queue before messages start getting dropped. ,
Format: int64 ,
Required: False ,
}
integer ,
strategy:
{
Description: The strategy to use for dropping messages from the queue. ,
Enum:
{
None: Messages are never dropped. ,
DropOldest: The oldest message is dropped. ,
}
,
Required: False ,
}
enum ,
}
,
maxReceiveMaximum:
{
Description: Upper bound of Receive Maximum that a client can request in the CONNECT packet. ,
Format: int32 ,
Required: False ,
}
integer ,
maxKeepAliveSeconds:
{
Description: Upper bound of a client's Keep Alive, in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
encryptInternalTraffic:
{
Description: The setting to enable or disable encryption of internal Traffic. ,
Enum:
{
Enabled: Enabled is equivalent to True ,
Disabled: Disabled is equivalent to False. ,
}
,
Required: False ,
}
enum ,
internalCerts:
{
Description: Certificate rotation and private key configuration. ,
Required: False ,
}
{
duration:
{
Description: Lifetime of certificate. Must be specified using a Go time.Duration format (h|m|s). E.g. 240h for 240 hours and 45m for 45 minutes. ,
Required: True ,
}
string ,
renewBefore:
{
Description: When to begin renewing certificate. Must be specified using a Go time.Duration format (h|m|s). E.g. 240h for 240 hours and 45m for 45 minutes. ,
Required: True ,
}
string ,
privateKey:
{
Description: Configuration of certificate private key. ,
Required: True ,
}
{
algorithm:
{
Description: algorithm for private key. ,
Enum:
{
Ec256: Algorithm - ec256. ,
Ec384: Algorithm - ec384. ,
Ec521: Algorithm - ec521. ,
Ed25519: Algorithm - ed25519. ,
Rsa2048: Algorithm - rsa2048. ,
Rsa4096: Algorithm - rsa4096. ,
Rsa8192: Algorithm - rsa8192. ,
}
,
Required: True ,
}
enum ,
rotationPolicy:
{
Description: cert-manager private key rotationPolicy. ,
Enum:
{
Always: Rotation Policy - Always. ,
Never: Rotation Policy - Never. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
cardinality:
{
Description: The cardinality details of the broker. ,
Required: False ,
}
{
backendChain:
{
Description: The backend broker desired properties ,
Required: True ,
}
{
partitions:
{
Description: The desired number of physical backend partitions. ,
Format: int32 ,
Required: True ,
}
integer ,
redundancyFactor:
{
Description: The desired numbers of backend replicas (pods) in a physical partition. ,
Format: int32 ,
Required: True ,
}
integer ,
workers:
{
Description: Number of logical backend workers per replica (pod). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
frontend:
{
Description: The frontend desired properties ,
Required: True ,
}
{
replicas:
{
Description: The desired number of frontend instances (pods). ,
Format: int32 ,
Required: True ,
}
integer ,
workers:
{
Description: Number of logical frontend workers per instance (pod). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
diagnostics:
{
Description: Spec defines the desired identities of Broker diagnostics settings. ,
Required: False ,
}
{
logs:
{
Description: Diagnostic log settings for the resource. ,
Required: False ,
}
{
level:
{
Description: The log level. Examples - 'debug', 'info', 'warn', 'error', 'trace'. ,
Required: False ,
}
string ,
}
,
metrics:
{
Description: The metrics settings for the resource. ,
Required: False ,
}
{
prometheusPort:
{
Description: The prometheus port to expose the metrics. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
selfCheck:
{
Description: The self check properties. ,
Required: False ,
}
{
mode:
{
Description: The toggle to enable/disable self check. ,
Enum:
{
Enabled: Enabled is equivalent to True ,
Disabled: Disabled is equivalent to False. ,
}
,
Required: False ,
}
enum ,
intervalSeconds:
{
Description: The self check interval. ,
Format: int32 ,
Required: False ,
}
integer ,
timeoutSeconds:
{
Description: The timeout for self check. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
traces:
{
Description: The trace properties. ,
Required: False ,
}
{
mode:
{
Description: The toggle to enable/disable traces. ,
Enum:
{
Enabled: Enabled is equivalent to True ,
Disabled: Disabled is equivalent to False. ,
}
,
Required: False ,
}
enum ,
cacheSizeMegabytes:
{
Description: The cache size in megabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
selfTracing:
{
Description: The self tracing properties. ,
Required: False ,
}
{
mode:
{
Description: The toggle to enable/disable self tracing. ,
Enum:
{
Enabled: Enabled is equivalent to True ,
Disabled: Disabled is equivalent to False. ,
}
,
Required: False ,
}
enum ,
intervalSeconds:
{
Description: The self tracing interval. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
spanChannelCapacity:
{
Description: The span channel capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
diskBackedMessageBuffer:
{
Description: Settings of Disk Backed Message Buffer. ,
Required: False ,
}
{
maxSize:
{
Description: The max size of the message buffer on disk. If a PVC template is specified using one of ephemeralVolumeClaimSpec or persistentVolumeClaimSpec, then this size is used as the request and limit sizes of that template. If neither ephemeralVolumeClaimSpec nor persistentVolumeClaimSpec are specified, then an emptyDir volume is mounted with this size as its limit. See for details. ,
Required: True ,
}
string ,
ephemeralVolumeClaimSpec:
{
Description: Use the specified persistent volume claim template to mount a "generic ephemeral volume" for the message buffer. See for details. ,
Required: False ,
}
{
volumeName:
{
Description: VolumeName is the binding reference to the PersistentVolume backing this claim. ,
Required: False ,
}
string ,
volumeMode:
{
Description: volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. This is a beta feature. ,
Required: False ,
}
string ,
storageClassName:
{
Description: Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 ,
Required: False ,
}
string ,
accessModes:
{
Description: AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 ,
Required: False ,
}
[
string ,
]
,
dataSource:
{
Description: This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field. ,
Required: False ,
}
{
apiGroup:
{
Description: APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. ,
Required: False ,
}
string ,
kind:
{
Description: Kind is the type of resource being referenced ,
Required: True ,
}
string ,
name:
{
Description: Name is the name of resource being referenced ,
Required: True ,
}
string ,
}
,
dataSourceRef:
{
Description: Specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: * While DataSource only allows two specific types of objects, DataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While DataSource ignores disallowed values (dropping them), DataSourceRef preserves all values, and generates an error if a disallowed value is specified. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. ,
Required: False ,
}
{
apiGroup:
{
Description: APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. ,
Required: False ,
}
string ,
kind:
{
Description: Kind is the type of resource being referenced ,
Required: True ,
}
string ,
name:
{
Description: Name is the name of resource being referenced ,
Required: True ,
}
string ,
namespace:
{
Description: Namespace is the namespace of the resource being referenced. This field is required when the resource has a namespace. ,
Required: False ,
}
string ,
}
,
resources:
{
Description: Resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources ,
Required: False ,
}
{
limits:
{
Description: Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ ,
Required: False ,
}
object ,
requests:
{
Description: Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ ,
Required: False ,
}
object ,
}
,
selector:
{
Description: A label query over volumes to consider for binding. ,
Required: False ,
}
{
matchExpressions:
{
Description: MatchExpressions is a list of label selector requirements. The requirements are ANDed. ,
Required: False ,
}
[
{
key:
{
Description: key is the label key that the selector applies to. ,
Required: True ,
}
string ,
operator:
{
Description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. ,
Enum:
{
In: In operator. ,
NotIn: NotIn operator. ,
Exists: Exists operator. ,
DoesNotExist: DoesNotExist operator. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
matchLabels:
{
Description: MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. ,
Required: False ,
}
object ,
}
,
}
,
persistentVolumeClaimSpec:
{
Description: Use the specified persistent volume claim template to mount a persistent volume for the message buffer. ,
Required: False ,
}
{
volumeName:
{
Description: VolumeName is the binding reference to the PersistentVolume backing this claim. ,
Required: False ,
}
string ,
volumeMode:
{
Description: volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. This is a beta feature. ,
Required: False ,
}
string ,
storageClassName:
{
Description: Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 ,
Required: False ,
}
string ,
accessModes:
{
Description: AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 ,
Required: False ,
}
[
string ,
]
,
dataSource:
{
Description: This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field. ,
Required: False ,
}
{
apiGroup:
{
Description: APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. ,
Required: False ,
}
string ,
kind:
{
Description: Kind is the type of resource being referenced ,
Required: True ,
}
string ,
name:
{
Description: Name is the name of resource being referenced ,
Required: True ,
}
string ,
}
,
dataSourceRef:
{
Description: Specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: * While DataSource only allows two specific types of objects, DataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While DataSource ignores disallowed values (dropping them), DataSourceRef preserves all values, and generates an error if a disallowed value is specified. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. ,
Required: False ,
}
{
apiGroup:
{
Description: APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. ,
Required: False ,
}
string ,
kind:
{
Description: Kind is the type of resource being referenced ,
Required: True ,
}
string ,
name:
{
Description: Name is the name of resource being referenced ,
Required: True ,
}
string ,
namespace:
{
Description: Namespace is the namespace of the resource being referenced. This field is required when the resource has a namespace. ,
Required: False ,
}
string ,
}
,
resources:
{
Description: Resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources ,
Required: False ,
}
{
limits:
{
Description: Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ ,
Required: False ,
}
object ,
requests:
{
Description: Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ ,
Required: False ,
}
object ,
}
,
selector:
{
Description: A label query over volumes to consider for binding. ,
Required: False ,
}
{
matchExpressions:
{
Description: MatchExpressions is a list of label selector requirements. The requirements are ANDed. ,
Required: False ,
}
[
{
key:
{
Description: key is the label key that the selector applies to. ,
Required: True ,
}
string ,
operator:
{
Description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. ,
Enum:
{
In: In operator. ,
NotIn: NotIn operator. ,
Exists: Exists operator. ,
DoesNotExist: DoesNotExist operator. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
matchLabels:
{
Description: MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. ,
Required: False ,
}
object ,
}
,
}
,
}
,
generateResourceLimits:
{
Description: This setting controls whether Kubernetes CPU resource limits are requested. Increasing the number of replicas or workers proportionally increases the amount of CPU resources requested. If this setting is enabled and there are insufficient CPU resources, an error will be emitted. ,
Required: False ,
}
{
cpu:
{
Description: The toggle to enable/disable cpu resource limits. ,
Enum:
{
Enabled: Enabled is equivalent to True ,
Disabled: Disabled is equivalent to False. ,
}
,
Required: False ,
}
enum ,
}
,
memoryProfile:
{
Description: Memory profile of Broker. ,
Enum:
{
Tiny: Tiny memory profile. ,
Low: Low memory profile. ,
Medium: Medium memory profile. ,
High: High memory profile. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Resource is getting provisioned. ,
Updating: Resource is Updating. ,
Deleting: Resource is Deleting. ,
Accepted: Resource has been Accepted. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: Edge location of the resource. ,
Required: True ,
}
{
name:
{
Description: The name of the extended location. ,
Required: True ,
}
string ,
type:
{
Description: Type of ExtendedLocation. ,
Enum:
{
CustomLocation: CustomLocation type ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Instance broker resource ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
advanced:
{
Description: Advanced settings of Broker. ,
Required: False ,
}
{
clients:
{
Description: Configurations related to All Clients. ,
Required: False ,
}
{
maxSessionExpirySeconds:
{
Description: Upper bound of Session Expiry Interval, in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxMessageExpirySeconds:
{
Description: Upper bound of Message Expiry Interval, in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxPacketSizeBytes:
{
Description: Max message size for a packet in Bytes. ,
Format: int32 ,
Required: False ,
}
integer ,
subscriberQueueLimit:
{
Description: The limit on the number of queued messages for a subscriber. ,
Required: False ,
}
{
length:
{
Description: The maximum length of the queue before messages start getting dropped. ,
Format: int64 ,
Required: False ,
}
integer ,
strategy:
{
Description: The strategy to use for dropping messages from the queue. ,
Enum:
{
None: Messages are never dropped. ,
DropOldest: The oldest message is dropped. ,
}
,
Required: False ,
}
enum ,
}
,
maxReceiveMaximum:
{
Description: Upper bound of Receive Maximum that a client can request in the CONNECT packet. ,
Format: int32 ,
Required: False ,
}
integer ,
maxKeepAliveSeconds:
{
Description: Upper bound of a client's Keep Alive, in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
encryptInternalTraffic:
{
Description: The setting to enable or disable encryption of internal Traffic. ,
Enum:
{
Enabled: Enabled is equivalent to True ,
Disabled: Disabled is equivalent to False. ,
}
,
Required: False ,
}
enum ,
internalCerts:
{
Description: Certificate rotation and private key configuration. ,
Required: False ,
}
{
duration:
{
Description: Lifetime of certificate. Must be specified using a Go time.Duration format (h|m|s). E.g. 240h for 240 hours and 45m for 45 minutes. ,
Required: True ,
}
string ,
renewBefore:
{
Description: When to begin renewing certificate. Must be specified using a Go time.Duration format (h|m|s). E.g. 240h for 240 hours and 45m for 45 minutes. ,
Required: True ,
}
string ,
privateKey:
{
Description: Configuration of certificate private key. ,
Required: True ,
}
{
algorithm:
{
Description: algorithm for private key. ,
Enum:
{
Ec256: Algorithm - ec256. ,
Ec384: Algorithm - ec384. ,
Ec521: Algorithm - ec521. ,
Ed25519: Algorithm - ed25519. ,
Rsa2048: Algorithm - rsa2048. ,
Rsa4096: Algorithm - rsa4096. ,
Rsa8192: Algorithm - rsa8192. ,
}
,
Required: True ,
}
enum ,
rotationPolicy:
{
Description: cert-manager private key rotationPolicy. ,
Enum:
{
Always: Rotation Policy - Always. ,
Never: Rotation Policy - Never. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}
,
cardinality:
{
Description: The cardinality details of the broker. ,
Required: False ,
}
{
backendChain:
{
Description: The backend broker desired properties ,
Required: True ,
}
{
partitions:
{
Description: The desired number of physical backend partitions. ,
Format: int32 ,
Required: True ,
}
integer ,
redundancyFactor:
{
Description: The desired numbers of backend replicas (pods) in a physical partition. ,
Format: int32 ,
Required: True ,
}
integer ,
workers:
{
Description: Number of logical backend workers per replica (pod). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
frontend:
{
Description: The frontend desired properties ,
Required: True ,
}
{
replicas:
{
Description: The desired number of frontend instances (pods). ,
Format: int32 ,
Required: True ,
}
integer ,
workers:
{
Description: Number of logical frontend workers per instance (pod). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
diagnostics:
{
Description: Spec defines the desired identities of Broker diagnostics settings. ,
Required: False ,
}
{
logs:
{
Description: Diagnostic log settings for the resource. ,
Required: False ,
}
{
level:
{
Description: The log level. Examples - 'debug', 'info', 'warn', 'error', 'trace'. ,
Required: False ,
}
string ,
}
,
metrics:
{
Description: The metrics settings for the resource. ,
Required: False ,
}
{
prometheusPort:
{
Description: The prometheus port to expose the metrics. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
selfCheck:
{
Description: The self check properties. ,
Required: False ,
}
{
mode:
{
Description: The toggle to enable/disable self check. ,
Enum:
{
Enabled: Enabled is equivalent to True ,
Disabled: Disabled is equivalent to False. ,
}
,
Required: False ,
}
enum ,
intervalSeconds:
{
Description: The self check interval. ,
Format: int32 ,
Required: False ,
}
integer ,
timeoutSeconds:
{
Description: The timeout for self check. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
traces:
{
Description: The trace properties. ,
Required: False ,
}
{
mode:
{
Description: The toggle to enable/disable traces. ,
Enum:
{
Enabled: Enabled is equivalent to True ,
Disabled: Disabled is equivalent to False. ,
}
,
Required: False ,
}
enum ,
cacheSizeMegabytes:
{
Description: The cache size in megabytes. ,
Format: int32 ,
Required: False ,
}
integer ,
selfTracing:
{
Description: The self tracing properties. ,
Required: False ,
}
{
mode:
{
Description: The toggle to enable/disable self tracing. ,
Enum:
{
Enabled: Enabled is equivalent to True ,
Disabled: Disabled is equivalent to False. ,
}
,
Required: False ,
}
enum ,
intervalSeconds:
{
Description: The self tracing interval. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
spanChannelCapacity:
{
Description: The span channel capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
diskBackedMessageBuffer:
{
Description: Settings of Disk Backed Message Buffer. ,
Required: False ,
}
{
maxSize:
{
Description: The max size of the message buffer on disk. If a PVC template is specified using one of ephemeralVolumeClaimSpec or persistentVolumeClaimSpec, then this size is used as the request and limit sizes of that template. If neither ephemeralVolumeClaimSpec nor persistentVolumeClaimSpec are specified, then an emptyDir volume is mounted with this size as its limit. See for details. ,
Required: True ,
}
string ,
ephemeralVolumeClaimSpec:
{
Description: Use the specified persistent volume claim template to mount a "generic ephemeral volume" for the message buffer. See for details. ,
Required: False ,
}
{
volumeName:
{
Description: VolumeName is the binding reference to the PersistentVolume backing this claim. ,
Required: False ,
}
string ,
volumeMode:
{
Description: volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. This is a beta feature. ,
Required: False ,
}
string ,
storageClassName:
{
Description: Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 ,
Required: False ,
}
string ,
accessModes:
{
Description: AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 ,
Required: False ,
}
[
string ,
]
,
dataSource:
{
Description: This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field. ,
Required: False ,
}
{
apiGroup:
{
Description: APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. ,
Required: False ,
}
string ,
kind:
{
Description: Kind is the type of resource being referenced ,
Required: True ,
}
string ,
name:
{
Description: Name is the name of resource being referenced ,
Required: True ,
}
string ,
}
,
dataSourceRef:
{
Description: Specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: * While DataSource only allows two specific types of objects, DataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While DataSource ignores disallowed values (dropping them), DataSourceRef preserves all values, and generates an error if a disallowed value is specified. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. ,
Required: False ,
}
{
apiGroup:
{
Description: APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. ,
Required: False ,
}
string ,
kind:
{
Description: Kind is the type of resource being referenced ,
Required: True ,
}
string ,
name:
{
Description: Name is the name of resource being referenced ,
Required: True ,
}
string ,
namespace:
{
Description: Namespace is the namespace of the resource being referenced. This field is required when the resource has a namespace. ,
Required: False ,
}
string ,
}
,
resources:
{
Description: Resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources ,
Required: False ,
}
{
limits:
{
Description: Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ ,
Required: False ,
}
object ,
requests:
{
Description: Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ ,
Required: False ,
}
object ,
}
,
selector:
{
Description: A label query over volumes to consider for binding. ,
Required: False ,
}
{
matchExpressions:
{
Description: MatchExpressions is a list of label selector requirements. The requirements are ANDed. ,
Required: False ,
}
[
{
key:
{
Description: key is the label key that the selector applies to. ,
Required: True ,
}
string ,
operator:
{
Description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. ,
Enum:
{
In: In operator. ,
NotIn: NotIn operator. ,
Exists: Exists operator. ,
DoesNotExist: DoesNotExist operator. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
matchLabels:
{
Description: MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. ,
Required: False ,
}
object ,
}
,
}
,
persistentVolumeClaimSpec:
{
Description: Use the specified persistent volume claim template to mount a persistent volume for the message buffer. ,
Required: False ,
}
{
volumeName:
{
Description: VolumeName is the binding reference to the PersistentVolume backing this claim. ,
Required: False ,
}
string ,
volumeMode:
{
Description: volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. This is a beta feature. ,
Required: False ,
}
string ,
storageClassName:
{
Description: Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 ,
Required: False ,
}
string ,
accessModes:
{
Description: AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 ,
Required: False ,
}
[
string ,
]
,
dataSource:
{
Description: This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field. ,
Required: False ,
}
{
apiGroup:
{
Description: APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. ,
Required: False ,
}
string ,
kind:
{
Description: Kind is the type of resource being referenced ,
Required: True ,
}
string ,
name:
{
Description: Name is the name of resource being referenced ,
Required: True ,
}
string ,
}
,
dataSourceRef:
{
Description: Specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: * While DataSource only allows two specific types of objects, DataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While DataSource ignores disallowed values (dropping them), DataSourceRef preserves all values, and generates an error if a disallowed value is specified. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. ,
Required: False ,
}
{
apiGroup:
{
Description: APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. ,
Required: False ,
}
string ,
kind:
{
Description: Kind is the type of resource being referenced ,
Required: True ,
}
string ,
name:
{
Description: Name is the name of resource being referenced ,
Required: True ,
}
string ,
namespace:
{
Description: Namespace is the namespace of the resource being referenced. This field is required when the resource has a namespace. ,
Required: False ,
}
string ,
}
,
resources:
{
Description: Resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources ,
Required: False ,
}
{
limits:
{
Description: Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ ,
Required: False ,
}
object ,
requests:
{
Description: Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ ,
Required: False ,
}
object ,
}
,
selector:
{
Description: A label query over volumes to consider for binding. ,
Required: False ,
}
{
matchExpressions:
{
Description: MatchExpressions is a list of label selector requirements. The requirements are ANDed. ,
Required: False ,
}
[
{
key:
{
Description: key is the label key that the selector applies to. ,
Required: True ,
}
string ,
operator:
{
Description: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. ,
Enum:
{
In: In operator. ,
NotIn: NotIn operator. ,
Exists: Exists operator. ,
DoesNotExist: DoesNotExist operator. ,
}
,
Required: True ,
}
enum ,
values:
{
Description: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
matchLabels:
{
Description: MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. ,
Required: False ,
}
object ,
}
,
}
,
}
,
generateResourceLimits:
{
Description: This setting controls whether Kubernetes CPU resource limits are requested. Increasing the number of replicas or workers proportionally increases the amount of CPU resources requested. If this setting is enabled and there are insufficient CPU resources, an error will be emitted. ,
Required: False ,
}
{
cpu:
{
Description: The toggle to enable/disable cpu resource limits. ,
Enum:
{
Enabled: Enabled is equivalent to True ,
Disabled: Disabled is equivalent to False. ,
}
,
Required: False ,
}
enum ,
}
,
memoryProfile:
{
Description: Memory profile of Broker. ,
Enum:
{
Tiny: Tiny memory profile. ,
Low: Low memory profile. ,
Medium: Medium memory profile. ,
High: High memory profile. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Resource is getting provisioned. ,
Updating: Resource is Updating. ,
Deleting: Resource is Deleting. ,
Accepted: Resource has been Accepted. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: Edge location of the resource. ,
Required: True ,
}
{
name:
{
Description: The name of the extended location. ,
Required: True ,
}
string ,
type:
{
Description: Type of ExtendedLocation. ,
Enum:
{
CustomLocation: CustomLocation type ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Broker_Delete (new)
Description :  Delete a BrokerResource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/brokers/{brokerName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
instanceName:
{
Description: Name of instance. ,
Required: True ,
}
string ,
brokerName:
{
Description: Name of broker. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BrokerAuthentication_ListByResourceGroup (new)
Description :  List BrokerAuthenticationResource resources by BrokerResource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/brokers/{brokerName}/authentications
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
instanceName:
{
Description: Name of instance. ,
Required: True ,
}
string ,
brokerName:
{
Description: Name of broker. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The BrokerAuthenticationResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
authenticationMethods:
{
Description: Defines a set of Broker authentication methods to be used on `BrokerListeners`. For each array element one authenticator type supported. ,
Required: True ,
}
[
{
method:
{
Description: Custom authentication configuration. ,
Enum:
{
Custom: Custom authentication configuration. ,
ServiceAccountToken: ServiceAccountToken authentication configuration. ,
X509: X.509 authentication configuration. ,
}
,
Required: True ,
}
enum ,
customSettings:
{
Description: Custom authentication configuration. ,
Required: False ,
}
{
auth:
{
Description: Optional authentication needed for authenticating with the custom authentication server. ,
Required: False ,
}
{
x509:
{
Description: X509 Custom Auth type details. ,
Required: True ,
}
{
secretRef:
{
Description: Kubernetes secret containing an X.509 client certificate. This is a reference to the secret through an identifying name, not the secret itself. ,
Required: True ,
}
string ,
}
,
}
,
caCertConfigMap:
{
Description: Optional CA certificate for validating the custom authentication server's certificate. ,
Required: False ,
}
string ,
endpoint:
{
Description: Endpoint of the custom authentication server. Must be an HTTPS endpoint. ,
Format: uri ,
Required: True ,
}
string ,
headers:
{
Description: Additional HTTP headers to pass to the custom authentication server. ,
Required: False ,
}
object ,
}
,
serviceAccountTokenSettings:
{
Description: ServiceAccountToken authentication configuration. ,
Required: False ,
}
{
audiences:
{
Description: List of allowed audience. ,
Required: True ,
}
[
string ,
]
,
}
,
x509Settings:
{
Description: X.509 authentication configuration. ,
Required: False ,
}
{
authorizationAttributes:
{
Description: X509 authorization attributes properties. ,
Required: False ,
}
object ,
trustedClientCaCert:
{
Description: Name of the trusted client ca cert resource. ,
Required: False ,
}
string ,
}
,
}
,
]
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Resource is getting provisioned. ,
Updating: Resource is Updating. ,
Deleting: Resource is Deleting. ,
Accepted: Resource has been Accepted. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: Edge location of the resource. ,
Required: True ,
}
{
name:
{
Description: The name of the extended location. ,
Required: True ,
}
string ,
type:
{
Description: Type of ExtendedLocation. ,
Enum:
{
CustomLocation: CustomLocation type ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BrokerAuthentication_Get (new)
Description :  Get a BrokerAuthenticationResource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/brokers/{brokerName}/authentications/{authenticationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
instanceName:
{
Description: Name of instance. ,
Required: True ,
}
string ,
brokerName:
{
Description: Name of broker. ,
Required: True ,
}
string ,
authenticationName:
{
Description: Name of Instance broker authentication resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
authenticationMethods:
{
Description: Defines a set of Broker authentication methods to be used on `BrokerListeners`. For each array element one authenticator type supported. ,
Required: True ,
}
[
{
method:
{
Description: Custom authentication configuration. ,
Enum:
{
Custom: Custom authentication configuration. ,
ServiceAccountToken: ServiceAccountToken authentication configuration. ,
X509: X.509 authentication configuration. ,
}
,
Required: True ,
}
enum ,
customSettings:
{
Description: Custom authentication configuration. ,
Required: False ,
}
{
auth:
{
Description: Optional authentication needed for authenticating with the custom authentication server. ,
Required: False ,
}
{
x509:
{
Description: X509 Custom Auth type details. ,
Required: True ,
}
{
secretRef:
{
Description: Kubernetes secret containing an X.509 client certificate. This is a reference to the secret through an identifying name, not the secret itself. ,
Required: True ,
}
string ,
}
,
}
,
caCertConfigMap:
{
Description: Optional CA certificate for validating the custom authentication server's certificate. ,
Required: False ,
}
string ,
endpoint:
{
Description: Endpoint of the custom authentication server. Must be an HTTPS endpoint. ,
Format: uri ,
Required: True ,
}
string ,
headers:
{
Description: Additional HTTP headers to pass to the custom authentication server. ,
Required: False ,
}
object ,
}
,
serviceAccountTokenSettings:
{
Description: ServiceAccountToken authentication configuration. ,
Required: False ,
}
{
audiences:
{
Description: List of allowed audience. ,
Required: True ,
}
[
string ,
]
,
}
,
x509Settings:
{
Description: X.509 authentication configuration. ,
Required: False ,
}
{
authorizationAttributes:
{
Description: X509 authorization attributes properties. ,
Required: False ,
}
object ,
trustedClientCaCert:
{
Description: Name of the trusted client ca cert resource. ,
Required: False ,
}
string ,
}
,
}
,
]
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Resource is getting provisioned. ,
Updating: Resource is Updating. ,
Deleting: Resource is Deleting. ,
Accepted: Resource has been Accepted. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: Edge location of the resource. ,
Required: True ,
}
{
name:
{
Description: The name of the extended location. ,
Required: True ,
}
string ,
type:
{
Description: Type of ExtendedLocation. ,
Enum:
{
CustomLocation: CustomLocation type ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BrokerAuthentication_CreateOrUpdate (new)
Description :  Create a BrokerAuthenticationResource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/brokers/{brokerName}/authentications/{authenticationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
instanceName:
{
Description: Name of instance. ,
Required: True ,
}
string ,
brokerName:
{
Description: Name of broker. ,
Required: True ,
}
string ,
authenticationName:
{
Description: Name of Instance broker authentication resource ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
authenticationMethods:
{
Description: Defines a set of Broker authentication methods to be used on `BrokerListeners`. For each array element one authenticator type supported. ,
Required: True ,
}
[
{
method:
{
Description: Custom authentication configuration. ,
Enum:
{
Custom: Custom authentication configuration. ,
ServiceAccountToken: ServiceAccountToken authentication configuration. ,
X509: X.509 authentication configuration. ,
}
,
Required: True ,
}
enum ,
customSettings:
{
Description: Custom authentication configuration. ,
Required: False ,
}
{
auth:
{
Description: Optional authentication needed for authenticating with the custom authentication server. ,
Required: False ,
}
{
x509:
{
Description: X509 Custom Auth type details. ,
Required: True ,
}
{
secretRef:
{
Description: Kubernetes secret containing an X.509 client certificate. This is a reference to the secret through an identifying name, not the secret itself. ,
Required: True ,
}
string ,
}
,
}
,
caCertConfigMap:
{
Description: Optional CA certificate for validating the custom authentication server's certificate. ,
Required: False ,
}
string ,
endpoint:
{
Description: Endpoint of the custom authentication server. Must be an HTTPS endpoint. ,
Format: uri ,
Required: True ,
}
string ,
headers:
{
Description: Additional HTTP headers to pass to the custom authentication server. ,
Required: False ,
}
object ,
}
,
serviceAccountTokenSettings:
{
Description: ServiceAccountToken authentication configuration. ,
Required: False ,
}
{
audiences:
{
Description: List of allowed audience. ,
Required: True ,
}
[
string ,
]
,
}
,
x509Settings:
{
Description: X.509 authentication configuration. ,
Required: False ,
}
{
authorizationAttributes:
{
Description: X509 authorization attributes properties. ,
Required: False ,
}
object ,
trustedClientCaCert:
{
Description: Name of the trusted client ca cert resource. ,
Required: False ,
}
string ,
}
,
}
,
]
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Resource is getting provisioned. ,
Updating: Resource is Updating. ,
Deleting: Resource is Deleting. ,
Accepted: Resource has been Accepted. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: Edge location of the resource. ,
Required: True ,
}
{
name:
{
Description: The name of the extended location. ,
Required: True ,
}
string ,
type:
{
Description: Type of ExtendedLocation. ,
Enum:
{
CustomLocation: CustomLocation type ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
authenticationMethods:
{
Description: Defines a set of Broker authentication methods to be used on `BrokerListeners`. For each array element one authenticator type supported. ,
Required: True ,
}
[
{
method:
{
Description: Custom authentication configuration. ,
Enum:
{
Custom: Custom authentication configuration. ,
ServiceAccountToken: ServiceAccountToken authentication configuration. ,
X509: X.509 authentication configuration. ,
}
,
Required: True ,
}
enum ,
customSettings:
{
Description: Custom authentication configuration. ,
Required: False ,
}
{
auth:
{
Description: Optional authentication needed for authenticating with the custom authentication server. ,
Required: False ,
}
{
x509:
{
Description: X509 Custom Auth type details. ,
Required: True ,
}
{
secretRef:
{
Description: Kubernetes secret containing an X.509 client certificate. This is a reference to the secret through an identifying name, not the secret itself. ,
Required: True ,
}
string ,
}
,
}
,
caCertConfigMap:
{
Description: Optional CA certificate for validating the custom authentication server's certificate. ,
Required: False ,
}
string ,
endpoint:
{
Description: Endpoint of the custom authentication server. Must be an HTTPS endpoint. ,
Format: uri ,
Required: True ,
}
string ,
headers:
{
Description: Additional HTTP headers to pass to the custom authentication server. ,
Required: False ,
}
object ,
}
,
serviceAccountTokenSettings:
{
Description: ServiceAccountToken authentication configuration. ,
Required: False ,
}
{
audiences:
{
Description: List of allowed audience. ,
Required: True ,
}
[
string ,
]
,
}
,
x509Settings:
{
Description: X.509 authentication configuration. ,
Required: False ,
}
{
authorizationAttributes:
{
Description: X509 authorization attributes properties. ,
Required: False ,
}
object ,
trustedClientCaCert:
{
Description: Name of the trusted client ca cert resource. ,
Required: False ,
}
string ,
}
,
}
,
]
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Resource is getting provisioned. ,
Updating: Resource is Updating. ,
Deleting: Resource is Deleting. ,
Accepted: Resource has been Accepted. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: Edge location of the resource. ,
Required: True ,
}
{
name:
{
Description: The name of the extended location. ,
Required: True ,
}
string ,
type:
{
Description: Type of ExtendedLocation. ,
Enum:
{
CustomLocation: CustomLocation type ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Instance broker authentication resource ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
authenticationMethods:
{
Description: Defines a set of Broker authentication methods to be used on `BrokerListeners`. For each array element one authenticator type supported. ,
Required: True ,
}
[
{
method:
{
Description: Custom authentication configuration. ,
Enum:
{
Custom: Custom authentication configuration. ,
ServiceAccountToken: ServiceAccountToken authentication configuration. ,
X509: X.509 authentication configuration. ,
}
,
Required: True ,
}
enum ,
customSettings:
{
Description: Custom authentication configuration. ,
Required: False ,
}
{
auth:
{
Description: Optional authentication needed for authenticating with the custom authentication server. ,
Required: False ,
}
{
x509:
{
Description: X509 Custom Auth type details. ,
Required: True ,
}
{
secretRef:
{
Description: Kubernetes secret containing an X.509 client certificate. This is a reference to the secret through an identifying name, not the secret itself. ,
Required: True ,
}
string ,
}
,
}
,
caCertConfigMap:
{
Description: Optional CA certificate for validating the custom authentication server's certificate. ,
Required: False ,
}
string ,
endpoint:
{
Description: Endpoint of the custom authentication server. Must be an HTTPS endpoint. ,
Format: uri ,
Required: True ,
}
string ,
headers:
{
Description: Additional HTTP headers to pass to the custom authentication server. ,
Required: False ,
}
object ,
}
,
serviceAccountTokenSettings:
{
Description: ServiceAccountToken authentication configuration. ,
Required: False ,
}
{
audiences:
{
Description: List of allowed audience. ,
Required: True ,
}
[
string ,
]
,
}
,
x509Settings:
{
Description: X.509 authentication configuration. ,
Required: False ,
}
{
authorizationAttributes:
{
Description: X509 authorization attributes properties. ,
Required: False ,
}
object ,
trustedClientCaCert:
{
Description: Name of the trusted client ca cert resource. ,
Required: False ,
}
string ,
}
,
}
,
]
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Resource is getting provisioned. ,
Updating: Resource is Updating. ,
Deleting: Resource is Deleting. ,
Accepted: Resource has been Accepted. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: Edge location of the resource. ,
Required: True ,
}
{
name:
{
Description: The name of the extended location. ,
Required: True ,
}
string ,
type:
{
Description: Type of ExtendedLocation. ,
Enum:
{
CustomLocation: CustomLocation type ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BrokerAuthentication_Delete (new)
Description :  Delete a BrokerAuthenticationResource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/brokers/{brokerName}/authentications/{authenticationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
instanceName:
{
Description: Name of instance. ,
Required: True ,
}
string ,
brokerName:
{
Description: Name of broker. ,
Required: True ,
}
string ,
authenticationName:
{
Description: Name of Instance broker authentication resource ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BrokerAuthorization_ListByResourceGroup (new)
Description :  List BrokerAuthorizationResource resources by BrokerResource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/brokers/{brokerName}/authorizations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
instanceName:
{
Description: Name of instance. ,
Required: True ,
}
string ,
brokerName:
{
Description: Name of broker. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The BrokerAuthorizationResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
authorizationPolicies:
{
Description: The list of authorization policies supported by the Authorization Resource. ,
Required: True ,
}
{
cache:
{
Description: Enable caching of the authorization rules. ,
Enum:
{
Enabled: Enabled is equivalent to True ,
Disabled: Disabled is equivalent to False. ,
}
,
Required: False ,
}
enum ,
rules:
{
Description: The authorization rules to follow. If no rule is set, but Authorization Resource is used that would mean DenyAll. ,
Required: False ,
}
[
{
brokerResources:
{
Description: Give access to Broker methods and topics. ,
Required: True ,
}
[
{
method:
{
Description: Give access for a Broker method (i.e., Connect, Subscribe, or Publish). ,
Enum:
{
Connect: Allowed Connecting to Broker ,
Publish: Allowed Publishing to Broker ,
Subscribe: Allowed Subscribing to Broker ,
}
,
Required: True ,
}
enum ,
clientIds:
{
Description: A list of client IDs that match the clients. The client IDs are case-sensitive and must match the client IDs provided by the clients during connection. This subfield may be set if the method is Connect. ,
Required: False ,
}
[
string ,
]
,
topics:
{
Description: A list of topics or topic patterns that match the topics that the clients can publish or subscribe to. This subfield is required if the method is Publish or Subscribe. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
principals:
{
Description: Give access to clients based on the following properties. ,
Required: True ,
}
{
attributes:
{
Description: A list of key-value pairs that match the attributes of the clients. The attributes are case-sensitive and must match the attributes provided by the clients during authentication. ,
Required: False ,
}
[
object ,
]
,
clientIds:
{
Description: A list of client IDs that match the clients. The client IDs are case-sensitive and must match the client IDs provided by the clients during connection. ,
Required: False ,
}
[
string ,
]
,
usernames:
{
Description: A list of usernames that match the clients. The usernames are case-sensitive and must match the usernames provided by the clients during authentication. ,
Required: False ,
}
[
string ,
]
,
}
,
stateStoreResources:
{
Description: Give access to state store resources. ,
Required: False ,
}
[
{
keyType:
{
Description: Allowed keyTypes pattern, string, binary. The key type used for matching, for example pattern tries to match the key to a glob-style pattern and string checks key is equal to value provided in keys. ,
Enum:
{
Pattern: Key type - pattern ,
String: Key type - string ,
Binary: Key type - binary ,
}
,
Required: True ,
}
enum ,
keys:
{
Description: Give access to state store keys for the corresponding principals defined. When key type is pattern set glob-style pattern (e.g., '*', 'clients/*'). ,
Required: True ,
}
[
string ,
]
,
method:
{
Description: Give access for `Read`, `Write` and `ReadWrite` access level. ,
Enum:
{
Read: Get/KeyNotify from Store ,
Write: Set/Delete in Store ,
ReadWrite: Allowed all operations on Store - Get/KeyNotify/Set/Delete ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
}
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Resource is getting provisioned. ,
Updating: Resource is Updating. ,
Deleting: Resource is Deleting. ,
Accepted: Resource has been Accepted. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: Edge location of the resource. ,
Required: True ,
}
{
name:
{
Description: The name of the extended location. ,
Required: True ,
}
string ,
type:
{
Description: Type of ExtendedLocation. ,
Enum:
{
CustomLocation: CustomLocation type ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BrokerAuthorization_Get (new)
Description :  Get a BrokerAuthorizationResource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/brokers/{brokerName}/authorizations/{authorizationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
instanceName:
{
Description: Name of instance. ,
Required: True ,
}
string ,
brokerName:
{
Description: Name of broker. ,
Required: True ,
}
string ,
authorizationName:
{
Description: Name of Instance broker authorization resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
authorizationPolicies:
{
Description: The list of authorization policies supported by the Authorization Resource. ,
Required: True ,
}
{
cache:
{
Description: Enable caching of the authorization rules. ,
Enum:
{
Enabled: Enabled is equivalent to True ,
Disabled: Disabled is equivalent to False. ,
}
,
Required: False ,
}
enum ,
rules:
{
Description: The authorization rules to follow. If no rule is set, but Authorization Resource is used that would mean DenyAll. ,
Required: False ,
}
[
{
brokerResources:
{
Description: Give access to Broker methods and topics. ,
Required: True ,
}
[
{
method:
{
Description: Give access for a Broker method (i.e., Connect, Subscribe, or Publish). ,
Enum:
{
Connect: Allowed Connecting to Broker ,
Publish: Allowed Publishing to Broker ,
Subscribe: Allowed Subscribing to Broker ,
}
,
Required: True ,
}
enum ,
clientIds:
{
Description: A list of client IDs that match the clients. The client IDs are case-sensitive and must match the client IDs provided by the clients during connection. This subfield may be set if the method is Connect. ,
Required: False ,
}
[
string ,
]
,
topics:
{
Description: A list of topics or topic patterns that match the topics that the clients can publish or subscribe to. This subfield is required if the method is Publish or Subscribe. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
principals:
{
Description: Give access to clients based on the following properties. ,
Required: True ,
}
{
attributes:
{
Description: A list of key-value pairs that match the attributes of the clients. The attributes are case-sensitive and must match the attributes provided by the clients during authentication. ,
Required: False ,
}
[
object ,
]
,
clientIds:
{
Description: A list of client IDs that match the clients. The client IDs are case-sensitive and must match the client IDs provided by the clients during connection. ,
Required: False ,
}
[
string ,
]
,
usernames:
{
Description: A list of usernames that match the clients. The usernames are case-sensitive and must match the usernames provided by the clients during authentication. ,
Required: False ,
}
[
string ,
]
,
}
,
stateStoreResources:
{
Description: Give access to state store resources. ,
Required: False ,
}
[
{
keyType:
{
Description: Allowed keyTypes pattern, string, binary. The key type used for matching, for example pattern tries to match the key to a glob-style pattern and string checks key is equal to value provided in keys. ,
Enum:
{
Pattern: Key type - pattern ,
String: Key type - string ,
Binary: Key type - binary ,
}
,
Required: True ,
}
enum ,
keys:
{
Description: Give access to state store keys for the corresponding principals defined. When key type is pattern set glob-style pattern (e.g., '*', 'clients/*'). ,
Required: True ,
}
[
string ,
]
,
method:
{
Description: Give access for `Read`, `Write` and `ReadWrite` access level. ,
Enum:
{
Read: Get/KeyNotify from Store ,
Write: Set/Delete in Store ,
ReadWrite: Allowed all operations on Store - Get/KeyNotify/Set/Delete ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
}
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Resource is getting provisioned. ,
Updating: Resource is Updating. ,
Deleting: Resource is Deleting. ,
Accepted: Resource has been Accepted. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: Edge location of the resource. ,
Required: True ,
}
{
name:
{
Description: The name of the extended location. ,
Required: True ,
}
string ,
type:
{
Description: Type of ExtendedLocation. ,
Enum:
{
CustomLocation: CustomLocation type ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BrokerAuthorization_CreateOrUpdate (new)
Description :  Create a BrokerAuthorizationResource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/brokers/{brokerName}/authorizations/{authorizationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
instanceName:
{
Description: Name of instance. ,
Required: True ,
}
string ,
brokerName:
{
Description: Name of broker. ,
Required: True ,
}
string ,
authorizationName:
{
Description: Name of Instance broker authorization resource ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
authorizationPolicies:
{
Description: The list of authorization policies supported by the Authorization Resource. ,
Required: True ,
}
{
cache:
{
Description: Enable caching of the authorization rules. ,
Enum:
{
Enabled: Enabled is equivalent to True ,
Disabled: Disabled is equivalent to False. ,
}
,
Required: False ,
}
enum ,
rules:
{
Description: The authorization rules to follow. If no rule is set, but Authorization Resource is used that would mean DenyAll. ,
Required: False ,
}
[
{
brokerResources:
{
Description: Give access to Broker methods and topics. ,
Required: True ,
}
[
{
method:
{
Description: Give access for a Broker method (i.e., Connect, Subscribe, or Publish). ,
Enum:
{
Connect: Allowed Connecting to Broker ,
Publish: Allowed Publishing to Broker ,
Subscribe: Allowed Subscribing to Broker ,
}
,
Required: True ,
}
enum ,
clientIds:
{
Description: A list of client IDs that match the clients. The client IDs are case-sensitive and must match the client IDs provided by the clients during connection. This subfield may be set if the method is Connect. ,
Required: False ,
}
[
string ,
]
,
topics:
{
Description: A list of topics or topic patterns that match the topics that the clients can publish or subscribe to. This subfield is required if the method is Publish or Subscribe. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
principals:
{
Description: Give access to clients based on the following properties. ,
Required: True ,
}
{
attributes:
{
Description: A list of key-value pairs that match the attributes of the clients. The attributes are case-sensitive and must match the attributes provided by the clients during authentication. ,
Required: False ,
}
[
object ,
]
,
clientIds:
{
Description: A list of client IDs that match the clients. The client IDs are case-sensitive and must match the client IDs provided by the clients during connection. ,
Required: False ,
}
[
string ,
]
,
usernames:
{
Description: A list of usernames that match the clients. The usernames are case-sensitive and must match the usernames provided by the clients during authentication. ,
Required: False ,
}
[
string ,
]
,
}
,
stateStoreResources:
{
Description: Give access to state store resources. ,
Required: False ,
}
[
{
keyType:
{
Description: Allowed keyTypes pattern, string, binary. The key type used for matching, for example pattern tries to match the key to a glob-style pattern and string checks key is equal to value provided in keys. ,
Enum:
{
Pattern: Key type - pattern ,
String: Key type - string ,
Binary: Key type - binary ,
}
,
Required: True ,
}
enum ,
keys:
{
Description: Give access to state store keys for the corresponding principals defined. When key type is pattern set glob-style pattern (e.g., '*', 'clients/*'). ,
Required: True ,
}
[
string ,
]
,
method:
{
Description: Give access for `Read`, `Write` and `ReadWrite` access level. ,
Enum:
{
Read: Get/KeyNotify from Store ,
Write: Set/Delete in Store ,
ReadWrite: Allowed all operations on Store - Get/KeyNotify/Set/Delete ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
}
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Resource is getting provisioned. ,
Updating: Resource is Updating. ,
Deleting: Resource is Deleting. ,
Accepted: Resource has been Accepted. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: Edge location of the resource. ,
Required: True ,
}
{
name:
{
Description: The name of the extended location. ,
Required: True ,
}
string ,
type:
{
Description: Type of ExtendedLocation. ,
Enum:
{
CustomLocation: CustomLocation type ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
authorizationPolicies:
{
Description: The list of authorization policies supported by the Authorization Resource. ,
Required: True ,
}
{
cache:
{
Description: Enable caching of the authorization rules. ,
Enum:
{
Enabled: Enabled is equivalent to True ,
Disabled: Disabled is equivalent to False. ,
}
,
Required: False ,
}
enum ,
rules:
{
Description: The authorization rules to follow. If no rule is set, but Authorization Resource is used that would mean DenyAll. ,
Required: False ,
}
[
{
brokerResources:
{
Description: Give access to Broker methods and topics. ,
Required: True ,
}
[
{
method:
{
Description: Give access for a Broker method (i.e., Connect, Subscribe, or Publish). ,
Enum:
{
Connect: Allowed Connecting to Broker ,
Publish: Allowed Publishing to Broker ,
Subscribe: Allowed Subscribing to Broker ,
}
,
Required: True ,
}
enum ,
clientIds:
{
Description: A list of client IDs that match the clients. The client IDs are case-sensitive and must match the client IDs provided by the clients during connection. This subfield may be set if the method is Connect. ,
Required: False ,
}
[
string ,
]
,
topics:
{
Description: A list of topics or topic patterns that match the topics that the clients can publish or subscribe to. This subfield is required if the method is Publish or Subscribe. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
principals:
{
Description: Give access to clients based on the following properties. ,
Required: True ,
}
{
attributes:
{
Description: A list of key-value pairs that match the attributes of the clients. The attributes are case-sensitive and must match the attributes provided by the clients during authentication. ,
Required: False ,
}
[
object ,
]
,
clientIds:
{
Description: A list of client IDs that match the clients. The client IDs are case-sensitive and must match the client IDs provided by the clients during connection. ,
Required: False ,
}
[
string ,
]
,
usernames:
{
Description: A list of usernames that match the clients. The usernames are case-sensitive and must match the usernames provided by the clients during authentication. ,
Required: False ,
}
[
string ,
]
,
}
,
stateStoreResources:
{
Description: Give access to state store resources. ,
Required: False ,
}
[
{
keyType:
{
Description: Allowed keyTypes pattern, string, binary. The key type used for matching, for example pattern tries to match the key to a glob-style pattern and string checks key is equal to value provided in keys. ,
Enum:
{
Pattern: Key type - pattern ,
String: Key type - string ,
Binary: Key type - binary ,
}
,
Required: True ,
}
enum ,
keys:
{
Description: Give access to state store keys for the corresponding principals defined. When key type is pattern set glob-style pattern (e.g., '*', 'clients/*'). ,
Required: True ,
}
[
string ,
]
,
method:
{
Description: Give access for `Read`, `Write` and `ReadWrite` access level. ,
Enum:
{
Read: Get/KeyNotify from Store ,
Write: Set/Delete in Store ,
ReadWrite: Allowed all operations on Store - Get/KeyNotify/Set/Delete ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
}
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Resource is getting provisioned. ,
Updating: Resource is Updating. ,
Deleting: Resource is Deleting. ,
Accepted: Resource has been Accepted. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: Edge location of the resource. ,
Required: True ,
}
{
name:
{
Description: The name of the extended location. ,
Required: True ,
}
string ,
type:
{
Description: Type of ExtendedLocation. ,
Enum:
{
CustomLocation: CustomLocation type ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Instance broker authorizations resource ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
authorizationPolicies:
{
Description: The list of authorization policies supported by the Authorization Resource. ,
Required: True ,
}
{
cache:
{
Description: Enable caching of the authorization rules. ,
Enum:
{
Enabled: Enabled is equivalent to True ,
Disabled: Disabled is equivalent to False. ,
}
,
Required: False ,
}
enum ,
rules:
{
Description: The authorization rules to follow. If no rule is set, but Authorization Resource is used that would mean DenyAll. ,
Required: False ,
}
[
{
brokerResources:
{
Description: Give access to Broker methods and topics. ,
Required: True ,
}
[
{
method:
{
Description: Give access for a Broker method (i.e., Connect, Subscribe, or Publish). ,
Enum:
{
Connect: Allowed Connecting to Broker ,
Publish: Allowed Publishing to Broker ,
Subscribe: Allowed Subscribing to Broker ,
}
,
Required: True ,
}
enum ,
clientIds:
{
Description: A list of client IDs that match the clients. The client IDs are case-sensitive and must match the client IDs provided by the clients during connection. This subfield may be set if the method is Connect. ,
Required: False ,
}
[
string ,
]
,
topics:
{
Description: A list of topics or topic patterns that match the topics that the clients can publish or subscribe to. This subfield is required if the method is Publish or Subscribe. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
principals:
{
Description: Give access to clients based on the following properties. ,
Required: True ,
}
{
attributes:
{
Description: A list of key-value pairs that match the attributes of the clients. The attributes are case-sensitive and must match the attributes provided by the clients during authentication. ,
Required: False ,
}
[
object ,
]
,
clientIds:
{
Description: A list of client IDs that match the clients. The client IDs are case-sensitive and must match the client IDs provided by the clients during connection. ,
Required: False ,
}
[
string ,
]
,
usernames:
{
Description: A list of usernames that match the clients. The usernames are case-sensitive and must match the usernames provided by the clients during authentication. ,
Required: False ,
}
[
string ,
]
,
}
,
stateStoreResources:
{
Description: Give access to state store resources. ,
Required: False ,
}
[
{
keyType:
{
Description: Allowed keyTypes pattern, string, binary. The key type used for matching, for example pattern tries to match the key to a glob-style pattern and string checks key is equal to value provided in keys. ,
Enum:
{
Pattern: Key type - pattern ,
String: Key type - string ,
Binary: Key type - binary ,
}
,
Required: True ,
}
enum ,
keys:
{
Description: Give access to state store keys for the corresponding principals defined. When key type is pattern set glob-style pattern (e.g., '*', 'clients/*'). ,
Required: True ,
}
[
string ,
]
,
method:
{
Description: Give access for `Read`, `Write` and `ReadWrite` access level. ,
Enum:
{
Read: Get/KeyNotify from Store ,
Write: Set/Delete in Store ,
ReadWrite: Allowed all operations on Store - Get/KeyNotify/Set/Delete ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
}
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Resource is getting provisioned. ,
Updating: Resource is Updating. ,
Deleting: Resource is Deleting. ,
Accepted: Resource has been Accepted. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: Edge location of the resource. ,
Required: True ,
}
{
name:
{
Description: The name of the extended location. ,
Required: True ,
}
string ,
type:
{
Description: Type of ExtendedLocation. ,
Enum:
{
CustomLocation: CustomLocation type ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BrokerAuthorization_Delete (new)
Description :  Delete a BrokerAuthorizationResource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/brokers/{brokerName}/authorizations/{authorizationName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
instanceName:
{
Description: Name of instance. ,
Required: True ,
}
string ,
brokerName:
{
Description: Name of broker. ,
Required: True ,
}
string ,
authorizationName:
{
Description: Name of Instance broker authorization resource ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BrokerListener_ListByResourceGroup (new)
Description :  List BrokerListenerResource resources by BrokerResource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/brokers/{brokerName}/listeners
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
instanceName:
{
Description: Name of instance. ,
Required: True ,
}
string ,
brokerName:
{
Description: Name of broker. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The BrokerListenerResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
serviceName:
{
Description: Kubernetes Service name of this listener. ,
Required: False ,
}
string ,
ports:
{
Description: Ports on which this listener accepts client connections. ,
Required: True ,
}
[
{
authenticationRef:
{
Description: Reference to client authentication settings. Omit to disable authentication. ,
Required: False ,
}
string ,
authorizationRef:
{
Description: Reference to client authorization settings. Omit to disable authorization. ,
Required: False ,
}
string ,
nodePort:
{
Description: Kubernetes node port. Only relevant when this port is associated with a `NodePort` listener. ,
Format: int32 ,
Required: False ,
}
integer ,
port:
{
Description: TCP port for accepting client connections. ,
Format: int32 ,
Required: True ,
}
integer ,
protocol:
{
Description: Protocol to use for client connections. ,
Enum:
{
Mqtt: protocol broker ,
WebSockets: protocol websocket ,
}
,
Required: False ,
}
enum ,
tls:
{
Description: TLS server certificate settings for this port. Omit to disable TLS. ,
Required: False ,
}
{
mode:
{
Description: Mode of TLS server certificate management. ,
Enum:
{
Automatic: Automatic TLS server certificate configuration. ,
Manual: Manual TLS server certificate configuration. ,
}
,
Required: True ,
}
enum ,
certManagerCertificateSpec:
{
Description: Option 1 - Automatic TLS server certificate management with cert-manager. ,
Required: False ,
}
{
duration:
{
Description: Lifetime of certificate. Must be specified using a Go time.Duration format (h|m|s). E.g. 240h for 240 hours and 45m for 45 minutes. ,
Required: False ,
}
string ,
secretName:
{
Description: Secret for storing server certificate. Any existing data will be overwritten. This is a reference to the secret through an identifying name, not the secret itself. ,
Required: False ,
}
string ,
renewBefore:
{
Description: When to begin renewing certificate. Must be specified using a Go time.Duration format (h|m|s). E.g. 240h for 240 hours and 45m for 45 minutes. ,
Required: False ,
}
string ,
issuerRef:
{
Description: cert-manager issuerRef. ,
Required: True ,
}
{
group:
{
Description: group of issuer. ,
Required: True ,
}
string ,
kind:
{
Description: kind of issuer (Issuer or ClusterIssuer). ,
Enum:
{
Issuer: Issuer kind. ,
ClusterIssuer: ClusterIssuer kind. ,
}
,
Required: True ,
}
enum ,
name:
{
Description: name of issuer. ,
Required: True ,
}
string ,
}
,
privateKey:
{
Description: Type of certificate private key. ,
Required: False ,
}
{
algorithm:
{
Description: algorithm for private key. ,
Enum:
{
Ec256: Algorithm - ec256. ,
Ec384: Algorithm - ec384. ,
Ec521: Algorithm - ec521. ,
Ed25519: Algorithm - ed25519. ,
Rsa2048: Algorithm - rsa2048. ,
Rsa4096: Algorithm - rsa4096. ,
Rsa8192: Algorithm - rsa8192. ,
}
,
Required: True ,
}
enum ,
rotationPolicy:
{
Description: cert-manager private key rotationPolicy. ,
Enum:
{
Always: Rotation Policy - Always. ,
Never: Rotation Policy - Never. ,
}
,
Required: True ,
}
enum ,
}
,
san:
{
Description: Additional Subject Alternative Names (SANs) to include in the certificate. ,
Required: False ,
}
{
dns:
{
Description: DNS SANs. ,
Required: True ,
}
[
string ,
]
,
ip:
{
Description: IP address SANs. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
manual:
{
Description: Option 2 - Manual TLS server certificate management through a defined secret. ,
Required: False ,
}
{
secretRef:
{
Description: Kubernetes secret containing an X.509 client certificate. This is a reference to the secret through an identifying name, not the secret itself. ,
Required: True ,
}
string ,
}
,
}
,
}
,
]
,
serviceType:
{
Description: Kubernetes Service type of this listener. ,
Enum:
{
ClusterIp: Cluster IP Service. ,
LoadBalancer: Load Balancer Service. ,
NodePort: Node Port Service. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Resource is getting provisioned. ,
Updating: Resource is Updating. ,
Deleting: Resource is Deleting. ,
Accepted: Resource has been Accepted. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: Edge location of the resource. ,
Required: True ,
}
{
name:
{
Description: The name of the extended location. ,
Required: True ,
}
string ,
type:
{
Description: Type of ExtendedLocation. ,
Enum:
{
CustomLocation: CustomLocation type ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BrokerListener_Get (new)
Description :  Get a BrokerListenerResource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/brokers/{brokerName}/listeners/{listenerName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
instanceName:
{
Description: Name of instance. ,
Required: True ,
}
string ,
brokerName:
{
Description: Name of broker. ,
Required: True ,
}
string ,
listenerName:
{
Description: Name of Instance broker listener resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
serviceName:
{
Description: Kubernetes Service name of this listener. ,
Required: False ,
}
string ,
ports:
{
Description: Ports on which this listener accepts client connections. ,
Required: True ,
}
[
{
authenticationRef:
{
Description: Reference to client authentication settings. Omit to disable authentication. ,
Required: False ,
}
string ,
authorizationRef:
{
Description: Reference to client authorization settings. Omit to disable authorization. ,
Required: False ,
}
string ,
nodePort:
{
Description: Kubernetes node port. Only relevant when this port is associated with a `NodePort` listener. ,
Format: int32 ,
Required: False ,
}
integer ,
port:
{
Description: TCP port for accepting client connections. ,
Format: int32 ,
Required: True ,
}
integer ,
protocol:
{
Description: Protocol to use for client connections. ,
Enum:
{
Mqtt: protocol broker ,
WebSockets: protocol websocket ,
}
,
Required: False ,
}
enum ,
tls:
{
Description: TLS server certificate settings for this port. Omit to disable TLS. ,
Required: False ,
}
{
mode:
{
Description: Mode of TLS server certificate management. ,
Enum:
{
Automatic: Automatic TLS server certificate configuration. ,
Manual: Manual TLS server certificate configuration. ,
}
,
Required: True ,
}
enum ,
certManagerCertificateSpec:
{
Description: Option 1 - Automatic TLS server certificate management with cert-manager. ,
Required: False ,
}
{
duration:
{
Description: Lifetime of certificate. Must be specified using a Go time.Duration format (h|m|s). E.g. 240h for 240 hours and 45m for 45 minutes. ,
Required: False ,
}
string ,
secretName:
{
Description: Secret for storing server certificate. Any existing data will be overwritten. This is a reference to the secret through an identifying name, not the secret itself. ,
Required: False ,
}
string ,
renewBefore:
{
Description: When to begin renewing certificate. Must be specified using a Go time.Duration format (h|m|s). E.g. 240h for 240 hours and 45m for 45 minutes. ,
Required: False ,
}
string ,
issuerRef:
{
Description: cert-manager issuerRef. ,
Required: True ,
}
{
group:
{
Description: group of issuer. ,
Required: True ,
}
string ,
kind:
{
Description: kind of issuer (Issuer or ClusterIssuer). ,
Enum:
{
Issuer: Issuer kind. ,
ClusterIssuer: ClusterIssuer kind. ,
}
,
Required: True ,
}
enum ,
name:
{
Description: name of issuer. ,
Required: True ,
}
string ,
}
,
privateKey:
{
Description: Type of certificate private key. ,
Required: False ,
}
{
algorithm:
{
Description: algorithm for private key. ,
Enum:
{
Ec256: Algorithm - ec256. ,
Ec384: Algorithm - ec384. ,
Ec521: Algorithm - ec521. ,
Ed25519: Algorithm - ed25519. ,
Rsa2048: Algorithm - rsa2048. ,
Rsa4096: Algorithm - rsa4096. ,
Rsa8192: Algorithm - rsa8192. ,
}
,
Required: True ,
}
enum ,
rotationPolicy:
{
Description: cert-manager private key rotationPolicy. ,
Enum:
{
Always: Rotation Policy - Always. ,
Never: Rotation Policy - Never. ,
}
,
Required: True ,
}
enum ,
}
,
san:
{
Description: Additional Subject Alternative Names (SANs) to include in the certificate. ,
Required: False ,
}
{
dns:
{
Description: DNS SANs. ,
Required: True ,
}
[
string ,
]
,
ip:
{
Description: IP address SANs. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
manual:
{
Description: Option 2 - Manual TLS server certificate management through a defined secret. ,
Required: False ,
}
{
secretRef:
{
Description: Kubernetes secret containing an X.509 client certificate. This is a reference to the secret through an identifying name, not the secret itself. ,
Required: True ,
}
string ,
}
,
}
,
}
,
]
,
serviceType:
{
Description: Kubernetes Service type of this listener. ,
Enum:
{
ClusterIp: Cluster IP Service. ,
LoadBalancer: Load Balancer Service. ,
NodePort: Node Port Service. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Resource is getting provisioned. ,
Updating: Resource is Updating. ,
Deleting: Resource is Deleting. ,
Accepted: Resource has been Accepted. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: Edge location of the resource. ,
Required: True ,
}
{
name:
{
Description: The name of the extended location. ,
Required: True ,
}
string ,
type:
{
Description: Type of ExtendedLocation. ,
Enum:
{
CustomLocation: CustomLocation type ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BrokerListener_CreateOrUpdate (new)
Description :  Create a BrokerListenerResource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/brokers/{brokerName}/listeners/{listenerName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
instanceName:
{
Description: Name of instance. ,
Required: True ,
}
string ,
brokerName:
{
Description: Name of broker. ,
Required: True ,
}
string ,
listenerName:
{
Description: Name of Instance broker listener resource ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
serviceName:
{
Description: Kubernetes Service name of this listener. ,
Required: False ,
}
string ,
ports:
{
Description: Ports on which this listener accepts client connections. ,
Required: True ,
}
[
{
authenticationRef:
{
Description: Reference to client authentication settings. Omit to disable authentication. ,
Required: False ,
}
string ,
authorizationRef:
{
Description: Reference to client authorization settings. Omit to disable authorization. ,
Required: False ,
}
string ,
nodePort:
{
Description: Kubernetes node port. Only relevant when this port is associated with a `NodePort` listener. ,
Format: int32 ,
Required: False ,
}
integer ,
port:
{
Description: TCP port for accepting client connections. ,
Format: int32 ,
Required: True ,
}
integer ,
protocol:
{
Description: Protocol to use for client connections. ,
Enum:
{
Mqtt: protocol broker ,
WebSockets: protocol websocket ,
}
,
Required: False ,
}
enum ,
tls:
{
Description: TLS server certificate settings for this port. Omit to disable TLS. ,
Required: False ,
}
{
mode:
{
Description: Mode of TLS server certificate management. ,
Enum:
{
Automatic: Automatic TLS server certificate configuration. ,
Manual: Manual TLS server certificate configuration. ,
}
,
Required: True ,
}
enum ,
certManagerCertificateSpec:
{
Description: Option 1 - Automatic TLS server certificate management with cert-manager. ,
Required: False ,
}
{
duration:
{
Description: Lifetime of certificate. Must be specified using a Go time.Duration format (h|m|s). E.g. 240h for 240 hours and 45m for 45 minutes. ,
Required: False ,
}
string ,
secretName:
{
Description: Secret for storing server certificate. Any existing data will be overwritten. This is a reference to the secret through an identifying name, not the secret itself. ,
Required: False ,
}
string ,
renewBefore:
{
Description: When to begin renewing certificate. Must be specified using a Go time.Duration format (h|m|s). E.g. 240h for 240 hours and 45m for 45 minutes. ,
Required: False ,
}
string ,
issuerRef:
{
Description: cert-manager issuerRef. ,
Required: True ,
}
{
group:
{
Description: group of issuer. ,
Required: True ,
}
string ,
kind:
{
Description: kind of issuer (Issuer or ClusterIssuer). ,
Enum:
{
Issuer: Issuer kind. ,
ClusterIssuer: ClusterIssuer kind. ,
}
,
Required: True ,
}
enum ,
name:
{
Description: name of issuer. ,
Required: True ,
}
string ,
}
,
privateKey:
{
Description: Type of certificate private key. ,
Required: False ,
}
{
algorithm:
{
Description: algorithm for private key. ,
Enum:
{
Ec256: Algorithm - ec256. ,
Ec384: Algorithm - ec384. ,
Ec521: Algorithm - ec521. ,
Ed25519: Algorithm - ed25519. ,
Rsa2048: Algorithm - rsa2048. ,
Rsa4096: Algorithm - rsa4096. ,
Rsa8192: Algorithm - rsa8192. ,
}
,
Required: True ,
}
enum ,
rotationPolicy:
{
Description: cert-manager private key rotationPolicy. ,
Enum:
{
Always: Rotation Policy - Always. ,
Never: Rotation Policy - Never. ,
}
,
Required: True ,
}
enum ,
}
,
san:
{
Description: Additional Subject Alternative Names (SANs) to include in the certificate. ,
Required: False ,
}
{
dns:
{
Description: DNS SANs. ,
Required: True ,
}
[
string ,
]
,
ip:
{
Description: IP address SANs. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
manual:
{
Description: Option 2 - Manual TLS server certificate management through a defined secret. ,
Required: False ,
}
{
secretRef:
{
Description: Kubernetes secret containing an X.509 client certificate. This is a reference to the secret through an identifying name, not the secret itself. ,
Required: True ,
}
string ,
}
,
}
,
}
,
]
,
serviceType:
{
Description: Kubernetes Service type of this listener. ,
Enum:
{
ClusterIp: Cluster IP Service. ,
LoadBalancer: Load Balancer Service. ,
NodePort: Node Port Service. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Resource is getting provisioned. ,
Updating: Resource is Updating. ,
Deleting: Resource is Deleting. ,
Accepted: Resource has been Accepted. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: Edge location of the resource. ,
Required: True ,
}
{
name:
{
Description: The name of the extended location. ,
Required: True ,
}
string ,
type:
{
Description: Type of ExtendedLocation. ,
Enum:
{
CustomLocation: CustomLocation type ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
serviceName:
{
Description: Kubernetes Service name of this listener. ,
Required: False ,
}
string ,
ports:
{
Description: Ports on which this listener accepts client connections. ,
Required: True ,
}
[
{
authenticationRef:
{
Description: Reference to client authentication settings. Omit to disable authentication. ,
Required: False ,
}
string ,
authorizationRef:
{
Description: Reference to client authorization settings. Omit to disable authorization. ,
Required: False ,
}
string ,
nodePort:
{
Description: Kubernetes node port. Only relevant when this port is associated with a `NodePort` listener. ,
Format: int32 ,
Required: False ,
}
integer ,
port:
{
Description: TCP port for accepting client connections. ,
Format: int32 ,
Required: True ,
}
integer ,
protocol:
{
Description: Protocol to use for client connections. ,
Enum:
{
Mqtt: protocol broker ,
WebSockets: protocol websocket ,
}
,
Required: False ,
}
enum ,
tls:
{
Description: TLS server certificate settings for this port. Omit to disable TLS. ,
Required: False ,
}
{
mode:
{
Description: Mode of TLS server certificate management. ,
Enum:
{
Automatic: Automatic TLS server certificate configuration. ,
Manual: Manual TLS server certificate configuration. ,
}
,
Required: True ,
}
enum ,
certManagerCertificateSpec:
{
Description: Option 1 - Automatic TLS server certificate management with cert-manager. ,
Required: False ,
}
{
duration:
{
Description: Lifetime of certificate. Must be specified using a Go time.Duration format (h|m|s). E.g. 240h for 240 hours and 45m for 45 minutes. ,
Required: False ,
}
string ,
secretName:
{
Description: Secret for storing server certificate. Any existing data will be overwritten. This is a reference to the secret through an identifying name, not the secret itself. ,
Required: False ,
}
string ,
renewBefore:
{
Description: When to begin renewing certificate. Must be specified using a Go time.Duration format (h|m|s). E.g. 240h for 240 hours and 45m for 45 minutes. ,
Required: False ,
}
string ,
issuerRef:
{
Description: cert-manager issuerRef. ,
Required: True ,
}
{
group:
{
Description: group of issuer. ,
Required: True ,
}
string ,
kind:
{
Description: kind of issuer (Issuer or ClusterIssuer). ,
Enum:
{
Issuer: Issuer kind. ,
ClusterIssuer: ClusterIssuer kind. ,
}
,
Required: True ,
}
enum ,
name:
{
Description: name of issuer. ,
Required: True ,
}
string ,
}
,
privateKey:
{
Description: Type of certificate private key. ,
Required: False ,
}
{
algorithm:
{
Description: algorithm for private key. ,
Enum:
{
Ec256: Algorithm - ec256. ,
Ec384: Algorithm - ec384. ,
Ec521: Algorithm - ec521. ,
Ed25519: Algorithm - ed25519. ,
Rsa2048: Algorithm - rsa2048. ,
Rsa4096: Algorithm - rsa4096. ,
Rsa8192: Algorithm - rsa8192. ,
}
,
Required: True ,
}
enum ,
rotationPolicy:
{
Description: cert-manager private key rotationPolicy. ,
Enum:
{
Always: Rotation Policy - Always. ,
Never: Rotation Policy - Never. ,
}
,
Required: True ,
}
enum ,
}
,
san:
{
Description: Additional Subject Alternative Names (SANs) to include in the certificate. ,
Required: False ,
}
{
dns:
{
Description: DNS SANs. ,
Required: True ,
}
[
string ,
]
,
ip:
{
Description: IP address SANs. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
manual:
{
Description: Option 2 - Manual TLS server certificate management through a defined secret. ,
Required: False ,
}
{
secretRef:
{
Description: Kubernetes secret containing an X.509 client certificate. This is a reference to the secret through an identifying name, not the secret itself. ,
Required: True ,
}
string ,
}
,
}
,
}
,
]
,
serviceType:
{
Description: Kubernetes Service type of this listener. ,
Enum:
{
ClusterIp: Cluster IP Service. ,
LoadBalancer: Load Balancer Service. ,
NodePort: Node Port Service. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Resource is getting provisioned. ,
Updating: Resource is Updating. ,
Deleting: Resource is Deleting. ,
Accepted: Resource has been Accepted. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: Edge location of the resource. ,
Required: True ,
}
{
name:
{
Description: The name of the extended location. ,
Required: True ,
}
string ,
type:
{
Description: Type of ExtendedLocation. ,
Enum:
{
CustomLocation: CustomLocation type ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Instance broker resource ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
serviceName:
{
Description: Kubernetes Service name of this listener. ,
Required: False ,
}
string ,
ports:
{
Description: Ports on which this listener accepts client connections. ,
Required: True ,
}
[
{
authenticationRef:
{
Description: Reference to client authentication settings. Omit to disable authentication. ,
Required: False ,
}
string ,
authorizationRef:
{
Description: Reference to client authorization settings. Omit to disable authorization. ,
Required: False ,
}
string ,
nodePort:
{
Description: Kubernetes node port. Only relevant when this port is associated with a `NodePort` listener. ,
Format: int32 ,
Required: False ,
}
integer ,
port:
{
Description: TCP port for accepting client connections. ,
Format: int32 ,
Required: True ,
}
integer ,
protocol:
{
Description: Protocol to use for client connections. ,
Enum:
{
Mqtt: protocol broker ,
WebSockets: protocol websocket ,
}
,
Required: False ,
}
enum ,
tls:
{
Description: TLS server certificate settings for this port. Omit to disable TLS. ,
Required: False ,
}
{
mode:
{
Description: Mode of TLS server certificate management. ,
Enum:
{
Automatic: Automatic TLS server certificate configuration. ,
Manual: Manual TLS server certificate configuration. ,
}
,
Required: True ,
}
enum ,
certManagerCertificateSpec:
{
Description: Option 1 - Automatic TLS server certificate management with cert-manager. ,
Required: False ,
}
{
duration:
{
Description: Lifetime of certificate. Must be specified using a Go time.Duration format (h|m|s). E.g. 240h for 240 hours and 45m for 45 minutes. ,
Required: False ,
}
string ,
secretName:
{
Description: Secret for storing server certificate. Any existing data will be overwritten. This is a reference to the secret through an identifying name, not the secret itself. ,
Required: False ,
}
string ,
renewBefore:
{
Description: When to begin renewing certificate. Must be specified using a Go time.Duration format (h|m|s). E.g. 240h for 240 hours and 45m for 45 minutes. ,
Required: False ,
}
string ,
issuerRef:
{
Description: cert-manager issuerRef. ,
Required: True ,
}
{
group:
{
Description: group of issuer. ,
Required: True ,
}
string ,
kind:
{
Description: kind of issuer (Issuer or ClusterIssuer). ,
Enum:
{
Issuer: Issuer kind. ,
ClusterIssuer: ClusterIssuer kind. ,
}
,
Required: True ,
}
enum ,
name:
{
Description: name of issuer. ,
Required: True ,
}
string ,
}
,
privateKey:
{
Description: Type of certificate private key. ,
Required: False ,
}
{
algorithm:
{
Description: algorithm for private key. ,
Enum:
{
Ec256: Algorithm - ec256. ,
Ec384: Algorithm - ec384. ,
Ec521: Algorithm - ec521. ,
Ed25519: Algorithm - ed25519. ,
Rsa2048: Algorithm - rsa2048. ,
Rsa4096: Algorithm - rsa4096. ,
Rsa8192: Algorithm - rsa8192. ,
}
,
Required: True ,
}
enum ,
rotationPolicy:
{
Description: cert-manager private key rotationPolicy. ,
Enum:
{
Always: Rotation Policy - Always. ,
Never: Rotation Policy - Never. ,
}
,
Required: True ,
}
enum ,
}
,
san:
{
Description: Additional Subject Alternative Names (SANs) to include in the certificate. ,
Required: False ,
}
{
dns:
{
Description: DNS SANs. ,
Required: True ,
}
[
string ,
]
,
ip:
{
Description: IP address SANs. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
manual:
{
Description: Option 2 - Manual TLS server certificate management through a defined secret. ,
Required: False ,
}
{
secretRef:
{
Description: Kubernetes secret containing an X.509 client certificate. This is a reference to the secret through an identifying name, not the secret itself. ,
Required: True ,
}
string ,
}
,
}
,
}
,
]
,
serviceType:
{
Description: Kubernetes Service type of this listener. ,
Enum:
{
ClusterIp: Cluster IP Service. ,
LoadBalancer: Load Balancer Service. ,
NodePort: Node Port Service. ,
}
,
Required: False ,
}
enum ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Resource is getting provisioned. ,
Updating: Resource is Updating. ,
Deleting: Resource is Deleting. ,
Accepted: Resource has been Accepted. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: Edge location of the resource. ,
Required: True ,
}
{
name:
{
Description: The name of the extended location. ,
Required: True ,
}
string ,
type:
{
Description: Type of ExtendedLocation. ,
Enum:
{
CustomLocation: CustomLocation type ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BrokerListener_Delete (new)
Description :  Delete a BrokerListenerResource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/brokers/{brokerName}/listeners/{listenerName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
instanceName:
{
Description: Name of instance. ,
Required: True ,
}
string ,
brokerName:
{
Description: Name of broker. ,
Required: True ,
}
string ,
listenerName:
{
Description: Name of Instance broker listener resource ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DataflowEndpoint_ListByResourceGroup (new)
Description :  List DataflowEndpointResource resources by InstanceResource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/dataflowEndpoints
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
instanceName:
{
Description: Name of instance. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The DataflowEndpointResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
endpointType:
{
Description: Endpoint Type. ,
Enum:
{
DataExplorer: Azure Data Explorer Type ,
DataLakeStorage: Azure Data Lake Type ,
FabricOneLake: Microsoft Fabric Type ,
Kafka: Kafka Type ,
LocalStorage: Local Storage Type ,
Mqtt: Broker Type ,
}
,
Required: True ,
}
enum ,
dataExplorerSettings:
{
Description: Azure Data Explorer endpoint. ,
Required: False ,
}
{
authentication:
{
Description: Authentication configuration. NOTE - only authentication property is allowed per entry. ,
Required: True ,
}
{
method:
{
Description: Mode of Authentication. ,
Enum:
{
SystemAssignedManagedIdentity: SystemAssignedManagedIdentity type ,
UserAssignedManagedIdentity: UserAssignedManagedIdentity type ,
}
,
Required: True ,
}
enum ,
systemAssignedManagedIdentitySettings:
{
Description: System-assigned managed identity authentication. ,
Required: False ,
}
{
audience:
{
Description: Audience of the service to authenticate against. Optional; defaults to the audience for Service host configuration. ,
Required: False ,
}
string ,
}
,
userAssignedManagedIdentitySettings:
{
Description: User-assigned managed identity authentication. ,
Required: False ,
}
{
clientId:
{
Description: Client ID for the user-assigned managed identity. ,
Required: True ,
}
string ,
scope:
{
Description: Resource identifier (application ID URI) of the resource, affixed with the .default suffix. ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID. ,
Required: True ,
}
string ,
}
,
}
,
database:
{
Description: Database name. ,
Required: True ,
}
string ,
host:
{
Description: Host of the Azure Data Explorer in the form of ..kusto.windows.net . ,
Required: True ,
}
string ,
batching:
{
Description: Azure Data Explorer endpoint batching configuration. ,
Required: False ,
}
{
latencySeconds:
{
Description: Batching latency in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxMessages:
{
Description: Maximum number of messages in a batch. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
dataLakeStorageSettings:
{
Description: Azure Data Lake endpoint. ,
Required: False ,
}
{
authentication:
{
Description: Authentication configuration. NOTE - only authentication property is allowed per entry. ,
Required: True ,
}
{
method:
{
Description: Mode of Authentication. ,
Enum:
{
SystemAssignedManagedIdentity: SystemAssignedManagedIdentity type ,
UserAssignedManagedIdentity: UserAssignedManagedIdentity type ,
AccessToken: AccessToken Option ,
}
,
Required: True ,
}
enum ,
accessTokenSettings:
{
Description: SAS token authentication. ,
Required: False ,
}
{
secretRef:
{
Description: Token secret name. ,
Required: True ,
}
string ,
}
,
systemAssignedManagedIdentitySettings:
{
Description: System-assigned managed identity authentication. ,
Required: False ,
}
{
audience:
{
Description: Audience of the service to authenticate against. Optional; defaults to the audience for Service host configuration. ,
Required: False ,
}
string ,
}
,
userAssignedManagedIdentitySettings:
{
Description: User-assigned managed identity authentication. ,
Required: False ,
}
{
clientId:
{
Description: Client ID for the user-assigned managed identity. ,
Required: True ,
}
string ,
scope:
{
Description: Resource identifier (application ID URI) of the resource, affixed with the .default suffix. ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID. ,
Required: True ,
}
string ,
}
,
}
,
host:
{
Description: Host of the Azure Data Lake in the form of .blob.core.windows.net . ,
Required: True ,
}
string ,
batching:
{
Description: Azure Data Lake endpoint batching configuration. ,
Required: False ,
}
{
latencySeconds:
{
Description: Batching latency in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxMessages:
{
Description: Maximum number of messages in a batch. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
fabricOneLakeSettings:
{
Description: Microsoft Fabric endpoint. ,
Required: False ,
}
{
authentication:
{
Description: Authentication configuration. NOTE - only one authentication property is allowed per entry. ,
Required: True ,
}
{
method:
{
Description: Mode of Authentication. ,
Enum:
{
SystemAssignedManagedIdentity: SystemAssignedManagedIdentity type ,
UserAssignedManagedIdentity: UserAssignedManagedIdentity type ,
}
,
Required: True ,
}
enum ,
systemAssignedManagedIdentitySettings:
{
Description: System-assigned managed identity authentication. ,
Required: False ,
}
{
audience:
{
Description: Audience of the service to authenticate against. Optional; defaults to the audience for Service host configuration. ,
Required: False ,
}
string ,
}
,
userAssignedManagedIdentitySettings:
{
Description: User-assigned managed identity authentication. ,
Required: False ,
}
{
clientId:
{
Description: Client ID for the user-assigned managed identity. ,
Required: True ,
}
string ,
scope:
{
Description: Resource identifier (application ID URI) of the resource, affixed with the .default suffix. ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID. ,
Required: True ,
}
string ,
}
,
}
,
names:
{
Description: Names of the workspace and lakehouse. ,
Required: True ,
}
{
lakehouseName:
{
Description: Lakehouse name. ,
Required: True ,
}
string ,
workspaceName:
{
Description: Workspace name. ,
Required: True ,
}
string ,
}
,
oneLakePathType:
{
Description: Type of location of the data in the workspace. Can be either tables or files. ,
Enum:
{
Files: FILES Type ,
Tables: TABLES Type ,
}
,
Required: True ,
}
enum ,
host:
{
Description: Host of the Microsoft Fabric in the form of https://.fabric.microsoft.com. ,
Required: True ,
}
string ,
batching:
{
Description: Batching configuration. ,
Required: False ,
}
{
latencySeconds:
{
Description: Batching latency in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxMessages:
{
Description: Maximum number of messages in a batch. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
kafkaSettings:
{
Description: Kafka endpoint. ,
Required: False ,
}
{
authentication:
{
Description: Authentication configuration. NOTE - only authentication property is allowed per entry. ,
Required: True ,
}
{
method:
{
Description: Mode of Authentication. ,
Enum:
{
SystemAssignedManagedIdentity: SystemAssignedManagedIdentity type ,
UserAssignedManagedIdentity: UserAssignedManagedIdentity type ,
Sasl: Sasl Option ,
X509Certificate: x509Certificate Option ,
Anonymous: Anonymous Option ,
}
,
Required: True ,
}
enum ,
systemAssignedManagedIdentitySettings:
{
Description: System-assigned managed identity authentication. ,
Required: False ,
}
{
audience:
{
Description: Audience of the service to authenticate against. Optional; defaults to the audience for Service host configuration. ,
Required: False ,
}
string ,
}
,
userAssignedManagedIdentitySettings:
{
Description: User-assigned managed identity authentication. ,
Required: False ,
}
{
clientId:
{
Description: Client ID for the user-assigned managed identity. ,
Required: True ,
}
string ,
scope:
{
Description: Resource identifier (application ID URI) of the resource, affixed with the .default suffix. ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID. ,
Required: True ,
}
string ,
}
,
saslSettings:
{
Description: SASL authentication. ,
Required: False ,
}
{
saslType:
{
Description: Type of SASL authentication. Can be PLAIN, SCRAM-SHA-256, or SCRAM-SHA-512. ,
Enum:
{
Plain: PLAIN Type ,
ScramSha256: SCRAM_SHA_256 Type ,
ScramSha512: SCRAM_SHA_512 Type ,
}
,
Required: True ,
}
enum ,
secretRef:
{
Description: Token secret name. ,
Required: True ,
}
string ,
}
,
x509CertificateSettings:
{
Description: X.509 certificate authentication. ,
Required: False ,
}
{
secretRef:
{
Description: Secret reference of the X.509 certificate. ,
Required: True ,
}
string ,
}
,
}
,
consumerGroupId:
{
Description: Consumer group ID. ,
Required: False ,
}
string ,
host:
{
Description: Kafka endpoint host. ,
Required: True ,
}
string ,
batching:
{
Description: Batching configuration. ,
Required: False ,
}
{
mode:
{
Description: Mode for batching. ,
Enum:
{
Enabled: Enabled is equivalent to True ,
Disabled: Disabled is equivalent to False. ,
}
,
Required: False ,
}
enum ,
latencyMs:
{
Description: Batching latency in milliseconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxBytes:
{
Description: Maximum number of bytes in a batch. ,
Format: int32 ,
Required: False ,
}
integer ,
maxMessages:
{
Description: Maximum number of messages in a batch. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
copyMqttProperties:
{
Description: Copy Broker properties. No effect if the endpoint is used as a source or if the dataflow doesn't have an Broker source. ,
Enum:
{
Enabled: Enabled is equivalent to True ,
Disabled: Disabled is equivalent to False. ,
}
,
Required: False ,
}
enum ,
compression:
{
Description: Compression. Can be none, gzip, lz4, or snappy. No effect if the endpoint is used as a source. ,
Enum:
{
None: NONE Option ,
Gzip: Gzip Option ,
Snappy: SNAPPY Option ,
Lz4: LZ4 Option ,
}
,
Required: False ,
}
enum ,
kafkaAcks:
{
Description: Kafka acks. Can be all, one, or zero. No effect if the endpoint is used as a source. ,
Enum:
{
Zero: ZERO Option ,
One: ONE Option ,
All: ALL Option ,
}
,
Required: False ,
}
enum ,
partitionStrategy:
{
Description: Partition handling strategy. Can be default or static. No effect if the endpoint is used as a source. ,
Enum:
{
Default: Default: Assigns messages to random partitions, using a round-robin algorithm. ,
Static: Static: Assigns messages to a fixed partition number that's derived from the instance ID of the dataflow. ,
Topic: TOPIC Option ,
Property: PROPERTY Option ,
}
,
Required: False ,
}
enum ,
tls:
{
Description: TLS configuration. ,
Required: False ,
}
{
mode:
{
Description: Mode for TLS. ,
Enum:
{
Enabled: Enabled is equivalent to True ,
Disabled: Disabled is equivalent to False. ,
}
,
Required: False ,
}
enum ,
trustedCaCertificateConfigMapRef:
{
Description: Trusted CA certificate config map. ,
Required: False ,
}
string ,
}
,
cloudEventAttributes:
{
Description: Cloud event mapping config. ,
Enum:
{
Propagate: Propagate type ,
CreateOrRemap: CreateOrRemap type ,
}
,
Required: False ,
}
enum ,
}
,
localStorageSettings:
{
Description: Local persistent volume endpoint. ,
Required: False ,
}
{
persistentVolumeClaimRef:
{
Description: Persistent volume claim name. ,
Required: True ,
}
string ,
}
,
mqttSettings:
{
Description: Broker endpoint. ,
Required: False ,
}
{
authentication:
{
Description: authentication properties. DEFAULT: kubernetes.audience=aio-internal. NOTE - Enum field only property is allowed ,
Required: True ,
}
{
method:
{
Description: Mode of Authentication. ,
Enum:
{
SystemAssignedManagedIdentity: SystemAssignedManagedIdentity type ,
UserAssignedManagedIdentity: UserAssignedManagedIdentity type ,
ServiceAccountToken: ServiceAccountToken Option ,
X509Certificate: x509Certificate Option ,
Anonymous: Anonymous Option ,
}
,
Required: True ,
}
enum ,
systemAssignedManagedIdentitySettings:
{
Description: System-assigned managed identity authentication. ,
Required: False ,
}
{
audience:
{
Description: Audience of the service to authenticate against. Optional; defaults to the audience for Service host configuration. ,
Required: False ,
}
string ,
}
,
userAssignedManagedIdentitySettings:
{
Description: User-assigned managed identity authentication. ,
Required: False ,
}
{
clientId:
{
Description: Client ID for the user-assigned managed identity. ,
Required: True ,
}
string ,
scope:
{
Description: Resource identifier (application ID URI) of the resource, affixed with the .default suffix. ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID. ,
Required: True ,
}
string ,
}
,
serviceAccountTokenSettings:
{
Description: Kubernetes service account token authentication. Default audience if not set is aio-internal ,
Required: False ,
}
{
audience:
{
Description: Audience of the service account. Optional, defaults to the broker internal service account audience. ,
Required: True ,
}
string ,
}
,
x509CertificateSettings:
{
Description: X.509 certificate authentication. ,
Required: False ,
}
{
secretRef:
{
Description: Secret reference of the X.509 certificate. ,
Required: True ,
}
string ,
}
,
}
,
clientIdPrefix:
{
Description: Client ID prefix. Client ID generated by the dataflow is -TBD. Optional; no prefix if omitted. ,
Required: False ,
}
string ,
host:
{
Description: Host of the Broker in the form of :. Optional; connects to Broker if omitted. ,
Required: False ,
}
string ,
protocol:
{
Description: Enable or disable websockets. ,
Enum:
{
Mqtt: protocol broker ,
WebSockets: protocol websocket ,
}
,
Required: False ,
}
enum ,
keepAliveSeconds:
{
Description: Broker KeepAlive for connection in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
retain:
{
Description: Whether or not to keep the retain setting. ,
Enum:
{
Keep: Retain the messages. ,
Never: Never retain messages. ,
}
,
Required: False ,
}
enum ,
maxInflightMessages:
{
Description: The max number of messages to keep in flight. For subscribe, this is the receive maximum. For publish, this is the maximum number of messages to send before waiting for an ack. ,
Format: int32 ,
Required: False ,
}
integer ,
qos:
{
Description: Qos for Broker connection. ,
Format: int32 ,
Required: False ,
}
integer ,
sessionExpirySeconds:
{
Description: Session expiry in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
tls:
{
Description: TLS configuration. ,
Required: False ,
}
{
mode:
{
Description: Mode for TLS. ,
Enum:
{
Enabled: Enabled is equivalent to True ,
Disabled: Disabled is equivalent to False. ,
}
,
Required: False ,
}
enum ,
trustedCaCertificateConfigMapRef:
{
Description: Trusted CA certificate config map. ,
Required: False ,
}
string ,
}
,
cloudEventAttributes:
{
Description: Cloud event mapping config. ,
Enum:
{
Propagate: Propagate type ,
CreateOrRemap: CreateOrRemap type ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Resource is getting provisioned. ,
Updating: Resource is Updating. ,
Deleting: Resource is Deleting. ,
Accepted: Resource has been Accepted. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: Edge location of the resource. ,
Required: True ,
}
{
name:
{
Description: The name of the extended location. ,
Required: True ,
}
string ,
type:
{
Description: Type of ExtendedLocation. ,
Enum:
{
CustomLocation: CustomLocation type ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DataflowEndpoint_Get (new)
Description :  Get a DataflowEndpointResource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/dataflowEndpoints/{dataflowEndpointName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
instanceName:
{
Description: Name of instance. ,
Required: True ,
}
string ,
dataflowEndpointName:
{
Description: Name of Instance dataflowEndpoint resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
endpointType:
{
Description: Endpoint Type. ,
Enum:
{
DataExplorer: Azure Data Explorer Type ,
DataLakeStorage: Azure Data Lake Type ,
FabricOneLake: Microsoft Fabric Type ,
Kafka: Kafka Type ,
LocalStorage: Local Storage Type ,
Mqtt: Broker Type ,
}
,
Required: True ,
}
enum ,
dataExplorerSettings:
{
Description: Azure Data Explorer endpoint. ,
Required: False ,
}
{
authentication:
{
Description: Authentication configuration. NOTE - only authentication property is allowed per entry. ,
Required: True ,
}
{
method:
{
Description: Mode of Authentication. ,
Enum:
{
SystemAssignedManagedIdentity: SystemAssignedManagedIdentity type ,
UserAssignedManagedIdentity: UserAssignedManagedIdentity type ,
}
,
Required: True ,
}
enum ,
systemAssignedManagedIdentitySettings:
{
Description: System-assigned managed identity authentication. ,
Required: False ,
}
{
audience:
{
Description: Audience of the service to authenticate against. Optional; defaults to the audience for Service host configuration. ,
Required: False ,
}
string ,
}
,
userAssignedManagedIdentitySettings:
{
Description: User-assigned managed identity authentication. ,
Required: False ,
}
{
clientId:
{
Description: Client ID for the user-assigned managed identity. ,
Required: True ,
}
string ,
scope:
{
Description: Resource identifier (application ID URI) of the resource, affixed with the .default suffix. ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID. ,
Required: True ,
}
string ,
}
,
}
,
database:
{
Description: Database name. ,
Required: True ,
}
string ,
host:
{
Description: Host of the Azure Data Explorer in the form of ..kusto.windows.net . ,
Required: True ,
}
string ,
batching:
{
Description: Azure Data Explorer endpoint batching configuration. ,
Required: False ,
}
{
latencySeconds:
{
Description: Batching latency in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxMessages:
{
Description: Maximum number of messages in a batch. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
dataLakeStorageSettings:
{
Description: Azure Data Lake endpoint. ,
Required: False ,
}
{
authentication:
{
Description: Authentication configuration. NOTE - only authentication property is allowed per entry. ,
Required: True ,
}
{
method:
{
Description: Mode of Authentication. ,
Enum:
{
SystemAssignedManagedIdentity: SystemAssignedManagedIdentity type ,
UserAssignedManagedIdentity: UserAssignedManagedIdentity type ,
AccessToken: AccessToken Option ,
}
,
Required: True ,
}
enum ,
accessTokenSettings:
{
Description: SAS token authentication. ,
Required: False ,
}
{
secretRef:
{
Description: Token secret name. ,
Required: True ,
}
string ,
}
,
systemAssignedManagedIdentitySettings:
{
Description: System-assigned managed identity authentication. ,
Required: False ,
}
{
audience:
{
Description: Audience of the service to authenticate against. Optional; defaults to the audience for Service host configuration. ,
Required: False ,
}
string ,
}
,
userAssignedManagedIdentitySettings:
{
Description: User-assigned managed identity authentication. ,
Required: False ,
}
{
clientId:
{
Description: Client ID for the user-assigned managed identity. ,
Required: True ,
}
string ,
scope:
{
Description: Resource identifier (application ID URI) of the resource, affixed with the .default suffix. ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID. ,
Required: True ,
}
string ,
}
,
}
,
host:
{
Description: Host of the Azure Data Lake in the form of .blob.core.windows.net . ,
Required: True ,
}
string ,
batching:
{
Description: Azure Data Lake endpoint batching configuration. ,
Required: False ,
}
{
latencySeconds:
{
Description: Batching latency in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxMessages:
{
Description: Maximum number of messages in a batch. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
fabricOneLakeSettings:
{
Description: Microsoft Fabric endpoint. ,
Required: False ,
}
{
authentication:
{
Description: Authentication configuration. NOTE - only one authentication property is allowed per entry. ,
Required: True ,
}
{
method:
{
Description: Mode of Authentication. ,
Enum:
{
SystemAssignedManagedIdentity: SystemAssignedManagedIdentity type ,
UserAssignedManagedIdentity: UserAssignedManagedIdentity type ,
}
,
Required: True ,
}
enum ,
systemAssignedManagedIdentitySettings:
{
Description: System-assigned managed identity authentication. ,
Required: False ,
}
{
audience:
{
Description: Audience of the service to authenticate against. Optional; defaults to the audience for Service host configuration. ,
Required: False ,
}
string ,
}
,
userAssignedManagedIdentitySettings:
{
Description: User-assigned managed identity authentication. ,
Required: False ,
}
{
clientId:
{
Description: Client ID for the user-assigned managed identity. ,
Required: True ,
}
string ,
scope:
{
Description: Resource identifier (application ID URI) of the resource, affixed with the .default suffix. ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID. ,
Required: True ,
}
string ,
}
,
}
,
names:
{
Description: Names of the workspace and lakehouse. ,
Required: True ,
}
{
lakehouseName:
{
Description: Lakehouse name. ,
Required: True ,
}
string ,
workspaceName:
{
Description: Workspace name. ,
Required: True ,
}
string ,
}
,
oneLakePathType:
{
Description: Type of location of the data in the workspace. Can be either tables or files. ,
Enum:
{
Files: FILES Type ,
Tables: TABLES Type ,
}
,
Required: True ,
}
enum ,
host:
{
Description: Host of the Microsoft Fabric in the form of https://.fabric.microsoft.com. ,
Required: True ,
}
string ,
batching:
{
Description: Batching configuration. ,
Required: False ,
}
{
latencySeconds:
{
Description: Batching latency in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxMessages:
{
Description: Maximum number of messages in a batch. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
kafkaSettings:
{
Description: Kafka endpoint. ,
Required: False ,
}
{
authentication:
{
Description: Authentication configuration. NOTE - only authentication property is allowed per entry. ,
Required: True ,
}
{
method:
{
Description: Mode of Authentication. ,
Enum:
{
SystemAssignedManagedIdentity: SystemAssignedManagedIdentity type ,
UserAssignedManagedIdentity: UserAssignedManagedIdentity type ,
Sasl: Sasl Option ,
X509Certificate: x509Certificate Option ,
Anonymous: Anonymous Option ,
}
,
Required: True ,
}
enum ,
systemAssignedManagedIdentitySettings:
{
Description: System-assigned managed identity authentication. ,
Required: False ,
}
{
audience:
{
Description: Audience of the service to authenticate against. Optional; defaults to the audience for Service host configuration. ,
Required: False ,
}
string ,
}
,
userAssignedManagedIdentitySettings:
{
Description: User-assigned managed identity authentication. ,
Required: False ,
}
{
clientId:
{
Description: Client ID for the user-assigned managed identity. ,
Required: True ,
}
string ,
scope:
{
Description: Resource identifier (application ID URI) of the resource, affixed with the .default suffix. ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID. ,
Required: True ,
}
string ,
}
,
saslSettings:
{
Description: SASL authentication. ,
Required: False ,
}
{
saslType:
{
Description: Type of SASL authentication. Can be PLAIN, SCRAM-SHA-256, or SCRAM-SHA-512. ,
Enum:
{
Plain: PLAIN Type ,
ScramSha256: SCRAM_SHA_256 Type ,
ScramSha512: SCRAM_SHA_512 Type ,
}
,
Required: True ,
}
enum ,
secretRef:
{
Description: Token secret name. ,
Required: True ,
}
string ,
}
,
x509CertificateSettings:
{
Description: X.509 certificate authentication. ,
Required: False ,
}
{
secretRef:
{
Description: Secret reference of the X.509 certificate. ,
Required: True ,
}
string ,
}
,
}
,
consumerGroupId:
{
Description: Consumer group ID. ,
Required: False ,
}
string ,
host:
{
Description: Kafka endpoint host. ,
Required: True ,
}
string ,
batching:
{
Description: Batching configuration. ,
Required: False ,
}
{
mode:
{
Description: Mode for batching. ,
Enum:
{
Enabled: Enabled is equivalent to True ,
Disabled: Disabled is equivalent to False. ,
}
,
Required: False ,
}
enum ,
latencyMs:
{
Description: Batching latency in milliseconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxBytes:
{
Description: Maximum number of bytes in a batch. ,
Format: int32 ,
Required: False ,
}
integer ,
maxMessages:
{
Description: Maximum number of messages in a batch. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
copyMqttProperties:
{
Description: Copy Broker properties. No effect if the endpoint is used as a source or if the dataflow doesn't have an Broker source. ,
Enum:
{
Enabled: Enabled is equivalent to True ,
Disabled: Disabled is equivalent to False. ,
}
,
Required: False ,
}
enum ,
compression:
{
Description: Compression. Can be none, gzip, lz4, or snappy. No effect if the endpoint is used as a source. ,
Enum:
{
None: NONE Option ,
Gzip: Gzip Option ,
Snappy: SNAPPY Option ,
Lz4: LZ4 Option ,
}
,
Required: False ,
}
enum ,
kafkaAcks:
{
Description: Kafka acks. Can be all, one, or zero. No effect if the endpoint is used as a source. ,
Enum:
{
Zero: ZERO Option ,
One: ONE Option ,
All: ALL Option ,
}
,
Required: False ,
}
enum ,
partitionStrategy:
{
Description: Partition handling strategy. Can be default or static. No effect if the endpoint is used as a source. ,
Enum:
{
Default: Default: Assigns messages to random partitions, using a round-robin algorithm. ,
Static: Static: Assigns messages to a fixed partition number that's derived from the instance ID of the dataflow. ,
Topic: TOPIC Option ,
Property: PROPERTY Option ,
}
,
Required: False ,
}
enum ,
tls:
{
Description: TLS configuration. ,
Required: False ,
}
{
mode:
{
Description: Mode for TLS. ,
Enum:
{
Enabled: Enabled is equivalent to True ,
Disabled: Disabled is equivalent to False. ,
}
,
Required: False ,
}
enum ,
trustedCaCertificateConfigMapRef:
{
Description: Trusted CA certificate config map. ,
Required: False ,
}
string ,
}
,
cloudEventAttributes:
{
Description: Cloud event mapping config. ,
Enum:
{
Propagate: Propagate type ,
CreateOrRemap: CreateOrRemap type ,
}
,
Required: False ,
}
enum ,
}
,
localStorageSettings:
{
Description: Local persistent volume endpoint. ,
Required: False ,
}
{
persistentVolumeClaimRef:
{
Description: Persistent volume claim name. ,
Required: True ,
}
string ,
}
,
mqttSettings:
{
Description: Broker endpoint. ,
Required: False ,
}
{
authentication:
{
Description: authentication properties. DEFAULT: kubernetes.audience=aio-internal. NOTE - Enum field only property is allowed ,
Required: True ,
}
{
method:
{
Description: Mode of Authentication. ,
Enum:
{
SystemAssignedManagedIdentity: SystemAssignedManagedIdentity type ,
UserAssignedManagedIdentity: UserAssignedManagedIdentity type ,
ServiceAccountToken: ServiceAccountToken Option ,
X509Certificate: x509Certificate Option ,
Anonymous: Anonymous Option ,
}
,
Required: True ,
}
enum ,
systemAssignedManagedIdentitySettings:
{
Description: System-assigned managed identity authentication. ,
Required: False ,
}
{
audience:
{
Description: Audience of the service to authenticate against. Optional; defaults to the audience for Service host configuration. ,
Required: False ,
}
string ,
}
,
userAssignedManagedIdentitySettings:
{
Description: User-assigned managed identity authentication. ,
Required: False ,
}
{
clientId:
{
Description: Client ID for the user-assigned managed identity. ,
Required: True ,
}
string ,
scope:
{
Description: Resource identifier (application ID URI) of the resource, affixed with the .default suffix. ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID. ,
Required: True ,
}
string ,
}
,
serviceAccountTokenSettings:
{
Description: Kubernetes service account token authentication. Default audience if not set is aio-internal ,
Required: False ,
}
{
audience:
{
Description: Audience of the service account. Optional, defaults to the broker internal service account audience. ,
Required: True ,
}
string ,
}
,
x509CertificateSettings:
{
Description: X.509 certificate authentication. ,
Required: False ,
}
{
secretRef:
{
Description: Secret reference of the X.509 certificate. ,
Required: True ,
}
string ,
}
,
}
,
clientIdPrefix:
{
Description: Client ID prefix. Client ID generated by the dataflow is -TBD. Optional; no prefix if omitted. ,
Required: False ,
}
string ,
host:
{
Description: Host of the Broker in the form of :. Optional; connects to Broker if omitted. ,
Required: False ,
}
string ,
protocol:
{
Description: Enable or disable websockets. ,
Enum:
{
Mqtt: protocol broker ,
WebSockets: protocol websocket ,
}
,
Required: False ,
}
enum ,
keepAliveSeconds:
{
Description: Broker KeepAlive for connection in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
retain:
{
Description: Whether or not to keep the retain setting. ,
Enum:
{
Keep: Retain the messages. ,
Never: Never retain messages. ,
}
,
Required: False ,
}
enum ,
maxInflightMessages:
{
Description: The max number of messages to keep in flight. For subscribe, this is the receive maximum. For publish, this is the maximum number of messages to send before waiting for an ack. ,
Format: int32 ,
Required: False ,
}
integer ,
qos:
{
Description: Qos for Broker connection. ,
Format: int32 ,
Required: False ,
}
integer ,
sessionExpirySeconds:
{
Description: Session expiry in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
tls:
{
Description: TLS configuration. ,
Required: False ,
}
{
mode:
{
Description: Mode for TLS. ,
Enum:
{
Enabled: Enabled is equivalent to True ,
Disabled: Disabled is equivalent to False. ,
}
,
Required: False ,
}
enum ,
trustedCaCertificateConfigMapRef:
{
Description: Trusted CA certificate config map. ,
Required: False ,
}
string ,
}
,
cloudEventAttributes:
{
Description: Cloud event mapping config. ,
Enum:
{
Propagate: Propagate type ,
CreateOrRemap: CreateOrRemap type ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Resource is getting provisioned. ,
Updating: Resource is Updating. ,
Deleting: Resource is Deleting. ,
Accepted: Resource has been Accepted. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: Edge location of the resource. ,
Required: True ,
}
{
name:
{
Description: The name of the extended location. ,
Required: True ,
}
string ,
type:
{
Description: Type of ExtendedLocation. ,
Enum:
{
CustomLocation: CustomLocation type ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DataflowEndpoint_CreateOrUpdate (new)
Description :  Create a DataflowEndpointResource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/dataflowEndpoints/{dataflowEndpointName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
instanceName:
{
Description: Name of instance. ,
Required: True ,
}
string ,
dataflowEndpointName:
{
Description: Name of Instance dataflowEndpoint resource ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
endpointType:
{
Description: Endpoint Type. ,
Enum:
{
DataExplorer: Azure Data Explorer Type ,
DataLakeStorage: Azure Data Lake Type ,
FabricOneLake: Microsoft Fabric Type ,
Kafka: Kafka Type ,
LocalStorage: Local Storage Type ,
Mqtt: Broker Type ,
}
,
Required: True ,
}
enum ,
dataExplorerSettings:
{
Description: Azure Data Explorer endpoint. ,
Required: False ,
}
{
authentication:
{
Description: Authentication configuration. NOTE - only authentication property is allowed per entry. ,
Required: True ,
}
{
method:
{
Description: Mode of Authentication. ,
Enum:
{
SystemAssignedManagedIdentity: SystemAssignedManagedIdentity type ,
UserAssignedManagedIdentity: UserAssignedManagedIdentity type ,
}
,
Required: True ,
}
enum ,
systemAssignedManagedIdentitySettings:
{
Description: System-assigned managed identity authentication. ,
Required: False ,
}
{
audience:
{
Description: Audience of the service to authenticate against. Optional; defaults to the audience for Service host configuration. ,
Required: False ,
}
string ,
}
,
userAssignedManagedIdentitySettings:
{
Description: User-assigned managed identity authentication. ,
Required: False ,
}
{
clientId:
{
Description: Client ID for the user-assigned managed identity. ,
Required: True ,
}
string ,
scope:
{
Description: Resource identifier (application ID URI) of the resource, affixed with the .default suffix. ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID. ,
Required: True ,
}
string ,
}
,
}
,
database:
{
Description: Database name. ,
Required: True ,
}
string ,
host:
{
Description: Host of the Azure Data Explorer in the form of ..kusto.windows.net . ,
Required: True ,
}
string ,
batching:
{
Description: Azure Data Explorer endpoint batching configuration. ,
Required: False ,
}
{
latencySeconds:
{
Description: Batching latency in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxMessages:
{
Description: Maximum number of messages in a batch. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
dataLakeStorageSettings:
{
Description: Azure Data Lake endpoint. ,
Required: False ,
}
{
authentication:
{
Description: Authentication configuration. NOTE - only authentication property is allowed per entry. ,
Required: True ,
}
{
method:
{
Description: Mode of Authentication. ,
Enum:
{
SystemAssignedManagedIdentity: SystemAssignedManagedIdentity type ,
UserAssignedManagedIdentity: UserAssignedManagedIdentity type ,
AccessToken: AccessToken Option ,
}
,
Required: True ,
}
enum ,
accessTokenSettings:
{
Description: SAS token authentication. ,
Required: False ,
}
{
secretRef:
{
Description: Token secret name. ,
Required: True ,
}
string ,
}
,
systemAssignedManagedIdentitySettings:
{
Description: System-assigned managed identity authentication. ,
Required: False ,
}
{
audience:
{
Description: Audience of the service to authenticate against. Optional; defaults to the audience for Service host configuration. ,
Required: False ,
}
string ,
}
,
userAssignedManagedIdentitySettings:
{
Description: User-assigned managed identity authentication. ,
Required: False ,
}
{
clientId:
{
Description: Client ID for the user-assigned managed identity. ,
Required: True ,
}
string ,
scope:
{
Description: Resource identifier (application ID URI) of the resource, affixed with the .default suffix. ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID. ,
Required: True ,
}
string ,
}
,
}
,
host:
{
Description: Host of the Azure Data Lake in the form of .blob.core.windows.net . ,
Required: True ,
}
string ,
batching:
{
Description: Azure Data Lake endpoint batching configuration. ,
Required: False ,
}
{
latencySeconds:
{
Description: Batching latency in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxMessages:
{
Description: Maximum number of messages in a batch. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
fabricOneLakeSettings:
{
Description: Microsoft Fabric endpoint. ,
Required: False ,
}
{
authentication:
{
Description: Authentication configuration. NOTE - only one authentication property is allowed per entry. ,
Required: True ,
}
{
method:
{
Description: Mode of Authentication. ,
Enum:
{
SystemAssignedManagedIdentity: SystemAssignedManagedIdentity type ,
UserAssignedManagedIdentity: UserAssignedManagedIdentity type ,
}
,
Required: True ,
}
enum ,
systemAssignedManagedIdentitySettings:
{
Description: System-assigned managed identity authentication. ,
Required: False ,
}
{
audience:
{
Description: Audience of the service to authenticate against. Optional; defaults to the audience for Service host configuration. ,
Required: False ,
}
string ,
}
,
userAssignedManagedIdentitySettings:
{
Description: User-assigned managed identity authentication. ,
Required: False ,
}
{
clientId:
{
Description: Client ID for the user-assigned managed identity. ,
Required: True ,
}
string ,
scope:
{
Description: Resource identifier (application ID URI) of the resource, affixed with the .default suffix. ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID. ,
Required: True ,
}
string ,
}
,
}
,
names:
{
Description: Names of the workspace and lakehouse. ,
Required: True ,
}
{
lakehouseName:
{
Description: Lakehouse name. ,
Required: True ,
}
string ,
workspaceName:
{
Description: Workspace name. ,
Required: True ,
}
string ,
}
,
oneLakePathType:
{
Description: Type of location of the data in the workspace. Can be either tables or files. ,
Enum:
{
Files: FILES Type ,
Tables: TABLES Type ,
}
,
Required: True ,
}
enum ,
host:
{
Description: Host of the Microsoft Fabric in the form of https://.fabric.microsoft.com. ,
Required: True ,
}
string ,
batching:
{
Description: Batching configuration. ,
Required: False ,
}
{
latencySeconds:
{
Description: Batching latency in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxMessages:
{
Description: Maximum number of messages in a batch. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
kafkaSettings:
{
Description: Kafka endpoint. ,
Required: False ,
}
{
authentication:
{
Description: Authentication configuration. NOTE - only authentication property is allowed per entry. ,
Required: True ,
}
{
method:
{
Description: Mode of Authentication. ,
Enum:
{
SystemAssignedManagedIdentity: SystemAssignedManagedIdentity type ,
UserAssignedManagedIdentity: UserAssignedManagedIdentity type ,
Sasl: Sasl Option ,
X509Certificate: x509Certificate Option ,
Anonymous: Anonymous Option ,
}
,
Required: True ,
}
enum ,
systemAssignedManagedIdentitySettings:
{
Description: System-assigned managed identity authentication. ,
Required: False ,
}
{
audience:
{
Description: Audience of the service to authenticate against. Optional; defaults to the audience for Service host configuration. ,
Required: False ,
}
string ,
}
,
userAssignedManagedIdentitySettings:
{
Description: User-assigned managed identity authentication. ,
Required: False ,
}
{
clientId:
{
Description: Client ID for the user-assigned managed identity. ,
Required: True ,
}
string ,
scope:
{
Description: Resource identifier (application ID URI) of the resource, affixed with the .default suffix. ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID. ,
Required: True ,
}
string ,
}
,
saslSettings:
{
Description: SASL authentication. ,
Required: False ,
}
{
saslType:
{
Description: Type of SASL authentication. Can be PLAIN, SCRAM-SHA-256, or SCRAM-SHA-512. ,
Enum:
{
Plain: PLAIN Type ,
ScramSha256: SCRAM_SHA_256 Type ,
ScramSha512: SCRAM_SHA_512 Type ,
}
,
Required: True ,
}
enum ,
secretRef:
{
Description: Token secret name. ,
Required: True ,
}
string ,
}
,
x509CertificateSettings:
{
Description: X.509 certificate authentication. ,
Required: False ,
}
{
secretRef:
{
Description: Secret reference of the X.509 certificate. ,
Required: True ,
}
string ,
}
,
}
,
consumerGroupId:
{
Description: Consumer group ID. ,
Required: False ,
}
string ,
host:
{
Description: Kafka endpoint host. ,
Required: True ,
}
string ,
batching:
{
Description: Batching configuration. ,
Required: False ,
}
{
mode:
{
Description: Mode for batching. ,
Enum:
{
Enabled: Enabled is equivalent to True ,
Disabled: Disabled is equivalent to False. ,
}
,
Required: False ,
}
enum ,
latencyMs:
{
Description: Batching latency in milliseconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxBytes:
{
Description: Maximum number of bytes in a batch. ,
Format: int32 ,
Required: False ,
}
integer ,
maxMessages:
{
Description: Maximum number of messages in a batch. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
copyMqttProperties:
{
Description: Copy Broker properties. No effect if the endpoint is used as a source or if the dataflow doesn't have an Broker source. ,
Enum:
{
Enabled: Enabled is equivalent to True ,
Disabled: Disabled is equivalent to False. ,
}
,
Required: False ,
}
enum ,
compression:
{
Description: Compression. Can be none, gzip, lz4, or snappy. No effect if the endpoint is used as a source. ,
Enum:
{
None: NONE Option ,
Gzip: Gzip Option ,
Snappy: SNAPPY Option ,
Lz4: LZ4 Option ,
}
,
Required: False ,
}
enum ,
kafkaAcks:
{
Description: Kafka acks. Can be all, one, or zero. No effect if the endpoint is used as a source. ,
Enum:
{
Zero: ZERO Option ,
One: ONE Option ,
All: ALL Option ,
}
,
Required: False ,
}
enum ,
partitionStrategy:
{
Description: Partition handling strategy. Can be default or static. No effect if the endpoint is used as a source. ,
Enum:
{
Default: Default: Assigns messages to random partitions, using a round-robin algorithm. ,
Static: Static: Assigns messages to a fixed partition number that's derived from the instance ID of the dataflow. ,
Topic: TOPIC Option ,
Property: PROPERTY Option ,
}
,
Required: False ,
}
enum ,
tls:
{
Description: TLS configuration. ,
Required: False ,
}
{
mode:
{
Description: Mode for TLS. ,
Enum:
{
Enabled: Enabled is equivalent to True ,
Disabled: Disabled is equivalent to False. ,
}
,
Required: False ,
}
enum ,
trustedCaCertificateConfigMapRef:
{
Description: Trusted CA certificate config map. ,
Required: False ,
}
string ,
}
,
cloudEventAttributes:
{
Description: Cloud event mapping config. ,
Enum:
{
Propagate: Propagate type ,
CreateOrRemap: CreateOrRemap type ,
}
,
Required: False ,
}
enum ,
}
,
localStorageSettings:
{
Description: Local persistent volume endpoint. ,
Required: False ,
}
{
persistentVolumeClaimRef:
{
Description: Persistent volume claim name. ,
Required: True ,
}
string ,
}
,
mqttSettings:
{
Description: Broker endpoint. ,
Required: False ,
}
{
authentication:
{
Description: authentication properties. DEFAULT: kubernetes.audience=aio-internal. NOTE - Enum field only property is allowed ,
Required: True ,
}
{
method:
{
Description: Mode of Authentication. ,
Enum:
{
SystemAssignedManagedIdentity: SystemAssignedManagedIdentity type ,
UserAssignedManagedIdentity: UserAssignedManagedIdentity type ,
ServiceAccountToken: ServiceAccountToken Option ,
X509Certificate: x509Certificate Option ,
Anonymous: Anonymous Option ,
}
,
Required: True ,
}
enum ,
systemAssignedManagedIdentitySettings:
{
Description: System-assigned managed identity authentication. ,
Required: False ,
}
{
audience:
{
Description: Audience of the service to authenticate against. Optional; defaults to the audience for Service host configuration. ,
Required: False ,
}
string ,
}
,
userAssignedManagedIdentitySettings:
{
Description: User-assigned managed identity authentication. ,
Required: False ,
}
{
clientId:
{
Description: Client ID for the user-assigned managed identity. ,
Required: True ,
}
string ,
scope:
{
Description: Resource identifier (application ID URI) of the resource, affixed with the .default suffix. ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID. ,
Required: True ,
}
string ,
}
,
serviceAccountTokenSettings:
{
Description: Kubernetes service account token authentication. Default audience if not set is aio-internal ,
Required: False ,
}
{
audience:
{
Description: Audience of the service account. Optional, defaults to the broker internal service account audience. ,
Required: True ,
}
string ,
}
,
x509CertificateSettings:
{
Description: X.509 certificate authentication. ,
Required: False ,
}
{
secretRef:
{
Description: Secret reference of the X.509 certificate. ,
Required: True ,
}
string ,
}
,
}
,
clientIdPrefix:
{
Description: Client ID prefix. Client ID generated by the dataflow is -TBD. Optional; no prefix if omitted. ,
Required: False ,
}
string ,
host:
{
Description: Host of the Broker in the form of :. Optional; connects to Broker if omitted. ,
Required: False ,
}
string ,
protocol:
{
Description: Enable or disable websockets. ,
Enum:
{
Mqtt: protocol broker ,
WebSockets: protocol websocket ,
}
,
Required: False ,
}
enum ,
keepAliveSeconds:
{
Description: Broker KeepAlive for connection in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
retain:
{
Description: Whether or not to keep the retain setting. ,
Enum:
{
Keep: Retain the messages. ,
Never: Never retain messages. ,
}
,
Required: False ,
}
enum ,
maxInflightMessages:
{
Description: The max number of messages to keep in flight. For subscribe, this is the receive maximum. For publish, this is the maximum number of messages to send before waiting for an ack. ,
Format: int32 ,
Required: False ,
}
integer ,
qos:
{
Description: Qos for Broker connection. ,
Format: int32 ,
Required: False ,
}
integer ,
sessionExpirySeconds:
{
Description: Session expiry in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
tls:
{
Description: TLS configuration. ,
Required: False ,
}
{
mode:
{
Description: Mode for TLS. ,
Enum:
{
Enabled: Enabled is equivalent to True ,
Disabled: Disabled is equivalent to False. ,
}
,
Required: False ,
}
enum ,
trustedCaCertificateConfigMapRef:
{
Description: Trusted CA certificate config map. ,
Required: False ,
}
string ,
}
,
cloudEventAttributes:
{
Description: Cloud event mapping config. ,
Enum:
{
Propagate: Propagate type ,
CreateOrRemap: CreateOrRemap type ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Resource is getting provisioned. ,
Updating: Resource is Updating. ,
Deleting: Resource is Deleting. ,
Accepted: Resource has been Accepted. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: Edge location of the resource. ,
Required: True ,
}
{
name:
{
Description: The name of the extended location. ,
Required: True ,
}
string ,
type:
{
Description: Type of ExtendedLocation. ,
Enum:
{
CustomLocation: CustomLocation type ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
endpointType:
{
Description: Endpoint Type. ,
Enum:
{
DataExplorer: Azure Data Explorer Type ,
DataLakeStorage: Azure Data Lake Type ,
FabricOneLake: Microsoft Fabric Type ,
Kafka: Kafka Type ,
LocalStorage: Local Storage Type ,
Mqtt: Broker Type ,
}
,
Required: True ,
}
enum ,
dataExplorerSettings:
{
Description: Azure Data Explorer endpoint. ,
Required: False ,
}
{
authentication:
{
Description: Authentication configuration. NOTE - only authentication property is allowed per entry. ,
Required: True ,
}
{
method:
{
Description: Mode of Authentication. ,
Enum:
{
SystemAssignedManagedIdentity: SystemAssignedManagedIdentity type ,
UserAssignedManagedIdentity: UserAssignedManagedIdentity type ,
}
,
Required: True ,
}
enum ,
systemAssignedManagedIdentitySettings:
{
Description: System-assigned managed identity authentication. ,
Required: False ,
}
{
audience:
{
Description: Audience of the service to authenticate against. Optional; defaults to the audience for Service host configuration. ,
Required: False ,
}
string ,
}
,
userAssignedManagedIdentitySettings:
{
Description: User-assigned managed identity authentication. ,
Required: False ,
}
{
clientId:
{
Description: Client ID for the user-assigned managed identity. ,
Required: True ,
}
string ,
scope:
{
Description: Resource identifier (application ID URI) of the resource, affixed with the .default suffix. ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID. ,
Required: True ,
}
string ,
}
,
}
,
database:
{
Description: Database name. ,
Required: True ,
}
string ,
host:
{
Description: Host of the Azure Data Explorer in the form of ..kusto.windows.net . ,
Required: True ,
}
string ,
batching:
{
Description: Azure Data Explorer endpoint batching configuration. ,
Required: False ,
}
{
latencySeconds:
{
Description: Batching latency in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxMessages:
{
Description: Maximum number of messages in a batch. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
dataLakeStorageSettings:
{
Description: Azure Data Lake endpoint. ,
Required: False ,
}
{
authentication:
{
Description: Authentication configuration. NOTE - only authentication property is allowed per entry. ,
Required: True ,
}
{
method:
{
Description: Mode of Authentication. ,
Enum:
{
SystemAssignedManagedIdentity: SystemAssignedManagedIdentity type ,
UserAssignedManagedIdentity: UserAssignedManagedIdentity type ,
AccessToken: AccessToken Option ,
}
,
Required: True ,
}
enum ,
accessTokenSettings:
{
Description: SAS token authentication. ,
Required: False ,
}
{
secretRef:
{
Description: Token secret name. ,
Required: True ,
}
string ,
}
,
systemAssignedManagedIdentitySettings:
{
Description: System-assigned managed identity authentication. ,
Required: False ,
}
{
audience:
{
Description: Audience of the service to authenticate against. Optional; defaults to the audience for Service host configuration. ,
Required: False ,
}
string ,
}
,
userAssignedManagedIdentitySettings:
{
Description: User-assigned managed identity authentication. ,
Required: False ,
}
{
clientId:
{
Description: Client ID for the user-assigned managed identity. ,
Required: True ,
}
string ,
scope:
{
Description: Resource identifier (application ID URI) of the resource, affixed with the .default suffix. ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID. ,
Required: True ,
}
string ,
}
,
}
,
host:
{
Description: Host of the Azure Data Lake in the form of .blob.core.windows.net . ,
Required: True ,
}
string ,
batching:
{
Description: Azure Data Lake endpoint batching configuration. ,
Required: False ,
}
{
latencySeconds:
{
Description: Batching latency in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxMessages:
{
Description: Maximum number of messages in a batch. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
fabricOneLakeSettings:
{
Description: Microsoft Fabric endpoint. ,
Required: False ,
}
{
authentication:
{
Description: Authentication configuration. NOTE - only one authentication property is allowed per entry. ,
Required: True ,
}
{
method:
{
Description: Mode of Authentication. ,
Enum:
{
SystemAssignedManagedIdentity: SystemAssignedManagedIdentity type ,
UserAssignedManagedIdentity: UserAssignedManagedIdentity type ,
}
,
Required: True ,
}
enum ,
systemAssignedManagedIdentitySettings:
{
Description: System-assigned managed identity authentication. ,
Required: False ,
}
{
audience:
{
Description: Audience of the service to authenticate against. Optional; defaults to the audience for Service host configuration. ,
Required: False ,
}
string ,
}
,
userAssignedManagedIdentitySettings:
{
Description: User-assigned managed identity authentication. ,
Required: False ,
}
{
clientId:
{
Description: Client ID for the user-assigned managed identity. ,
Required: True ,
}
string ,
scope:
{
Description: Resource identifier (application ID URI) of the resource, affixed with the .default suffix. ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID. ,
Required: True ,
}
string ,
}
,
}
,
names:
{
Description: Names of the workspace and lakehouse. ,
Required: True ,
}
{
lakehouseName:
{
Description: Lakehouse name. ,
Required: True ,
}
string ,
workspaceName:
{
Description: Workspace name. ,
Required: True ,
}
string ,
}
,
oneLakePathType:
{
Description: Type of location of the data in the workspace. Can be either tables or files. ,
Enum:
{
Files: FILES Type ,
Tables: TABLES Type ,
}
,
Required: True ,
}
enum ,
host:
{
Description: Host of the Microsoft Fabric in the form of https://.fabric.microsoft.com. ,
Required: True ,
}
string ,
batching:
{
Description: Batching configuration. ,
Required: False ,
}
{
latencySeconds:
{
Description: Batching latency in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxMessages:
{
Description: Maximum number of messages in a batch. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
kafkaSettings:
{
Description: Kafka endpoint. ,
Required: False ,
}
{
authentication:
{
Description: Authentication configuration. NOTE - only authentication property is allowed per entry. ,
Required: True ,
}
{
method:
{
Description: Mode of Authentication. ,
Enum:
{
SystemAssignedManagedIdentity: SystemAssignedManagedIdentity type ,
UserAssignedManagedIdentity: UserAssignedManagedIdentity type ,
Sasl: Sasl Option ,
X509Certificate: x509Certificate Option ,
Anonymous: Anonymous Option ,
}
,
Required: True ,
}
enum ,
systemAssignedManagedIdentitySettings:
{
Description: System-assigned managed identity authentication. ,
Required: False ,
}
{
audience:
{
Description: Audience of the service to authenticate against. Optional; defaults to the audience for Service host configuration. ,
Required: False ,
}
string ,
}
,
userAssignedManagedIdentitySettings:
{
Description: User-assigned managed identity authentication. ,
Required: False ,
}
{
clientId:
{
Description: Client ID for the user-assigned managed identity. ,
Required: True ,
}
string ,
scope:
{
Description: Resource identifier (application ID URI) of the resource, affixed with the .default suffix. ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID. ,
Required: True ,
}
string ,
}
,
saslSettings:
{
Description: SASL authentication. ,
Required: False ,
}
{
saslType:
{
Description: Type of SASL authentication. Can be PLAIN, SCRAM-SHA-256, or SCRAM-SHA-512. ,
Enum:
{
Plain: PLAIN Type ,
ScramSha256: SCRAM_SHA_256 Type ,
ScramSha512: SCRAM_SHA_512 Type ,
}
,
Required: True ,
}
enum ,
secretRef:
{
Description: Token secret name. ,
Required: True ,
}
string ,
}
,
x509CertificateSettings:
{
Description: X.509 certificate authentication. ,
Required: False ,
}
{
secretRef:
{
Description: Secret reference of the X.509 certificate. ,
Required: True ,
}
string ,
}
,
}
,
consumerGroupId:
{
Description: Consumer group ID. ,
Required: False ,
}
string ,
host:
{
Description: Kafka endpoint host. ,
Required: True ,
}
string ,
batching:
{
Description: Batching configuration. ,
Required: False ,
}
{
mode:
{
Description: Mode for batching. ,
Enum:
{
Enabled: Enabled is equivalent to True ,
Disabled: Disabled is equivalent to False. ,
}
,
Required: False ,
}
enum ,
latencyMs:
{
Description: Batching latency in milliseconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxBytes:
{
Description: Maximum number of bytes in a batch. ,
Format: int32 ,
Required: False ,
}
integer ,
maxMessages:
{
Description: Maximum number of messages in a batch. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
copyMqttProperties:
{
Description: Copy Broker properties. No effect if the endpoint is used as a source or if the dataflow doesn't have an Broker source. ,
Enum:
{
Enabled: Enabled is equivalent to True ,
Disabled: Disabled is equivalent to False. ,
}
,
Required: False ,
}
enum ,
compression:
{
Description: Compression. Can be none, gzip, lz4, or snappy. No effect if the endpoint is used as a source. ,
Enum:
{
None: NONE Option ,
Gzip: Gzip Option ,
Snappy: SNAPPY Option ,
Lz4: LZ4 Option ,
}
,
Required: False ,
}
enum ,
kafkaAcks:
{
Description: Kafka acks. Can be all, one, or zero. No effect if the endpoint is used as a source. ,
Enum:
{
Zero: ZERO Option ,
One: ONE Option ,
All: ALL Option ,
}
,
Required: False ,
}
enum ,
partitionStrategy:
{
Description: Partition handling strategy. Can be default or static. No effect if the endpoint is used as a source. ,
Enum:
{
Default: Default: Assigns messages to random partitions, using a round-robin algorithm. ,
Static: Static: Assigns messages to a fixed partition number that's derived from the instance ID of the dataflow. ,
Topic: TOPIC Option ,
Property: PROPERTY Option ,
}
,
Required: False ,
}
enum ,
tls:
{
Description: TLS configuration. ,
Required: False ,
}
{
mode:
{
Description: Mode for TLS. ,
Enum:
{
Enabled: Enabled is equivalent to True ,
Disabled: Disabled is equivalent to False. ,
}
,
Required: False ,
}
enum ,
trustedCaCertificateConfigMapRef:
{
Description: Trusted CA certificate config map. ,
Required: False ,
}
string ,
}
,
cloudEventAttributes:
{
Description: Cloud event mapping config. ,
Enum:
{
Propagate: Propagate type ,
CreateOrRemap: CreateOrRemap type ,
}
,
Required: False ,
}
enum ,
}
,
localStorageSettings:
{
Description: Local persistent volume endpoint. ,
Required: False ,
}
{
persistentVolumeClaimRef:
{
Description: Persistent volume claim name. ,
Required: True ,
}
string ,
}
,
mqttSettings:
{
Description: Broker endpoint. ,
Required: False ,
}
{
authentication:
{
Description: authentication properties. DEFAULT: kubernetes.audience=aio-internal. NOTE - Enum field only property is allowed ,
Required: True ,
}
{
method:
{
Description: Mode of Authentication. ,
Enum:
{
SystemAssignedManagedIdentity: SystemAssignedManagedIdentity type ,
UserAssignedManagedIdentity: UserAssignedManagedIdentity type ,
ServiceAccountToken: ServiceAccountToken Option ,
X509Certificate: x509Certificate Option ,
Anonymous: Anonymous Option ,
}
,
Required: True ,
}
enum ,
systemAssignedManagedIdentitySettings:
{
Description: System-assigned managed identity authentication. ,
Required: False ,
}
{
audience:
{
Description: Audience of the service to authenticate against. Optional; defaults to the audience for Service host configuration. ,
Required: False ,
}
string ,
}
,
userAssignedManagedIdentitySettings:
{
Description: User-assigned managed identity authentication. ,
Required: False ,
}
{
clientId:
{
Description: Client ID for the user-assigned managed identity. ,
Required: True ,
}
string ,
scope:
{
Description: Resource identifier (application ID URI) of the resource, affixed with the .default suffix. ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID. ,
Required: True ,
}
string ,
}
,
serviceAccountTokenSettings:
{
Description: Kubernetes service account token authentication. Default audience if not set is aio-internal ,
Required: False ,
}
{
audience:
{
Description: Audience of the service account. Optional, defaults to the broker internal service account audience. ,
Required: True ,
}
string ,
}
,
x509CertificateSettings:
{
Description: X.509 certificate authentication. ,
Required: False ,
}
{
secretRef:
{
Description: Secret reference of the X.509 certificate. ,
Required: True ,
}
string ,
}
,
}
,
clientIdPrefix:
{
Description: Client ID prefix. Client ID generated by the dataflow is -TBD. Optional; no prefix if omitted. ,
Required: False ,
}
string ,
host:
{
Description: Host of the Broker in the form of :. Optional; connects to Broker if omitted. ,
Required: False ,
}
string ,
protocol:
{
Description: Enable or disable websockets. ,
Enum:
{
Mqtt: protocol broker ,
WebSockets: protocol websocket ,
}
,
Required: False ,
}
enum ,
keepAliveSeconds:
{
Description: Broker KeepAlive for connection in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
retain:
{
Description: Whether or not to keep the retain setting. ,
Enum:
{
Keep: Retain the messages. ,
Never: Never retain messages. ,
}
,
Required: False ,
}
enum ,
maxInflightMessages:
{
Description: The max number of messages to keep in flight. For subscribe, this is the receive maximum. For publish, this is the maximum number of messages to send before waiting for an ack. ,
Format: int32 ,
Required: False ,
}
integer ,
qos:
{
Description: Qos for Broker connection. ,
Format: int32 ,
Required: False ,
}
integer ,
sessionExpirySeconds:
{
Description: Session expiry in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
tls:
{
Description: TLS configuration. ,
Required: False ,
}
{
mode:
{
Description: Mode for TLS. ,
Enum:
{
Enabled: Enabled is equivalent to True ,
Disabled: Disabled is equivalent to False. ,
}
,
Required: False ,
}
enum ,
trustedCaCertificateConfigMapRef:
{
Description: Trusted CA certificate config map. ,
Required: False ,
}
string ,
}
,
cloudEventAttributes:
{
Description: Cloud event mapping config. ,
Enum:
{
Propagate: Propagate type ,
CreateOrRemap: CreateOrRemap type ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Resource is getting provisioned. ,
Updating: Resource is Updating. ,
Deleting: Resource is Deleting. ,
Accepted: Resource has been Accepted. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: Edge location of the resource. ,
Required: True ,
}
{
name:
{
Description: The name of the extended location. ,
Required: True ,
}
string ,
type:
{
Description: Type of ExtendedLocation. ,
Enum:
{
CustomLocation: CustomLocation type ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Instance dataflowEndpoint resource ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
endpointType:
{
Description: Endpoint Type. ,
Enum:
{
DataExplorer: Azure Data Explorer Type ,
DataLakeStorage: Azure Data Lake Type ,
FabricOneLake: Microsoft Fabric Type ,
Kafka: Kafka Type ,
LocalStorage: Local Storage Type ,
Mqtt: Broker Type ,
}
,
Required: True ,
}
enum ,
dataExplorerSettings:
{
Description: Azure Data Explorer endpoint. ,
Required: False ,
}
{
authentication:
{
Description: Authentication configuration. NOTE - only authentication property is allowed per entry. ,
Required: True ,
}
{
method:
{
Description: Mode of Authentication. ,
Enum:
{
SystemAssignedManagedIdentity: SystemAssignedManagedIdentity type ,
UserAssignedManagedIdentity: UserAssignedManagedIdentity type ,
}
,
Required: True ,
}
enum ,
systemAssignedManagedIdentitySettings:
{
Description: System-assigned managed identity authentication. ,
Required: False ,
}
{
audience:
{
Description: Audience of the service to authenticate against. Optional; defaults to the audience for Service host configuration. ,
Required: False ,
}
string ,
}
,
userAssignedManagedIdentitySettings:
{
Description: User-assigned managed identity authentication. ,
Required: False ,
}
{
clientId:
{
Description: Client ID for the user-assigned managed identity. ,
Required: True ,
}
string ,
scope:
{
Description: Resource identifier (application ID URI) of the resource, affixed with the .default suffix. ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID. ,
Required: True ,
}
string ,
}
,
}
,
database:
{
Description: Database name. ,
Required: True ,
}
string ,
host:
{
Description: Host of the Azure Data Explorer in the form of ..kusto.windows.net . ,
Required: True ,
}
string ,
batching:
{
Description: Azure Data Explorer endpoint batching configuration. ,
Required: False ,
}
{
latencySeconds:
{
Description: Batching latency in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxMessages:
{
Description: Maximum number of messages in a batch. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
dataLakeStorageSettings:
{
Description: Azure Data Lake endpoint. ,
Required: False ,
}
{
authentication:
{
Description: Authentication configuration. NOTE - only authentication property is allowed per entry. ,
Required: True ,
}
{
method:
{
Description: Mode of Authentication. ,
Enum:
{
SystemAssignedManagedIdentity: SystemAssignedManagedIdentity type ,
UserAssignedManagedIdentity: UserAssignedManagedIdentity type ,
AccessToken: AccessToken Option ,
}
,
Required: True ,
}
enum ,
accessTokenSettings:
{
Description: SAS token authentication. ,
Required: False ,
}
{
secretRef:
{
Description: Token secret name. ,
Required: True ,
}
string ,
}
,
systemAssignedManagedIdentitySettings:
{
Description: System-assigned managed identity authentication. ,
Required: False ,
}
{
audience:
{
Description: Audience of the service to authenticate against. Optional; defaults to the audience for Service host configuration. ,
Required: False ,
}
string ,
}
,
userAssignedManagedIdentitySettings:
{
Description: User-assigned managed identity authentication. ,
Required: False ,
}
{
clientId:
{
Description: Client ID for the user-assigned managed identity. ,
Required: True ,
}
string ,
scope:
{
Description: Resource identifier (application ID URI) of the resource, affixed with the .default suffix. ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID. ,
Required: True ,
}
string ,
}
,
}
,
host:
{
Description: Host of the Azure Data Lake in the form of .blob.core.windows.net . ,
Required: True ,
}
string ,
batching:
{
Description: Azure Data Lake endpoint batching configuration. ,
Required: False ,
}
{
latencySeconds:
{
Description: Batching latency in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxMessages:
{
Description: Maximum number of messages in a batch. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
fabricOneLakeSettings:
{
Description: Microsoft Fabric endpoint. ,
Required: False ,
}
{
authentication:
{
Description: Authentication configuration. NOTE - only one authentication property is allowed per entry. ,
Required: True ,
}
{
method:
{
Description: Mode of Authentication. ,
Enum:
{
SystemAssignedManagedIdentity: SystemAssignedManagedIdentity type ,
UserAssignedManagedIdentity: UserAssignedManagedIdentity type ,
}
,
Required: True ,
}
enum ,
systemAssignedManagedIdentitySettings:
{
Description: System-assigned managed identity authentication. ,
Required: False ,
}
{
audience:
{
Description: Audience of the service to authenticate against. Optional; defaults to the audience for Service host configuration. ,
Required: False ,
}
string ,
}
,
userAssignedManagedIdentitySettings:
{
Description: User-assigned managed identity authentication. ,
Required: False ,
}
{
clientId:
{
Description: Client ID for the user-assigned managed identity. ,
Required: True ,
}
string ,
scope:
{
Description: Resource identifier (application ID URI) of the resource, affixed with the .default suffix. ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID. ,
Required: True ,
}
string ,
}
,
}
,
names:
{
Description: Names of the workspace and lakehouse. ,
Required: True ,
}
{
lakehouseName:
{
Description: Lakehouse name. ,
Required: True ,
}
string ,
workspaceName:
{
Description: Workspace name. ,
Required: True ,
}
string ,
}
,
oneLakePathType:
{
Description: Type of location of the data in the workspace. Can be either tables or files. ,
Enum:
{
Files: FILES Type ,
Tables: TABLES Type ,
}
,
Required: True ,
}
enum ,
host:
{
Description: Host of the Microsoft Fabric in the form of https://.fabric.microsoft.com. ,
Required: True ,
}
string ,
batching:
{
Description: Batching configuration. ,
Required: False ,
}
{
latencySeconds:
{
Description: Batching latency in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxMessages:
{
Description: Maximum number of messages in a batch. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
kafkaSettings:
{
Description: Kafka endpoint. ,
Required: False ,
}
{
authentication:
{
Description: Authentication configuration. NOTE - only authentication property is allowed per entry. ,
Required: True ,
}
{
method:
{
Description: Mode of Authentication. ,
Enum:
{
SystemAssignedManagedIdentity: SystemAssignedManagedIdentity type ,
UserAssignedManagedIdentity: UserAssignedManagedIdentity type ,
Sasl: Sasl Option ,
X509Certificate: x509Certificate Option ,
Anonymous: Anonymous Option ,
}
,
Required: True ,
}
enum ,
systemAssignedManagedIdentitySettings:
{
Description: System-assigned managed identity authentication. ,
Required: False ,
}
{
audience:
{
Description: Audience of the service to authenticate against. Optional; defaults to the audience for Service host configuration. ,
Required: False ,
}
string ,
}
,
userAssignedManagedIdentitySettings:
{
Description: User-assigned managed identity authentication. ,
Required: False ,
}
{
clientId:
{
Description: Client ID for the user-assigned managed identity. ,
Required: True ,
}
string ,
scope:
{
Description: Resource identifier (application ID URI) of the resource, affixed with the .default suffix. ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID. ,
Required: True ,
}
string ,
}
,
saslSettings:
{
Description: SASL authentication. ,
Required: False ,
}
{
saslType:
{
Description: Type of SASL authentication. Can be PLAIN, SCRAM-SHA-256, or SCRAM-SHA-512. ,
Enum:
{
Plain: PLAIN Type ,
ScramSha256: SCRAM_SHA_256 Type ,
ScramSha512: SCRAM_SHA_512 Type ,
}
,
Required: True ,
}
enum ,
secretRef:
{
Description: Token secret name. ,
Required: True ,
}
string ,
}
,
x509CertificateSettings:
{
Description: X.509 certificate authentication. ,
Required: False ,
}
{
secretRef:
{
Description: Secret reference of the X.509 certificate. ,
Required: True ,
}
string ,
}
,
}
,
consumerGroupId:
{
Description: Consumer group ID. ,
Required: False ,
}
string ,
host:
{
Description: Kafka endpoint host. ,
Required: True ,
}
string ,
batching:
{
Description: Batching configuration. ,
Required: False ,
}
{
mode:
{
Description: Mode for batching. ,
Enum:
{
Enabled: Enabled is equivalent to True ,
Disabled: Disabled is equivalent to False. ,
}
,
Required: False ,
}
enum ,
latencyMs:
{
Description: Batching latency in milliseconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxBytes:
{
Description: Maximum number of bytes in a batch. ,
Format: int32 ,
Required: False ,
}
integer ,
maxMessages:
{
Description: Maximum number of messages in a batch. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
copyMqttProperties:
{
Description: Copy Broker properties. No effect if the endpoint is used as a source or if the dataflow doesn't have an Broker source. ,
Enum:
{
Enabled: Enabled is equivalent to True ,
Disabled: Disabled is equivalent to False. ,
}
,
Required: False ,
}
enum ,
compression:
{
Description: Compression. Can be none, gzip, lz4, or snappy. No effect if the endpoint is used as a source. ,
Enum:
{
None: NONE Option ,
Gzip: Gzip Option ,
Snappy: SNAPPY Option ,
Lz4: LZ4 Option ,
}
,
Required: False ,
}
enum ,
kafkaAcks:
{
Description: Kafka acks. Can be all, one, or zero. No effect if the endpoint is used as a source. ,
Enum:
{
Zero: ZERO Option ,
One: ONE Option ,
All: ALL Option ,
}
,
Required: False ,
}
enum ,
partitionStrategy:
{
Description: Partition handling strategy. Can be default or static. No effect if the endpoint is used as a source. ,
Enum:
{
Default: Default: Assigns messages to random partitions, using a round-robin algorithm. ,
Static: Static: Assigns messages to a fixed partition number that's derived from the instance ID of the dataflow. ,
Topic: TOPIC Option ,
Property: PROPERTY Option ,
}
,
Required: False ,
}
enum ,
tls:
{
Description: TLS configuration. ,
Required: False ,
}
{
mode:
{
Description: Mode for TLS. ,
Enum:
{
Enabled: Enabled is equivalent to True ,
Disabled: Disabled is equivalent to False. ,
}
,
Required: False ,
}
enum ,
trustedCaCertificateConfigMapRef:
{
Description: Trusted CA certificate config map. ,
Required: False ,
}
string ,
}
,
cloudEventAttributes:
{
Description: Cloud event mapping config. ,
Enum:
{
Propagate: Propagate type ,
CreateOrRemap: CreateOrRemap type ,
}
,
Required: False ,
}
enum ,
}
,
localStorageSettings:
{
Description: Local persistent volume endpoint. ,
Required: False ,
}
{
persistentVolumeClaimRef:
{
Description: Persistent volume claim name. ,
Required: True ,
}
string ,
}
,
mqttSettings:
{
Description: Broker endpoint. ,
Required: False ,
}
{
authentication:
{
Description: authentication properties. DEFAULT: kubernetes.audience=aio-internal. NOTE - Enum field only property is allowed ,
Required: True ,
}
{
method:
{
Description: Mode of Authentication. ,
Enum:
{
SystemAssignedManagedIdentity: SystemAssignedManagedIdentity type ,
UserAssignedManagedIdentity: UserAssignedManagedIdentity type ,
ServiceAccountToken: ServiceAccountToken Option ,
X509Certificate: x509Certificate Option ,
Anonymous: Anonymous Option ,
}
,
Required: True ,
}
enum ,
systemAssignedManagedIdentitySettings:
{
Description: System-assigned managed identity authentication. ,
Required: False ,
}
{
audience:
{
Description: Audience of the service to authenticate against. Optional; defaults to the audience for Service host configuration. ,
Required: False ,
}
string ,
}
,
userAssignedManagedIdentitySettings:
{
Description: User-assigned managed identity authentication. ,
Required: False ,
}
{
clientId:
{
Description: Client ID for the user-assigned managed identity. ,
Required: True ,
}
string ,
scope:
{
Description: Resource identifier (application ID URI) of the resource, affixed with the .default suffix. ,
Required: False ,
}
string ,
tenantId:
{
Description: Tenant ID. ,
Required: True ,
}
string ,
}
,
serviceAccountTokenSettings:
{
Description: Kubernetes service account token authentication. Default audience if not set is aio-internal ,
Required: False ,
}
{
audience:
{
Description: Audience of the service account. Optional, defaults to the broker internal service account audience. ,
Required: True ,
}
string ,
}
,
x509CertificateSettings:
{
Description: X.509 certificate authentication. ,
Required: False ,
}
{
secretRef:
{
Description: Secret reference of the X.509 certificate. ,
Required: True ,
}
string ,
}
,
}
,
clientIdPrefix:
{
Description: Client ID prefix. Client ID generated by the dataflow is -TBD. Optional; no prefix if omitted. ,
Required: False ,
}
string ,
host:
{
Description: Host of the Broker in the form of :. Optional; connects to Broker if omitted. ,
Required: False ,
}
string ,
protocol:
{
Description: Enable or disable websockets. ,
Enum:
{
Mqtt: protocol broker ,
WebSockets: protocol websocket ,
}
,
Required: False ,
}
enum ,
keepAliveSeconds:
{
Description: Broker KeepAlive for connection in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
retain:
{
Description: Whether or not to keep the retain setting. ,
Enum:
{
Keep: Retain the messages. ,
Never: Never retain messages. ,
}
,
Required: False ,
}
enum ,
maxInflightMessages:
{
Description: The max number of messages to keep in flight. For subscribe, this is the receive maximum. For publish, this is the maximum number of messages to send before waiting for an ack. ,
Format: int32 ,
Required: False ,
}
integer ,
qos:
{
Description: Qos for Broker connection. ,
Format: int32 ,
Required: False ,
}
integer ,
sessionExpirySeconds:
{
Description: Session expiry in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
tls:
{
Description: TLS configuration. ,
Required: False ,
}
{
mode:
{
Description: Mode for TLS. ,
Enum:
{
Enabled: Enabled is equivalent to True ,
Disabled: Disabled is equivalent to False. ,
}
,
Required: False ,
}
enum ,
trustedCaCertificateConfigMapRef:
{
Description: Trusted CA certificate config map. ,
Required: False ,
}
string ,
}
,
cloudEventAttributes:
{
Description: Cloud event mapping config. ,
Enum:
{
Propagate: Propagate type ,
CreateOrRemap: CreateOrRemap type ,
}
,
Required: False ,
}
enum ,
}
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Resource is getting provisioned. ,
Updating: Resource is Updating. ,
Deleting: Resource is Deleting. ,
Accepted: Resource has been Accepted. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: Edge location of the resource. ,
Required: True ,
}
{
name:
{
Description: The name of the extended location. ,
Required: True ,
}
string ,
type:
{
Description: Type of ExtendedLocation. ,
Enum:
{
CustomLocation: CustomLocation type ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DataflowEndpoint_Delete (new)
Description :  Delete a DataflowEndpointResource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/dataflowEndpoints/{dataflowEndpointName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
instanceName:
{
Description: Name of instance. ,
Required: True ,
}
string ,
dataflowEndpointName:
{
Description: Name of Instance dataflowEndpoint resource ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DataflowProfile_ListByResourceGroup (new)
Description :  List DataflowProfileResource resources by InstanceResource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/dataflowProfiles
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
instanceName:
{
Description: Name of instance. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The DataflowProfileResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
diagnostics:
{
Description: Spec defines the desired identities of NBC diagnostics settings. ,
Required: False ,
}
{
logs:
{
Description: Diagnostic log settings for the resource. ,
Required: False ,
}
{
level:
{
Description: The log level. Examples - 'debug', 'info', 'warn', 'error', 'trace'. ,
Required: False ,
}
string ,
}
,
metrics:
{
Description: The metrics settings for the resource. ,
Required: False ,
}
{
prometheusPort:
{
Description: The prometheus port to expose the metrics. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
instanceCount:
{
Description: To manually scale the dataflow profile, specify the maximum number of instances you want to run. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Resource is getting provisioned. ,
Updating: Resource is Updating. ,
Deleting: Resource is Deleting. ,
Accepted: Resource has been Accepted. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: Edge location of the resource. ,
Required: True ,
}
{
name:
{
Description: The name of the extended location. ,
Required: True ,
}
string ,
type:
{
Description: Type of ExtendedLocation. ,
Enum:
{
CustomLocation: CustomLocation type ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DataflowProfile_Get (new)
Description :  Get a DataflowProfileResource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/dataflowProfiles/{dataflowProfileName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
instanceName:
{
Description: Name of instance. ,
Required: True ,
}
string ,
dataflowProfileName:
{
Description: Name of Instance dataflowProfile resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
diagnostics:
{
Description: Spec defines the desired identities of NBC diagnostics settings. ,
Required: False ,
}
{
logs:
{
Description: Diagnostic log settings for the resource. ,
Required: False ,
}
{
level:
{
Description: The log level. Examples - 'debug', 'info', 'warn', 'error', 'trace'. ,
Required: False ,
}
string ,
}
,
metrics:
{
Description: The metrics settings for the resource. ,
Required: False ,
}
{
prometheusPort:
{
Description: The prometheus port to expose the metrics. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
instanceCount:
{
Description: To manually scale the dataflow profile, specify the maximum number of instances you want to run. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Resource is getting provisioned. ,
Updating: Resource is Updating. ,
Deleting: Resource is Deleting. ,
Accepted: Resource has been Accepted. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: Edge location of the resource. ,
Required: True ,
}
{
name:
{
Description: The name of the extended location. ,
Required: True ,
}
string ,
type:
{
Description: Type of ExtendedLocation. ,
Enum:
{
CustomLocation: CustomLocation type ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DataflowProfile_CreateOrUpdate (new)
Description :  Create a DataflowProfileResource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/dataflowProfiles/{dataflowProfileName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
instanceName:
{
Description: Name of instance. ,
Required: True ,
}
string ,
dataflowProfileName:
{
Description: Name of Instance dataflowProfile resource ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
diagnostics:
{
Description: Spec defines the desired identities of NBC diagnostics settings. ,
Required: False ,
}
{
logs:
{
Description: Diagnostic log settings for the resource. ,
Required: False ,
}
{
level:
{
Description: The log level. Examples - 'debug', 'info', 'warn', 'error', 'trace'. ,
Required: False ,
}
string ,
}
,
metrics:
{
Description: The metrics settings for the resource. ,
Required: False ,
}
{
prometheusPort:
{
Description: The prometheus port to expose the metrics. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
instanceCount:
{
Description: To manually scale the dataflow profile, specify the maximum number of instances you want to run. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Resource is getting provisioned. ,
Updating: Resource is Updating. ,
Deleting: Resource is Deleting. ,
Accepted: Resource has been Accepted. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: Edge location of the resource. ,
Required: True ,
}
{
name:
{
Description: The name of the extended location. ,
Required: True ,
}
string ,
type:
{
Description: Type of ExtendedLocation. ,
Enum:
{
CustomLocation: CustomLocation type ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
diagnostics:
{
Description: Spec defines the desired identities of NBC diagnostics settings. ,
Required: False ,
}
{
logs:
{
Description: Diagnostic log settings for the resource. ,
Required: False ,
}
{
level:
{
Description: The log level. Examples - 'debug', 'info', 'warn', 'error', 'trace'. ,
Required: False ,
}
string ,
}
,
metrics:
{
Description: The metrics settings for the resource. ,
Required: False ,
}
{
prometheusPort:
{
Description: The prometheus port to expose the metrics. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
instanceCount:
{
Description: To manually scale the dataflow profile, specify the maximum number of instances you want to run. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Resource is getting provisioned. ,
Updating: Resource is Updating. ,
Deleting: Resource is Deleting. ,
Accepted: Resource has been Accepted. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: Edge location of the resource. ,
Required: True ,
}
{
name:
{
Description: The name of the extended location. ,
Required: True ,
}
string ,
type:
{
Description: Type of ExtendedLocation. ,
Enum:
{
CustomLocation: CustomLocation type ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Instance dataflowProfile resource ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
diagnostics:
{
Description: Spec defines the desired identities of NBC diagnostics settings. ,
Required: False ,
}
{
logs:
{
Description: Diagnostic log settings for the resource. ,
Required: False ,
}
{
level:
{
Description: The log level. Examples - 'debug', 'info', 'warn', 'error', 'trace'. ,
Required: False ,
}
string ,
}
,
metrics:
{
Description: The metrics settings for the resource. ,
Required: False ,
}
{
prometheusPort:
{
Description: The prometheus port to expose the metrics. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
instanceCount:
{
Description: To manually scale the dataflow profile, specify the maximum number of instances you want to run. ,
Format: int32 ,
Required: False ,
}
integer ,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Resource is getting provisioned. ,
Updating: Resource is Updating. ,
Deleting: Resource is Deleting. ,
Accepted: Resource has been Accepted. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: Edge location of the resource. ,
Required: True ,
}
{
name:
{
Description: The name of the extended location. ,
Required: True ,
}
string ,
type:
{
Description: Type of ExtendedLocation. ,
Enum:
{
CustomLocation: CustomLocation type ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DataflowProfile_Delete (new)
Description :  Delete a DataflowProfileResource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/dataflowProfiles/{dataflowProfileName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
instanceName:
{
Description: Name of instance. ,
Required: True ,
}
string ,
dataflowProfileName:
{
Description: Name of Instance dataflowProfile resource ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Dataflow_ListByProfileResource (new)
Description :  List DataflowResource resources by DataflowProfileResource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/dataflowProfiles/{dataflowProfileName}/dataflows
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
instanceName:
{
Description: Name of instance. ,
Required: True ,
}
string ,
dataflowProfileName:
{
Description: Name of Instance dataflowProfile resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The DataflowResource items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
mode:
{
Description: Mode for Dataflow. Optional; defaults to Enabled. ,
Enum:
{
Enabled: Enabled is equivalent to True ,
Disabled: Disabled is equivalent to False. ,
}
,
Required: False ,
}
enum ,
operations:
{
Description: List of operations including source and destination references as well as transformation. ,
Required: True ,
}
[
{
operationType:
{
Description: Type of operation. ,
Enum:
{
Source: Dataflow Source Operation ,
Destination: Dataflow Destination Operation ,
BuiltInTransformation: Dataflow BuiltIn Transformation Operation ,
}
,
Required: True ,
}
enum ,
name:
{
Description: Optional user provided name of the transformation. ,
Required: False ,
}
string ,
sourceSettings:
{
Description: Source configuration. ,
Required: False ,
}
{
endpointRef:
{
Description: Reference to the Dataflow Endpoint resource. Can only be of Broker and Kafka type. ,
Required: True ,
}
string ,
assetRef:
{
Description: Reference to the resource in Azure Device Registry where the data in the endpoint originates from. ,
Required: False ,
}
string ,
serializationFormat:
{
Description: Content is a JSON Schema. Allowed: JSON Schema/draft-7. ,
Enum:
{
Json: JSON Format ,
}
,
Required: False ,
}
enum ,
schemaRef:
{
Description: Schema CR reference. Data will be deserialized according to the schema, and dropped if it doesn't match. ,
Required: False ,
}
string ,
dataSources:
{
Description: List of source locations. Can be Broker or Kafka topics. Supports wildcards # and +. ,
Required: True ,
}
[
string ,
]
,
}
,
builtInTransformationSettings:
{
Description: Built In Transformation configuration. ,
Required: False ,
}
{
serializationFormat:
{
Description: Serialization format. Optional; defaults to JSON. Allowed value JSON Schema/draft-7, Parquet. Default: Json ,
Enum:
{
Delta: Delta Format ,
Json: JSON Format ,
Parquet: Parquet Format ,
}
,
Required: False ,
}
enum ,
schemaRef:
{
Description: Reference to the schema that describes the output of the transformation. ,
Required: False ,
}
string ,
datasets:
{
Description: Enrich data from Broker State Store. Dataset references a key in Broker State Store. ,
Required: False ,
}
[
{
key:
{
Description: The key of the dataset. ,
Required: True ,
}
string ,
description:
{
Description: A user provided optional description of the dataset. ,
Required: False ,
}
string ,
schemaRef:
{
Description: The reference to the schema that describes the dataset. Allowed: JSON Schema/draft-7. ,
Required: False ,
}
string ,
inputs:
{
Description: List of fields for enriching from the Broker State Store. ,
Required: True ,
}
[
string ,
]
,
expression:
{
Description: Condition to enrich data from Broker State Store. Example: $1 < 0 || $1 > $2 (Assuming inputs section $1 and $2 are provided) ,
Required: False ,
}
string ,
}
,
]
,
filter:
{
Description: Filters input record or datapoints based on condition. ,
Required: False ,
}
[
{
type:
{
Description: The type of dataflow operation. ,
Enum:
{
Filter: Filter type ,
}
,
Required: False ,
}
enum ,
description:
{
Description: A user provided optional description of the filter. ,
Required: False ,
}
string ,
inputs:
{
Description: List of fields for filtering in JSON path expression. ,
Required: True ,
}
[
string ,
]
,
expression:
{
Description: Condition to filter data. Can reference input fields with {n} where n is the index of the input field starting from 1. Example: $1 < 0 || $1 > $2 (Assuming inputs section $1 and $2 are provided) ,
Required: True ,
}
string ,
}
,
]
,
map:
{
Description: Maps input to output message. ,
Required: False ,
}
[
{
type:
{
Description: Type of transformation. ,
Enum:
{
NewProperties: New Properties type ,
Rename: Rename type ,
Compute: Compute type ,
PassThrough: Pass-through type ,
BuiltInFunction: Built in function type ,
}
,
Required: False ,
}
enum ,
description:
{
Description: A user provided optional description of the mapping function. ,
Required: False ,
}
string ,
inputs:
{
Description: List of fields for mapping in JSON path expression. ,
Required: True ,
}
[
string ,
]
,
expression:
{
Description: Modify the inputs field(s) to the final output field. Example: $1 * 2.2 (Assuming inputs section $1 is provided) ,
Required: False ,
}
string ,
output:
{
Description: Where and how the input fields to be organized in the output record. ,
Required: True ,
}
string ,
}
,
]
,
}
,
destinationSettings:
{
Description: Destination configuration. ,
Required: False ,
}
{
endpointRef:
{
Description: Reference to the Endpoint CR. Can be of Broker, Kafka, Fabric, ADLS, ADX type. ,
Required: True ,
}
string ,
dataDestination:
{
Description: Destination location, can be a topic or table name. Supports dynamic values with $topic, $systemProperties, $userProperties, $payload, $context, and $subscription. ,
Required: True ,
}
string ,
}
,
}
,
]
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Resource is getting provisioned. ,
Updating: Resource is Updating. ,
Deleting: Resource is Deleting. ,
Accepted: Resource has been Accepted. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: Edge location of the resource. ,
Required: True ,
}
{
name:
{
Description: The name of the extended location. ,
Required: True ,
}
string ,
type:
{
Description: Type of ExtendedLocation. ,
Enum:
{
CustomLocation: CustomLocation type ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Dataflow_Get (new)
Description :  Get a DataflowResource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/dataflowProfiles/{dataflowProfileName}/dataflows/{dataflowName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
instanceName:
{
Description: Name of instance. ,
Required: True ,
}
string ,
dataflowProfileName:
{
Description: Name of Instance dataflowProfile resource ,
Required: True ,
}
string ,
dataflowName:
{
Description: Name of Instance dataflowProfile dataflow resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
mode:
{
Description: Mode for Dataflow. Optional; defaults to Enabled. ,
Enum:
{
Enabled: Enabled is equivalent to True ,
Disabled: Disabled is equivalent to False. ,
}
,
Required: False ,
}
enum ,
operations:
{
Description: List of operations including source and destination references as well as transformation. ,
Required: True ,
}
[
{
operationType:
{
Description: Type of operation. ,
Enum:
{
Source: Dataflow Source Operation ,
Destination: Dataflow Destination Operation ,
BuiltInTransformation: Dataflow BuiltIn Transformation Operation ,
}
,
Required: True ,
}
enum ,
name:
{
Description: Optional user provided name of the transformation. ,
Required: False ,
}
string ,
sourceSettings:
{
Description: Source configuration. ,
Required: False ,
}
{
endpointRef:
{
Description: Reference to the Dataflow Endpoint resource. Can only be of Broker and Kafka type. ,
Required: True ,
}
string ,
assetRef:
{
Description: Reference to the resource in Azure Device Registry where the data in the endpoint originates from. ,
Required: False ,
}
string ,
serializationFormat:
{
Description: Content is a JSON Schema. Allowed: JSON Schema/draft-7. ,
Enum:
{
Json: JSON Format ,
}
,
Required: False ,
}
enum ,
schemaRef:
{
Description: Schema CR reference. Data will be deserialized according to the schema, and dropped if it doesn't match. ,
Required: False ,
}
string ,
dataSources:
{
Description: List of source locations. Can be Broker or Kafka topics. Supports wildcards # and +. ,
Required: True ,
}
[
string ,
]
,
}
,
builtInTransformationSettings:
{
Description: Built In Transformation configuration. ,
Required: False ,
}
{
serializationFormat:
{
Description: Serialization format. Optional; defaults to JSON. Allowed value JSON Schema/draft-7, Parquet. Default: Json ,
Enum:
{
Delta: Delta Format ,
Json: JSON Format ,
Parquet: Parquet Format ,
}
,
Required: False ,
}
enum ,
schemaRef:
{
Description: Reference to the schema that describes the output of the transformation. ,
Required: False ,
}
string ,
datasets:
{
Description: Enrich data from Broker State Store. Dataset references a key in Broker State Store. ,
Required: False ,
}
[
{
key:
{
Description: The key of the dataset. ,
Required: True ,
}
string ,
description:
{
Description: A user provided optional description of the dataset. ,
Required: False ,
}
string ,
schemaRef:
{
Description: The reference to the schema that describes the dataset. Allowed: JSON Schema/draft-7. ,
Required: False ,
}
string ,
inputs:
{
Description: List of fields for enriching from the Broker State Store. ,
Required: True ,
}
[
string ,
]
,
expression:
{
Description: Condition to enrich data from Broker State Store. Example: $1 < 0 || $1 > $2 (Assuming inputs section $1 and $2 are provided) ,
Required: False ,
}
string ,
}
,
]
,
filter:
{
Description: Filters input record or datapoints based on condition. ,
Required: False ,
}
[
{
type:
{
Description: The type of dataflow operation. ,
Enum:
{
Filter: Filter type ,
}
,
Required: False ,
}
enum ,
description:
{
Description: A user provided optional description of the filter. ,
Required: False ,
}
string ,
inputs:
{
Description: List of fields for filtering in JSON path expression. ,
Required: True ,
}
[
string ,
]
,
expression:
{
Description: Condition to filter data. Can reference input fields with {n} where n is the index of the input field starting from 1. Example: $1 < 0 || $1 > $2 (Assuming inputs section $1 and $2 are provided) ,
Required: True ,
}
string ,
}
,
]
,
map:
{
Description: Maps input to output message. ,
Required: False ,
}
[
{
type:
{
Description: Type of transformation. ,
Enum:
{
NewProperties: New Properties type ,
Rename: Rename type ,
Compute: Compute type ,
PassThrough: Pass-through type ,
BuiltInFunction: Built in function type ,
}
,
Required: False ,
}
enum ,
description:
{
Description: A user provided optional description of the mapping function. ,
Required: False ,
}
string ,
inputs:
{
Description: List of fields for mapping in JSON path expression. ,
Required: True ,
}
[
string ,
]
,
expression:
{
Description: Modify the inputs field(s) to the final output field. Example: $1 * 2.2 (Assuming inputs section $1 is provided) ,
Required: False ,
}
string ,
output:
{
Description: Where and how the input fields to be organized in the output record. ,
Required: True ,
}
string ,
}
,
]
,
}
,
destinationSettings:
{
Description: Destination configuration. ,
Required: False ,
}
{
endpointRef:
{
Description: Reference to the Endpoint CR. Can be of Broker, Kafka, Fabric, ADLS, ADX type. ,
Required: True ,
}
string ,
dataDestination:
{
Description: Destination location, can be a topic or table name. Supports dynamic values with $topic, $systemProperties, $userProperties, $payload, $context, and $subscription. ,
Required: True ,
}
string ,
}
,
}
,
]
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Resource is getting provisioned. ,
Updating: Resource is Updating. ,
Deleting: Resource is Deleting. ,
Accepted: Resource has been Accepted. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: Edge location of the resource. ,
Required: True ,
}
{
name:
{
Description: The name of the extended location. ,
Required: True ,
}
string ,
type:
{
Description: Type of ExtendedLocation. ,
Enum:
{
CustomLocation: CustomLocation type ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Dataflow_CreateOrUpdate (new)
Description :  Create a DataflowResource
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/dataflowProfiles/{dataflowProfileName}/dataflows/{dataflowName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
instanceName:
{
Description: Name of instance. ,
Required: True ,
}
string ,
dataflowProfileName:
{
Description: Name of Instance dataflowProfile resource ,
Required: True ,
}
string ,
dataflowName:
{
Description: Name of Instance dataflowProfile dataflow resource ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
mode:
{
Description: Mode for Dataflow. Optional; defaults to Enabled. ,
Enum:
{
Enabled: Enabled is equivalent to True ,
Disabled: Disabled is equivalent to False. ,
}
,
Required: False ,
}
enum ,
operations:
{
Description: List of operations including source and destination references as well as transformation. ,
Required: True ,
}
[
{
operationType:
{
Description: Type of operation. ,
Enum:
{
Source: Dataflow Source Operation ,
Destination: Dataflow Destination Operation ,
BuiltInTransformation: Dataflow BuiltIn Transformation Operation ,
}
,
Required: True ,
}
enum ,
name:
{
Description: Optional user provided name of the transformation. ,
Required: False ,
}
string ,
sourceSettings:
{
Description: Source configuration. ,
Required: False ,
}
{
endpointRef:
{
Description: Reference to the Dataflow Endpoint resource. Can only be of Broker and Kafka type. ,
Required: True ,
}
string ,
assetRef:
{
Description: Reference to the resource in Azure Device Registry where the data in the endpoint originates from. ,
Required: False ,
}
string ,
serializationFormat:
{
Description: Content is a JSON Schema. Allowed: JSON Schema/draft-7. ,
Enum:
{
Json: JSON Format ,
}
,
Required: False ,
}
enum ,
schemaRef:
{
Description: Schema CR reference. Data will be deserialized according to the schema, and dropped if it doesn't match. ,
Required: False ,
}
string ,
dataSources:
{
Description: List of source locations. Can be Broker or Kafka topics. Supports wildcards # and +. ,
Required: True ,
}
[
string ,
]
,
}
,
builtInTransformationSettings:
{
Description: Built In Transformation configuration. ,
Required: False ,
}
{
serializationFormat:
{
Description: Serialization format. Optional; defaults to JSON. Allowed value JSON Schema/draft-7, Parquet. Default: Json ,
Enum:
{
Delta: Delta Format ,
Json: JSON Format ,
Parquet: Parquet Format ,
}
,
Required: False ,
}
enum ,
schemaRef:
{
Description: Reference to the schema that describes the output of the transformation. ,
Required: False ,
}
string ,
datasets:
{
Description: Enrich data from Broker State Store. Dataset references a key in Broker State Store. ,
Required: False ,
}
[
{
key:
{
Description: The key of the dataset. ,
Required: True ,
}
string ,
description:
{
Description: A user provided optional description of the dataset. ,
Required: False ,
}
string ,
schemaRef:
{
Description: The reference to the schema that describes the dataset. Allowed: JSON Schema/draft-7. ,
Required: False ,
}
string ,
inputs:
{
Description: List of fields for enriching from the Broker State Store. ,
Required: True ,
}
[
string ,
]
,
expression:
{
Description: Condition to enrich data from Broker State Store. Example: $1 < 0 || $1 > $2 (Assuming inputs section $1 and $2 are provided) ,
Required: False ,
}
string ,
}
,
]
,
filter:
{
Description: Filters input record or datapoints based on condition. ,
Required: False ,
}
[
{
type:
{
Description: The type of dataflow operation. ,
Enum:
{
Filter: Filter type ,
}
,
Required: False ,
}
enum ,
description:
{
Description: A user provided optional description of the filter. ,
Required: False ,
}
string ,
inputs:
{
Description: List of fields for filtering in JSON path expression. ,
Required: True ,
}
[
string ,
]
,
expression:
{
Description: Condition to filter data. Can reference input fields with {n} where n is the index of the input field starting from 1. Example: $1 < 0 || $1 > $2 (Assuming inputs section $1 and $2 are provided) ,
Required: True ,
}
string ,
}
,
]
,
map:
{
Description: Maps input to output message. ,
Required: False ,
}
[
{
type:
{
Description: Type of transformation. ,
Enum:
{
NewProperties: New Properties type ,
Rename: Rename type ,
Compute: Compute type ,
PassThrough: Pass-through type ,
BuiltInFunction: Built in function type ,
}
,
Required: False ,
}
enum ,
description:
{
Description: A user provided optional description of the mapping function. ,
Required: False ,
}
string ,
inputs:
{
Description: List of fields for mapping in JSON path expression. ,
Required: True ,
}
[
string ,
]
,
expression:
{
Description: Modify the inputs field(s) to the final output field. Example: $1 * 2.2 (Assuming inputs section $1 is provided) ,
Required: False ,
}
string ,
output:
{
Description: Where and how the input fields to be organized in the output record. ,
Required: True ,
}
string ,
}
,
]
,
}
,
destinationSettings:
{
Description: Destination configuration. ,
Required: False ,
}
{
endpointRef:
{
Description: Reference to the Endpoint CR. Can be of Broker, Kafka, Fabric, ADLS, ADX type. ,
Required: True ,
}
string ,
dataDestination:
{
Description: Destination location, can be a topic or table name. Supports dynamic values with $topic, $systemProperties, $userProperties, $payload, $context, and $subscription. ,
Required: True ,
}
string ,
}
,
}
,
]
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Resource is getting provisioned. ,
Updating: Resource is Updating. ,
Deleting: Resource is Deleting. ,
Accepted: Resource has been Accepted. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: Edge location of the resource. ,
Required: True ,
}
{
name:
{
Description: The name of the extended location. ,
Required: True ,
}
string ,
type:
{
Description: Type of ExtendedLocation. ,
Enum:
{
CustomLocation: CustomLocation type ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
mode:
{
Description: Mode for Dataflow. Optional; defaults to Enabled. ,
Enum:
{
Enabled: Enabled is equivalent to True ,
Disabled: Disabled is equivalent to False. ,
}
,
Required: False ,
}
enum ,
operations:
{
Description: List of operations including source and destination references as well as transformation. ,
Required: True ,
}
[
{
operationType:
{
Description: Type of operation. ,
Enum:
{
Source: Dataflow Source Operation ,
Destination: Dataflow Destination Operation ,
BuiltInTransformation: Dataflow BuiltIn Transformation Operation ,
}
,
Required: True ,
}
enum ,
name:
{
Description: Optional user provided name of the transformation. ,
Required: False ,
}
string ,
sourceSettings:
{
Description: Source configuration. ,
Required: False ,
}
{
endpointRef:
{
Description: Reference to the Dataflow Endpoint resource. Can only be of Broker and Kafka type. ,
Required: True ,
}
string ,
assetRef:
{
Description: Reference to the resource in Azure Device Registry where the data in the endpoint originates from. ,
Required: False ,
}
string ,
serializationFormat:
{
Description: Content is a JSON Schema. Allowed: JSON Schema/draft-7. ,
Enum:
{
Json: JSON Format ,
}
,
Required: False ,
}
enum ,
schemaRef:
{
Description: Schema CR reference. Data will be deserialized according to the schema, and dropped if it doesn't match. ,
Required: False ,
}
string ,
dataSources:
{
Description: List of source locations. Can be Broker or Kafka topics. Supports wildcards # and +. ,
Required: True ,
}
[
string ,
]
,
}
,
builtInTransformationSettings:
{
Description: Built In Transformation configuration. ,
Required: False ,
}
{
serializationFormat:
{
Description: Serialization format. Optional; defaults to JSON. Allowed value JSON Schema/draft-7, Parquet. Default: Json ,
Enum:
{
Delta: Delta Format ,
Json: JSON Format ,
Parquet: Parquet Format ,
}
,
Required: False ,
}
enum ,
schemaRef:
{
Description: Reference to the schema that describes the output of the transformation. ,
Required: False ,
}
string ,
datasets:
{
Description: Enrich data from Broker State Store. Dataset references a key in Broker State Store. ,
Required: False ,
}
[
{
key:
{
Description: The key of the dataset. ,
Required: True ,
}
string ,
description:
{
Description: A user provided optional description of the dataset. ,
Required: False ,
}
string ,
schemaRef:
{
Description: The reference to the schema that describes the dataset. Allowed: JSON Schema/draft-7. ,
Required: False ,
}
string ,
inputs:
{
Description: List of fields for enriching from the Broker State Store. ,
Required: True ,
}
[
string ,
]
,
expression:
{
Description: Condition to enrich data from Broker State Store. Example: $1 < 0 || $1 > $2 (Assuming inputs section $1 and $2 are provided) ,
Required: False ,
}
string ,
}
,
]
,
filter:
{
Description: Filters input record or datapoints based on condition. ,
Required: False ,
}
[
{
type:
{
Description: The type of dataflow operation. ,
Enum:
{
Filter: Filter type ,
}
,
Required: False ,
}
enum ,
description:
{
Description: A user provided optional description of the filter. ,
Required: False ,
}
string ,
inputs:
{
Description: List of fields for filtering in JSON path expression. ,
Required: True ,
}
[
string ,
]
,
expression:
{
Description: Condition to filter data. Can reference input fields with {n} where n is the index of the input field starting from 1. Example: $1 < 0 || $1 > $2 (Assuming inputs section $1 and $2 are provided) ,
Required: True ,
}
string ,
}
,
]
,
map:
{
Description: Maps input to output message. ,
Required: False ,
}
[
{
type:
{
Description: Type of transformation. ,
Enum:
{
NewProperties: New Properties type ,
Rename: Rename type ,
Compute: Compute type ,
PassThrough: Pass-through type ,
BuiltInFunction: Built in function type ,
}
,
Required: False ,
}
enum ,
description:
{
Description: A user provided optional description of the mapping function. ,
Required: False ,
}
string ,
inputs:
{
Description: List of fields for mapping in JSON path expression. ,
Required: True ,
}
[
string ,
]
,
expression:
{
Description: Modify the inputs field(s) to the final output field. Example: $1 * 2.2 (Assuming inputs section $1 is provided) ,
Required: False ,
}
string ,
output:
{
Description: Where and how the input fields to be organized in the output record. ,
Required: True ,
}
string ,
}
,
]
,
}
,
destinationSettings:
{
Description: Destination configuration. ,
Required: False ,
}
{
endpointRef:
{
Description: Reference to the Endpoint CR. Can be of Broker, Kafka, Fabric, ADLS, ADX type. ,
Required: True ,
}
string ,
dataDestination:
{
Description: Destination location, can be a topic or table name. Supports dynamic values with $topic, $systemProperties, $userProperties, $payload, $context, and $subscription. ,
Required: True ,
}
string ,
}
,
}
,
]
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Resource is getting provisioned. ,
Updating: Resource is Updating. ,
Deleting: Resource is Deleting. ,
Accepted: Resource has been Accepted. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: Edge location of the resource. ,
Required: True ,
}
{
name:
{
Description: The name of the extended location. ,
Required: True ,
}
string ,
type:
{
Description: Type of ExtendedLocation. ,
Enum:
{
CustomLocation: CustomLocation type ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Instance dataflowProfile dataflow resource ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
mode:
{
Description: Mode for Dataflow. Optional; defaults to Enabled. ,
Enum:
{
Enabled: Enabled is equivalent to True ,
Disabled: Disabled is equivalent to False. ,
}
,
Required: False ,
}
enum ,
operations:
{
Description: List of operations including source and destination references as well as transformation. ,
Required: True ,
}
[
{
operationType:
{
Description: Type of operation. ,
Enum:
{
Source: Dataflow Source Operation ,
Destination: Dataflow Destination Operation ,
BuiltInTransformation: Dataflow BuiltIn Transformation Operation ,
}
,
Required: True ,
}
enum ,
name:
{
Description: Optional user provided name of the transformation. ,
Required: False ,
}
string ,
sourceSettings:
{
Description: Source configuration. ,
Required: False ,
}
{
endpointRef:
{
Description: Reference to the Dataflow Endpoint resource. Can only be of Broker and Kafka type. ,
Required: True ,
}
string ,
assetRef:
{
Description: Reference to the resource in Azure Device Registry where the data in the endpoint originates from. ,
Required: False ,
}
string ,
serializationFormat:
{
Description: Content is a JSON Schema. Allowed: JSON Schema/draft-7. ,
Enum:
{
Json: JSON Format ,
}
,
Required: False ,
}
enum ,
schemaRef:
{
Description: Schema CR reference. Data will be deserialized according to the schema, and dropped if it doesn't match. ,
Required: False ,
}
string ,
dataSources:
{
Description: List of source locations. Can be Broker or Kafka topics. Supports wildcards # and +. ,
Required: True ,
}
[
string ,
]
,
}
,
builtInTransformationSettings:
{
Description: Built In Transformation configuration. ,
Required: False ,
}
{
serializationFormat:
{
Description: Serialization format. Optional; defaults to JSON. Allowed value JSON Schema/draft-7, Parquet. Default: Json ,
Enum:
{
Delta: Delta Format ,
Json: JSON Format ,
Parquet: Parquet Format ,
}
,
Required: False ,
}
enum ,
schemaRef:
{
Description: Reference to the schema that describes the output of the transformation. ,
Required: False ,
}
string ,
datasets:
{
Description: Enrich data from Broker State Store. Dataset references a key in Broker State Store. ,
Required: False ,
}
[
{
key:
{
Description: The key of the dataset. ,
Required: True ,
}
string ,
description:
{
Description: A user provided optional description of the dataset. ,
Required: False ,
}
string ,
schemaRef:
{
Description: The reference to the schema that describes the dataset. Allowed: JSON Schema/draft-7. ,
Required: False ,
}
string ,
inputs:
{
Description: List of fields for enriching from the Broker State Store. ,
Required: True ,
}
[
string ,
]
,
expression:
{
Description: Condition to enrich data from Broker State Store. Example: $1 < 0 || $1 > $2 (Assuming inputs section $1 and $2 are provided) ,
Required: False ,
}
string ,
}
,
]
,
filter:
{
Description: Filters input record or datapoints based on condition. ,
Required: False ,
}
[
{
type:
{
Description: The type of dataflow operation. ,
Enum:
{
Filter: Filter type ,
}
,
Required: False ,
}
enum ,
description:
{
Description: A user provided optional description of the filter. ,
Required: False ,
}
string ,
inputs:
{
Description: List of fields for filtering in JSON path expression. ,
Required: True ,
}
[
string ,
]
,
expression:
{
Description: Condition to filter data. Can reference input fields with {n} where n is the index of the input field starting from 1. Example: $1 < 0 || $1 > $2 (Assuming inputs section $1 and $2 are provided) ,
Required: True ,
}
string ,
}
,
]
,
map:
{
Description: Maps input to output message. ,
Required: False ,
}
[
{
type:
{
Description: Type of transformation. ,
Enum:
{
NewProperties: New Properties type ,
Rename: Rename type ,
Compute: Compute type ,
PassThrough: Pass-through type ,
BuiltInFunction: Built in function type ,
}
,
Required: False ,
}
enum ,
description:
{
Description: A user provided optional description of the mapping function. ,
Required: False ,
}
string ,
inputs:
{
Description: List of fields for mapping in JSON path expression. ,
Required: True ,
}
[
string ,
]
,
expression:
{
Description: Modify the inputs field(s) to the final output field. Example: $1 * 2.2 (Assuming inputs section $1 is provided) ,
Required: False ,
}
string ,
output:
{
Description: Where and how the input fields to be organized in the output record. ,
Required: True ,
}
string ,
}
,
]
,
}
,
destinationSettings:
{
Description: Destination configuration. ,
Required: False ,
}
{
endpointRef:
{
Description: Reference to the Endpoint CR. Can be of Broker, Kafka, Fabric, ADLS, ADX type. ,
Required: True ,
}
string ,
dataDestination:
{
Description: Destination location, can be a topic or table name. Supports dynamic values with $topic, $systemProperties, $userProperties, $payload, $context, and $subscription. ,
Required: True ,
}
string ,
}
,
}
,
]
,
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource has been created. ,
Failed: Resource creation failed. ,
Canceled: Resource creation was canceled. ,
Provisioning: Resource is getting provisioned. ,
Updating: Resource is Updating. ,
Deleting: Resource is Deleting. ,
Accepted: Resource has been Accepted. ,
}
,
Required: False ,
}
enum ,
}
,
extendedLocation:
{
Description: Edge location of the resource. ,
Required: True ,
}
{
name:
{
Description: The name of the extended location. ,
Required: True ,
}
string ,
type:
{
Description: Type of ExtendedLocation. ,
Enum:
{
CustomLocation: CustomLocation type ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Dataflow_Delete (new)
Description :  Delete a DataflowResource
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperations/instances/{instanceName}/dataflowProfiles/{dataflowProfileName}/dataflows/{dataflowName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
instanceName:
{
Description: Name of instance. ,
Required: True ,
}
string ,
dataflowProfileName:
{
Description: Name of Instance dataflowProfile resource ,
Required: True ,
}
string ,
dataflowName:
{
Description: Name of Instance dataflowProfile dataflow resource ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}