.. _cloud_services_kafka_server_profile:

cloud-services kafka-server-profile
===================================

configure kafka server profile


kafka-server-profile Specification
----------------------------------

	===================================== ============================================================================
	 **Parameter**                         **Value** 

	===================================== ============================================================================
	 **Type**                              *Configuration Resource*

	 **Element Name**                      kafka-server-profile

	 **Element URI**                       /axapi/v3/cloud-services/kafka-server-profile

	 **Element Attributes**                kafka-server-profile_attributes

	 **Partition Visibility**              shared

	 **Operational Data URI**              /axapi/v3/cloud-services/kafka-server-profile/oper

	 **Schema**                             :download:`kafka-server-profile schema <cloud-services-kafka-server-profile/cloud-services-kafka-server-profile.txt>`
	===================================== ============================================================================





	**Operations Allowed:**




.. raw:: html

   <script type="text/javascript">
 function showExample(a,b) { document.getElementById(a+'_div').style.display = 'block'; document.getElementById(a+'_cl').style.display = 'block'; document.getElementById(a+'_eg').style.display = 'none';}
   function closeExample(a,b) { document.getElementById(a+'_div').style.display = 'none'; document.getElementById(a+'_cl').style.display = 'none'; document.getElementById(a+'_eg').style.display = 'block';}
 </script>
   <table width='90%' style='margin-left:5%'>



.. raw:: html

   <tr style='border-bottom: thin solid; border-top: thin solid'><th width=15%>Operation</th><th width=10%>Method</th><th>URI</th><th width=15%>Payload</th><th width=10%></th></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Create Object



.. raw:: html

   </td><td valign = 'top'>


POST



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/cloud-services/kafka-server-profile



.. raw:: html

   </td><td valign = 'top'>


:ref:`642_kafka-server-profile_attributes`



.. raw:: html

   </td><td><button id='post_eg' onClick="showExample('post')">example</button> <button id='post_cl' onClick="closeExample('post')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='post_div' style='display:none'>


.. include:: ../artifacts/cloud_services_kafka_server_profile_POST.txt
   :literal:




.. raw:: html

   </div></td></tr>


.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Get Object



.. raw:: html

   </td><td valign = 'top'>


GET



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/cloud-services/kafka-server-profile



.. raw:: html

   </td><td valign = 'top'>


:ref:`642_kafka-server-profile_attributes`



.. raw:: html

   </td><td><button id='get_eg' onClick="showExample('get')">example</button> <button id='get_cl' onClick="closeExample('get')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='get_div' style='display:none'>


.. include:: ../artifacts/cloud_services_kafka_server_profile_GET.txt
   :literal:




.. raw:: html

   </div></td></tr>


.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Modify Object



.. raw:: html

   </td><td valign = 'top'>


POST



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/cloud-services/kafka-server-profile



.. raw:: html

   </td><td valign = 'top'>


:ref:`642_kafka-server-profile_attributes`



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Replace Object



.. raw:: html

   </td><td valign = 'top'>


PUT



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/cloud-services/kafka-server-profile



.. raw:: html

   </td><td valign = 'top'>


:ref:`642_kafka-server-profile_attributes`



.. raw:: html

   </td><td><button id='put_eg' onClick="showExample('put')">example</button> <button id='put_cl' onClick="closeExample('put')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='put_div' style='display:none'>


.. include:: ../artifacts/cloud_services_kafka_server_profile_PUT.txt
   :literal:




.. raw:: html

   </div></td></tr>


.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Delete Object



.. raw:: html

   </td><td valign = 'top'>


DELETE



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/cloud-services/kafka-server-profile



.. raw:: html

   </td><td valign = 'top'>


:ref:`642_kafka-server-profile_attributes`



.. raw:: html

   </td><td><button id='delete_eg' onClick="showExample('delete')">example</button> <button id='delete_cl' onClick="closeExample('delete')" style='display:none'>close</button></td></tr>




.. raw:: html

   <tr><td colspan=5 style='padding: 0         % 0    %;' valign = 'top'><div id='delete_div' style='display:none'>


.. include:: ../artifacts/cloud_services_kafka_server_profile_DELETE.txt
   :literal:




.. raw:: html

   </div></td></tr>


.. raw:: html

   </table>

.. _642_kafka-server-profile_attributes:

kafka-server-profile attributes
-------------------------------

    **action**

        **Description** 'register': Register the device to the cloud; 'deregister': Deregister the device from the cloud; 

        **Type:** string

        **Supported Values:** register, deregister

    **active_ns**

        **Description** Set active_ns in cloud credentials file

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **alias_ns**

        **Description** Set active_ns in cloud credentials file

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **bootstrap_servers**

        **Description** Set bootstrap_servers in cloud credentials file

        **Type:** string

        **Format:** password

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **client_id**

        **Description** Set client_id in cloud credentials file

        **Type:** string

        **Format:** password

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **client_secret**

        **Description** Set client_secret in cloud credentials file

        **Type:** string

        **Format:** password

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **primary_ns**

        **Description** Set active_ns in cloud credentials file

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **resource_group**

        **Description** Set resource_group in cloud credentials file

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **sasl_mechanisms**

        **Description** Set sasl_mechanisms in cloud credentials file

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **sasl_password**

        **Description** Set sasl_password in cloud credentials file

        **Type:** string

        **Format:** password

        **Maximum Length:** 256 characters

        **Maximum Length:** 1 characters

    **schema_group_name**

        **Description** Set schema_group_name in cloud credentials file

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **secondary_ns**

        **Description** Set active_ns in cloud credentials file

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **security_protocol**

        **Description** Set security_protocol in cloud credentials file

        **Type:** string

        **Maximum Length:** 128 characters

        **Maximum Length:** 1 characters

    **subscription_id**

        **Description** Set subscription_id in cloud credentials file

        **Type:** string

        **Format:** password

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **tenant_id**

        **Description** Set tenant_id in cloud credentials file

        **Type:** string

        **Format:** password

        **Maximum Length:** 63 characters

        **Maximum Length:** 1 characters

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters