Cluster - Create Or Update

Referencia

Servicio:: Confluent

Versión de la API:: 2024-07-01

Creación de clústeres confluent

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/environments/{environmentId}/clusters/{clusterId}?api-version=2024-07-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
clusterId	path	True	string	Identificador de clúster del registro de esquema o kafka de Confluent
environmentId	path	True	string	Identificador de entorno de Confluent
organizationName	path	True	string	Nombre del recurso de la organización
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.
subscriptionId	path	True	string	Identificador de suscripción de Microsoft Azure
api-version	query	True	string	Versión de api de cliente.

Cuerpo de la solicitud

Nombre	Tipo	Description
id	string	Identificador del clúster
kind	string	Tipo de clúster
name	string	Nombre para mostrar del clúster
properties.metadata	SCMetadataEntity	Metadatos del registro
properties.spec	SCClusterSpecEntity	Especificación del clúster
properties.status	ClusterStatusEntity	Especificación del estado del clúster
type	string	Tipo del recurso

Respuestas

Nombre	Tipo	Description
200 OK	SCClusterRecord	Éxito
201 Created	SCClusterRecord	Creado
Other Status Codes	ResourceProviderDefaultErrorResponse	Respuesta de error predeterminada.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

Cluster_CreateOrUpdate

Solicitud de ejemplo

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Confluent/organizations/myOrganization/environments/env-1/clusters/cluster-1?api-version=2024-07-01

{
  "properties": {
    "spec": {
      "package": "ESSENTIALS",
      "environment": {
        "id": "env-1"
      },
      "region": "us-east4"
    }
  }
}

Respuesta de muestra

status code:: 200

{
  "kind": "Cluster",
  "id": "dlz-f3a90de",
  "name": "cluster-1",
  "properties": {
    "metadata": {
      "self": "https://api.confluent.cloud/cmk/v2/clusters/lkc-12345",
      "resourceName": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/cloud-cluster=lkc-12345",
      "createdTimestamp": "2006-01-02T15:04:05-07:00",
      "updatedTimestamp": "2006-01-02T15:04:05-07:00",
      "deletedTimestamp": "2006-01-02T15:04:05-07:00"
    },
    "spec": {
      "name": "ProdKafkaCluster",
      "availability": "SINGLE_ZONE",
      "cloud": "GCP",
      "region": "us-east4",
      "config": {
        "kind": "Basic"
      },
      "kafkaBootstrapEndpoint": "lkc-00000-00000.us-central1.gcp.glb.confluent.cloud:9092",
      "httpEndpoint": "https://lkc-00000-00000.us-central1.gcp.glb.confluent.cloud",
      "apiEndpoint": "https://pkac-00000.us-west-2.aws.confluent.cloud",
      "environment": {
        "id": "env-00000",
        "environment": "string",
        "related": "https://api.confluent.cloud/v2/environments/env-00000",
        "resourceName": "https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000"
      },
      "network": {
        "id": "n-00000",
        "environment": "string",
        "related": "https://api.confluent.cloud/networking/v1/networks/n-00000",
        "resourceName": "https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-00000"
      },
      "byok": {
        "id": "cck-00000",
        "related": "https://api.confluent.cloud/byok/v1/keys/cck-00000",
        "resourceName": "https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/key=cck-00000"
      }
    },
    "status": {
      "phase": "PROVISIONED",
      "cku": 2
    }
  }
}

status code:: 201

{
  "kind": "Cluster",
  "id": "dlz-f3a90de",
  "name": "cluster-1",
  "properties": {
    "metadata": {
      "self": "https://api.confluent.cloud/cmk/v2/clusters/lkc-12345",
      "resourceName": "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/cloud-cluster=lkc-12345",
      "createdTimestamp": "2006-01-02T15:04:05-07:00",
      "updatedTimestamp": "2006-01-02T15:04:05-07:00",
      "deletedTimestamp": "2006-01-02T15:04:05-07:00"
    },
    "spec": {
      "name": "ProdKafkaCluster",
      "availability": "SINGLE_ZONE",
      "cloud": "GCP",
      "region": "us-east4",
      "config": {
        "kind": "Basic"
      },
      "kafkaBootstrapEndpoint": "lkc-00000-00000.us-central1.gcp.glb.confluent.cloud:9092",
      "httpEndpoint": "https://lkc-00000-00000.us-central1.gcp.glb.confluent.cloud",
      "apiEndpoint": "https://pkac-00000.us-west-2.aws.confluent.cloud",
      "environment": {
        "id": "env-00000",
        "environment": "string",
        "related": "https://api.confluent.cloud/v2/environments/env-00000",
        "resourceName": "https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000"
      },
      "network": {
        "id": "n-00000",
        "environment": "string",
        "related": "https://api.confluent.cloud/networking/v1/networks/n-00000",
        "resourceName": "https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-abc123/network=n-00000"
      },
      "byok": {
        "id": "cck-00000",
        "related": "https://api.confluent.cloud/byok/v1/keys/cck-00000",
        "resourceName": "https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/key=cck-00000"
      }
    },
    "status": {
      "phase": "PROVISIONED",
      "cku": 2
    }
  }
}

Definiciones

Nombre	Description
ClusterConfigEntity	Configuración del clúster de Kafka
ClusterStatusEntity	Estado del registro del clúster
ErrorResponseBody	ErrorResponseBody
Package	Paquete de gobernanza de flujos. Los valores admitidos son ESSENTIALS y ADVANCED
ResourceProviderDefaultErrorResponse	ResourceProviderDefaultErrorResponse
SCClusterByokEntity	La red asociada a este objeto
SCClusterNetworkEnvironmentEntity	El entorno o la red a la que pertenece el clúster
SCClusterRecord	Detalles del registro del clúster
SCClusterSpecEntity	Especificación del registro del clúster
SCMetadataEntity	Metadatos del registro de datos

ClusterConfigEntity

Object

Configuración del clúster de Kafka

Nombre	Tipo	Description
kind	string	La fase de ciclo de vida del clúster

ClusterStatusEntity

Object

Estado del registro del clúster

Nombre	Tipo	Description
cku	integer (int32)	Número de unidades de Kafka confluent
phase	string	La fase de ciclo de vida del clúster

ErrorResponseBody

Object

ErrorResponseBody

Nombre	Tipo	Description
code	string	Código de error
details	ErrorResponseBody[]	Detalles del error
message	string	Mensaje de error
target	string	Destino de error

Package

Enumeración

Paquete de gobernanza de flujos. Los valores admitidos son ESSENTIALS y ADVANCED

Valor	Description
ADVANCED
ESSENTIALS

ResourceProviderDefaultErrorResponse

Object

ResourceProviderDefaultErrorResponse

Nombre	Tipo	Description
error	ErrorResponseBody	ErrorResponseBody Cuerpo de respuesta del error

SCClusterByokEntity

Object

La red asociada a este objeto

Nombre	Tipo	Description
id	string	Identificador del recurso al que se hace referencia
related	string	Dirección URL de API para acceder o modificar el objeto al que se hace referencia
resourceName	string	Referencia de CRN al recurso al que se hace referencia

SCClusterNetworkEnvironmentEntity

Object

El entorno o la red a la que pertenece el clúster

Nombre	Tipo	Description
environment	string	Entorno del recurso al que se hace referencia
id	string	Identificador del recurso al que se hace referencia
related	string	Dirección URL de API para acceder o modificar el objeto al que se hace referencia
resourceName	string	Referencia de CRN al recurso al que se hace referencia

SCClusterRecord

Object

Detalles del registro del clúster

Nombre	Tipo	Description
id	string	Identificador del clúster
kind	string	Tipo de clúster
name	string	Nombre para mostrar del clúster
properties.metadata	SCMetadataEntity	Metadatos del registro
properties.spec	SCClusterSpecEntity	Especificación del clúster
properties.status	ClusterStatusEntity	Especificación del estado del clúster
type	string	Tipo del recurso

SCClusterSpecEntity

Object

Especificación del registro del clúster

Nombre	Tipo	Description
apiEndpoint	string	El punto de conexión del clúster de la API de Kafka
availability	string	Configuración de la zona de disponibilidad del clúster
byok	SCClusterByokEntity	Especificación del clúster byok
cloud	string	Proveedor de servicios en la nube
config	ClusterConfigEntity	Especificación de la configuración del clúster
environment	SCClusterNetworkEnvironmentEntity	Especificación del entorno de clúster
httpEndpoint	string	Dirección URL de solicitud HTTP del clúster.
kafkaBootstrapEndpoint	string	Punto de conexión de arranque usado por los clientes de Kafka para conectarse al clúster
name	string	Nombre del clúster
network	SCClusterNetworkEnvironmentEntity	Especificación de la red del clúster
package	Package	Configuración de gobernanza de flujos
region	string	Región del proveedor de servicios en la nube
zone	string	tipo de disponibilidad de zona

SCMetadataEntity

Object

Metadatos del registro de datos

Nombre	Tipo	Description
createdTimestamp	string	Fecha y hora de creación
deletedTimestamp	string	Fecha y hora eliminadas
resourceName	string	Nombre del recurso del registro
self	string	Dirección URL de búsqueda propia
updatedTimestamp	string	Fecha y hora actualizadas

Compartir a través de

Cluster - Create Or Update

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

Cluster_CreateOrUpdate

Solicitud de ejemplo

Respuesta de muestra

Definiciones

ClusterConfigEntity

ClusterStatusEntity

ErrorResponseBody

Package

ResourceProviderDefaultErrorResponse

SCClusterByokEntity

SCClusterNetworkEnvironmentEntity

SCClusterRecord

SCClusterSpecEntity

SCMetadataEntity