WorkspaceApiPolicy interface
Interfaccia che rappresenta un oggetto WorkspaceApiPolicy.
Metodi
| create |
Crea o aggiorna la configurazione dei criteri per l'API. |
| delete(string, string, string, string, string, string, Workspace |
Elimina la configurazione dei criteri nell'API. |
| get(string, string, string, string, string, Workspace |
Ottenere la configurazione dei criteri a livello di API. |
| get |
Ottiene la versione dello stato dell'entità (Etag) dei criteri API specificati dal relativo identificatore. |
| list |
Ottenere la configurazione dei criteri a livello di API. |
Dettagli metodo
createOrUpdate(string, string, string, string, string, PolicyContract, WorkspaceApiPolicyCreateOrUpdateOptionalParams)
Crea o aggiorna la configurazione dei criteri per l'API.
function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, policyId: string, parameters: PolicyContract, options?: WorkspaceApiPolicyCreateOrUpdateOptionalParams): Promise<WorkspaceApiPolicyCreateOrUpdateResponse>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.
- serviceName
-
string
Nome del servizio Gestione API.
- workspaceId
-
string
Identificatore dell'area di lavoro. Deve essere univoco nell'istanza corrente del servizio Gestione API.
- apiId
-
string
Identificatore di revisione API. Deve essere univoco nell'istanza corrente del servizio Gestione API. La revisione non corrente ha ; rev=n come suffisso dove n è il numero di revisione.
- policyId
-
string
Identificatore del criterio.
- parameters
- PolicyContract
Contenuto dei criteri da applicare.
Parametri delle opzioni.
Restituisce
delete(string, string, string, string, string, string, WorkspaceApiPolicyDeleteOptionalParams)
Elimina la configurazione dei criteri nell'API.
function delete(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, policyId: string, ifMatch: string, options?: WorkspaceApiPolicyDeleteOptionalParams): Promise<void>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.
- serviceName
-
string
Nome del servizio Gestione API.
- workspaceId
-
string
Identificatore dell'area di lavoro. Deve essere univoco nell'istanza corrente del servizio Gestione API.
- apiId
-
string
Identificatore di revisione API. Deve essere univoco nell'istanza corrente del servizio Gestione API. La revisione non corrente ha ; rev=n come suffisso dove n è il numero di revisione.
- policyId
-
string
Identificatore del criterio.
- ifMatch
-
string
ETag dell'entità. ETag deve corrispondere allo stato corrente dell'entità dalla risposta dell'intestazione della richiesta GET oppure deve essere * per l'aggiornamento incondizionato.
Parametri delle opzioni.
Restituisce
Promise<void>
get(string, string, string, string, string, WorkspaceApiPolicyGetOptionalParams)
Ottenere la configurazione dei criteri a livello di API.
function get(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, policyId: string, options?: WorkspaceApiPolicyGetOptionalParams): Promise<WorkspaceApiPolicyGetResponse>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.
- serviceName
-
string
Nome del servizio Gestione API.
- workspaceId
-
string
Identificatore dell'area di lavoro. Deve essere univoco nell'istanza corrente del servizio Gestione API.
- apiId
-
string
Identificatore di revisione API. Deve essere univoco nell'istanza corrente del servizio Gestione API. La revisione non corrente ha ; rev=n come suffisso dove n è il numero di revisione.
- policyId
-
string
Identificatore del criterio.
Parametri delle opzioni.
Restituisce
Promise<WorkspaceApiPolicyGetResponse>
getEntityTag(string, string, string, string, string, WorkspaceApiPolicyGetEntityTagOptionalParams)
Ottiene la versione dello stato dell'entità (Etag) dei criteri API specificati dal relativo identificatore.
function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, policyId: string, options?: WorkspaceApiPolicyGetEntityTagOptionalParams): Promise<WorkspaceApiPolicyGetEntityTagHeaders>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.
- serviceName
-
string
Nome del servizio Gestione API.
- workspaceId
-
string
Identificatore dell'area di lavoro. Deve essere univoco nell'istanza corrente del servizio Gestione API.
- apiId
-
string
Identificatore di revisione API. Deve essere univoco nell'istanza corrente del servizio Gestione API. La revisione non corrente ha ; rev=n come suffisso dove n è il numero di revisione.
- policyId
-
string
Identificatore del criterio.
Parametri delle opzioni.
Restituisce
listByApi(string, string, string, string, WorkspaceApiPolicyListByApiOptionalParams)
Ottenere la configurazione dei criteri a livello di API.
function listByApi(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, options?: WorkspaceApiPolicyListByApiOptionalParams): PagedAsyncIterableIterator<PolicyContract, PolicyContract[], PageSettings>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.
- serviceName
-
string
Nome del servizio Gestione API.
- workspaceId
-
string
Identificatore dell'area di lavoro. Deve essere univoco nell'istanza corrente del servizio Gestione API.
- apiId
-
string
Identificatore di revisione API. Deve essere univoco nell'istanza corrente del servizio Gestione API. La revisione non corrente ha ; rev=n come suffisso dove n è il numero di revisione.
Parametri delle opzioni.