Package version:

Interface ScopeMaps

Interface representing a ScopeMaps.

Hierarchy

ScopeMaps

Index

Methods

beginCreate beginCreateAndWait beginDelete beginDeleteAndWait beginUpdate beginUpdateAndWait get list

Methods

beginCreate

beginCreate(resourceGroupName: string, registryName: string, scopeMapName: string, scopeMapCreateParameters: ScopeMap, options?: ScopeMapsCreateOptionalParams): Promise<PollerLike<PollOperationState<ScopeMap>, ScopeMap>>
Creates a scope map for a container registry with the specified parameters.
Parameters
- resourceGroupName: string
  
  The name of the resource group to which the container registry belongs.
- registryName: string
  
  The name of the container registry.
- scopeMapName: string
  
  The name of the scope map.
- scopeMapCreateParameters: ScopeMap
  
  The parameters for creating a scope map.
- Optional options: ScopeMapsCreateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<ScopeMap>, ScopeMap>>
- Defined in operationsInterfaces/scopeMaps.ts:59

beginCreateAndWait

beginCreateAndWait(resourceGroupName: string, registryName: string, scopeMapName: string, scopeMapCreateParameters: ScopeMap, options?: ScopeMapsCreateOptionalParams): Promise<ScopeMap>
Creates a scope map for a container registry with the specified parameters.
Parameters
- resourceGroupName: string
  
  The name of the resource group to which the container registry belongs.
- registryName: string
  
  The name of the container registry.
- scopeMapName: string
  
  The name of the scope map.
- scopeMapCreateParameters: ScopeMap
  
  The parameters for creating a scope map.
- Optional options: ScopeMapsCreateOptionalParams
  
  The options parameters.
Returns Promise<ScopeMap>
- Defined in operationsInterfaces/scopeMaps.ts:79

beginDelete

beginDelete(resourceGroupName: string, registryName: string, scopeMapName: string, options?: ScopeMapsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>
Deletes a scope map from a container registry.
Parameters
- resourceGroupName: string
  
  The name of the resource group to which the container registry belongs.
- registryName: string
  
  The name of the container registry.
- scopeMapName: string
  
  The name of the scope map.
- Optional options: ScopeMapsDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>
- Defined in operationsInterfaces/scopeMaps.ts:93

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, registryName: string, scopeMapName: string, options?: ScopeMapsDeleteOptionalParams): Promise<void>
Deletes a scope map from a container registry.
Parameters
- resourceGroupName: string
  
  The name of the resource group to which the container registry belongs.
- registryName: string
  
  The name of the container registry.
- scopeMapName: string
  
  The name of the scope map.
- Optional options: ScopeMapsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>
- Defined in operationsInterfaces/scopeMaps.ts:106

beginUpdate

beginUpdate(resourceGroupName: string, registryName: string, scopeMapName: string, scopeMapUpdateParameters: ScopeMapUpdateParameters, options?: ScopeMapsUpdateOptionalParams): Promise<PollerLike<PollOperationState<ScopeMap>, ScopeMap>>
Updates a scope map with the specified parameters.
Parameters
- resourceGroupName: string
  
  The name of the resource group to which the container registry belongs.
- registryName: string
  
  The name of the container registry.
- scopeMapName: string
  
  The name of the scope map.
- scopeMapUpdateParameters: ScopeMapUpdateParameters
  
  The parameters for updating a scope map.
- Optional options: ScopeMapsUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<ScopeMap>, ScopeMap>>
- Defined in operationsInterfaces/scopeMaps.ts:120

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName: string, registryName: string, scopeMapName: string, scopeMapUpdateParameters: ScopeMapUpdateParameters, options?: ScopeMapsUpdateOptionalParams): Promise<ScopeMap>
Updates a scope map with the specified parameters.
Parameters
- resourceGroupName: string
  
  The name of the resource group to which the container registry belongs.
- registryName: string
  
  The name of the container registry.
- scopeMapName: string
  
  The name of the scope map.
- scopeMapUpdateParameters: ScopeMapUpdateParameters
  
  The parameters for updating a scope map.
- Optional options: ScopeMapsUpdateOptionalParams
  
  The options parameters.
Returns Promise<ScopeMap>
- Defined in operationsInterfaces/scopeMaps.ts:140

get

get(resourceGroupName: string, registryName: string, scopeMapName: string, options?: ScopeMapsGetOptionalParams): Promise<ScopeMap>
Gets the properties of the specified scope map.
Parameters
- resourceGroupName: string
  
  The name of the resource group to which the container registry belongs.
- registryName: string
  
  The name of the container registry.
- scopeMapName: string
  
  The name of the scope map.
- Optional options: ScopeMapsGetOptionalParams
  
  The options parameters.
Returns Promise<ScopeMap>
- Defined in operationsInterfaces/scopeMaps.ts:45

list

list(resourceGroupName: string, registryName: string, options?: ScopeMapsListOptionalParams): PagedAsyncIterableIterator<ScopeMap>
Lists all the scope maps for the specified container registry.
Parameters
- resourceGroupName: string
  
  The name of the resource group to which the container registry belongs.
- registryName: string
  
  The name of the container registry.
- Optional options: ScopeMapsListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<ScopeMap>
- Defined in operationsInterfaces/scopeMaps.ts:33

Interface ScopeMaps

Hierarchy

Index

Methods

Methods

beginCreate

Parameters

resourceGroupName: string

registryName: string

scopeMapName: string

scopeMapCreateParameters: ScopeMap

Optional options: ScopeMapsCreateOptionalParams

Returns Promise<PollerLike<PollOperationState<ScopeMap>, ScopeMap>>

beginCreateAndWait

Parameters

resourceGroupName: string

registryName: string

scopeMapName: string

scopeMapCreateParameters: ScopeMap

Optional options: ScopeMapsCreateOptionalParams

Returns Promise<ScopeMap>

beginDelete

Parameters

resourceGroupName: string

registryName: string

scopeMapName: string

Optional options: ScopeMapsDeleteOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

Parameters

resourceGroupName: string

registryName: string

scopeMapName: string

Optional options: ScopeMapsDeleteOptionalParams

Returns Promise<void>

beginUpdate

Parameters

resourceGroupName: string

registryName: string

scopeMapName: string

scopeMapUpdateParameters: ScopeMapUpdateParameters

Optional options: ScopeMapsUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<ScopeMap>, ScopeMap>>

beginUpdateAndWait

Parameters

resourceGroupName: string

registryName: string

scopeMapName: string

scopeMapUpdateParameters: ScopeMapUpdateParameters

Optional options: ScopeMapsUpdateOptionalParams

Returns Promise<ScopeMap>

get

Parameters

resourceGroupName: string

registryName: string

scopeMapName: string

Optional options: ScopeMapsGetOptionalParams

Returns Promise<ScopeMap>

list

Parameters

resourceGroupName: string

registryName: string

Optional options: ScopeMapsListOptionalParams

Returns PagedAsyncIterableIterator<ScopeMap>

Settings

Member Visibility

Theme

`Optional` options: ScopeMapsCreateOptionalParams

`Optional` options: ScopeMapsCreateOptionalParams

`Optional` options: ScopeMapsDeleteOptionalParams

`Optional` options: ScopeMapsDeleteOptionalParams

`Optional` options: ScopeMapsUpdateOptionalParams

`Optional` options: ScopeMapsUpdateOptionalParams

`Optional` options: ScopeMapsGetOptionalParams

`Optional` options: ScopeMapsListOptionalParams