Organization interface

Pakiet:

@azure/arm-confluent

Interfejs reprezentujący organizację.

Metody

beginCreate(string, string, OrganizationCreateOptionalParams)	Tworzenie zasobu organizacji
beginCreateAndWait(string, string, OrganizationCreateOptionalParams)	Tworzenie zasobu organizacji
beginDelete(string, string, OrganizationDeleteOptionalParams)	Usuwanie zasobu organizacji
beginDeleteAndWait(string, string, OrganizationDeleteOptionalParams)	Usuwanie zasobu organizacji
createAPIKey(string, string, string, string, CreateAPIKeyModel, OrganizationCreateAPIKeyOptionalParams)	Tworzy klucz interfejsu API dla identyfikatora klastra schematu lub identyfikatora klastra platformy Kafka w środowisku
deleteClusterAPIKey(string, string, string, OrganizationDeleteClusterAPIKeyOptionalParams)	Usuwa klucz interfejsu API klastra rejestru kafka lub schematu
get(string, string, OrganizationGetOptionalParams)	Pobierz właściwości określonego zasobu organizacji.
getClusterAPIKey(string, string, string, OrganizationGetClusterAPIKeyOptionalParams)	Uzyskiwanie szczegółów klucza interfejsu API dla klastra rejestru kafka lub schematu
getClusterById(string, string, string, string, OrganizationGetClusterByIdOptionalParams)	Pobieranie klastra według identyfikatora
getEnvironmentById(string, string, string, OrganizationGetEnvironmentByIdOptionalParams)	Pobieranie szczegółów środowiska według identyfikatora środowiska
getSchemaRegistryClusterById(string, string, string, string, OrganizationGetSchemaRegistryClusterByIdOptionalParams)	Pobieranie klastra rejestru schematów według identyfikatora
listByResourceGroup(string, OrganizationListByResourceGroupOptionalParams)	Wyświetl listę wszystkich organizacji w ramach określonej grupy zasobów.
listBySubscription(OrganizationListBySubscriptionOptionalParams)	Wyświetl listę wszystkich organizacji w ramach określonej subskrypcji.
listClusters(string, string, string, OrganizationListClustersOptionalParams)	Listy wszystkich klastrów w środowisku
listEnvironments(string, string, OrganizationListEnvironmentsOptionalParams)	Listy wszystkich środowisk w organizacji
listRegions(string, string, ListAccessRequestModel, OrganizationListRegionsOptionalParams)	Regiony dostawców usług w chmurze dostępne do tworzenia klastrów rejestru schematów.
listSchemaRegistryClusters(string, string, string, OrganizationListSchemaRegistryClustersOptionalParams)	Pobieranie klastrów rejestru schematów
update(string, string, OrganizationUpdateOptionalParams)	Aktualizowanie zasobu organizacji

Szczegóły metody

beginCreate(string, string, OrganizationCreateOptionalParams)

Tworzenie zasobu organizacji

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów

organizationName

string

Nazwa zasobu organizacji

options

OrganizationCreateOptionalParams

Parametry opcji.

Zwraca

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

beginCreateAndWait(string, string, OrganizationCreateOptionalParams)

Tworzenie zasobu organizacji

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów

organizationName

string

Nazwa zasobu organizacji

options

OrganizationCreateOptionalParams

Parametry opcji.

Zwraca

Promise<OrganizationResource>

beginDelete(string, string, OrganizationDeleteOptionalParams)

Usuwanie zasobu organizacji

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów

organizationName

string

Nazwa zasobu organizacji

options

OrganizationDeleteOptionalParams

Parametry opcji.

Zwraca

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

beginDeleteAndWait(string, string, OrganizationDeleteOptionalParams)

Usuwanie zasobu organizacji

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów

organizationName

string

Nazwa zasobu organizacji

options

OrganizationDeleteOptionalParams

Parametry opcji.

Zwraca

Promise<void>

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

Tworzy klucz interfejsu API dla identyfikatora klastra schematu lub identyfikatora klastra platformy Kafka w środowisku

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

organizationName

string

Nazwa zasobu organizacji

environmentId

string

Identyfikator środowiska confluent

clusterId

string

Identyfikator klastra klastra kafka lub schematu platformy Confluent

body

CreateAPIKeyModel

Żądanie ładunku pobierania klucza interfejsu API dla identyfikatora klastra rejestru schematu lub identyfikatora klastra kafka w środowisku

options

OrganizationCreateAPIKeyOptionalParams

Parametry opcji.

Zwraca

Promise<APIKeyRecord>

deleteClusterAPIKey(string, string, string, OrganizationDeleteClusterAPIKeyOptionalParams)

Usuwa klucz interfejsu API klastra rejestru kafka lub schematu

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

organizationName

string

Nazwa zasobu organizacji

apiKeyId

string

Identyfikator klucza interfejsu API platformy Confluent

options

OrganizationDeleteClusterAPIKeyOptionalParams

Parametry opcji.

Zwraca

Promise<void>

get(string, string, OrganizationGetOptionalParams)

Pobierz właściwości określonego zasobu organizacji.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów

organizationName

string

Nazwa zasobu organizacji

options

OrganizationGetOptionalParams

Parametry opcji.

Zwraca

Promise<OrganizationResource>

getClusterAPIKey(string, string, string, OrganizationGetClusterAPIKeyOptionalParams)

Uzyskiwanie szczegółów klucza interfejsu API dla klastra rejestru kafka lub schematu

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

organizationName

string

Nazwa zasobu organizacji

apiKeyId

string

Identyfikator klucza interfejsu API platformy Confluent

options

OrganizationGetClusterAPIKeyOptionalParams

Parametry opcji.

Zwraca

Promise<APIKeyRecord>

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

Pobieranie klastra według identyfikatora

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

organizationName

string

Nazwa zasobu organizacji

environmentId

string

Identyfikator środowiska confluent

clusterId

string

Identyfikator klastra klastra kafka lub schematu platformy Confluent

options

OrganizationGetClusterByIdOptionalParams

Parametry opcji.

Zwraca

Promise<SCClusterRecord>

getEnvironmentById(string, string, string, OrganizationGetEnvironmentByIdOptionalParams)

Pobieranie szczegółów środowiska według identyfikatora środowiska

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

organizationName

string

Nazwa zasobu organizacji

environmentId

string

Identyfikator środowiska confluent

options

OrganizationGetEnvironmentByIdOptionalParams

Parametry opcji.

Zwraca

Promise<SCEnvironmentRecord>

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

Pobieranie klastra rejestru schematów według identyfikatora

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

organizationName

string

Nazwa zasobu organizacji

environmentId

string

Identyfikator środowiska confluent

clusterId

string

Identyfikator klastra klastra kafka lub schematu platformy Confluent

options

OrganizationGetSchemaRegistryClusterByIdOptionalParams

Parametry opcji.

Zwraca

Promise<SchemaRegistryClusterRecord>

listByResourceGroup(string, OrganizationListByResourceGroupOptionalParams)

Wyświetl listę wszystkich organizacji w ramach określonej grupy zasobów.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów

options

OrganizationListByResourceGroupOptionalParams

Parametry opcji.

Zwraca

PagedAsyncIterableIterator<OrganizationResource, OrganizationResource[], PageSettings>

listBySubscription(OrganizationListBySubscriptionOptionalParams)

Wyświetl listę wszystkich organizacji w ramach określonej subskrypcji.

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

Parametry

options

OrganizationListBySubscriptionOptionalParams

Parametry opcji.

Zwraca

PagedAsyncIterableIterator<OrganizationResource, OrganizationResource[], PageSettings>

listClusters(string, string, string, OrganizationListClustersOptionalParams)

Listy wszystkich klastrów w środowisku

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

organizationName

string

Nazwa zasobu organizacji

environmentId

string

Identyfikator środowiska confluent

options

OrganizationListClustersOptionalParams

Parametry opcji.

Zwraca

PagedAsyncIterableIterator<SCClusterRecord, SCClusterRecord[], PageSettings>

listEnvironments(string, string, OrganizationListEnvironmentsOptionalParams)

Listy wszystkich środowisk w organizacji

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

organizationName

string

Nazwa zasobu organizacji

options

OrganizationListEnvironmentsOptionalParams

Parametry opcji.

Zwraca

PagedAsyncIterableIterator<SCEnvironmentRecord, SCEnvironmentRecord[], PageSettings>

listRegions(string, string, ListAccessRequestModel, OrganizationListRegionsOptionalParams)

Regiony dostawców usług w chmurze dostępne do tworzenia klastrów rejestru schematów.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

organizationName

string

Nazwa zasobu organizacji

body

ListAccessRequestModel

Model żądania dostępu do listy

options

OrganizationListRegionsOptionalParams

Parametry opcji.

Zwraca

Promise<ListRegionsSuccessResponse>

listSchemaRegistryClusters(string, string, string, OrganizationListSchemaRegistryClustersOptionalParams)

Pobieranie klastrów rejestru schematów

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

organizationName

string

Nazwa zasobu organizacji

environmentId

string

Identyfikator środowiska confluent

options

OrganizationListSchemaRegistryClustersOptionalParams

Parametry opcji.

Zwraca

PagedAsyncIterableIterator<SchemaRegistryClusterRecord, SchemaRegistryClusterRecord[], PageSettings>

update(string, string, OrganizationUpdateOptionalParams)

Aktualizowanie zasobu organizacji

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów

organizationName

string

Nazwa zasobu organizacji

options

OrganizationUpdateOptionalParams

Parametry opcji.

Zwraca

Promise<OrganizationResource>