Organization - Create API Key

Referensi

Layanan:: Confluent

Versi API:: 2024-02-13

Membuat kunci API untuk ID Kluster registri skema atau ID Kluster Kafka di bawah lingkungan

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
clusterId	path	True	string	Id kluster confluent kafka atau registri skema
environmentId	path	True	string	Id lingkungan confluent
organizationName	path	True	string	Nama sumber daya organisasi
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.
subscriptionId	path	True	string	Id langganan Microsoft Azure
api-version	query	True	string	Versi Api Klien.

Isi Permintaan

Nama	Jenis	Deskripsi
description	string	Deskripsi Kunci API
name	string	Nama Kunci API

Respons

Nama	Jenis	Deskripsi
200 OK	APIKeyRecord	Keberhasilan
Other Status Codes	ResourceProviderDefaultErrorResponse	Respons kesalahan default.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

Organization_CreateAPIKey

Permintaan sampel

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Confluent/organizations/myOrganization/environments/env-12132/clusters/clusterId-123/createAPIKey?api-version=2024-02-13

{
  "name": "CI kafka access key",
  "description": "This API key provides kafka access to cluster x"
}


import com.azure.resourcemanager.confluent.models.CreateApiKeyModel;

/**
 * Samples for Organization CreateApiKey.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/confluent/resource-manager/Microsoft.Confluent/stable/2024-02-13/examples/
     * Organization_CreateClusterAPIKey.json
     */
    /**
     * Sample code: Organization_CreateAPIKey.
     * 
     * @param manager Entry point to ConfluentManager.
     */
    public static void organizationCreateAPIKey(com.azure.resourcemanager.confluent.ConfluentManager manager) {
        manager.organizations().createApiKeyWithResponse(
            "myResourceGroup", "myOrganization", "env-12132", "clusterId-123", new CreateApiKeyModel()
                .withName("CI kafka access key").withDescription("This API key provides kafka access to cluster x"),
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential
from azure.mgmt.confluent import ConfluentManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-confluent
# USAGE
    python organization_create_cluster_api_key.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ConfluentManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.organization.create_api_key(
        resource_group_name="myResourceGroup",
        organization_name="myOrganization",
        environment_id="env-12132",
        cluster_id="clusterId-123",
        body={"description": "This API key provides kafka access to cluster x", "name": "CI kafka access key"},
    )
    print(response)


# x-ms-original-file: specification/confluent/resource-manager/Microsoft.Confluent/stable/2024-02-13/examples/Organization_CreateClusterAPIKey.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armconfluent_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/confluent/armconfluent"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/cf5ad1932d00c7d15497705ad6b71171d3d68b1e/specification/confluent/resource-manager/Microsoft.Confluent/stable/2024-02-13/examples/Organization_CreateClusterAPIKey.json
func ExampleOrganizationClient_CreateAPIKey() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armconfluent.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewOrganizationClient().CreateAPIKey(ctx, "myResourceGroup", "myOrganization", "env-12132", "clusterId-123", armconfluent.CreateAPIKeyModel{
		Name:        to.Ptr("CI kafka access key"),
		Description: to.Ptr("This API key provides kafka access to cluster x"),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.APIKeyRecord = armconfluent.APIKeyRecord{
	// 	ID: to.Ptr("JDCXTFUVFVQGF56J"),
	// 	Kind: to.Ptr("ApiKey"),
	// 	Properties: &armconfluent.APIKeyProperties{
	// 		Metadata: &armconfluent.SCMetadataEntity{
	// 			CreatedTimestamp: to.Ptr("2023-11-15T16:15:44.489498Z"),
	// 			ResourceName: to.Ptr("crn://api.stag.cpdev.cloud/organization=37d1220b-93a6-43e3-a114-dd8a20a94a31/service-account=sa-wwn7mm/api-key=JDCXTFUVFVQGF56J"),
	// 			Self: to.Ptr("https://api.stag.cpdev.cloud/iam/v2/api-keys/JDCXTFUVFVQGF56J"),
	// 			UpdatedTimestamp: to.Ptr("2023-11-15T16:15:44.489498Z"),
	// 		},
	// 		Spec: &armconfluent.APIKeySpecEntity{
	// 			Name: to.Ptr("CI kafka access key"),
	// 			Description: to.Ptr("This API key provides kafka access to cluster x"),
	// 			Owner: &armconfluent.APIKeyOwnerEntity{
	// 				ID: to.Ptr("sa-wwn7mm"),
	// 				Kind: to.Ptr("ServiceAccount"),
	// 				Related: to.Ptr("https://api.stag.cpdev.cloud/iam/v2/service-accounts/sa-wwn7mm"),
	// 				ResourceName: to.Ptr("crn://api.stag.cpdev.cloud/organization=37d1220b-93a6-43e3-a114-dd8a20a94a31/service-account=sa-wwn7mm"),
	// 			},
	// 			Resource: &armconfluent.APIKeyResourceEntity{
	// 				ID: to.Ptr("lsrc-stgc1yrzz3"),
	// 				Kind: to.Ptr("SchemaRegistry"),
	// 				Related: to.Ptr("https://api.stag.cpdev.cloud/srcm/v2/schema-registries/lsrc-stgc1yrzz3"),
	// 				ResourceName: to.Ptr("crn://api.stag.cpdev.cloud/organization=37d1220b-93a6-43e3-a114-dd8a20a94a31/schema-registry=lsrc-stgc1yrzz3"),
	// 			},
	// 			Secret: to.Ptr(""),
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { ConfluentManagementClient } = require("@azure/arm-confluent");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Creates API key for a schema registry Cluster ID or Kafka Cluster ID under a environment
 *
 * @summary Creates API key for a schema registry Cluster ID or Kafka Cluster ID under a environment
 * x-ms-original-file: specification/confluent/resource-manager/Microsoft.Confluent/stable/2024-02-13/examples/Organization_CreateClusterAPIKey.json
 */
async function organizationCreateApiKey() {
  const subscriptionId =
    process.env["CONFLUENT_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["CONFLUENT_RESOURCE_GROUP"] || "myResourceGroup";
  const organizationName = "myOrganization";
  const environmentId = "env-12132";
  const clusterId = "clusterId-123";
  const body = {
    name: "CI kafka access key",
    description: "This API key provides kafka access to cluster x",
  };
  const credential = new DefaultAzureCredential();
  const client = new ConfluentManagementClient(credential, subscriptionId);
  const result = await client.organization.createAPIKey(
    resourceGroupName,
    organizationName,
    environmentId,
    clusterId,
    body,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Confluent.Models;
using Azure.ResourceManager.Confluent;

// Generated from example definition: specification/confluent/resource-manager/Microsoft.Confluent/stable/2024-02-13/examples/Organization_CreateClusterAPIKey.json
// this example is just showing the usage of "Organization_CreateApiKey" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ConfluentOrganizationResource created on azure
// for more information of creating ConfluentOrganizationResource, please refer to the document of ConfluentOrganizationResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "myResourceGroup";
string organizationName = "myOrganization";
ResourceIdentifier confluentOrganizationResourceId = ConfluentOrganizationResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, organizationName);
ConfluentOrganizationResource confluentOrganization = client.GetConfluentOrganizationResource(confluentOrganizationResourceId);

// invoke the operation
string environmentId = "env-12132";
string clusterId = "clusterId-123";
ConfluentApiKeyCreateContent content = new ConfluentApiKeyCreateContent
{
    Name = "CI kafka access key",
    Description = "This API key provides kafka access to cluster x",
};
ConfluentApiKeyRecord result = await confluentOrganization.CreateApiKeyAsync(environmentId, clusterId, content);

Console.WriteLine($"Succeeded: {result}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Respon sampel

Kode status:: 200

{
  "id": "JDCXTFUVFVQGF56J",
  "kind": "ApiKey",
  "properties": {
    "metadata": {
      "createdTimestamp": "2023-11-15T16:15:44.489498Z",
      "resourceName": "crn://api.stag.cpdev.cloud/organization=37d1220b-93a6-43e3-a114-dd8a20a94a31/service-account=sa-wwn7mm/api-key=JDCXTFUVFVQGF56J",
      "self": "https://api.stag.cpdev.cloud/iam/v2/api-keys/JDCXTFUVFVQGF56J",
      "updatedTimestamp": "2023-11-15T16:15:44.489498Z"
    },
    "spec": {
      "description": "This API key provides kafka access to cluster x",
      "name": "CI kafka access key",
      "owner": {
        "id": "sa-wwn7mm",
        "kind": "ServiceAccount",
        "related": "https://api.stag.cpdev.cloud/iam/v2/service-accounts/sa-wwn7mm",
        "resourceName": "crn://api.stag.cpdev.cloud/organization=37d1220b-93a6-43e3-a114-dd8a20a94a31/service-account=sa-wwn7mm"
      },
      "resource": {
        "id": "lsrc-stgc1yrzz3",
        "kind": "SchemaRegistry",
        "related": "https://api.stag.cpdev.cloud/srcm/v2/schema-registries/lsrc-stgc1yrzz3",
        "resourceName": "crn://api.stag.cpdev.cloud/organization=37d1220b-93a6-43e3-a114-dd8a20a94a31/schema-registry=lsrc-stgc1yrzz3"
      },
      "secret": ""
    }
  }
}

Definisi

Nama	Deskripsi
APIKeyOwnerEntity	Detail Pemilik Kunci API yang dapat menjadi akun pengguna atau layanan
APIKeyRecord	Detail kunci API
APIKeyResourceEntity	Detail Sumber Daya Kunci API yang dapat berupa kluster kafka atau kluster registri skema
APIKeySpecEntity	Spesifikasi rekaman KUNCI API
CreateAPIKeyModel	Membuat model Kunci API
ErrorResponseBody	ErrorResponseBody
ResourceProviderDefaultErrorResponse	ResourceProviderDefaultErrorResponse
SCMetadataEntity	Metadata rekaman data

APIKeyOwnerEntity

Objek

Detail Pemilik Kunci API yang dapat menjadi akun pengguna atau layanan

Nama	Jenis	Deskripsi
id	string	Id pemilik Kunci API
kind	string	Jenis layanan pemilik atau akun pengguna
related	string	URL API untuk mengakses atau memodifikasi objek yang dirujuk
resourceName	string	Referensi CRN ke sumber daya yang dirujuk

APIKeyRecord

Objek

Detail kunci API

Nama	Jenis	Deskripsi
id	string	Id kunci api
kind	string	Jenis kunci api
properties.metadata	SCMetadataEntity	Metadata rekaman
properties.spec	APIKeySpecEntity	Spesifikasi Kunci API

APIKeyResourceEntity

Objek

Detail Sumber Daya Kunci API yang dapat berupa kluster kafka atau kluster registri skema

Nama	Jenis	Deskripsi
environment	string	Lingkungan kunci api
id	string	Id sumber daya
kind	string	Jenis pemilik yang dapat berupa layanan atau akun pengguna
related	string	URL API untuk mengakses atau memodifikasi objek sumber daya kunci api
resourceName	string	Referensi CRN ke sumber daya yang dirujuk

APIKeySpecEntity

Objek

Spesifikasi rekaman KUNCI API

Nama	Jenis	Deskripsi
description	string	Penjabaran dari Kunci API
name	string	Nama Kunci API
owner	APIKeyOwnerEntity	Spesifikasi kluster
resource	APIKeyResourceEntity	Spesifikasi kluster
secret	string	Rahasia Kunci API

CreateAPIKeyModel

Objek

Membuat model Kunci API

Nama	Jenis	Deskripsi
description	string	Deskripsi Kunci API
name	string	Nama Kunci API

ErrorResponseBody

Objek

ErrorResponseBody

Nama	Jenis	Deskripsi
code	string	Kode kesalahan
details	ErrorResponseBody[]	Detail kesalahan
message	string	Pesan kesalahan
target	string	Target kesalahan

ResourceProviderDefaultErrorResponse

Objek

ResourceProviderDefaultErrorResponse

Nama	Jenis	Deskripsi
error	ErrorResponseBody	ErrorResponseBody Isi respons Kesalahan

SCMetadataEntity

Objek

Metadata rekaman data

Nama	Jenis	Deskripsi
createdTimestamp	string	Waktu Tanggal Dibuat
deletedTimestamp	string	Waktu Tanggal Dihapus
resourceName	string	Nama sumber daya rekaman
self	string	Url pencarian mandiri
updatedTimestamp	string	Waktu Tanggal Diperbarui