GlobalSchema interface
Interface representing a GlobalSchema.
Methods
| begin |
Creates new or updates existing specified Schema of the API Management service instance. |
| begin |
Creates new or updates existing specified Schema of the API Management service instance. |
| delete(string, string, string, string, Global |
Deletes specific Schema. |
| get(string, string, string, Global |
Gets the details of the Schema specified by its identifier. |
| get |
Gets the entity state (Etag) version of the Schema specified by its identifier. |
| list |
Lists a collection of schemas registered with service instance. |
Method Details
beginCreateOrUpdate(string, string, string, GlobalSchemaContract, GlobalSchemaCreateOrUpdateOptionalParams)
Creates new or updates existing specified Schema of the API Management service instance.
function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, schemaId: string, parameters: GlobalSchemaContract, options?: GlobalSchemaCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<GlobalSchemaCreateOrUpdateResponse>, GlobalSchemaCreateOrUpdateResponse>>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- 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<GlobalSchemaCreateOrUpdateResponse>, GlobalSchemaCreateOrUpdateResponse>>
beginCreateOrUpdateAndWait(string, string, string, GlobalSchemaContract, GlobalSchemaCreateOrUpdateOptionalParams)
Creates new or updates existing specified Schema of the API Management service instance.
function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, schemaId: string, parameters: GlobalSchemaContract, options?: GlobalSchemaCreateOrUpdateOptionalParams): Promise<GlobalSchemaCreateOrUpdateResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- 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<GlobalSchemaCreateOrUpdateResponse>
delete(string, string, string, string, GlobalSchemaDeleteOptionalParams)
Deletes specific Schema.
function delete(resourceGroupName: string, serviceName: string, schemaId: string, ifMatch: string, options?: GlobalSchemaDeleteOptionalParams): 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.
- 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.
- options
- GlobalSchemaDeleteOptionalParams
The options parameters.
Returns
Promise<void>
get(string, string, string, GlobalSchemaGetOptionalParams)
Gets the details of the Schema specified by its identifier.
function get(resourceGroupName: string, serviceName: string, schemaId: string, options?: GlobalSchemaGetOptionalParams): Promise<GlobalSchemaGetResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- schemaId
-
string
Schema id identifier. Must be unique in the current API Management service instance.
- options
- GlobalSchemaGetOptionalParams
The options parameters.
Returns
Promise<GlobalSchemaGetResponse>
getEntityTag(string, string, string, GlobalSchemaGetEntityTagOptionalParams)
Gets the entity state (Etag) version of the Schema specified by its identifier.
function getEntityTag(resourceGroupName: string, serviceName: string, schemaId: string, options?: GlobalSchemaGetEntityTagOptionalParams): Promise<GlobalSchemaGetEntityTagHeaders>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- schemaId
-
string
Schema id identifier. Must be unique in the current API Management service instance.
The options parameters.
Returns
Promise<GlobalSchemaGetEntityTagHeaders>
listByService(string, string, GlobalSchemaListByServiceOptionalParams)
Lists a collection of schemas registered with service instance.
function listByService(resourceGroupName: string, serviceName: string, options?: GlobalSchemaListByServiceOptionalParams): 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.
The options parameters.