Share via


PortalConfigContractCollection Class

Definition

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

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

Constructors

PortalConfigContractCollection()

Initializes a new instance of the PortalConfigContractCollection 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, ETag, PortalConfigContractData, CancellationToken)

Create or update the developer portal configuration.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalconfigs/{portalConfigId}
  • Operation Id: PortalConfig_CreateOrUpdate
  • Default Api Version: 2023-03-01-preview
  • Resource: PortalConfigContractResource
CreateOrUpdateAsync(WaitUntil, String, ETag, PortalConfigContractData, CancellationToken)

Create or update the developer portal configuration.

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

Checks to see if the resource exists in azure.

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

Checks to see if the resource exists in azure.

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

Get the developer portal configuration.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalconfigs/{portalConfigId}
  • Operation Id: PortalConfig_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: PortalConfigContractResource
GetAll(CancellationToken)

Lists the developer portal configurations.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalconfigs
  • Operation Id: PortalConfig_ListByService
  • Default Api Version: 2023-03-01-preview
  • Resource: PortalConfigContractResource
GetAllAsync(CancellationToken)

Lists the developer portal configurations.

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

Get the developer portal configuration.

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

Tries to get details for this resource from the service.

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

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalconfigs/{portalConfigId}
  • Operation Id: PortalConfig_Get
  • Default Api Version: 2023-03-01-preview
  • Resource: PortalConfigContractResource
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<PortalConfigContractResource>.GetAsyncEnumerator(CancellationToken)

Returns an enumerator that iterates asynchronously through the collection.

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

IEnumerable<PortalConfigContractResource>.GetEnumerator()

Returns an enumerator that iterates through the collection.

Applies to