ApiResource 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 an Api along with the instance operations that can be performed on it. If you have a ResourceIdentifier you can construct an ApiResource from an instance of ArmClient using the GetApiResource method. Otherwise you can get one from its parent resource ApiManagementServiceResource using the GetApi method.
public class ApiResource : Azure.ResourceManager.ArmResource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.ApiManagement.ApiData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.ApiManagement.ApiData>type ApiResource = class
inherit ArmResource
interface IJsonModel<ApiData>
interface IPersistableModel<ApiData>Public Class ApiResource
Inherits ArmResource
Implements IJsonModel(Of ApiData), IPersistableModel(Of ApiData)- Inheritance
- Implements
Constructors
| Name | Description |
|---|---|
| ApiResource() |
Initializes a new instance of the ApiResource class for mocking. |
Fields
| Name | Description |
|---|---|
| ResourceType |
Gets the resource type for the operations. |
Properties
| Name | Description |
|---|---|
| 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
| Name | Description |
|---|---|
| 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, String) |
Generate the resource identifier of a ApiResource instance. |
| Delete(WaitUntil, ETag, Nullable<Boolean>, CancellationToken) |
Deletes the specified API of the API Management service instance.
|
| DeleteAsync(WaitUntil, ETag, Nullable<Boolean>, CancellationToken) |
Deletes the specified API of the API Management service instance.
|
| Get(CancellationToken) |
Gets the details of the API specified by its identifier.
|
| GetApiDiagnostic(String, CancellationToken) |
Gets the details of the Diagnostic for an API specified by its identifier.
|
| GetApiDiagnosticAsync(String, CancellationToken) |
Gets the details of the Diagnostic for an API specified by its identifier.
|
| GetApiDiagnostics() |
Gets a collection of ApiDiagnosticResources in the Api. |
| GetApiIssue(String, Nullable<Boolean>, CancellationToken) |
Gets the details of the Issue for an API specified by its identifier.
|
| GetApiIssueAsync(String, Nullable<Boolean>, CancellationToken) |
Gets the details of the Issue for an API specified by its identifier.
|
| GetApiIssues() |
Gets a collection of ApiIssueResources in the Api. |
| GetApiOperation(String, CancellationToken) |
Gets the details of the API Operation specified by its identifier.
|
| GetApiOperationAsync(String, CancellationToken) |
Gets the details of the API Operation specified by its identifier.
|
| GetApiOperations() |
Gets a collection of ApiOperationResources in the Api. |
| GetApiPolicies() |
Gets a collection of ApiPolicyResources in the Api. |
| GetApiPolicy(PolicyName, Nullable<PolicyExportFormat>, CancellationToken) |
Get the policy configuration at the API level.
|
| GetApiPolicyAsync(PolicyName, Nullable<PolicyExportFormat>, CancellationToken) |
Get the policy configuration at the API level.
|
| GetApiProducts(String, Nullable<Int32>, Nullable<Int32>, CancellationToken) |
Lists all Products, which the API is part of.
|
| GetApiProductsAsync(String, Nullable<Int32>, Nullable<Int32>, CancellationToken) |
Lists all Products, which the API is part of.
|
| GetApiRelease(String, CancellationToken) |
Returns the details of an API release.
|
| GetApiReleaseAsync(String, CancellationToken) |
Returns the details of an API release.
|
| GetApiReleases() |
Gets a collection of ApiReleaseResources in the Api. |
| GetApiRevisionsByService(String, Nullable<Int32>, Nullable<Int32>, CancellationToken) |
Lists all revisions of an API.
|
| GetApiRevisionsByServiceAsync(String, Nullable<Int32>, Nullable<Int32>, CancellationToken) |
Lists all revisions of an API.
|
| GetApiSchema(String, CancellationToken) |
Get the schema configuration at the API level.
|
| GetApiSchemaAsync(String, CancellationToken) |
Get the schema configuration at the API level.
|
| GetApiSchemas() |
Gets a collection of ApiSchemaResources in the Api. |
| GetApiTag(String, CancellationToken) |
Get tag associated with the API.
|
| GetApiTagAsync(String, CancellationToken) |
Get tag associated with the API.
|
| GetApiTagDescription(String, CancellationToken) |
Get Tag description in scope of API
|
| GetApiTagDescriptionAsync(String, CancellationToken) |
Get Tag description in scope of API
|
| GetApiTagDescriptions() |
Gets a collection of ApiTagDescriptionResources in the Api. |
| GetApiTags() |
Gets a collection of ApiTagResources in the Api. |
| GetAsync(CancellationToken) |
Gets the details of the API specified by its identifier.
|
| GetAvailableLocations(CancellationToken) |
Lists all available geo-locations. (Inherited from ArmResource) |
| GetAvailableLocationsAsync(CancellationToken) |
Lists all available geo-locations. (Inherited from ArmResource) |
| GetEntityTag(CancellationToken) |
Gets the entity state (Etag) version of the API specified by its identifier.
|
| GetEntityTagAsync(CancellationToken) |
Gets the entity state (Etag) version of the API specified by its identifier.
|
| 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) |
| GetOperationsByTags(String, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, CancellationToken) |
Lists a collection of operations associated with tags.
|
| GetOperationsByTagsAsync(String, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, CancellationToken) |
Lists a collection of operations associated with tags.
|
| 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) |
| GetResolverContract(String, CancellationToken) |
Gets the details of the GraphQL API Resolver specified by its identifier.
|
| GetResolverContractAsync(String, CancellationToken) |
Gets the details of the GraphQL API Resolver specified by its identifier.
|
| GetResolverContracts() |
Gets a collection of ResolverContractResources in the Api. |
| GetServiceApiWiki() |
Gets an object representing a ServiceApiWikiResource along with the instance operations that can be performed on it in the Api. |
| GetTagResource() |
Gets an object representing a TagResource along with the instance operations that can be performed on it in the ArmResource. (Inherited from ArmResource) |
| TryGetApiVersion(ResourceType, String) |
Gets the api version override if it has been set for the current client options. (Inherited from ArmResource) |
| Update(ETag, ApiPatch, CancellationToken) |
Updates the specified API of the API Management service instance.
|
| UpdateAsync(ETag, ApiPatch, CancellationToken) |
Updates the specified API of the API Management service instance.
|
Explicit Interface Implementations
| Name | Description |
|---|---|
| IJsonModel<ApiData>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
| IJsonModel<ApiData>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
| IPersistableModel<ApiData>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
| IPersistableModel<ApiData>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
| IPersistableModel<ApiData>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |
