ApiVersionSetImpl | @azure/arm-apimanagement

Class containing ApiVersionSet operations.

Hierarchy

ApiVersionSetImpl

Implements

ApiVersionSet

Index

Constructors

constructor

Methods

Constructors

constructor

new ApiVersionSetImpl(client: ApiManagementClientContext): ApiVersionSetImpl

- Defined in operations/apiVersionSet.ts:36
Initialize a new instance of the class ApiVersionSet class.

Parameters
- client: ApiManagementClientContext
  
  Reference to the service client
Returns ApiVersionSetImpl

Methods

createOrUpdate

createOrUpdate(resourceGroupName: string, serviceName: string, versionSetId: string, parameters: ApiVersionSetContract, options?: ApiVersionSetCreateOrUpdateOptionalParams): Promise<ApiVersionSetCreateOrUpdateResponse>

Implementation of ApiVersionSet.createOrUpdate
- Defined in operations/apiVersionSet.ts:183
Creates or Updates a Api Version Set.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- versionSetId: string
  
  Api Version Set identifier. Must be unique in the current API Management service instance.
- parameters: ApiVersionSetContract
  
  Create or update parameters.
- Optional options: ApiVersionSetCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<ApiVersionSetCreateOrUpdateResponse>

delete

delete(resourceGroupName: string, serviceName: string, versionSetId: string, ifMatch: string, options?: ApiVersionSetDeleteOptionalParams): Promise<void>

Implementation of ApiVersionSet.delete
- Defined in operations/apiVersionSet.ts:238
Deletes specific Api Version Set.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- versionSetId: string
  
  Api Version Set identifier. Must be unique in the current API Management service instance.
- ifMatch: string
  
  ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
- Optional options: ApiVersionSetDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

get

get(resourceGroupName: string, serviceName: string, versionSetId: string, options?: ApiVersionSetGetOptionalParams): Promise<ApiVersionSetGetResponse>

Implementation of ApiVersionSet.get
- Defined in operations/apiVersionSet.ts:162
Gets the details of the Api Version Set specified by its identifier.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- versionSetId: string
  
  Api Version Set identifier. Must be unique in the current API Management service instance.
- Optional options: ApiVersionSetGetOptionalParams
  
  The options parameters.
Returns Promise<ApiVersionSetGetResponse>

getEntityTag

getEntityTag(resourceGroupName: string, serviceName: string, versionSetId: string, options?: ApiVersionSetGetEntityTagOptionalParams): Promise<ApiVersionSetGetEntityTagResponse>

Implementation of ApiVersionSet.getEntityTag
- Defined in operations/apiVersionSet.ts:142
Gets the entity state (Etag) version of the Api Version Set specified by its identifier.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- versionSetId: string
  
  Api Version Set identifier. Must be unique in the current API Management service instance.
- Optional options: ApiVersionSetGetEntityTagOptionalParams
  
  The options parameters.
Returns Promise<ApiVersionSetGetEntityTagResponse>

listByService

listByService(resourceGroupName: string, serviceName: string, options?: ApiVersionSetListByServiceOptionalParams): PagedAsyncIterableIterator<ApiVersionSetContract>

Implementation of ApiVersionSet.listByService
- Defined in operations/apiVersionSet.ts:52
Lists a collection of API Version Sets in the specified service instance.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- Optional options: ApiVersionSetListByServiceOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<ApiVersionSetContract>

update

update(resourceGroupName: string, serviceName: string, versionSetId: string, ifMatch: string, parameters: ApiVersionSetUpdateParameters, options?: ApiVersionSetUpdateOptionalParams): Promise<ApiVersionSetUpdateResponse>

Implementation of ApiVersionSet.update
- Defined in operations/apiVersionSet.ts:207
Updates the details of the Api VersionSet specified by its identifier.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- versionSetId: string
  
  Api Version Set identifier. Must be unique in the current API Management service instance.
- ifMatch: string
  
  ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
- parameters: ApiVersionSetUpdateParameters
  
  Update parameters.
- Optional options: ApiVersionSetUpdateOptionalParams
  
  The options parameters.
Returns Promise<ApiVersionSetUpdateResponse>

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: ApiManagementClientContext

Returns ApiVersionSetImpl

Methods

createOrUpdate

Parameters

resourceGroupName: string

serviceName: string

versionSetId: string

parameters: ApiVersionSetContract

Optional options: ApiVersionSetCreateOrUpdateOptionalParams

Returns Promise<ApiVersionSetCreateOrUpdateResponse>

delete

Parameters

resourceGroupName: string

serviceName: string

versionSetId: string

ifMatch: string

Optional options: ApiVersionSetDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

serviceName: string

versionSetId: string

Optional options: ApiVersionSetGetOptionalParams

Returns Promise<ApiVersionSetGetResponse>

getEntityTag

Parameters

resourceGroupName: string

serviceName: string

versionSetId: string

Optional options: ApiVersionSetGetEntityTagOptionalParams

Returns Promise<ApiVersionSetGetEntityTagResponse>

listByService

Parameters

resourceGroupName: string

serviceName: string

Optional options: ApiVersionSetListByServiceOptionalParams

Returns PagedAsyncIterableIterator<ApiVersionSetContract>

update

Parameters

resourceGroupName: string

serviceName: string

versionSetId: string

ifMatch: string

parameters: ApiVersionSetUpdateParameters

Optional options: ApiVersionSetUpdateOptionalParams

Returns Promise<ApiVersionSetUpdateResponse>