Organization interface

Paket:

@azure/arm-confluent

Gränssnitt som representerar en organisation.

Metoder

beginCreate(string, string, OrganizationCreateOptionalParams)	Skapa organisationsresurs
beginCreateAndWait(string, string, OrganizationCreateOptionalParams)	Skapa organisationsresurs
beginDelete(string, string, OrganizationDeleteOptionalParams)	Ta bort organisationsresurs
beginDeleteAndWait(string, string, OrganizationDeleteOptionalParams)	Ta bort organisationsresurs
createAPIKey(string, string, string, string, CreateAPIKeyModel, OrganizationCreateAPIKeyOptionalParams)	Skapar API-nyckel för ett kluster-ID för schemaregistret eller Kafka-kluster-ID under en miljö
deleteClusterAPIKey(string, string, string, OrganizationDeleteClusterAPIKeyOptionalParams)	Tar bort API-nyckeln för ett kafka- eller schemaregisterkluster
get(string, string, OrganizationGetOptionalParams)	Hämta egenskaperna för en specifik organisationsresurs.
getClusterAPIKey(string, string, string, OrganizationGetClusterAPIKeyOptionalParams)	Hämta API-nyckelinformation för ett kafka- eller schemaregisterkluster
getClusterById(string, string, string, string, OrganizationGetClusterByIdOptionalParams)	Hämta kluster efter ID
getEnvironmentById(string, string, string, OrganizationGetEnvironmentByIdOptionalParams)	Hämta miljöinformation efter miljö-ID
getSchemaRegistryClusterById(string, string, string, string, OrganizationGetSchemaRegistryClusterByIdOptionalParams)	Hämta schemaregisterkluster efter ID
listByResourceGroup(string, OrganizationListByResourceGroupOptionalParams)	Visa en lista över alla organisationer under den angivna resursgruppen.
listBySubscription(OrganizationListBySubscriptionOptionalParams)	Visa en lista över alla organisationer under den angivna prenumerationen.
listClusters(string, string, string, OrganizationListClustersOptionalParams)	Listor av alla kluster i en miljö
listEnvironments(string, string, OrganizationListEnvironmentsOptionalParams)	Listor av alla miljöer i en organisation
listRegions(string, string, ListAccessRequestModel, OrganizationListRegionsOptionalParams)	molnleverantörsregioner som är tillgängliga för att skapa Schema Registry-kluster.
listSchemaRegistryClusters(string, string, string, OrganizationListSchemaRegistryClustersOptionalParams)	Hämta schemaregisterkluster
update(string, string, OrganizationUpdateOptionalParams)	Uppdatera organisationsresurs

Metodinformation

beginCreate(string, string, OrganizationCreateOptionalParams)

Skapa organisationsresurs

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

Parametrar

resourceGroupName

string

Namn på resursgrupp

organizationName

string

Namn på organisationsresurs

options

OrganizationCreateOptionalParams

Alternativparametrarna.

Returer

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

beginCreateAndWait(string, string, OrganizationCreateOptionalParams)

Skapa organisationsresurs

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

Parametrar

resourceGroupName

string

Namn på resursgrupp

organizationName

string

Namn på organisationsresurs

options

OrganizationCreateOptionalParams

Alternativparametrarna.

Returer

Promise<OrganizationResource>

beginDelete(string, string, OrganizationDeleteOptionalParams)

Ta bort organisationsresurs

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

Parametrar

resourceGroupName

string

Namn på resursgrupp

organizationName

string

Namn på organisationsresurs

options

OrganizationDeleteOptionalParams

Alternativparametrarna.

Returer

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

beginDeleteAndWait(string, string, OrganizationDeleteOptionalParams)

Ta bort organisationsresurs

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

Parametrar

resourceGroupName

string

Namn på resursgrupp

organizationName

string

Namn på organisationsresurs

options

OrganizationDeleteOptionalParams

Alternativparametrarna.

Returer

Promise<void>

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

Skapar API-nyckel för ett kluster-ID för schemaregistret eller Kafka-kluster-ID under en miljö

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

organizationName

string

Namn på organisationsresurs

environmentId

string

Confluent-miljö-ID

clusterId

string

Kluster-ID för Confluent kafka eller schemaregister

body

CreateAPIKeyModel

Begär nyttolast för att skapa API-nyckel för schemaregistrets kluster-ID eller Kafka-kluster-ID under en miljö

options

OrganizationCreateAPIKeyOptionalParams

Alternativparametrarna.

Returer

Promise<APIKeyRecord>

deleteClusterAPIKey(string, string, string, OrganizationDeleteClusterAPIKeyOptionalParams)

Tar bort API-nyckeln för ett kafka- eller schemaregisterkluster

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

organizationName

string

Namn på organisationsresurs

apiKeyId

string

Confluent API-nyckel-ID

options

OrganizationDeleteClusterAPIKeyOptionalParams

Alternativparametrarna.

Returer

Promise<void>

get(string, string, OrganizationGetOptionalParams)

Hämta egenskaperna för en specifik organisationsresurs.

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

Parametrar

resourceGroupName

string

Namn på resursgrupp

organizationName

string

Namn på organisationsresurs

options

OrganizationGetOptionalParams

Alternativparametrarna.

Returer

Promise<OrganizationResource>

getClusterAPIKey(string, string, string, OrganizationGetClusterAPIKeyOptionalParams)

Hämta API-nyckelinformation för ett kafka- eller schemaregisterkluster

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

organizationName

string

Namn på organisationsresurs

apiKeyId

string

Confluent API-nyckel-ID

options

OrganizationGetClusterAPIKeyOptionalParams

Alternativparametrarna.

Returer

Promise<APIKeyRecord>

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

Hämta kluster efter ID

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

organizationName

string

Namn på organisationsresurs

environmentId

string

Confluent-miljö-ID

clusterId

string

Kluster-ID för Confluent kafka eller schemaregister

options

OrganizationGetClusterByIdOptionalParams

Alternativparametrarna.

Returer

Promise<SCClusterRecord>

getEnvironmentById(string, string, string, OrganizationGetEnvironmentByIdOptionalParams)

Hämta miljöinformation efter miljö-ID

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

organizationName

string

Namn på organisationsresurs

environmentId

string

Confluent-miljö-ID

options

OrganizationGetEnvironmentByIdOptionalParams

Alternativparametrarna.

Returer

Promise<SCEnvironmentRecord>

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

Hämta schemaregisterkluster efter ID

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

organizationName

string

Namn på organisationsresurs

environmentId

string

Confluent-miljö-ID

clusterId

string

Kluster-ID för Confluent kafka eller schemaregister

options

OrganizationGetSchemaRegistryClusterByIdOptionalParams

Alternativparametrarna.

Returer

Promise<SchemaRegistryClusterRecord>

listByResourceGroup(string, OrganizationListByResourceGroupOptionalParams)

Visa en lista över alla organisationer under den angivna resursgruppen.

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

Parametrar

resourceGroupName

string

Namn på resursgrupp

options

OrganizationListByResourceGroupOptionalParams

Alternativparametrarna.

Returer

PagedAsyncIterableIterator<OrganizationResource, OrganizationResource[], PageSettings>

listBySubscription(OrganizationListBySubscriptionOptionalParams)

Visa en lista över alla organisationer under den angivna prenumerationen.

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

Parametrar

options

OrganizationListBySubscriptionOptionalParams

Alternativparametrarna.

Returer

PagedAsyncIterableIterator<OrganizationResource, OrganizationResource[], PageSettings>

listClusters(string, string, string, OrganizationListClustersOptionalParams)

Listor av alla kluster i en miljö

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

organizationName

string

Namn på organisationsresurs

environmentId

string

Confluent-miljö-ID

options

OrganizationListClustersOptionalParams

Alternativparametrarna.

Returer

PagedAsyncIterableIterator<SCClusterRecord, SCClusterRecord[], PageSettings>

listEnvironments(string, string, OrganizationListEnvironmentsOptionalParams)

Listor av alla miljöer i en organisation

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

organizationName

string

Namn på organisationsresurs

options

OrganizationListEnvironmentsOptionalParams

Alternativparametrarna.

Returer

PagedAsyncIterableIterator<SCEnvironmentRecord, SCEnvironmentRecord[], PageSettings>

listRegions(string, string, ListAccessRequestModel, OrganizationListRegionsOptionalParams)

molnleverantörsregioner som är tillgängliga för att skapa Schema Registry-kluster.

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

organizationName

string

Namn på organisationsresurs

body

ListAccessRequestModel

Lista med modell för åtkomstbegäran

options

OrganizationListRegionsOptionalParams

Alternativparametrarna.

Returer

Promise<ListRegionsSuccessResponse>

listSchemaRegistryClusters(string, string, string, OrganizationListSchemaRegistryClustersOptionalParams)

Hämta schemaregisterkluster

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

Parametrar

resourceGroupName

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

organizationName

string

Namn på organisationsresurs

environmentId

string

Confluent-miljö-ID

options

OrganizationListSchemaRegistryClustersOptionalParams

Alternativparametrarna.

Returer

PagedAsyncIterableIterator<SchemaRegistryClusterRecord, SchemaRegistryClusterRecord[], PageSettings>

update(string, string, OrganizationUpdateOptionalParams)

Uppdatera organisationsresurs

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

Parametrar

resourceGroupName

string

Namn på resursgrupp

organizationName

string

Namn på organisationsresurs

options

OrganizationUpdateOptionalParams

Alternativparametrarna.

Returer

Promise<OrganizationResource>