Condividi tramite


DocumentationContractCollection Class

Definition

A class representing a collection of DocumentationContractResource and their operations. Each DocumentationContractResource in the collection will belong to the same instance of ApiManagementServiceResource. To get a DocumentationContractCollection instance call the GetDocumentationContracts method from an instance of ApiManagementServiceResource.

public class DocumentationContractCollection : Azure.ResourceManager.ArmCollection, System.Collections.Generic.IAsyncEnumerable<Azure.ResourceManager.ApiManagement.DocumentationContractResource>, System.Collections.Generic.IEnumerable<Azure.ResourceManager.ApiManagement.DocumentationContractResource>
type DocumentationContractCollection = class
    inherit ArmCollection
    interface seq<DocumentationContractResource>
    interface IEnumerable
    interface IAsyncEnumerable<DocumentationContractResource>
Public Class DocumentationContractCollection
Inherits ArmCollection
Implements IAsyncEnumerable(Of DocumentationContractResource), IEnumerable(Of DocumentationContractResource)
Inheritance
DocumentationContractCollection
Implements

Constructors

DocumentationContractCollection()

Initializes a new instance of the DocumentationContractCollection class for mocking.

Properties

Client

Gets the ArmClient this resource client was created from.

(Inherited from ArmCollection)
Diagnostics

Gets the diagnostic options for this resource client.

(Inherited from ArmCollection)
Endpoint

Gets the base uri for this resource client.

(Inherited from ArmCollection)
Id

Gets the resource identifier.

(Inherited from ArmCollection)
Pipeline

Gets the pipeline for this resource client.

(Inherited from ArmCollection)

Methods

CreateOrUpdate(WaitUntil, String, DocumentationContractData, Nullable<ETag>, CancellationToken)

Creates a new Documentation or updates an existing one.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/documentations/{documentationId}
  • Operation Id: Documentation_CreateOrUpdate
  • Default Api Version: 2023-03-01-preview
  • Resource: DocumentationContractResource
CreateOrUpdateAsync(WaitUntil, String, DocumentationContractData, Nullable<ETag>, CancellationToken)

Creates a new Documentation or updates an existing one.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/documentations/{documentationId}
  • Operation Id: Documentation_CreateOrUpdate
  • Default Api Version: 2023-03-01-preview
  • Resource: DocumentationContractResource
Exists(String, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/documentations/{documentationId}
  • Operation Id: Documentation_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: DocumentationContractResource
ExistsAsync(String, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/documentations/{documentationId}
  • Operation Id: Documentation_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: DocumentationContractResource
Get(String, CancellationToken)

Gets the details of the Documentation specified by its identifier.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/documentations/{documentationId}
  • Operation Id: Documentation_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: DocumentationContractResource
GetAll(String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

Lists all Documentations of the API Management service instance.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/documentations
  • Operation Id: Documentation_ListByService
  • Default Api Version: 2023-03-01-preview
  • Resource: DocumentationContractResource
GetAllAsync(String, Nullable<Int32>, Nullable<Int32>, CancellationToken)

Lists all Documentations of the API Management service instance.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/documentations
  • Operation Id: Documentation_ListByService
  • Default Api Version: 2023-03-01-preview
  • Resource: DocumentationContractResource
GetAsync(String, CancellationToken)

Gets the details of the Documentation specified by its identifier.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/documentations/{documentationId}
  • Operation Id: Documentation_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: DocumentationContractResource
GetIfExists(String, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/documentations/{documentationId}
  • Operation Id: Documentation_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: DocumentationContractResource
GetIfExistsAsync(String, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/documentations/{documentationId}
  • Operation Id: Documentation_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: DocumentationContractResource
TryGetApiVersion(ResourceType, String)

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

(Inherited from ArmCollection)

Explicit Interface Implementations

IAsyncEnumerable<DocumentationContractResource>.GetAsyncEnumerator(CancellationToken)

Returns an enumerator that iterates asynchronously through the collection.

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

IEnumerable<DocumentationContractResource>.GetEnumerator()

Returns an enumerator that iterates through the collection.

Applies to