ApiVersionSet interface
Interface representing a ApiVersionSet.
Methods
| create |
Creates or Updates a Api Version Set. |
| delete(string, string, string, string, Api |
Deletes specific Api Version Set. |
| get(string, string, string, Api |
Gets the details of the Api Version Set specified by its identifier. |
| get |
Gets the entity state (Etag) version of the Api Version Set specified by its identifier. |
| list |
Lists a collection of API Version Sets in the specified service instance. |
| update(string, string, string, string, Api |
Updates the details of the Api VersionSet specified by its identifier. |
Method Details
createOrUpdate(string, string, string, ApiVersionSetContract, ApiVersionSetCreateOrUpdateOptionalParams)
Creates or Updates a Api Version Set.
function createOrUpdate(resourceGroupName: string, serviceName: string, versionSetId: string, parameters: ApiVersionSetContract, options?: ApiVersionSetCreateOrUpdateOptionalParams): Promise<ApiVersionSetCreateOrUpdateResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- 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.
The options parameters.
Returns
Promise<ApiVersionSetCreateOrUpdateResponse>
delete(string, string, string, string, ApiVersionSetDeleteOptionalParams)
Deletes specific Api Version Set.
function delete(resourceGroupName: string, serviceName: string, versionSetId: string, ifMatch: string, options?: ApiVersionSetDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- 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.
The options parameters.
Returns
Promise<void>
get(string, string, string, ApiVersionSetGetOptionalParams)
Gets the details of the Api Version Set specified by its identifier.
function get(resourceGroupName: string, serviceName: string, versionSetId: string, options?: ApiVersionSetGetOptionalParams): Promise<ApiVersionSetGetResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- 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.
- options
- ApiVersionSetGetOptionalParams
The options parameters.
Returns
Promise<ApiVersionSetGetResponse>
getEntityTag(string, string, string, ApiVersionSetGetEntityTagOptionalParams)
Gets the entity state (Etag) version of the Api Version Set specified by its identifier.
function getEntityTag(resourceGroupName: string, serviceName: string, versionSetId: string, options?: ApiVersionSetGetEntityTagOptionalParams): Promise<ApiVersionSetGetEntityTagHeaders>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- 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.
The options parameters.
Returns
Promise<ApiVersionSetGetEntityTagHeaders>
listByService(string, string, ApiVersionSetListByServiceOptionalParams)
Lists a collection of API Version Sets in the specified service instance.
function listByService(resourceGroupName: string, serviceName: string, options?: ApiVersionSetListByServiceOptionalParams): PagedAsyncIterableIterator<ApiVersionSetContract, ApiVersionSetContract[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
The options parameters.
Returns
update(string, string, string, string, ApiVersionSetUpdateParameters, ApiVersionSetUpdateOptionalParams)
Updates the details of the Api VersionSet specified by its identifier.
function update(resourceGroupName: string, serviceName: string, versionSetId: string, ifMatch: string, parameters: ApiVersionSetUpdateParameters, options?: ApiVersionSetUpdateOptionalParams): Promise<ApiVersionSetUpdateResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- 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.
The options parameters.
Returns
Promise<ApiVersionSetUpdateResponse>