IdentityAssignmentsOperations interface

Package:

@azure/arm-horizondb

Interface representing a IdentityAssignments operations.

Properties

beginCreateOrReplace
beginCreateOrReplaceAndWait
beginDelete
beginDeleteAndWait
createOrReplace	Creates or idempotently replaces a change data capture identity assignment. The identity resource ID is immutable and must reference a user-assigned managed identity already attached to the parent cluster. The service also validates destination permissions, which are not granted by attaching the identity to the cluster.
delete	Deletes an inactive change data capture identity assignment.
get	Gets a change data capture identity assignment.
list	Lists identity assignments for a change data capture destination.

Property Details

beginCreateOrReplace

Warning

This API is now deprecated.

use createOrReplace instead

beginCreateOrReplace: (resourceGroupName: string, clusterName: string, destinationName: string, assignmentName: string, resource: IdentityAssignmentCreateOrUpdate, options?: IdentityAssignmentsCreateOrReplaceOptionalParams) => Promise<SimplePollerLike<OperationState<IdentityAssignment>, IdentityAssignment>>

Property Value

(resourceGroupName: string, clusterName: string, destinationName: string, assignmentName: string, resource: IdentityAssignmentCreateOrUpdate, options?: IdentityAssignmentsCreateOrReplaceOptionalParams) => Promise<SimplePollerLike<OperationState<IdentityAssignment>, IdentityAssignment>>

beginCreateOrReplaceAndWait

Warning

This API is now deprecated.

use createOrReplace instead

beginCreateOrReplaceAndWait: (resourceGroupName: string, clusterName: string, destinationName: string, assignmentName: string, resource: IdentityAssignmentCreateOrUpdate, options?: IdentityAssignmentsCreateOrReplaceOptionalParams) => Promise<IdentityAssignment>

Property Value

(resourceGroupName: string, clusterName: string, destinationName: string, assignmentName: string, resource: IdentityAssignmentCreateOrUpdate, options?: IdentityAssignmentsCreateOrReplaceOptionalParams) => Promise<IdentityAssignment>

beginDelete

Warning

This API is now deprecated.

use delete instead

beginDelete: (resourceGroupName: string, clusterName: string, destinationName: string, assignmentName: string, options?: IdentityAssignmentsDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, clusterName: string, destinationName: string, assignmentName: string, options?: IdentityAssignmentsDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

beginDeleteAndWait: (resourceGroupName: string, clusterName: string, destinationName: string, assignmentName: string, options?: IdentityAssignmentsDeleteOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, clusterName: string, destinationName: string, assignmentName: string, options?: IdentityAssignmentsDeleteOptionalParams) => Promise<void>

createOrReplace

Creates or idempotently replaces a change data capture identity assignment. The identity resource ID is immutable and must reference a user-assigned managed identity already attached to the parent cluster. The service also validates destination permissions, which are not granted by attaching the identity to the cluster.

createOrReplace: (resourceGroupName: string, clusterName: string, destinationName: string, assignmentName: string, resource: IdentityAssignmentCreateOrUpdate, options?: IdentityAssignmentsCreateOrReplaceOptionalParams) => PollerLike<OperationState<IdentityAssignment>, IdentityAssignment>

Property Value

(resourceGroupName: string, clusterName: string, destinationName: string, assignmentName: string, resource: IdentityAssignmentCreateOrUpdate, options?: IdentityAssignmentsCreateOrReplaceOptionalParams) => PollerLike<OperationState<IdentityAssignment>, IdentityAssignment>

delete

Deletes an inactive change data capture identity assignment.

delete: (resourceGroupName: string, clusterName: string, destinationName: string, assignmentName: string, options?: IdentityAssignmentsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, clusterName: string, destinationName: string, assignmentName: string, options?: IdentityAssignmentsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

Gets a change data capture identity assignment.

get: (resourceGroupName: string, clusterName: string, destinationName: string, assignmentName: string, options?: IdentityAssignmentsGetOptionalParams) => Promise<IdentityAssignment>

Property Value

(resourceGroupName: string, clusterName: string, destinationName: string, assignmentName: string, options?: IdentityAssignmentsGetOptionalParams) => Promise<IdentityAssignment>

list

Lists identity assignments for a change data capture destination.

list: (resourceGroupName: string, clusterName: string, destinationName: string, options?: IdentityAssignmentsListOptionalParams) => PagedAsyncIterableIterator<IdentityAssignment, IdentityAssignment[], PageSettings>

Property Value

(resourceGroupName: string, clusterName: string, destinationName: string, options?: IdentityAssignmentsListOptionalParams) => PagedAsyncIterableIterator<IdentityAssignment, IdentityAssignment[], PageSettings>