Share via


NginxDeploymentApiKeyCollection Class

Definition

A class representing a collection of NginxDeploymentApiKeyResource and their operations. Each NginxDeploymentApiKeyResource in the collection will belong to the same instance of NginxDeploymentResource. To get a NginxDeploymentApiKeyCollection instance call the GetNginxDeploymentApiKeys method from an instance of NginxDeploymentResource.

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

Constructors

NginxDeploymentApiKeyCollection()

Initializes a new instance of the NginxDeploymentApiKeyCollection 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, NginxDeploymentApiKeyCreateOrUpdateContent, CancellationToken)

Create or update an API Key for the Nginx deployment in order to access the dataplane API endpoint

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Nginx.NginxPlus/nginxDeployments/{deploymentName}/apiKeys/{apiKeyName}
  • Operation Id: ApiKeys_CreateOrUpdate
  • Default Api Version: 2024-11-01-preview
  • Resource: NginxDeploymentApiKeyResource
CreateOrUpdateAsync(WaitUntil, String, NginxDeploymentApiKeyCreateOrUpdateContent, CancellationToken)

Create or update an API Key for the Nginx deployment in order to access the dataplane API endpoint

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Nginx.NginxPlus/nginxDeployments/{deploymentName}/apiKeys/{apiKeyName}
  • Operation Id: ApiKeys_CreateOrUpdate
  • Default Api Version: 2024-11-01-preview
  • Resource: NginxDeploymentApiKeyResource
Exists(String, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Nginx.NginxPlus/nginxDeployments/{deploymentName}/apiKeys/{apiKeyName}
  • Operation Id: ApiKeys_Get
  • Default Api Version: 2024-11-01-preview
  • Resource: NginxDeploymentApiKeyResource
ExistsAsync(String, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Nginx.NginxPlus/nginxDeployments/{deploymentName}/apiKeys/{apiKeyName}
  • Operation Id: ApiKeys_Get
  • Default Api Version: 2024-11-01-preview
  • Resource: NginxDeploymentApiKeyResource
Get(String, CancellationToken)

Get the specified API Key of the given Nginx deployment

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Nginx.NginxPlus/nginxDeployments/{deploymentName}/apiKeys/{apiKeyName}
  • Operation Id: ApiKeys_Get
  • Default Api Version: 2024-11-01-preview
  • Resource: NginxDeploymentApiKeyResource
GetAll(CancellationToken)

List all API Keys of the given Nginx deployment

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Nginx.NginxPlus/nginxDeployments/{deploymentName}/apiKeys
  • Operation Id: ApiKeys_List
  • Default Api Version: 2024-11-01-preview
  • Resource: NginxDeploymentApiKeyResource
GetAllAsync(CancellationToken)

List all API Keys of the given Nginx deployment

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Nginx.NginxPlus/nginxDeployments/{deploymentName}/apiKeys
  • Operation Id: ApiKeys_List
  • Default Api Version: 2024-11-01-preview
  • Resource: NginxDeploymentApiKeyResource
GetAsync(String, CancellationToken)

Get the specified API Key of the given Nginx deployment

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Nginx.NginxPlus/nginxDeployments/{deploymentName}/apiKeys/{apiKeyName}
  • Operation Id: ApiKeys_Get
  • Default Api Version: 2024-11-01-preview
  • Resource: NginxDeploymentApiKeyResource
GetIfExists(String, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Nginx.NginxPlus/nginxDeployments/{deploymentName}/apiKeys/{apiKeyName}
  • Operation Id: ApiKeys_Get
  • Default Api Version: 2024-11-01-preview
  • Resource: NginxDeploymentApiKeyResource
GetIfExistsAsync(String, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Nginx.NginxPlus/nginxDeployments/{deploymentName}/apiKeys/{apiKeyName}
  • Operation Id: ApiKeys_Get
  • Default Api Version: 2024-11-01-preview
  • Resource: NginxDeploymentApiKeyResource
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<NginxDeploymentApiKeyResource>.GetAsyncEnumerator(CancellationToken)

Returns an enumerator that iterates asynchronously through the collection.

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

IEnumerable<NginxDeploymentApiKeyResource>.GetEnumerator()

Returns an enumerator that iterates through the collection.

Applies to