WorkspaceSubscription interface

Csomag:

@azure/arm-apimanagement

A WorkspaceSubscriptiont képviselő felület.

Metódusok

createOrUpdate(string, string, string, string, SubscriptionCreateParameters, WorkspaceSubscriptionCreateOrUpdateOptionalParams)	Létrehozza vagy frissíti a megadott felhasználó előfizetését a megadott termékre.
delete(string, string, string, string, string, WorkspaceSubscriptionDeleteOptionalParams)	Törli a megadott előfizetést.
get(string, string, string, string, WorkspaceSubscriptionGetOptionalParams)	Lekéri a megadott előfizetési entitást.
getEntityTag(string, string, string, string, WorkspaceSubscriptionGetEntityTagOptionalParams)	Lekéri az apimanagement-előfizetés entitásállapotának (Etag) verzióját, amelyet az azonosítója határoz meg.
list(string, string, string, WorkspaceSubscriptionListOptionalParams)	Megjeleníti a munkaterület összes előfizetését egy API Management-szolgáltatáspéldányban.
listSecrets(string, string, string, string, WorkspaceSubscriptionListSecretsOptionalParams)	Lekéri a megadott előfizetési kulcsokat.
regeneratePrimaryKey(string, string, string, string, WorkspaceSubscriptionRegeneratePrimaryKeyOptionalParams)	Újragenerálja a munkaterület meglévő előfizetésének elsődleges kulcsát egy API Management szolgáltatáspéldányban.
regenerateSecondaryKey(string, string, string, string, WorkspaceSubscriptionRegenerateSecondaryKeyOptionalParams)	Újragenerálja a munkaterület meglévő előfizetésének másodlagos kulcsát egy API Management szolgáltatáspéldányban.
update(string, string, string, string, string, SubscriptionUpdateParameters, WorkspaceSubscriptionUpdateOptionalParams)	Frissíti az azonosító által megadott előfizetés részleteit.

Metódus adatai

createOrUpdate(string, string, string, string, SubscriptionCreateParameters, WorkspaceSubscriptionCreateOrUpdateOptionalParams)

Létrehozza vagy frissíti a megadott felhasználó előfizetését a megadott termékre.

function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, parameters: SubscriptionCreateParameters, options?: WorkspaceSubscriptionCreateOrUpdateOptionalParams): Promise<WorkspaceSubscriptionCreateOrUpdateResponse>

Paraméterek

resourceGroupName

string

Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.

serviceName

string

Az API Management szolgáltatás neve.

workspaceId

string

Munkaterület azonosítója. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.

sid

string

Előfizetési entitás azonosítója. Az entitás egy felhasználó és egy termék közötti társítást jelöli az API Managementben.

parameters

SubscriptionCreateParameters

Paraméterek létrehozása.

options

WorkspaceSubscriptionCreateOrUpdateOptionalParams

A beállítások paraméterei.

Válaszok

Promise<WorkspaceSubscriptionCreateOrUpdateResponse>

delete(string, string, string, string, string, WorkspaceSubscriptionDeleteOptionalParams)

Törli a megadott előfizetést.

function delete(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, ifMatch: string, options?: WorkspaceSubscriptionDeleteOptionalParams): Promise<void>

Paraméterek

resourceGroupName

string

Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.

serviceName

string

Az API Management szolgáltatás neve.

workspaceId

string

Munkaterület azonosítója. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.

sid

string

Előfizetési entitás azonosítója. Az entitás egy felhasználó és egy termék közötti társítást jelöli az API Managementben.

ifMatch

string

Az entitás ETagje. Az ETag-nek meg kell egyeznie a GET-kérés fejlécválaszából származó aktuális entitásállapotmal, vagy * kell lennie a feltétel nélküli frissítéshez.

options

WorkspaceSubscriptionDeleteOptionalParams

A beállítások paraméterei.

Válaszok

Promise<void>

get(string, string, string, string, WorkspaceSubscriptionGetOptionalParams)

Lekéri a megadott előfizetési entitást.

function get(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, options?: WorkspaceSubscriptionGetOptionalParams): Promise<WorkspaceSubscriptionGetResponse>

Paraméterek

resourceGroupName

string

Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.

serviceName

string

Az API Management szolgáltatás neve.

workspaceId

string

Munkaterület azonosítója. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.

sid

string

Előfizetési entitás azonosítója. Az entitás egy felhasználó és egy termék közötti társítást jelöli az API Managementben.

options

WorkspaceSubscriptionGetOptionalParams

A beállítások paraméterei.

Válaszok

Promise<WorkspaceSubscriptionGetResponse>

getEntityTag(string, string, string, string, WorkspaceSubscriptionGetEntityTagOptionalParams)

Lekéri az apimanagement-előfizetés entitásállapotának (Etag) verzióját, amelyet az azonosítója határoz meg.

function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, options?: WorkspaceSubscriptionGetEntityTagOptionalParams): Promise<WorkspaceSubscriptionGetEntityTagHeaders>

Paraméterek

resourceGroupName

string

Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.

serviceName

string

Az API Management szolgáltatás neve.

workspaceId

string

Munkaterület azonosítója. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.

sid

string

Előfizetési entitás azonosítója. Az entitás egy felhasználó és egy termék közötti társítást jelöli az API Managementben.

options

WorkspaceSubscriptionGetEntityTagOptionalParams

A beállítások paraméterei.

Válaszok

Promise<WorkspaceSubscriptionGetEntityTagHeaders>

list(string, string, string, WorkspaceSubscriptionListOptionalParams)

Megjeleníti a munkaterület összes előfizetését egy API Management-szolgáltatáspéldányban.

function list(resourceGroupName: string, serviceName: string, workspaceId: string, options?: WorkspaceSubscriptionListOptionalParams): PagedAsyncIterableIterator<SubscriptionContract, SubscriptionContract[], PageSettings>

Paraméterek

resourceGroupName

string

Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.

serviceName

string

Az API Management szolgáltatás neve.

workspaceId

string

Munkaterület azonosítója. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.

options

WorkspaceSubscriptionListOptionalParams

A beállítások paraméterei.

Válaszok

PagedAsyncIterableIterator<SubscriptionContract, SubscriptionContract[], PageSettings>

listSecrets(string, string, string, string, WorkspaceSubscriptionListSecretsOptionalParams)

Lekéri a megadott előfizetési kulcsokat.

function listSecrets(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, options?: WorkspaceSubscriptionListSecretsOptionalParams): Promise<WorkspaceSubscriptionListSecretsResponse>

Paraméterek

resourceGroupName

string

Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.

serviceName

string

Az API Management szolgáltatás neve.

workspaceId

string

Munkaterület azonosítója. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.

sid

string

Előfizetési entitás azonosítója. Az entitás egy felhasználó és egy termék közötti társítást jelöli az API Managementben.

options

WorkspaceSubscriptionListSecretsOptionalParams

A beállítások paraméterei.

Válaszok

Promise<WorkspaceSubscriptionListSecretsResponse>

regeneratePrimaryKey(string, string, string, string, WorkspaceSubscriptionRegeneratePrimaryKeyOptionalParams)

Újragenerálja a munkaterület meglévő előfizetésének elsődleges kulcsát egy API Management szolgáltatáspéldányban.

function regeneratePrimaryKey(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, options?: WorkspaceSubscriptionRegeneratePrimaryKeyOptionalParams): Promise<void>

Paraméterek

resourceGroupName

string

Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.

serviceName

string

Az API Management szolgáltatás neve.

workspaceId

string

Munkaterület azonosítója. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.

sid

string

Előfizetési entitás azonosítója. Az entitás egy felhasználó és egy termék közötti társítást jelöli az API Managementben.

options

WorkspaceSubscriptionRegeneratePrimaryKeyOptionalParams

A beállítások paraméterei.

Válaszok

Promise<void>

regenerateSecondaryKey(string, string, string, string, WorkspaceSubscriptionRegenerateSecondaryKeyOptionalParams)

Újragenerálja a munkaterület meglévő előfizetésének másodlagos kulcsát egy API Management szolgáltatáspéldányban.

function regenerateSecondaryKey(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, options?: WorkspaceSubscriptionRegenerateSecondaryKeyOptionalParams): Promise<void>

Paraméterek

resourceGroupName

string

Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.

serviceName

string

Az API Management szolgáltatás neve.

workspaceId

string

Munkaterület azonosítója. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.

sid

string

Előfizetési entitás azonosítója. Az entitás egy felhasználó és egy termék közötti társítást jelöli az API Managementben.

options

WorkspaceSubscriptionRegenerateSecondaryKeyOptionalParams

A beállítások paraméterei.

Válaszok

Promise<void>

update(string, string, string, string, string, SubscriptionUpdateParameters, WorkspaceSubscriptionUpdateOptionalParams)

Frissíti az azonosító által megadott előfizetés részleteit.

function update(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, ifMatch: string, parameters: SubscriptionUpdateParameters, options?: WorkspaceSubscriptionUpdateOptionalParams): Promise<WorkspaceSubscriptionUpdateResponse>

Paraméterek

resourceGroupName

string

Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.

serviceName

string

Az API Management szolgáltatás neve.

workspaceId

string

Munkaterület azonosítója. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.

sid

string

Előfizetési entitás azonosítója. Az entitás egy felhasználó és egy termék közötti társítást jelöli az API Managementben.

ifMatch

string

Az entitás ETagje. Az ETag-nek meg kell egyeznie a GET-kérés fejlécválaszából származó aktuális entitásállapotmal, vagy * kell lennie a feltétel nélküli frissítéshez.

parameters

SubscriptionUpdateParameters

Paraméterek frissítése.

options

WorkspaceSubscriptionUpdateOptionalParams

A beállítások paraméterei.

Válaszok

Promise<WorkspaceSubscriptionUpdateResponse>