Organization interface
Interface die een organisatie vertegenwoordigt.
Methoden
Methodedetails
beginCreate(string, string, OrganizationCreateOptionalParams)
Organisatieresource maken
function beginCreate(resourceGroupName: string, organizationName: string, options?: OrganizationCreateOptionalParams): Promise<SimplePollerLike<OperationState<OrganizationResource>, OrganizationResource>>
Parameters
- resourceGroupName
-
string
Naam van resourcegroep
- organizationName
-
string
Naam van organisatieresource
- options
- OrganizationCreateOptionalParams
De optiesparameters.
Retouren
Promise<@azure/core-lro.SimplePollerLike<OperationState<OrganizationResource>, OrganizationResource>>
beginCreateAndWait(string, string, OrganizationCreateOptionalParams)
Organisatieresource maken
function beginCreateAndWait(resourceGroupName: string, organizationName: string, options?: OrganizationCreateOptionalParams): Promise<OrganizationResource>
Parameters
- resourceGroupName
-
string
Naam van resourcegroep
- organizationName
-
string
Naam van organisatieresource
- options
- OrganizationCreateOptionalParams
De optiesparameters.
Retouren
Promise<OrganizationResource>
beginDelete(string, string, OrganizationDeleteOptionalParams)
Organisatieresource verwijderen
function beginDelete(resourceGroupName: string, organizationName: string, options?: OrganizationDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
Parameters
- resourceGroupName
-
string
Naam van resourcegroep
- organizationName
-
string
Naam van organisatieresource
- options
- OrganizationDeleteOptionalParams
De optiesparameters.
Retouren
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, OrganizationDeleteOptionalParams)
Organisatieresource verwijderen
function beginDeleteAndWait(resourceGroupName: string, organizationName: string, options?: OrganizationDeleteOptionalParams): Promise<void>
Parameters
- resourceGroupName
-
string
Naam van resourcegroep
- organizationName
-
string
Naam van organisatieresource
- options
- OrganizationDeleteOptionalParams
De optiesparameters.
Retouren
Promise<void>
createAPIKey(string, string, string, string, CreateAPIKeyModel, OrganizationCreateAPIKeyOptionalParams)
Hiermee maakt u een API-sleutel voor een schemaregistercluster-id of Kafka-cluster-id onder een omgeving
function createAPIKey(resourceGroupName: string, organizationName: string, environmentId: string, clusterId: string, body: CreateAPIKeyModel, options?: OrganizationCreateAPIKeyOptionalParams): Promise<APIKeyRecord>
Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- organizationName
-
string
Naam van organisatieresource
- environmentId
-
string
Confluent-omgevings-id
- clusterId
-
string
Confluent kafka- of schemaregistercluster-id
- body
- CreateAPIKeyModel
Nettolading aanvragen voor het maken van EEN API-sleutel voor de cluster-id van het schemaregister of kafka-cluster-id onder een omgeving
De optiesparameters.
Retouren
Promise<APIKeyRecord>
deleteClusterAPIKey(string, string, string, OrganizationDeleteClusterAPIKeyOptionalParams)
Hiermee verwijdert u de API-sleutel van een kafka- of schemaregistercluster
function deleteClusterAPIKey(resourceGroupName: string, organizationName: string, apiKeyId: string, options?: OrganizationDeleteClusterAPIKeyOptionalParams): Promise<void>
Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- organizationName
-
string
Naam van organisatieresource
- apiKeyId
-
string
Confluent-API-sleutel-id
De optiesparameters.
Retouren
Promise<void>
get(string, string, OrganizationGetOptionalParams)
Haal de eigenschappen van een specifieke organisatieresource op.
function get(resourceGroupName: string, organizationName: string, options?: OrganizationGetOptionalParams): Promise<OrganizationResource>
Parameters
- resourceGroupName
-
string
Naam van resourcegroep
- organizationName
-
string
Naam van organisatieresource
- options
- OrganizationGetOptionalParams
De optiesparameters.
Retouren
Promise<OrganizationResource>
getClusterAPIKey(string, string, string, OrganizationGetClusterAPIKeyOptionalParams)
Api-sleuteldetails ophalen van een kafka- of schemaregistercluster
function getClusterAPIKey(resourceGroupName: string, organizationName: string, apiKeyId: string, options?: OrganizationGetClusterAPIKeyOptionalParams): Promise<APIKeyRecord>
Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- organizationName
-
string
Naam van organisatieresource
- apiKeyId
-
string
Confluent-API-sleutel-id
De optiesparameters.
Retouren
Promise<APIKeyRecord>
getClusterById(string, string, string, string, OrganizationGetClusterByIdOptionalParams)
Cluster ophalen op id
function getClusterById(resourceGroupName: string, organizationName: string, environmentId: string, clusterId: string, options?: OrganizationGetClusterByIdOptionalParams): Promise<SCClusterRecord>
Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- organizationName
-
string
Naam van organisatieresource
- environmentId
-
string
Confluent-omgevings-id
- clusterId
-
string
Confluent kafka- of schemaregistercluster-id
De optiesparameters.
Retouren
Promise<SCClusterRecord>
getEnvironmentById(string, string, string, OrganizationGetEnvironmentByIdOptionalParams)
Omgevingsgegevens ophalen op omgevings-id
function getEnvironmentById(resourceGroupName: string, organizationName: string, environmentId: string, options?: OrganizationGetEnvironmentByIdOptionalParams): Promise<SCEnvironmentRecord>
Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- organizationName
-
string
Naam van organisatieresource
- environmentId
-
string
Confluent-omgevings-id
De optiesparameters.
Retouren
Promise<SCEnvironmentRecord>
getSchemaRegistryClusterById(string, string, string, string, OrganizationGetSchemaRegistryClusterByIdOptionalParams)
Schemaregistercluster ophalen op id
function getSchemaRegistryClusterById(resourceGroupName: string, organizationName: string, environmentId: string, clusterId: string, options?: OrganizationGetSchemaRegistryClusterByIdOptionalParams): Promise<SchemaRegistryClusterRecord>
Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- organizationName
-
string
Naam van organisatieresource
- environmentId
-
string
Confluent-omgevings-id
- clusterId
-
string
Confluent kafka- of schemaregistercluster-id
De optiesparameters.
Retouren
Promise<SchemaRegistryClusterRecord>
listByResourceGroup(string, OrganizationListByResourceGroupOptionalParams)
Alle organisaties onder de opgegeven resourcegroep weergeven.
function listByResourceGroup(resourceGroupName: string, options?: OrganizationListByResourceGroupOptionalParams): PagedAsyncIterableIterator<OrganizationResource, OrganizationResource[], PageSettings>
Parameters
- resourceGroupName
-
string
Naam van resourcegroep
De optiesparameters.
Retouren
listBySubscription(OrganizationListBySubscriptionOptionalParams)
Vermeld alle organisaties onder het opgegeven abonnement.
function listBySubscription(options?: OrganizationListBySubscriptionOptionalParams): PagedAsyncIterableIterator<OrganizationResource, OrganizationResource[], PageSettings>
Parameters
De optiesparameters.
Retouren
listClusters(string, string, string, OrganizationListClustersOptionalParams)
Lijsten met alle clusters in een omgeving
function listClusters(resourceGroupName: string, organizationName: string, environmentId: string, options?: OrganizationListClustersOptionalParams): PagedAsyncIterableIterator<SCClusterRecord, SCClusterRecord[], PageSettings>
Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- organizationName
-
string
Naam van organisatieresource
- environmentId
-
string
Confluent-omgevings-id
De optiesparameters.
Retouren
listEnvironments(string, string, OrganizationListEnvironmentsOptionalParams)
Lijsten met alle omgevingen in een organisatie
function listEnvironments(resourceGroupName: string, organizationName: string, options?: OrganizationListEnvironmentsOptionalParams): PagedAsyncIterableIterator<SCEnvironmentRecord, SCEnvironmentRecord[], PageSettings>
Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- organizationName
-
string
Naam van organisatieresource
De optiesparameters.
Retouren
listRegions(string, string, ListAccessRequestModel, OrganizationListRegionsOptionalParams)
cloudproviderregio's die beschikbaar zijn voor het maken van schemaregisterclusters.
function listRegions(resourceGroupName: string, organizationName: string, body: ListAccessRequestModel, options?: OrganizationListRegionsOptionalParams): Promise<ListRegionsSuccessResponse>
Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- organizationName
-
string
Naam van organisatieresource
Toegangsaanvraagmodel weergeven
De optiesparameters.
Retouren
Promise<ListRegionsSuccessResponse>
listSchemaRegistryClusters(string, string, string, OrganizationListSchemaRegistryClustersOptionalParams)
Schemaregisterclusters ophalen
function listSchemaRegistryClusters(resourceGroupName: string, organizationName: string, environmentId: string, options?: OrganizationListSchemaRegistryClustersOptionalParams): PagedAsyncIterableIterator<SchemaRegistryClusterRecord, SchemaRegistryClusterRecord[], PageSettings>
Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- organizationName
-
string
Naam van organisatieresource
- environmentId
-
string
Confluent-omgevings-id
De optiesparameters.
Retouren
update(string, string, OrganizationUpdateOptionalParams)
Organisatieresource bijwerken
function update(resourceGroupName: string, organizationName: string, options?: OrganizationUpdateOptionalParams): Promise<OrganizationResource>
Parameters
- resourceGroupName
-
string
Naam van resourcegroep
- organizationName
-
string
Naam van organisatieresource
- options
- OrganizationUpdateOptionalParams
De optiesparameters.
Retouren
Promise<OrganizationResource>