Share via

ConfluentOrganizationResource Class

  • Reference

Definition

Namespace:
Azure.ResourceManager.Confluent
Assembly:
Azure.ResourceManager.Confluent.dll
Package:
Azure.ResourceManager.Confluent v1.2.0
Package:
Azure.ResourceManager.Confluent v1.1.0-beta.1
Source:
ConfluentOrganizationResource.cs
Source:
ConfluentOrganizationResource.cs

A Class representing a ConfluentOrganization along with the instance operations that can be performed on it. If you have a ResourceIdentifier you can construct a ConfluentOrganizationResource from an instance of ArmClient using the GetConfluentOrganizationResource method. Otherwise you can get one from its parent resource ResourceGroupResource using the GetConfluentOrganization method.

public class ConfluentOrganizationResource : Azure.ResourceManager.ArmResource
type ConfluentOrganizationResource = class
    inherit ArmResource
Public Class ConfluentOrganizationResource
Inherits ArmResource
Inheritance
Object
ArmResource
ConfluentOrganizationResource

Constructors

ConfluentOrganizationResource()

Initializes a new instance of the ConfluentOrganizationResource class for mocking.

Fields

ResourceType

Gets the resource type for the operations.

Properties

Client

Gets the ArmClient this resource client was created from.

(Inherited from ArmResource)
Data

Gets the data representing this Feature.
Diagnostics

Gets the diagnostic options for this resource client.

(Inherited from ArmResource)
Endpoint

Gets the base uri for this resource client.

(Inherited from ArmResource)
HasData

Gets whether or not the current instance has data.
Id

Gets the resource identifier.

(Inherited from ArmResource)
Pipeline

Gets the pipeline for this resource client.

(Inherited from ArmResource)

Methods

AddTag(String, String, CancellationToken)

Add a tag to the current resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}
  • Operation Id: Organization_Get
  • Default Api Version: 2024-02-13
  • Resource: ConfluentOrganizationResource
AddTagAsync(String, String, CancellationToken)

Add a tag to the current resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}
  • Operation Id: Organization_Get
  • Default Api Version: 2024-02-13
  • Resource: ConfluentOrganizationResource
CanUseTagResource(CancellationToken)

Checks to see if the TagResource API is deployed in the current environment.

(Inherited from ArmResource)
CanUseTagResourceAsync(CancellationToken)

Checks to see if the TagResource API is deployed in the current environment.

(Inherited from ArmResource)
CreateAccessRoleBinding(AccessRoleBindingCreateContent, CancellationToken)

Organization role bindings

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/access/default/createRoleBinding
  • Operation Id: Access_CreateRoleBinding
  • Default Api Version: 2024-02-13
CreateAccessRoleBindingAsync(AccessRoleBindingCreateContent, CancellationToken)

Organization role bindings

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/access/default/createRoleBinding
  • Operation Id: Access_CreateRoleBinding
  • Default Api Version: 2024-02-13
CreateApiKey(String, String, ConfluentApiKeyCreateContent, CancellationToken)

Creates API key for a schema registry Cluster ID or Kafka Cluster ID under a environment

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/environments/{environmentId}/clusters/{clusterId}/createAPIKey
  • Operation Id: Organization_CreateAPIKey
  • Default Api Version: 2024-02-13
  • Resource: ConfluentOrganizationResource
CreateApiKeyAsync(String, String, ConfluentApiKeyCreateContent, CancellationToken)

Creates API key for a schema registry Cluster ID or Kafka Cluster ID under a environment

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/environments/{environmentId}/clusters/{clusterId}/createAPIKey
  • Operation Id: Organization_CreateAPIKey
  • Default Api Version: 2024-02-13
  • Resource: ConfluentOrganizationResource
CreateResourceIdentifier(String, String, String)

Generate the resource identifier of a ConfluentOrganizationResource instance.
Delete(WaitUntil, CancellationToken)

Delete Organization resource

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}
  • Operation Id: Organization_Delete
  • Default Api Version: 2024-02-13
  • Resource: ConfluentOrganizationResource
DeleteAccessRoleBinding(String, CancellationToken)

Organization role bindings

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/access/default/deleteRoleBinding/{roleBindingId}
  • Operation Id: Access_DeleteRoleBinding
  • Default Api Version: 2024-02-13
DeleteAccessRoleBindingAsync(String, CancellationToken)

Organization role bindings

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/access/default/deleteRoleBinding/{roleBindingId}
  • Operation Id: Access_DeleteRoleBinding
  • Default Api Version: 2024-02-13
DeleteAsync(WaitUntil, CancellationToken)

Delete Organization resource

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}
  • Operation Id: Organization_Delete
  • Default Api Version: 2024-02-13
  • Resource: ConfluentOrganizationResource
DeleteClusterApiKey(String, CancellationToken)

Deletes API key of a kafka or schema registry cluster

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/apiKeys/{apiKeyId}
  • Operation Id: Organization_DeleteClusterAPIKey
  • Default Api Version: 2024-02-13
  • Resource: ConfluentOrganizationResource
DeleteClusterApiKeyAsync(String, CancellationToken)

Deletes API key of a kafka or schema registry cluster

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/apiKeys/{apiKeyId}
  • Operation Id: Organization_DeleteClusterAPIKey
  • Default Api Version: 2024-02-13
  • Resource: ConfluentOrganizationResource
Get(CancellationToken)

Get the properties of a specific Organization resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}
  • Operation Id: Organization_Get
  • Default Api Version: 2024-02-13
  • Resource: ConfluentOrganizationResource
GetAccessClusters(AccessListContent, CancellationToken)

Cluster details

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/access/default/listClusters
  • Operation Id: Access_ListClusters
  • Default Api Version: 2024-02-13
GetAccessClustersAsync(AccessListContent, CancellationToken)

Cluster details

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/access/default/listClusters
  • Operation Id: Access_ListClusters
  • Default Api Version: 2024-02-13
GetAccessEnvironments(AccessListContent, CancellationToken)

Environment list of an organization

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/access/default/listEnvironments
  • Operation Id: Access_ListEnvironments
  • Default Api Version: 2024-02-13
GetAccessEnvironmentsAsync(AccessListContent, CancellationToken)

Environment list of an organization

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/access/default/listEnvironments
  • Operation Id: Access_ListEnvironments
  • Default Api Version: 2024-02-13
GetAccessInvitations(AccessListContent, CancellationToken)

Organization accounts invitation details

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/access/default/listInvitations
  • Operation Id: Access_ListInvitations
  • Default Api Version: 2024-02-13
GetAccessInvitationsAsync(AccessListContent, CancellationToken)

Organization accounts invitation details

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/access/default/listInvitations
  • Operation Id: Access_ListInvitations
  • Default Api Version: 2024-02-13
GetAccessRoleBindingNames(AccessListContent, CancellationToken)

Organization role bindings

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/access/default/listRoleBindingNameList
  • Operation Id: Access_ListRoleBindingNameList
  • Default Api Version: 2024-02-13
GetAccessRoleBindingNamesAsync(AccessListContent, CancellationToken)

Organization role bindings

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/access/default/listRoleBindingNameList
  • Operation Id: Access_ListRoleBindingNameList
  • Default Api Version: 2024-02-13
GetAccessRoleBindings(AccessListContent, CancellationToken)

Organization role bindings

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/access/default/listRoleBindings
  • Operation Id: Access_ListRoleBindings
  • Default Api Version: 2024-02-13
GetAccessRoleBindingsAsync(AccessListContent, CancellationToken)

Organization role bindings

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/access/default/listRoleBindings
  • Operation Id: Access_ListRoleBindings
  • Default Api Version: 2024-02-13
GetAccessServiceAccounts(AccessListContent, CancellationToken)

Organization service accounts details

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/access/default/listServiceAccounts
  • Operation Id: Access_ListServiceAccounts
  • Default Api Version: 2024-02-13
GetAccessServiceAccountsAsync(AccessListContent, CancellationToken)

Organization service accounts details

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/access/default/listServiceAccounts
  • Operation Id: Access_ListServiceAccounts
  • Default Api Version: 2024-02-13
GetAccessUsers(AccessListContent, CancellationToken)

Organization users details

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/access/default/listUsers
  • Operation Id: Access_ListUsers
  • Default Api Version: 2024-02-13
GetAccessUsersAsync(AccessListContent, CancellationToken)

Organization users details

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/access/default/listUsers
  • Operation Id: Access_ListUsers
  • Default Api Version: 2024-02-13
GetAsync(CancellationToken)

Get the properties of a specific Organization resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}
  • Operation Id: Organization_Get
  • Default Api Version: 2024-02-13
  • Resource: ConfluentOrganizationResource
GetAvailableLocations(CancellationToken)

Lists all available geo-locations.

(Inherited from ArmResource)
GetAvailableLocationsAsync(CancellationToken)

Lists all available geo-locations.

(Inherited from ArmResource)
GetCluster(String, String, CancellationToken)

Get cluster by Id

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/environments/{environmentId}/clusters/{clusterId}
  • Operation Id: Organization_GetClusterById
  • Default Api Version: 2024-02-13
  • Resource: ConfluentOrganizationResource
GetClusterApiKey(String, CancellationToken)

Get API key details of a kafka or schema registry cluster

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/apiKeys/{apiKeyId}
  • Operation Id: Organization_GetClusterAPIKey
  • Default Api Version: 2024-02-13
  • Resource: ConfluentOrganizationResource
GetClusterApiKeyAsync(String, CancellationToken)

Get API key details of a kafka or schema registry cluster

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/apiKeys/{apiKeyId}
  • Operation Id: Organization_GetClusterAPIKey
  • Default Api Version: 2024-02-13
  • Resource: ConfluentOrganizationResource
GetClusterAsync(String, String, CancellationToken)

Get cluster by Id

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/environments/{environmentId}/clusters/{clusterId}
  • Operation Id: Organization_GetClusterById
  • Default Api Version: 2024-02-13
  • Resource: ConfluentOrganizationResource
GetClusters(String, Nullable<Int32>, String, CancellationToken)

Lists of all the clusters in a environment

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/environments/{environmentId}/clusters
  • Operation Id: Organization_ListClusters
  • Default Api Version: 2024-02-13
  • Resource: ConfluentOrganizationResource
GetClustersAsync(String, Nullable<Int32>, String, CancellationToken)

Lists of all the clusters in a environment

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/environments/{environmentId}/clusters
  • Operation Id: Organization_ListClusters
  • Default Api Version: 2024-02-13
  • Resource: ConfluentOrganizationResource
GetEnvironment(String, CancellationToken)

Get Environment details by environment Id

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/environments/{environmentId}
  • Operation Id: Organization_GetEnvironmentById
  • Default Api Version: 2024-02-13
  • Resource: ConfluentOrganizationResource
GetEnvironmentAsync(String, CancellationToken)

Get Environment details by environment Id

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/environments/{environmentId}
  • Operation Id: Organization_GetEnvironmentById
  • Default Api Version: 2024-02-13
  • Resource: ConfluentOrganizationResource
GetEnvironments(Nullable<Int32>, String, CancellationToken)

Lists of all the environments in a organization

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/environments
  • Operation Id: Organization_ListEnvironments
  • Default Api Version: 2024-02-13
  • Resource: ConfluentOrganizationResource
GetEnvironmentsAsync(Nullable<Int32>, String, CancellationToken)

Lists of all the environments in a organization

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/environments
  • Operation Id: Organization_ListEnvironments
  • Default Api Version: 2024-02-13
  • Resource: ConfluentOrganizationResource
GetManagementLock(String, CancellationToken)

Get a management lock by scope.

  • Request Path: /{scope}/providers/Microsoft.Authorization/locks/{lockName}
  • Operation Id: ManagementLocks_GetByScope
  • Default Api Version: 2020-05-01
  • Resource: ManagementLockResource
(Inherited from ArmResource)
GetManagementLockAsync(String, CancellationToken)

Get a management lock by scope.

  • Request Path: /{scope}/providers/Microsoft.Authorization/locks/{lockName}
  • Operation Id: ManagementLocks_GetByScope
  • Default Api Version: 2020-05-01
  • Resource: ManagementLockResource
(Inherited from ArmResource)
GetManagementLocks()

Gets a collection of ManagementLockResources in the ArmResource.

(Inherited from ArmResource)
GetPolicyAssignment(String, CancellationToken)

This operation retrieves a single policy assignment, given its name and the scope it was created at.

  • Request Path: /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}
  • Operation Id: PolicyAssignments_Get
  • Default Api Version: 2022-06-01
  • Resource: PolicyAssignmentResource
(Inherited from ArmResource)
GetPolicyAssignmentAsync(String, CancellationToken)

This operation retrieves a single policy assignment, given its name and the scope it was created at.

  • Request Path: /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}
  • Operation Id: PolicyAssignments_Get
  • Default Api Version: 2022-06-01
  • Resource: PolicyAssignmentResource
(Inherited from ArmResource)
GetPolicyAssignments()

Gets a collection of PolicyAssignmentResources in the ArmResource.

(Inherited from ArmResource)
GetRegions(AccessListContent, CancellationToken)

cloud provider regions available for creating Schema Registry clusters.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/listRegions
  • Operation Id: Organization_ListRegions
  • Default Api Version: 2024-02-13
  • Resource: ConfluentOrganizationResource
GetRegionsAsync(AccessListContent, CancellationToken)

cloud provider regions available for creating Schema Registry clusters.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/listRegions
  • Operation Id: Organization_ListRegions
  • Default Api Version: 2024-02-13
  • Resource: ConfluentOrganizationResource
GetSchemaRegistryCluster(String, String, CancellationToken)

Get schema registry cluster by Id

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/environments/{environmentId}/schemaRegistryClusters/{clusterId}
  • Operation Id: Organization_GetSchemaRegistryClusterById
  • Default Api Version: 2024-02-13
  • Resource: ConfluentOrganizationResource
GetSchemaRegistryClusterAsync(String, String, CancellationToken)

Get schema registry cluster by Id

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/environments/{environmentId}/schemaRegistryClusters/{clusterId}
  • Operation Id: Organization_GetSchemaRegistryClusterById
  • Default Api Version: 2024-02-13
  • Resource: ConfluentOrganizationResource
GetSchemaRegistryClusters(String, Nullable<Int32>, String, CancellationToken)

Get schema registry clusters

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/environments/{environmentId}/schemaRegistryClusters
  • Operation Id: Organization_ListSchemaRegistryClusters
  • Default Api Version: 2024-02-13
  • Resource: ConfluentOrganizationResource
GetSchemaRegistryClustersAsync(String, Nullable<Int32>, String, CancellationToken)

Get schema registry clusters

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/environments/{environmentId}/schemaRegistryClusters
  • Operation Id: Organization_ListSchemaRegistryClusters
  • Default Api Version: 2024-02-13
  • Resource: ConfluentOrganizationResource
GetTagResource()

Gets an object representing a TagResource along with the instance operations that can be performed on it in the ArmResource.

(Inherited from ArmResource)
InviteUser(AccessInvitationContent, CancellationToken)

Invite user to the organization

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/access/default/createInvitation
  • Operation Id: Access_InviteUser
  • Default Api Version: 2024-02-13
InviteUserAsync(AccessInvitationContent, CancellationToken)

Invite user to the organization

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}/access/default/createInvitation
  • Operation Id: Access_InviteUser
  • Default Api Version: 2024-02-13
RemoveTag(String, CancellationToken)

Removes a tag by key from the resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}
  • Operation Id: Organization_Get
  • Default Api Version: 2024-02-13
  • Resource: ConfluentOrganizationResource
RemoveTagAsync(String, CancellationToken)

Removes a tag by key from the resource.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}
  • Operation Id: Organization_Get
  • Default Api Version: 2024-02-13
  • Resource: ConfluentOrganizationResource
SetTags(IDictionary<String,String>, CancellationToken)

Replace the tags on the resource with the given set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}
  • Operation Id: Organization_Get
  • Default Api Version: 2024-02-13
  • Resource: ConfluentOrganizationResource
SetTagsAsync(IDictionary<String,String>, CancellationToken)

Replace the tags on the resource with the given set.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}
  • Operation Id: Organization_Get
  • Default Api Version: 2024-02-13
  • Resource: ConfluentOrganizationResource
TryGetApiVersion(ResourceType, String)

Gets the api version override if it has been set for the current client options.

(Inherited from ArmResource)
Update(ConfluentOrganizationPatch, CancellationToken)

Update Organization resource

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}
  • Operation Id: Organization_Update
  • Default Api Version: 2024-02-13
  • Resource: ConfluentOrganizationResource
UpdateAsync(ConfluentOrganizationPatch, CancellationToken)

Update Organization resource

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}
  • Operation Id: Organization_Update
  • Default Api Version: 2024-02-13
  • Resource: ConfluentOrganizationResource

Extension Methods

GetAuthorizationRoleDefinition(ArmResource, ResourceIdentifier, CancellationToken)

Get role definition by name (GUID).

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId}
  • Operation Id: RoleDefinitions_Get
  • Default Api Version: 2022-04-01
  • Resource: AuthorizationRoleDefinitionResource
GetAuthorizationRoleDefinitionAsync(ArmResource, ResourceIdentifier, CancellationToken)

Get role definition by name (GUID).

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId}
  • Operation Id: RoleDefinitions_Get
  • Default Api Version: 2022-04-01
  • Resource: AuthorizationRoleDefinitionResource
GetAuthorizationRoleDefinitions(ArmResource)

Gets a collection of AuthorizationRoleDefinitionResources in the ArmResource. MockingTo mock this method, please mock GetAuthorizationRoleDefinitions() instead.
GetDenyAssignment(ArmResource, String, CancellationToken)

Get the specified deny assignment.

  • Request Path: /{scope}/providers/Microsoft.Authorization/denyAssignments/{denyAssignmentId}
  • Operation Id: DenyAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: DenyAssignmentResource
GetDenyAssignmentAsync(ArmResource, String, CancellationToken)

Get the specified deny assignment.

  • Request Path: /{scope}/providers/Microsoft.Authorization/denyAssignments/{denyAssignmentId}
  • Operation Id: DenyAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: DenyAssignmentResource
GetDenyAssignments(ArmResource)

Gets a collection of DenyAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetDenyAssignments() instead.
GetRoleAssignment(ArmResource, String, String, CancellationToken)

Get a role assignment by scope and name.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}
  • Operation Id: RoleAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: RoleAssignmentResource
GetRoleAssignmentAsync(ArmResource, String, String, CancellationToken)

Get a role assignment by scope and name.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}
  • Operation Id: RoleAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: RoleAssignmentResource
GetRoleAssignments(ArmResource)

Gets a collection of RoleAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignments() instead.
GetRoleAssignmentSchedule(ArmResource, String, CancellationToken)

Get the specified role assignment schedule for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentSchedules/{roleAssignmentScheduleName}
  • Operation Id: RoleAssignmentSchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleResource
GetRoleAssignmentScheduleAsync(ArmResource, String, CancellationToken)

Get the specified role assignment schedule for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentSchedules/{roleAssignmentScheduleName}
  • Operation Id: RoleAssignmentSchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleResource
GetRoleAssignmentScheduleInstance(ArmResource, String, CancellationToken)

Gets the specified role assignment schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleInstances/{roleAssignmentScheduleInstanceName}
  • Operation Id: RoleAssignmentScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleInstanceResource
GetRoleAssignmentScheduleInstanceAsync(ArmResource, String, CancellationToken)

Gets the specified role assignment schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleInstances/{roleAssignmentScheduleInstanceName}
  • Operation Id: RoleAssignmentScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleInstanceResource
GetRoleAssignmentScheduleInstances(ArmResource)

Gets a collection of RoleAssignmentScheduleInstanceResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentScheduleInstances() instead.
GetRoleAssignmentScheduleRequest(ArmResource, String, CancellationToken)

Get the specified role assignment schedule request.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleRequests/{roleAssignmentScheduleRequestName}
  • Operation Id: RoleAssignmentScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleRequestResource
GetRoleAssignmentScheduleRequestAsync(ArmResource, String, CancellationToken)

Get the specified role assignment schedule request.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleRequests/{roleAssignmentScheduleRequestName}
  • Operation Id: RoleAssignmentScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleRequestResource
GetRoleAssignmentScheduleRequests(ArmResource)

Gets a collection of RoleAssignmentScheduleRequestResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentScheduleRequests() instead.
GetRoleAssignmentSchedules(ArmResource)

Gets a collection of RoleAssignmentScheduleResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentSchedules() instead.
GetRoleEligibilitySchedule(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilitySchedules/{roleEligibilityScheduleName}
  • Operation Id: RoleEligibilitySchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleResource
GetRoleEligibilityScheduleAsync(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilitySchedules/{roleEligibilityScheduleName}
  • Operation Id: RoleEligibilitySchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleResource
GetRoleEligibilityScheduleInstance(ArmResource, String, CancellationToken)

Gets the specified role eligibility schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleInstances/{roleEligibilityScheduleInstanceName}
  • Operation Id: RoleEligibilityScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleInstanceResource
GetRoleEligibilityScheduleInstanceAsync(ArmResource, String, CancellationToken)

Gets the specified role eligibility schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleInstances/{roleEligibilityScheduleInstanceName}
  • Operation Id: RoleEligibilityScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleInstanceResource
GetRoleEligibilityScheduleInstances(ArmResource)

Gets a collection of RoleEligibilityScheduleInstanceResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilityScheduleInstances() instead.
GetRoleEligibilityScheduleRequest(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule request.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleRequests/{roleEligibilityScheduleRequestName}
  • Operation Id: RoleEligibilityScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleRequestResource
GetRoleEligibilityScheduleRequestAsync(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule request.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleRequests/{roleEligibilityScheduleRequestName}
  • Operation Id: RoleEligibilityScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleRequestResource
GetRoleEligibilityScheduleRequests(ArmResource)

Gets a collection of RoleEligibilityScheduleRequestResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilityScheduleRequests() instead.
GetRoleEligibilitySchedules(ArmResource)

Gets a collection of RoleEligibilityScheduleResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilitySchedules() instead.
GetRoleManagementPolicies(ArmResource)

Gets a collection of RoleManagementPolicyResources in the ArmResource. MockingTo mock this method, please mock GetRoleManagementPolicies() instead.
GetRoleManagementPolicy(ArmResource, String, CancellationToken)

Get the specified role management policy for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicies/{roleManagementPolicyName}
  • Operation Id: RoleManagementPolicies_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyResource
GetRoleManagementPolicyAssignment(ArmResource, String, CancellationToken)

Get the specified role management policy assignment for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicyAssignments/{roleManagementPolicyAssignmentName}
  • Operation Id: RoleManagementPolicyAssignments_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyAssignmentResource
GetRoleManagementPolicyAssignmentAsync(ArmResource, String, CancellationToken)

Get the specified role management policy assignment for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicyAssignments/{roleManagementPolicyAssignmentName}
  • Operation Id: RoleManagementPolicyAssignments_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyAssignmentResource
GetRoleManagementPolicyAssignments(ArmResource)

Gets a collection of RoleManagementPolicyAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetRoleManagementPolicyAssignments() instead.
GetRoleManagementPolicyAsync(ArmResource, String, CancellationToken)

Get the specified role management policy for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicies/{roleManagementPolicyName}
  • Operation Id: RoleManagementPolicies_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyResource
GetSystemAssignedIdentity(ArmResource)

Gets an object representing a SystemAssignedIdentityResource along with the instance operations that can be performed on it in the ArmResource. MockingTo mock this method, please mock GetSystemAssignedIdentity() instead.
GetLinkerResource(ArmResource, String, CancellationToken)

Returns Linker resource for a given name.

  • Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}
  • Operation Id: Linker_Get
GetLinkerResourceAsync(ArmResource, String, CancellationToken)

Returns Linker resource for a given name.

  • Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}
  • Operation Id: Linker_Get
GetLinkerResources(ArmResource)

Gets a collection of LinkerResources in the ArmResource. MockingTo mock this method, please mock GetLinkerResources() instead.

Applies to