CognitiveServicesAccountResource Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
A Class representing a CognitiveServicesAccount along with the instance operations that can be performed on it. If you have a ResourceIdentifier you can construct a CognitiveServicesAccountResource from an instance of ArmClient using the GetCognitiveServicesAccountResource method. Otherwise you can get one from its parent resource ResourceGroupResource using the GetCognitiveServicesAccount method.
public class CognitiveServicesAccountResource : Azure.ResourceManager.ArmResource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.CognitiveServices.CognitiveServicesAccountData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.CognitiveServices.CognitiveServicesAccountData>
type CognitiveServicesAccountResource = class
inherit ArmResource
interface IJsonModel<CognitiveServicesAccountData>
interface IPersistableModel<CognitiveServicesAccountData>
Public Class CognitiveServicesAccountResource
Inherits ArmResource
Implements IJsonModel(Of CognitiveServicesAccountData), IPersistableModel(Of CognitiveServicesAccountData)
- Inheritance
- Implements
Constructors
CognitiveServicesAccountResource() |
Initializes a new instance of the CognitiveServicesAccountResource 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.
|
AddTagAsync(String, String, CancellationToken) |
Add a tag to the current resource.
|
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) |
CreateResourceIdentifier(String, String, String) |
Generate the resource identifier of a CognitiveServicesAccountResource instance. |
Delete(WaitUntil, CancellationToken) |
Deletes a Cognitive Services account from the resource group.
|
DeleteAsync(WaitUntil, CancellationToken) |
Deletes a Cognitive Services account from the resource group.
|
Get(CancellationToken) |
Returns a Cognitive Services account specified by the parameters.
|
GetAsync(CancellationToken) |
Returns a Cognitive Services account specified by the parameters.
|
GetAvailableLocations(CancellationToken) |
Lists all available geo-locations. (Inherited from ArmResource) |
GetAvailableLocationsAsync(CancellationToken) |
Lists all available geo-locations. (Inherited from ArmResource) |
GetCognitiveServicesAccountDeployment(String, CancellationToken) |
Gets the specified deployments associated with the Cognitive Services account.
|
GetCognitiveServicesAccountDeploymentAsync(String, CancellationToken) |
Gets the specified deployments associated with the Cognitive Services account.
|
GetCognitiveServicesAccountDeployments() |
Gets a collection of CognitiveServicesAccountDeploymentResources in the CognitiveServicesAccount. |
GetCognitiveServicesEncryptionScope(String, CancellationToken) |
Gets the specified EncryptionScope associated with the Cognitive Services account.
|
GetCognitiveServicesEncryptionScopeAsync(String, CancellationToken) |
Gets the specified EncryptionScope associated with the Cognitive Services account.
|
GetCognitiveServicesEncryptionScopes() |
Gets a collection of CognitiveServicesEncryptionScopeResources in the CognitiveServicesAccount. |
GetCognitiveServicesPrivateEndpointConnection(String, CancellationToken) |
Gets the specified private endpoint connection associated with the Cognitive Services account.
|
GetCognitiveServicesPrivateEndpointConnectionAsync(String, CancellationToken) |
Gets the specified private endpoint connection associated with the Cognitive Services account.
|
GetCognitiveServicesPrivateEndpointConnections() |
Gets a collection of CognitiveServicesPrivateEndpointConnectionResources in the CognitiveServicesAccount. |
GetCommitmentPlan(String, CancellationToken) |
Gets the specified commitmentPlans associated with the Cognitive Services account.
|
GetCommitmentPlanAsync(String, CancellationToken) |
Gets the specified commitmentPlans associated with the Cognitive Services account.
|
GetCommitmentPlans() |
Gets a collection of CommitmentPlanResources in the CognitiveServicesAccount. |
GetDefenderForAISetting(String, CancellationToken) |
Gets the specified Defender for AI setting by name.
|
GetDefenderForAISettingAsync(String, CancellationToken) |
Gets the specified Defender for AI setting by name.
|
GetDefenderForAISettings() |
Gets a collection of DefenderForAISettingResources in the CognitiveServicesAccount. |
GetKeys(CancellationToken) |
Lists the account keys for the specified Cognitive Services account.
|
GetKeysAsync(CancellationToken) |
Lists the account keys for the specified Cognitive Services account.
|
GetManagementLock(String, CancellationToken) |
Get a management lock by scope.
|
GetManagementLockAsync(String, CancellationToken) |
Get a management lock by scope.
|
GetManagementLocks() |
Gets a collection of ManagementLockResources in the ArmResource. (Inherited from ArmResource) |
GetModels(CancellationToken) |
List available Models for the requested Cognitive Services account
|
GetModelsAsync(CancellationToken) |
List available Models for the requested Cognitive Services account
|
GetNetworkSecurityPerimeterConfiguration(String, CancellationToken) |
Gets the specified NSP configurations for an account.
|
GetNetworkSecurityPerimeterConfigurationAsync(String, CancellationToken) |
Gets the specified NSP configurations for an account.
|
GetNetworkSecurityPerimeterConfigurations() |
Gets a collection of NetworkSecurityPerimeterConfigurationResources in the CognitiveServicesAccount. |
GetPolicyAssignment(String, CancellationToken) |
This operation retrieves a single policy assignment, given its name and the scope it was created at.
|
GetPolicyAssignmentAsync(String, CancellationToken) |
This operation retrieves a single policy assignment, given its name and the scope it was created at.
|
GetPolicyAssignments() |
Gets a collection of PolicyAssignmentResources in the ArmResource. (Inherited from ArmResource) |
GetPrivateLinkResources(CancellationToken) |
Gets the private link resources that need to be created for a Cognitive Services account.
|
GetPrivateLinkResourcesAsync(CancellationToken) |
Gets the private link resources that need to be created for a Cognitive Services account.
|
GetRaiBlocklist(String, CancellationToken) |
Gets the specified custom blocklist associated with the Azure OpenAI account.
|
GetRaiBlocklistAsync(String, CancellationToken) |
Gets the specified custom blocklist associated with the Azure OpenAI account.
|
GetRaiBlocklists() |
Gets a collection of RaiBlocklistResources in the CognitiveServicesAccount. |
GetRaiPolicies() |
Gets a collection of RaiPolicyResources in the CognitiveServicesAccount. |
GetRaiPolicy(String, CancellationToken) |
Gets the specified Content Filters associated with the Azure OpenAI account.
|
GetRaiPolicyAsync(String, CancellationToken) |
Gets the specified Content Filters associated with the Azure OpenAI account.
|
GetSkus(CancellationToken) |
List available SKUs for the requested Cognitive Services account
|
GetSkusAsync(CancellationToken) |
List available SKUs for the requested Cognitive Services account
|
GetTagResource() |
Gets an object representing a TagResource along with the instance operations that can be performed on it in the ArmResource. (Inherited from ArmResource) |
GetUsages(String, CancellationToken) |
Get usages for the requested Cognitive Services account
|
GetUsagesAsync(String, CancellationToken) |
Get usages for the requested Cognitive Services account
|
RegenerateKey(RegenerateServiceAccountKeyContent, CancellationToken) |
Regenerates the specified account key for the specified Cognitive Services account.
|
RegenerateKeyAsync(RegenerateServiceAccountKeyContent, CancellationToken) |
Regenerates the specified account key for the specified Cognitive Services account.
|
RemoveTag(String, CancellationToken) |
Removes a tag by key from the resource.
|
RemoveTagAsync(String, CancellationToken) |
Removes a tag by key from the resource.
|
SetTags(IDictionary<String,String>, CancellationToken) |
Replace the tags on the resource with the given set.
|
SetTagsAsync(IDictionary<String,String>, CancellationToken) |
Replace the tags on the resource with the given set.
|
TryGetApiVersion(ResourceType, String) |
Gets the api version override if it has been set for the current client options. (Inherited from ArmResource) |
Update(WaitUntil, CognitiveServicesAccountData, CancellationToken) |
Updates a Cognitive Services account
|
UpdateAsync(WaitUntil, CognitiveServicesAccountData, CancellationToken) |
Updates a Cognitive Services account
|
Explicit Interface Implementations
IJsonModel<CognitiveServicesAccountData>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
IJsonModel<CognitiveServicesAccountData>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
IPersistableModel<CognitiveServicesAccountData>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
IPersistableModel<CognitiveServicesAccountData>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
IPersistableModel<CognitiveServicesAccountData>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |
Extension Methods
GetAuthorizationRoleDefinition(ArmResource, ResourceIdentifier, CancellationToken) |
Get role definition by name (GUID).
|
GetAuthorizationRoleDefinitionAsync(ArmResource, ResourceIdentifier, CancellationToken) |
Get role definition by name (GUID).
|
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.
|
GetDenyAssignmentAsync(ArmResource, String, CancellationToken) |
Get the specified deny assignment.
|
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.
|
GetRoleAssignmentAsync(ArmResource, String, String, CancellationToken) |
Get a role assignment by scope and name.
|
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
|
GetRoleAssignmentScheduleAsync(ArmResource, String, CancellationToken) |
Get the specified role assignment schedule for a resource scope
|
GetRoleAssignmentScheduleInstance(ArmResource, String, CancellationToken) |
Gets the specified role assignment schedule instance.
|
GetRoleAssignmentScheduleInstanceAsync(ArmResource, String, CancellationToken) |
Gets the specified role assignment schedule instance.
|
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.
|
GetRoleAssignmentScheduleRequestAsync(ArmResource, String, CancellationToken) |
Get the specified role assignment schedule request.
|
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
|
GetRoleEligibilityScheduleAsync(ArmResource, String, CancellationToken) |
Get the specified role eligibility schedule for a resource scope
|
GetRoleEligibilityScheduleInstance(ArmResource, String, CancellationToken) |
Gets the specified role eligibility schedule instance.
|
GetRoleEligibilityScheduleInstanceAsync(ArmResource, String, CancellationToken) |
Gets the specified role eligibility schedule instance.
|
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.
|
GetRoleEligibilityScheduleRequestAsync(ArmResource, String, CancellationToken) |
Get the specified role eligibility schedule request.
|
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
|
GetRoleManagementPolicyAssignment(ArmResource, String, CancellationToken) |
Get the specified role management policy assignment for a resource scope
|
GetRoleManagementPolicyAssignmentAsync(ArmResource, String, CancellationToken) |
Get the specified role management policy assignment for a resource scope
|
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
|
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.
|
GetLinkerResourceAsync(ArmResource, String, CancellationToken) |
Returns Linker resource for a given name.
|
GetLinkerResources(ArmResource) |
Gets a collection of LinkerResources in the ArmResource. MockingTo mock this method, please mock GetLinkerResources() instead. |