WorkspaceGlobalSchema interface
Interface representing a WorkspaceGlobalSchema.
Methods
Method Details
beginCreateOrUpdate(string, string, string, string, GlobalSchemaContract, WorkspaceGlobalSchemaCreateOrUpdateOptionalParams)
Creates new or updates existing specified Schema of the workspace in an API Management service instance.
function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, schemaId: string, parameters: GlobalSchemaContract, options?: WorkspaceGlobalSchemaCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<WorkspaceGlobalSchemaCreateOrUpdateResponse>, WorkspaceGlobalSchemaCreateOrUpdateResponse>>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.
- schemaId
-
string
Schema id identifier. Must be unique in the current API Management service instance.
- parameters
- GlobalSchemaContract
Create or update parameters.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<WorkspaceGlobalSchemaCreateOrUpdateResponse>, WorkspaceGlobalSchemaCreateOrUpdateResponse>>
beginCreateOrUpdateAndWait(string, string, string, string, GlobalSchemaContract, WorkspaceGlobalSchemaCreateOrUpdateOptionalParams)
Creates new or updates existing specified Schema of the workspace in an API Management service instance.
function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, workspaceId: string, schemaId: string, parameters: GlobalSchemaContract, options?: WorkspaceGlobalSchemaCreateOrUpdateOptionalParams): Promise<WorkspaceGlobalSchemaCreateOrUpdateResponse>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.
- schemaId
-
string
Schema id identifier. Must be unique in the current API Management service instance.
- parameters
- GlobalSchemaContract
Create or update parameters.
The options parameters.
Returns
delete(string, string, string, string, string, WorkspaceGlobalSchemaDeleteOptionalParams)
Deletes specific Schema.
function delete(resourceGroupName: string, serviceName: string, workspaceId: string, schemaId: string, ifMatch: string, options?: WorkspaceGlobalSchemaDeleteOptionalParams): 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.
- 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, WorkspaceGlobalSchemaGetOptionalParams)
Gets the details of the Schema specified by its identifier.
function get(resourceGroupName: string, serviceName: string, workspaceId: string, schemaId: string, options?: WorkspaceGlobalSchemaGetOptionalParams): Promise<WorkspaceGlobalSchemaGetResponse>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.
- schemaId
-
string
Schema id identifier. Must be unique in the current API Management service instance.
The options parameters.
Returns
Promise<WorkspaceGlobalSchemaGetResponse>
getEntityTag(string, string, string, string, WorkspaceGlobalSchemaGetEntityTagOptionalParams)
Gets the entity state (Etag) version of the Schema specified by its identifier.
function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, schemaId: string, options?: WorkspaceGlobalSchemaGetEntityTagOptionalParams): Promise<WorkspaceGlobalSchemaGetEntityTagHeaders>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.
- schemaId
-
string
Schema id identifier. Must be unique in the current API Management service instance.
The options parameters.
Returns
listByService(string, string, string, WorkspaceGlobalSchemaListByServiceOptionalParams)
Lists a collection of schemas registered with workspace in a service instance.
function listByService(resourceGroupName: string, serviceName: string, workspaceId: string, options?: WorkspaceGlobalSchemaListByServiceOptionalParams): PagedAsyncIterableIterator<GlobalSchemaContract, GlobalSchemaContract[], 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.
The options parameters.