WorkspaceApiSchema interface
Interface representing a WorkspaceApiSchema.
Methods
| begin |
Creates or updates schema configuration for the API. |
| begin |
Creates or updates schema configuration for the API. |
| delete(string, string, string, string, string, string, Workspace |
Deletes the schema configuration at the Api. |
| get(string, string, string, string, string, Workspace |
Get the schema configuration at the API level. |
| get |
Gets the entity state (Etag) version of the schema specified by its identifier. |
| list |
Get the schema configuration at the API level. |
Method Details
beginCreateOrUpdate(string, string, string, string, string, SchemaContract, WorkspaceApiSchemaCreateOrUpdateOptionalParams)
Creates or updates schema configuration for the API.
function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, schemaId: string, parameters: SchemaContract, options?: WorkspaceApiSchemaCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<WorkspaceApiSchemaCreateOrUpdateResponse>, WorkspaceApiSchemaCreateOrUpdateResponse>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- workspaceId
-
string
Workspace identifier. Must be unique in the current API Management service instance.
- apiId
-
string
API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
- schemaId
-
string
Schema id identifier. Must be unique in the current API Management service instance.
- parameters
- SchemaContract
The schema contents to apply.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<WorkspaceApiSchemaCreateOrUpdateResponse>, WorkspaceApiSchemaCreateOrUpdateResponse>>
beginCreateOrUpdateAndWait(string, string, string, string, string, SchemaContract, WorkspaceApiSchemaCreateOrUpdateOptionalParams)
Creates or updates schema configuration for the API.
function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, schemaId: string, parameters: SchemaContract, options?: WorkspaceApiSchemaCreateOrUpdateOptionalParams): Promise<WorkspaceApiSchemaCreateOrUpdateResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- workspaceId
-
string
Workspace identifier. Must be unique in the current API Management service instance.
- apiId
-
string
API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
- schemaId
-
string
Schema id identifier. Must be unique in the current API Management service instance.
- parameters
- SchemaContract
The schema contents to apply.
The options parameters.
Returns
delete(string, string, string, string, string, string, WorkspaceApiSchemaDeleteOptionalParams)
Deletes the schema configuration at the Api.
function delete(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, schemaId: string, ifMatch: string, options?: WorkspaceApiSchemaDeleteOptionalParams): 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.
- workspaceId
-
string
Workspace identifier. Must be unique in the current API Management service instance.
- apiId
-
string
API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
- schemaId
-
string
Schema id 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, string, string, WorkspaceApiSchemaGetOptionalParams)
Get the schema configuration at the API level.
function get(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, schemaId: string, options?: WorkspaceApiSchemaGetOptionalParams): Promise<WorkspaceApiSchemaGetResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- workspaceId
-
string
Workspace identifier. Must be unique in the current API Management service instance.
- apiId
-
string
API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
- schemaId
-
string
Schema id identifier. Must be unique in the current API Management service instance.
The options parameters.
Returns
Promise<WorkspaceApiSchemaGetResponse>
getEntityTag(string, string, string, string, string, WorkspaceApiSchemaGetEntityTagOptionalParams)
Gets the entity state (Etag) version of the schema specified by its identifier.
function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, schemaId: string, options?: WorkspaceApiSchemaGetEntityTagOptionalParams): Promise<WorkspaceApiSchemaGetEntityTagHeaders>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- workspaceId
-
string
Workspace identifier. Must be unique in the current API Management service instance.
- apiId
-
string
API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
- schemaId
-
string
Schema id identifier. Must be unique in the current API Management service instance.
The options parameters.
Returns
listByApi(string, string, string, string, WorkspaceApiSchemaListByApiOptionalParams)
Get the schema configuration at the API level.
function listByApi(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, options?: WorkspaceApiSchemaListByApiOptionalParams): PagedAsyncIterableIterator<SchemaContract, SchemaContract[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- workspaceId
-
string
Workspace identifier. Must be unique in the current API Management service instance.
- apiId
-
string
API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
The options parameters.