Package version:

Interface ManagedInstanceKeys

Interface representing a ManagedInstanceKeys.

Hierarchy

ManagedInstanceKeys

Index

Methods

beginCreateOrUpdate beginCreateOrUpdateAndWait beginDelete beginDeleteAndWait get listByInstance

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, managedInstanceName: string, keyName: string, parameters: ManagedInstanceKey, options?: ManagedInstanceKeysCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ManagedInstanceKey>, ManagedInstanceKey>>
Creates or updates a managed instance key.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- managedInstanceName: string
  
  The name of the managed instance.
- keyName: string
  
  The name of the managed instance key to be operated on (updated or created).
- parameters: ManagedInstanceKey
  
  The requested managed instance key resource state.
- Optional options: ManagedInstanceKeysCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<ManagedInstanceKey>, ManagedInstanceKey>>
- Defined in operationsInterfaces/managedInstanceKeys.ts:59

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, managedInstanceName: string, keyName: string, parameters: ManagedInstanceKey, options?: ManagedInstanceKeysCreateOrUpdateOptionalParams): Promise<ManagedInstanceKey>
Creates or updates a managed instance key.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- managedInstanceName: string
  
  The name of the managed instance.
- keyName: string
  
  The name of the managed instance key to be operated on (updated or created).
- parameters: ManagedInstanceKey
  
  The requested managed instance key resource state.
- Optional options: ManagedInstanceKeysCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<ManagedInstanceKey>
- Defined in operationsInterfaces/managedInstanceKeys.ts:80

beginDelete

beginDelete(resourceGroupName: string, managedInstanceName: string, keyName: string, options?: ManagedInstanceKeysDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
Deletes the managed instance key with the given name.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- managedInstanceName: string
  
  The name of the managed instance.
- keyName: string
  
  The name of the managed instance key to be deleted.
- Optional options: ManagedInstanceKeysDeleteOptionalParams
  
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<void>, void>>
- Defined in operationsInterfaces/managedInstanceKeys.ts:95

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, managedInstanceName: string, keyName: string, options?: ManagedInstanceKeysDeleteOptionalParams): Promise<void>
Deletes the managed instance key with the given name.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- managedInstanceName: string
  
  The name of the managed instance.
- keyName: string
  
  The name of the managed instance key to be deleted.
- Optional options: ManagedInstanceKeysDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/managedInstanceKeys.ts:109

get

get(resourceGroupName: string, managedInstanceName: string, keyName: string, options?: ManagedInstanceKeysGetOptionalParams): Promise<ManagedInstanceKey>
Gets a managed instance key.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- managedInstanceName: string
  
  The name of the managed instance.
- keyName: string
  
  The name of the managed instance key to be retrieved.
- Optional options: ManagedInstanceKeysGetOptionalParams
  
  The options parameters.
Returns Promise<ManagedInstanceKey>
- Defined in operationsInterfaces/managedInstanceKeys.ts:44

listByInstance

listByInstance(resourceGroupName: string, managedInstanceName: string, options?: ManagedInstanceKeysListByInstanceOptionalParams): PagedAsyncIterableIterator<ManagedInstanceKey>
Gets a list of managed instance keys.
Parameters
- resourceGroupName: string
  
  The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
- managedInstanceName: string
  
  The name of the managed instance.
- Optional options: ManagedInstanceKeysListByInstanceOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<ManagedInstanceKey>
- Defined in operationsInterfaces/managedInstanceKeys.ts:31

Interface ManagedInstanceKeys

Hierarchy

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

managedInstanceName: string

keyName: string

parameters: ManagedInstanceKey

Optional options: ManagedInstanceKeysCreateOrUpdateOptionalParams

Returns Promise<SimplePollerLike<OperationState<ManagedInstanceKey>, ManagedInstanceKey>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

managedInstanceName: string

keyName: string

parameters: ManagedInstanceKey

Optional options: ManagedInstanceKeysCreateOrUpdateOptionalParams

Returns Promise<ManagedInstanceKey>

beginDelete

Parameters

resourceGroupName: string

managedInstanceName: string

keyName: string

Optional options: ManagedInstanceKeysDeleteOptionalParams

Returns Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Parameters

resourceGroupName: string

managedInstanceName: string

keyName: string

Optional options: ManagedInstanceKeysDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

managedInstanceName: string

keyName: string

Optional options: ManagedInstanceKeysGetOptionalParams

Returns Promise<ManagedInstanceKey>

listByInstance

Parameters

resourceGroupName: string

managedInstanceName: string

Optional options: ManagedInstanceKeysListByInstanceOptionalParams

Returns PagedAsyncIterableIterator<ManagedInstanceKey>

Settings

Member Visibility

Theme

`Optional` options: ManagedInstanceKeysCreateOrUpdateOptionalParams

`Optional` options: ManagedInstanceKeysCreateOrUpdateOptionalParams

`Optional` options: ManagedInstanceKeysDeleteOptionalParams

`Optional` options: ManagedInstanceKeysDeleteOptionalParams

`Optional` options: ManagedInstanceKeysGetOptionalParams

`Optional` options: ManagedInstanceKeysListByInstanceOptionalParams