Organization interface
조직을 나타내는 인터페이스입니다.
메서드
메서드 세부 정보
beginCreate(string, string, OrganizationCreateOptionalParams)
조직 리소스 만들기
function beginCreate(resourceGroupName: string, organizationName: string, options?: OrganizationCreateOptionalParams): Promise<SimplePollerLike<OperationState<OrganizationResource>, OrganizationResource>>매개 변수
- resourceGroupName
-
string
리소스 그룹 이름
- organizationName
-
string
조직 리소스 이름
- options
- OrganizationCreateOptionalParams
옵션 매개 변수입니다.
반환
Promise<@azure/core-lro.SimplePollerLike<OperationState<OrganizationResource>, OrganizationResource>>
beginCreateAndWait(string, string, OrganizationCreateOptionalParams)
조직 리소스 만들기
function beginCreateAndWait(resourceGroupName: string, organizationName: string, options?: OrganizationCreateOptionalParams): Promise<OrganizationResource>매개 변수
- resourceGroupName
-
string
리소스 그룹 이름
- organizationName
-
string
조직 리소스 이름
- options
- OrganizationCreateOptionalParams
옵션 매개 변수입니다.
반환
Promise<OrganizationResource>
beginDelete(string, string, OrganizationDeleteOptionalParams)
조직 리소스 삭제
function beginDelete(resourceGroupName: string, organizationName: string, options?: OrganizationDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>매개 변수
- resourceGroupName
-
string
리소스 그룹 이름
- organizationName
-
string
조직 리소스 이름
- options
- OrganizationDeleteOptionalParams
옵션 매개 변수입니다.
반환
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, OrganizationDeleteOptionalParams)
조직 리소스 삭제
function beginDeleteAndWait(resourceGroupName: string, organizationName: string, options?: OrganizationDeleteOptionalParams): Promise<void>매개 변수
- resourceGroupName
-
string
리소스 그룹 이름
- organizationName
-
string
조직 리소스 이름
- options
- OrganizationDeleteOptionalParams
옵션 매개 변수입니다.
반환
Promise<void>
createAPIKey(string, string, string, string, CreateAPIKeyModel, OrganizationCreateAPIKeyOptionalParams)
환경에서 스키마 레지스트리 클러스터 ID 또는 Kafka 클러스터 ID에 대한 API 키를 만듭니다.
function createAPIKey(resourceGroupName: string, organizationName: string, environmentId: string, clusterId: string, body: CreateAPIKeyModel, options?: OrganizationCreateAPIKeyOptionalParams): Promise<APIKeyRecord>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- organizationName
-
string
조직 리소스 이름
- environmentId
-
string
Confluent 환경 ID
- clusterId
-
string
Confluent kafka 또는 스키마 레지스트리 클러스터 ID
- body
- CreateAPIKeyModel
환경에서 스키마 레지스트리 클러스터 ID 또는 Kafka 클러스터 ID에 대한 API 키를 만들기 위한 요청 페이로드
옵션 매개 변수입니다.
반환
Promise<APIKeyRecord>
deleteClusterAPIKey(string, string, string, OrganizationDeleteClusterAPIKeyOptionalParams)
kafka 또는 스키마 레지스트리 클러스터의 API 키를 삭제합니다.
function deleteClusterAPIKey(resourceGroupName: string, organizationName: string, apiKeyId: string, options?: OrganizationDeleteClusterAPIKeyOptionalParams): Promise<void>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- organizationName
-
string
조직 리소스 이름
- apiKeyId
-
string
Confluent API 키 ID
옵션 매개 변수입니다.
반환
Promise<void>
get(string, string, OrganizationGetOptionalParams)
특정 조직 리소스의 속성을 가져옵니다.
function get(resourceGroupName: string, organizationName: string, options?: OrganizationGetOptionalParams): Promise<OrganizationResource>매개 변수
- resourceGroupName
-
string
리소스 그룹 이름
- organizationName
-
string
조직 리소스 이름
- options
- OrganizationGetOptionalParams
옵션 매개 변수입니다.
반환
Promise<OrganizationResource>
getClusterAPIKey(string, string, string, OrganizationGetClusterAPIKeyOptionalParams)
kafka 또는 스키마 레지스트리 클러스터의 API 키 세부 정보 가져오기
function getClusterAPIKey(resourceGroupName: string, organizationName: string, apiKeyId: string, options?: OrganizationGetClusterAPIKeyOptionalParams): Promise<APIKeyRecord>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- organizationName
-
string
조직 리소스 이름
- apiKeyId
-
string
Confluent API 키 ID
옵션 매개 변수입니다.
반환
Promise<APIKeyRecord>
getClusterById(string, string, string, string, OrganizationGetClusterByIdOptionalParams)
ID로 클러스터 가져오기
function getClusterById(resourceGroupName: string, organizationName: string, environmentId: string, clusterId: string, options?: OrganizationGetClusterByIdOptionalParams): Promise<SCClusterRecord>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- organizationName
-
string
조직 리소스 이름
- environmentId
-
string
Confluent 환경 ID
- clusterId
-
string
Confluent kafka 또는 스키마 레지스트리 클러스터 ID
옵션 매개 변수입니다.
반환
Promise<SCClusterRecord>
getEnvironmentById(string, string, string, OrganizationGetEnvironmentByIdOptionalParams)
환경 ID로 환경 세부 정보 가져오기
function getEnvironmentById(resourceGroupName: string, organizationName: string, environmentId: string, options?: OrganizationGetEnvironmentByIdOptionalParams): Promise<SCEnvironmentRecord>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- organizationName
-
string
조직 리소스 이름
- environmentId
-
string
Confluent 환경 ID
옵션 매개 변수입니다.
반환
Promise<SCEnvironmentRecord>
getSchemaRegistryClusterById(string, string, string, string, OrganizationGetSchemaRegistryClusterByIdOptionalParams)
ID로 스키마 레지스트리 클러스터 가져오기
function getSchemaRegistryClusterById(resourceGroupName: string, organizationName: string, environmentId: string, clusterId: string, options?: OrganizationGetSchemaRegistryClusterByIdOptionalParams): Promise<SchemaRegistryClusterRecord>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- organizationName
-
string
조직 리소스 이름
- environmentId
-
string
Confluent 환경 ID
- clusterId
-
string
Confluent kafka 또는 스키마 레지스트리 클러스터 ID
옵션 매개 변수입니다.
반환
Promise<SchemaRegistryClusterRecord>
listByResourceGroup(string, OrganizationListByResourceGroupOptionalParams)
지정된 리소스 그룹 아래에 있는 모든 조직을 나열합니다.
function listByResourceGroup(resourceGroupName: string, options?: OrganizationListByResourceGroupOptionalParams): PagedAsyncIterableIterator<OrganizationResource, OrganizationResource[], PageSettings>매개 변수
- resourceGroupName
-
string
리소스 그룹 이름
옵션 매개 변수입니다.
반환
listBySubscription(OrganizationListBySubscriptionOptionalParams)
지정된 구독 아래의 모든 조직을 나열합니다.
function listBySubscription(options?: OrganizationListBySubscriptionOptionalParams): PagedAsyncIterableIterator<OrganizationResource, OrganizationResource[], PageSettings>매개 변수
옵션 매개 변수입니다.
반환
listClusters(string, string, string, OrganizationListClustersOptionalParams)
환경의 모든 클러스터 Lists
function listClusters(resourceGroupName: string, organizationName: string, environmentId: string, options?: OrganizationListClustersOptionalParams): PagedAsyncIterableIterator<SCClusterRecord, SCClusterRecord[], PageSettings>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- organizationName
-
string
조직 리소스 이름
- environmentId
-
string
Confluent 환경 ID
옵션 매개 변수입니다.
반환
listEnvironments(string, string, OrganizationListEnvironmentsOptionalParams)
organization 모든 환경의 Lists
function listEnvironments(resourceGroupName: string, organizationName: string, options?: OrganizationListEnvironmentsOptionalParams): PagedAsyncIterableIterator<SCEnvironmentRecord, SCEnvironmentRecord[], PageSettings>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- organizationName
-
string
조직 리소스 이름
옵션 매개 변수입니다.
반환
listRegions(string, string, ListAccessRequestModel, OrganizationListRegionsOptionalParams)
스키마 레지스트리 클러스터를 만드는 데 사용할 수 있는 클라우드 공급자 지역입니다.
function listRegions(resourceGroupName: string, organizationName: string, body: ListAccessRequestModel, options?: OrganizationListRegionsOptionalParams): Promise<ListRegionsSuccessResponse>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- organizationName
-
string
조직 리소스 이름
액세스 요청 모델 나열
옵션 매개 변수입니다.
반환
Promise<ListRegionsSuccessResponse>
listSchemaRegistryClusters(string, string, string, OrganizationListSchemaRegistryClustersOptionalParams)
스키마 레지스트리 클러스터 가져오기
function listSchemaRegistryClusters(resourceGroupName: string, organizationName: string, environmentId: string, options?: OrganizationListSchemaRegistryClustersOptionalParams): PagedAsyncIterableIterator<SchemaRegistryClusterRecord, SchemaRegistryClusterRecord[], PageSettings>매개 변수
- resourceGroupName
-
string
리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
- organizationName
-
string
조직 리소스 이름
- environmentId
-
string
Confluent 환경 ID
옵션 매개 변수입니다.
반환
update(string, string, OrganizationUpdateOptionalParams)
조직 리소스 업데이트
function update(resourceGroupName: string, organizationName: string, options?: OrganizationUpdateOptionalParams): Promise<OrganizationResource>매개 변수
- resourceGroupName
-
string
리소스 그룹 이름
- organizationName
-
string
조직 리소스 이름
- options
- OrganizationUpdateOptionalParams
옵션 매개 변수입니다.
반환
Promise<OrganizationResource>