Organization interface

Balíček:

@azure/arm-confluent

Rozhraní představující organizaci

Metody

beginCreate(string, string, OrganizationCreateOptionalParams)	Vytvoření prostředku organizace
beginCreateAndWait(string, string, OrganizationCreateOptionalParams)	Vytvoření prostředku organizace
beginDelete(string, string, OrganizationDeleteOptionalParams)	Odstranění prostředku organizace
beginDeleteAndWait(string, string, OrganizationDeleteOptionalParams)	Odstranění prostředku organizace
createAPIKey(string, string, string, string, CreateAPIKeyModel, OrganizationCreateAPIKeyOptionalParams)	Vytvoří klíč rozhraní API pro ID clusteru registru schématu nebo ID clusteru Kafka v prostředí.
deleteClusterAPIKey(string, string, string, OrganizationDeleteClusterAPIKeyOptionalParams)	Odstraní klíč rozhraní API clusteru registru Kafka nebo schématu.
get(string, string, OrganizationGetOptionalParams)	Získejte vlastnosti konkrétního prostředku organizace.
getClusterAPIKey(string, string, string, OrganizationGetClusterAPIKeyOptionalParams)	Získání podrobností o klíči rozhraní API clusteru registru Kafka nebo schématu
getClusterById(string, string, string, string, OrganizationGetClusterByIdOptionalParams)	Získání clusteru podle ID
getEnvironmentById(string, string, string, OrganizationGetEnvironmentByIdOptionalParams)	Získání podrobností o prostředí podle ID prostředí
getSchemaRegistryClusterById(string, string, string, string, OrganizationGetSchemaRegistryClusterByIdOptionalParams)	Získání clusteru registru schématu podle ID
listByResourceGroup(string, OrganizationListByResourceGroupOptionalParams)	Zobrazí seznam všech organizací v zadané skupině prostředků.
listBySubscription(OrganizationListBySubscriptionOptionalParams)	Zobrazí seznam všech organizací v rámci zadaného předplatného.
listClusters(string, string, string, OrganizationListClustersOptionalParams)	Seznamy všech clusterů v prostředí
listEnvironments(string, string, OrganizationListEnvironmentsOptionalParams)	Seznamy všech prostředí v organizaci
listRegions(string, string, ListAccessRequestModel, OrganizationListRegionsOptionalParams)	Oblasti poskytovatele cloudu dostupné pro vytváření clusterů registru schémat.
listSchemaRegistryClusters(string, string, string, OrganizationListSchemaRegistryClustersOptionalParams)	Získání clusterů registru schématu
update(string, string, OrganizationUpdateOptionalParams)	Aktualizace prostředku organizace

Podrobnosti metody

beginCreate(string, string, OrganizationCreateOptionalParams)

Vytvoření prostředku organizace

function beginCreate(resourceGroupName: string, organizationName: string, options?: OrganizationCreateOptionalParams): Promise<SimplePollerLike<OperationState<OrganizationResource>, OrganizationResource>>

Parametry

resourceGroupName

string

Název skupiny prostředků

organizationName

string

Název prostředku organizace

options

OrganizationCreateOptionalParams

Parametry možností.

Návraty

Promise<@azure/core-lro.SimplePollerLike<OperationState<OrganizationResource>, OrganizationResource>>

beginCreateAndWait(string, string, OrganizationCreateOptionalParams)

Vytvoření prostředku organizace

function beginCreateAndWait(resourceGroupName: string, organizationName: string, options?: OrganizationCreateOptionalParams): Promise<OrganizationResource>

Parametry

resourceGroupName

string

Název skupiny prostředků

organizationName

string

Název prostředku organizace

options

OrganizationCreateOptionalParams

Parametry možností.

Návraty

Promise<OrganizationResource>

beginDelete(string, string, OrganizationDeleteOptionalParams)

Odstranění prostředku organizace

function beginDelete(resourceGroupName: string, organizationName: string, options?: OrganizationDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parametry

resourceGroupName

string

Název skupiny prostředků

organizationName

string

Název prostředku organizace

options

OrganizationDeleteOptionalParams

Parametry možností.

Návraty

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, OrganizationDeleteOptionalParams)

Odstranění prostředku organizace

function beginDeleteAndWait(resourceGroupName: string, organizationName: string, options?: OrganizationDeleteOptionalParams): Promise<void>

Parametry

resourceGroupName

string

Název skupiny prostředků

organizationName

string

Název prostředku organizace

options

OrganizationDeleteOptionalParams

Parametry možností.

Návraty

Promise<void>

createAPIKey(string, string, string, string, CreateAPIKeyModel, OrganizationCreateAPIKeyOptionalParams)

Vytvoří klíč rozhraní API pro ID clusteru registru schématu nebo ID clusteru Kafka v prostředí.

function createAPIKey(resourceGroupName: string, organizationName: string, environmentId: string, clusterId: string, body: CreateAPIKeyModel, options?: OrganizationCreateAPIKeyOptionalParams): Promise<APIKeyRecord>

Parametry

resourceGroupName

string

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

organizationName

string

Název prostředku organizace

environmentId

string

ID prostředí Confluent

clusterId

string

Confluent Kafka nebo ID clusteru registru schématu

body

CreateAPIKeyModel

Žádost o datovou část pro vytvoření klíče rozhraní API pro ID clusteru registru schématu nebo ID clusteru Kafka v rámci prostředí

options

OrganizationCreateAPIKeyOptionalParams

Parametry možností.

Návraty

Promise<APIKeyRecord>

deleteClusterAPIKey(string, string, string, OrganizationDeleteClusterAPIKeyOptionalParams)

Odstraní klíč rozhraní API clusteru registru Kafka nebo schématu.

function deleteClusterAPIKey(resourceGroupName: string, organizationName: string, apiKeyId: string, options?: OrganizationDeleteClusterAPIKeyOptionalParams): Promise<void>

Parametry

resourceGroupName

string

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

organizationName

string

Název prostředku organizace

apiKeyId

string

ID klíče rozhraní API Confluent

options

OrganizationDeleteClusterAPIKeyOptionalParams

Parametry možností.

Návraty

Promise<void>

get(string, string, OrganizationGetOptionalParams)

Získejte vlastnosti konkrétního prostředku organizace.

function get(resourceGroupName: string, organizationName: string, options?: OrganizationGetOptionalParams): Promise<OrganizationResource>

Parametry

resourceGroupName

string

Název skupiny prostředků

organizationName

string

Název prostředku organizace

options

OrganizationGetOptionalParams

Parametry možností.

Návraty

Promise<OrganizationResource>

getClusterAPIKey(string, string, string, OrganizationGetClusterAPIKeyOptionalParams)

Získání podrobností o klíči rozhraní API clusteru registru Kafka nebo schématu

function getClusterAPIKey(resourceGroupName: string, organizationName: string, apiKeyId: string, options?: OrganizationGetClusterAPIKeyOptionalParams): Promise<APIKeyRecord>

Parametry

resourceGroupName

string

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

organizationName

string

Název prostředku organizace

apiKeyId

string

ID klíče rozhraní API Confluent

options

OrganizationGetClusterAPIKeyOptionalParams

Parametry možností.

Návraty

Promise<APIKeyRecord>

getClusterById(string, string, string, string, OrganizationGetClusterByIdOptionalParams)

Získání clusteru podle ID

function getClusterById(resourceGroupName: string, organizationName: string, environmentId: string, clusterId: string, options?: OrganizationGetClusterByIdOptionalParams): Promise<SCClusterRecord>

Parametry

resourceGroupName

string

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

organizationName

string

Název prostředku organizace

environmentId

string

ID prostředí Confluent

clusterId

string

Confluent Kafka nebo ID clusteru registru schématu

options

OrganizationGetClusterByIdOptionalParams

Parametry možností.

Návraty

Promise<SCClusterRecord>

getEnvironmentById(string, string, string, OrganizationGetEnvironmentByIdOptionalParams)

Získání podrobností o prostředí podle ID prostředí

function getEnvironmentById(resourceGroupName: string, organizationName: string, environmentId: string, options?: OrganizationGetEnvironmentByIdOptionalParams): Promise<SCEnvironmentRecord>

Parametry

resourceGroupName

string

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

organizationName

string

Název prostředku organizace

environmentId

string

ID prostředí Confluent

options

OrganizationGetEnvironmentByIdOptionalParams

Parametry možností.

Návraty

Promise<SCEnvironmentRecord>

getSchemaRegistryClusterById(string, string, string, string, OrganizationGetSchemaRegistryClusterByIdOptionalParams)

Získání clusteru registru schématu podle ID

function getSchemaRegistryClusterById(resourceGroupName: string, organizationName: string, environmentId: string, clusterId: string, options?: OrganizationGetSchemaRegistryClusterByIdOptionalParams): Promise<SchemaRegistryClusterRecord>

Parametry

resourceGroupName

string

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

organizationName

string

Název prostředku organizace

environmentId

string

ID prostředí Confluent

clusterId

string

Confluent Kafka nebo ID clusteru registru schématu

options

OrganizationGetSchemaRegistryClusterByIdOptionalParams

Parametry možností.

Návraty

Promise<SchemaRegistryClusterRecord>

listByResourceGroup(string, OrganizationListByResourceGroupOptionalParams)

Zobrazí seznam všech organizací v zadané skupině prostředků.

function listByResourceGroup(resourceGroupName: string, options?: OrganizationListByResourceGroupOptionalParams): PagedAsyncIterableIterator<OrganizationResource, OrganizationResource[], PageSettings>

Parametry

resourceGroupName

string

Název skupiny prostředků

options

OrganizationListByResourceGroupOptionalParams

Parametry možností.

Návraty

PagedAsyncIterableIterator<OrganizationResource, OrganizationResource[], PageSettings>

listBySubscription(OrganizationListBySubscriptionOptionalParams)

Zobrazí seznam všech organizací v rámci zadaného předplatného.

function listBySubscription(options?: OrganizationListBySubscriptionOptionalParams): PagedAsyncIterableIterator<OrganizationResource, OrganizationResource[], PageSettings>

Parametry

options

OrganizationListBySubscriptionOptionalParams

Parametry možností.

Návraty

PagedAsyncIterableIterator<OrganizationResource, OrganizationResource[], PageSettings>

listClusters(string, string, string, OrganizationListClustersOptionalParams)

Seznamy všech clusterů v prostředí

function listClusters(resourceGroupName: string, organizationName: string, environmentId: string, options?: OrganizationListClustersOptionalParams): PagedAsyncIterableIterator<SCClusterRecord, SCClusterRecord[], PageSettings>

Parametry

resourceGroupName

string

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

organizationName

string

Název prostředku organizace

environmentId

string

ID prostředí Confluent

options

OrganizationListClustersOptionalParams

Parametry možností.

Návraty

PagedAsyncIterableIterator<SCClusterRecord, SCClusterRecord[], PageSettings>

listEnvironments(string, string, OrganizationListEnvironmentsOptionalParams)

Seznamy všech prostředí v organizaci

function listEnvironments(resourceGroupName: string, organizationName: string, options?: OrganizationListEnvironmentsOptionalParams): PagedAsyncIterableIterator<SCEnvironmentRecord, SCEnvironmentRecord[], PageSettings>

Parametry

resourceGroupName

string

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

organizationName

string

Název prostředku organizace

options

OrganizationListEnvironmentsOptionalParams

Parametry možností.

Návraty

PagedAsyncIterableIterator<SCEnvironmentRecord, SCEnvironmentRecord[], PageSettings>

listRegions(string, string, ListAccessRequestModel, OrganizationListRegionsOptionalParams)

Oblasti poskytovatele cloudu dostupné pro vytváření clusterů registru schémat.

function listRegions(resourceGroupName: string, organizationName: string, body: ListAccessRequestModel, options?: OrganizationListRegionsOptionalParams): Promise<ListRegionsSuccessResponse>

Parametry

resourceGroupName

string

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

organizationName

string

Název prostředku organizace

body

ListAccessRequestModel

Výpis modelu žádosti o přístup

options

OrganizationListRegionsOptionalParams

Parametry možností.

Návraty

Promise<ListRegionsSuccessResponse>

listSchemaRegistryClusters(string, string, string, OrganizationListSchemaRegistryClustersOptionalParams)

Získání clusterů registru schématu

function listSchemaRegistryClusters(resourceGroupName: string, organizationName: string, environmentId: string, options?: OrganizationListSchemaRegistryClustersOptionalParams): PagedAsyncIterableIterator<SchemaRegistryClusterRecord, SchemaRegistryClusterRecord[], PageSettings>

Parametry

resourceGroupName

string

Název skupiny prostředků. Název nerozlišuje malá a velká písmena.

organizationName

string

Název prostředku organizace

environmentId

string

ID prostředí Confluent

options

OrganizationListSchemaRegistryClustersOptionalParams

Parametry možností.

Návraty

PagedAsyncIterableIterator<SchemaRegistryClusterRecord, SchemaRegistryClusterRecord[], PageSettings>

update(string, string, OrganizationUpdateOptionalParams)

Aktualizace prostředku organizace

function update(resourceGroupName: string, organizationName: string, options?: OrganizationUpdateOptionalParams): Promise<OrganizationResource>

Parametry

resourceGroupName

string

Název skupiny prostředků

organizationName

string

Název prostředku organizace

options

OrganizationUpdateOptionalParams

Parametry možností.

Návraty

Promise<OrganizationResource>