azure-docs-sdk-java/docs-ref-autogen/com.microsoft.azure.managem...

500 строки
26 KiB
YAML

### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.management.batchai._batch_a_i_clusters
id: _batch_a_i_clusters
parent: com.microsoft.azure.management.batchai
href: com.microsoft.azure.management.batchai._batch_a_i_clusters.yml
langs:
- java
name: BatchAIClusters
nameWithType: BatchAIClusters
fullName: com.microsoft.azure.management.batchai.BatchAIClusters
type: Interface
source:
remote:
path: azure-mgmt-batchai/src/main/java/com/microsoft/azure/management/batchai/BatchAIClusters.java
branch: master
repo: https://github.com/Azure/azure-libraries-for-java
path: azure-mgmt-batchai/src/main/java/com/microsoft/azure/management/batchai/BatchAIClusters.java
startLine: 26
package: com.microsoft.azure.management.batchai
summary: <p>Entry point to Batch AI cluster management API in Azure. </p>
syntax:
content: public interface BatchAIClusters extends SupportsCreating<BatchAICluster.DefinitionStages.Blank>,SupportsListing<BatchAICluster>,SupportsGettingById<BatchAICluster>,SupportsGettingByNameAsync<BatchAICluster>,SupportsDeletingById,SupportsDeletingByName,HasManager<BatchAIManager>,HasInner<ClustersInner>,HasParent<BatchAIWorkspace>
inheritedMembers:
- com.microsoft.azure.management.resources.fluentcore.collection._supports_creating.define(String)
- com.microsoft.azure.management.resources.fluentcore.collection._supports_deleting_by_id.deleteById(String)
- com.microsoft.azure.management.resources.fluentcore.collection._supports_deleting_by_id.deleteByIdAsync(String,ServiceCallback<Void>)
- com.microsoft.azure.management.resources.fluentcore.collection._supports_deleting_by_id.deleteByIdAsync(String)
- com.microsoft.azure.management.resources.fluentcore.collection._supports_deleting_by_name.deleteByName(String)
- com.microsoft.azure.management.resources.fluentcore.collection._supports_deleting_by_name.deleteByNameAsync(String,ServiceCallback<Void>)
- com.microsoft.azure.management.resources.fluentcore.collection._supports_deleting_by_name.deleteByNameAsync(String)
- com.microsoft.azure.management.resources.fluentcore.arm.collection._supports_getting_by_id.getById(String)
- com.microsoft.azure.management.resources.fluentcore.arm.collection._supports_getting_by_id.getByIdAsync(String)
- com.microsoft.azure.management.resources.fluentcore.arm.collection._supports_getting_by_id.getByIdAsync(String,ServiceCallback<T>)
- com.microsoft.azure.management.resources.fluentcore.arm.collection._supports_getting_by_name.getByName(String)
- com.microsoft.azure.management.resources.fluentcore.arm.collectionc5f43ffbf69fd8f6f2762a26b4886409.getByNameAsync(String)
- com.microsoft.azure.management.resources.fluentcore.model._has_inner.inner()
- com.microsoft.azure.management.resources.fluentcore.collection._supports_listing.list()
- com.microsoft.azure.management.resources.fluentcore.collection._supports_listing.listAsync()
- com.microsoft.azure.management.resources.fluentcore.arm.models._has_manager.manager()
- com.microsoft.azure.management.resources.fluentcore.arm.models._has_parent.parent()
references:
- uid: com.microsoft.azure.management.resources.fluentcore.collection._supports_creating.define(String)
parent: com.microsoft.azure.management.resources.fluentcore.collection._supports_creating
href: com.microsoft.azure.management.resources.fluentcore.collection._supports_creating.yml
name: define(String name)
nameWithType: SupportsCreating<T>.define(String name)
fullName: com.microsoft.azure.management.resources.fluentcore.collection.SupportsCreating<T>.define(String name)
type: Method
summary: >-
<p>Begins a definition for a new resource. </p>
<p>This is the beginning of the builder pattern used to create top level resources in Azure. The final method completing the definition and starting the actual resource creation process in Azure is <xref uid="com.microsoft.azure.management.resources.fluentcore.model._creatable.create()" data-throw-if-not-resolved="false">Creatable#create()</xref>. </p>
<p>Note that the <xref uid="com.microsoft.azure.management.resources.fluentcore.model._creatable.create()" data-throw-if-not-resolved="false">Creatable#create()</xref> method is only available at the stage of the resource definition that has the minimum set of input parameters specified. If you do not see <xref uid="com.microsoft.azure.management.resources.fluentcore.model._creatable.create()" data-throw-if-not-resolved="false">Creatable#create()</xref> among the available methods, it means you have not yet specified all the required input settings. Input settings generally begin with the word "with", for example: and return the next stage of the resource definition, as an interface in the "fluent interface" style. </p>
syntax:
content: public T define(String name)
parameters:
- id: name
type: "26831127"
description: <p>the name of the new resource </p>
return:
type: 8ce1ecb9
description: <p>the first stage of the new resource definition </p>
- uid: com.microsoft.azure.management.resources.fluentcore.collection._supports_deleting_by_id.deleteById(String)
parent: com.microsoft.azure.management.resources.fluentcore.collection._supports_deleting_by_id
href: com.microsoft.azure.management.resources.fluentcore.collection._supports_deleting_by_id.yml
name: deleteById(String id)
nameWithType: SupportsDeletingById.deleteById(String id)
fullName: com.microsoft.azure.management.resources.fluentcore.collection.SupportsDeletingById.deleteById(String id)
type: Method
summary: >-
<p>Deletes a resource from Azure, identifying it by its resource ID.</p>
<p></p>
syntax:
content: public void deleteById(String id)
parameters:
- id: id
type: "26831127"
description: <p>the resource ID of the resource to delete </p>
- uid: com.microsoft.azure.management.resources.fluentcore.collection._supports_deleting_by_id.deleteByIdAsync(String,ServiceCallback<Void>)
parent: com.microsoft.azure.management.resources.fluentcore.collection._supports_deleting_by_id
href: com.microsoft.azure.management.resources.fluentcore.collection._supports_deleting_by_id.yml
name: deleteByIdAsync(String id, ServiceCallback<Void> callback)
nameWithType: SupportsDeletingById.deleteByIdAsync(String id, ServiceCallback<Void> callback)
fullName: com.microsoft.azure.management.resources.fluentcore.collection.SupportsDeletingById.deleteByIdAsync(String id, ServiceCallback<Void> callback)
type: Method
summary: >-
<p>Asynchronously delete a resource from Azure, identifying it by its resource ID.</p>
<p></p>
syntax:
content: public ServiceFuture<Void> deleteByIdAsync(String id, ServiceCallback<Void> callback)
parameters:
- id: id
type: "26831127"
description: <p>the resource ID of the resource to delete </p>
- id: callback
type: da7fd5ea
description: <p>the callback on success or failure </p>
return:
type: aa81d378
description: <p>a handle to cancel the request </p>
- uid: com.microsoft.azure.management.resources.fluentcore.collection._supports_deleting_by_id.deleteByIdAsync(String)
parent: com.microsoft.azure.management.resources.fluentcore.collection._supports_deleting_by_id
href: com.microsoft.azure.management.resources.fluentcore.collection._supports_deleting_by_id.yml
name: deleteByIdAsync(String id)
nameWithType: SupportsDeletingById.deleteByIdAsync(String id)
fullName: com.microsoft.azure.management.resources.fluentcore.collection.SupportsDeletingById.deleteByIdAsync(String id)
type: Method
summary: >-
<p>Asynchronously delete a resource from Azure, identifying it by its resource ID.</p>
<p></p>
syntax:
content: public Completable deleteByIdAsync(String id)
parameters:
- id: id
type: "26831127"
description: <p>the resource ID of the resource to delete </p>
return:
type: "56537e90"
description: <p>a representation of the deferred computation of this call </p>
- uid: com.microsoft.azure.management.resources.fluentcore.collection._supports_deleting_by_name.deleteByName(String)
parent: com.microsoft.azure.management.resources.fluentcore.collection._supports_deleting_by_name
href: com.microsoft.azure.management.resources.fluentcore.collection._supports_deleting_by_name.yml
name: deleteByName(String name)
nameWithType: SupportsDeletingByName.deleteByName(String name)
fullName: com.microsoft.azure.management.resources.fluentcore.collection.SupportsDeletingByName.deleteByName(String name)
type: Method
summary: >-
<p>Deletes a resource from Azure, identifying it by its resource name.</p>
<p></p>
syntax:
content: public void deleteByName(String name)
parameters:
- id: name
type: "26831127"
description: <p>the name of the resource to delete </p>
- uid: com.microsoft.azure.management.resources.fluentcore.collection._supports_deleting_by_name.deleteByNameAsync(String,ServiceCallback<Void>)
parent: com.microsoft.azure.management.resources.fluentcore.collection._supports_deleting_by_name
href: com.microsoft.azure.management.resources.fluentcore.collection._supports_deleting_by_name.yml
name: deleteByNameAsync(String name, ServiceCallback<Void> callback)
nameWithType: SupportsDeletingByName.deleteByNameAsync(String name, ServiceCallback<Void> callback)
fullName: com.microsoft.azure.management.resources.fluentcore.collection.SupportsDeletingByName.deleteByNameAsync(String name, ServiceCallback<Void> callback)
type: Method
summary: >-
<p>Asynchronously delete a resource from Azure, identifying it by its resource name.</p>
<p></p>
syntax:
content: public ServiceFuture<Void> deleteByNameAsync(String name, ServiceCallback<Void> callback)
parameters:
- id: name
type: "26831127"
description: <p>the name of the resource to delete </p>
- id: callback
type: da7fd5ea
description: <p>the callback on success or failure </p>
return:
type: aa81d378
description: <p>a handle to cancel the request </p>
- uid: com.microsoft.azure.management.resources.fluentcore.collection._supports_deleting_by_name.deleteByNameAsync(String)
parent: com.microsoft.azure.management.resources.fluentcore.collection._supports_deleting_by_name
href: com.microsoft.azure.management.resources.fluentcore.collection._supports_deleting_by_name.yml
name: deleteByNameAsync(String name)
nameWithType: SupportsDeletingByName.deleteByNameAsync(String name)
fullName: com.microsoft.azure.management.resources.fluentcore.collection.SupportsDeletingByName.deleteByNameAsync(String name)
type: Method
summary: >-
<p>Asynchronously delete a resource from Azure, identifying it by its resource name.</p>
<p></p>
syntax:
content: public Completable deleteByNameAsync(String name)
parameters:
- id: name
type: "26831127"
description: <p>the name of the resource to delete </p>
return:
type: "56537e90"
description: <p>a representation of the deferred computation of this call </p>
- uid: com.microsoft.azure.management.resources.fluentcore.arm.collection._supports_getting_by_id.getById(String)
parent: com.microsoft.azure.management.resources.fluentcore.arm.collection._supports_getting_by_id
href: com.microsoft.azure.management.resources.fluentcore.arm.collection._supports_getting_by_id.yml
name: getById(String id)
nameWithType: SupportsGettingById<T>.getById(String id)
fullName: com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsGettingById<T>.getById(String id)
type: Method
summary: >-
<p>Gets the information about a resource from Azure based on the resource id.</p>
<p></p>
syntax:
content: public T getById(String id)
parameters:
- id: id
type: "26831127"
description: <p>the id of the resource. </p>
return:
type: 8ce1ecb9
description: <p>an immutable representation of the resource </p>
- uid: com.microsoft.azure.management.resources.fluentcore.arm.collection._supports_getting_by_id.getByIdAsync(String)
parent: com.microsoft.azure.management.resources.fluentcore.arm.collection._supports_getting_by_id
href: com.microsoft.azure.management.resources.fluentcore.arm.collection._supports_getting_by_id.yml
name: getByIdAsync(String id)
nameWithType: SupportsGettingById<T>.getByIdAsync(String id)
fullName: com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsGettingById<T>.getByIdAsync(String id)
type: Method
summary: >-
<p>Gets the information about a resource from Azure based on the resource id.</p>
<p></p>
syntax:
content: public Observable<T> getByIdAsync(String id)
parameters:
- id: id
type: "26831127"
description: <p>the id of the resource. </p>
return:
type: c4094ba1
description: <p>an immutable representation of the resource </p>
- uid: com.microsoft.azure.management.resources.fluentcore.arm.collection._supports_getting_by_id.getByIdAsync(String,ServiceCallback<T>)
parent: com.microsoft.azure.management.resources.fluentcore.arm.collection._supports_getting_by_id
href: com.microsoft.azure.management.resources.fluentcore.arm.collection._supports_getting_by_id.yml
name: getByIdAsync(String id, ServiceCallback<T> callback)
nameWithType: SupportsGettingById<T>.getByIdAsync(String id, ServiceCallback<T> callback)
fullName: com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsGettingById<T>.getByIdAsync(String id, ServiceCallback<T> callback)
type: Method
summary: >-
<p>Gets the information about a resource from Azure based on the resource id.</p>
<p></p>
syntax:
content: public ServiceFuture<T> getByIdAsync(String id, ServiceCallback<T> callback)
parameters:
- id: id
type: "26831127"
description: <p>the id of the resource. </p>
- id: callback
type: 4b6febe3
description: <p>the callback to call on success or failure </p>
return:
type: c0371a4e
description: <p>an immutable representation of the resource </p>
- uid: com.microsoft.azure.management.resources.fluentcore.arm.collection._supports_getting_by_name.getByName(String)
parent: com.microsoft.azure.management.resources.fluentcore.arm.collection._supports_getting_by_name
href: com.microsoft.azure.management.resources.fluentcore.arm.collection._supports_getting_by_name.yml
name: getByName(String name)
nameWithType: SupportsGettingByName<T>.getByName(String name)
fullName: com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsGettingByName<T>.getByName(String name)
type: Method
summary: >-
<p>Gets the information about a resource from Azure based on the resource name within the current resource group.</p>
<p></p>
syntax:
content: public T getByName(String name)
parameters:
- id: name
type: "26831127"
description: <p>the name of the resource. (Note, this is not the resource ID.) </p>
return:
type: 8ce1ecb9
description: <p>an immutable representation of the resource </p>
- uid: com.microsoft.azure.management.resources.fluentcore.arm.collectionc5f43ffbf69fd8f6f2762a26b4886409.getByNameAsync(String)
parent: com.microsoft.azure.management.resources.fluentcore.arm.collectionc5f43ffbf69fd8f6f2762a26b4886409
href: com.microsoft.azure.management.resources.fluentcore.arm.collectionc5f43ffbf69fd8f6f2762a26b4886409.yml
name: getByNameAsync(String name)
nameWithType: SupportsGettingByNameAsync<T>.getByNameAsync(String name)
fullName: com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsGettingByNameAsync<T>.getByNameAsync(String name)
type: Method
summary: >-
<p>Gets the information about a resource based on the resource name.</p>
<p></p>
syntax:
content: public Observable<T> getByNameAsync(String name)
parameters:
- id: name
type: "26831127"
description: <p>the name of the resource. (Note, this is not the resource ID.) </p>
return:
type: c4094ba1
description: <p>an immutable representation of the resource </p>
- uid: com.microsoft.azure.management.resources.fluentcore.model._has_inner.inner()
parent: com.microsoft.azure.management.resources.fluentcore.model._has_inner
href: com.microsoft.azure.management.resources.fluentcore.model._has_inner.yml
name: inner()
nameWithType: HasInner<T>.inner()
fullName: com.microsoft.azure.management.resources.fluentcore.model.HasInner<T>.inner()
type: Method
syntax:
content: public T inner()
return:
type: 8ce1ecb9
description: <p>wrapped inner object providing direct access to the underlying auto-generated API implementation, based on Azure REST API </p>
- uid: com.microsoft.azure.management.resources.fluentcore.collection._supports_listing.list()
parent: com.microsoft.azure.management.resources.fluentcore.collection._supports_listing
href: com.microsoft.azure.management.resources.fluentcore.collection._supports_listing.yml
name: list()
nameWithType: SupportsListing<T>.list()
fullName: com.microsoft.azure.management.resources.fluentcore.collection.SupportsListing<T>.list()
type: Method
summary: >-
<p>Lists all the resources of the specified type in the currently selected subscription.</p>
<p></p>
syntax:
content: public PagedList<T> list()
return:
type: e5f90f8a
description: <p>list of resources </p>
- uid: com.microsoft.azure.management.resources.fluentcore.collection._supports_listing.listAsync()
parent: com.microsoft.azure.management.resources.fluentcore.collection._supports_listing
href: com.microsoft.azure.management.resources.fluentcore.collection._supports_listing.yml
name: listAsync()
nameWithType: SupportsListing<T>.listAsync()
fullName: com.microsoft.azure.management.resources.fluentcore.collection.SupportsListing<T>.listAsync()
type: Method
summary: >-
<p>Lists all the resources of the specified type in the currently selected subscription.</p>
<p></p>
syntax:
content: public Observable<T> listAsync()
return:
type: c4094ba1
description: <p>list of resources </p>
- uid: com.microsoft.azure.management.resources.fluentcore.arm.models._has_manager.manager()
parent: com.microsoft.azure.management.resources.fluentcore.arm.models._has_manager
href: com.microsoft.azure.management.resources.fluentcore.arm.models._has_manager.yml
name: manager()
nameWithType: HasManager<ManagerT>.manager()
fullName: com.microsoft.azure.management.resources.fluentcore.arm.models.HasManager<ManagerT>.manager()
type: Method
syntax:
content: public ManagerT manager()
return:
type: 8b0aab42
description: <p>the manager client of this resource type </p>
- uid: com.microsoft.azure.management.resources.fluentcore.arm.models._has_parent.parent()
parent: com.microsoft.azure.management.resources.fluentcore.arm.models._has_parent
href: com.microsoft.azure.management.resources.fluentcore.arm.models._has_parent.yml
name: parent()
nameWithType: HasParent<ParentT>.parent()
fullName: com.microsoft.azure.management.resources.fluentcore.arm.models.HasParent<ParentT>.parent()
type: Method
syntax:
content: public ParentT parent()
return:
type: 18a275b1
description: <p>the parent of this child object </p>
- uid: com.microsoft.azure.management.resources.fluentcore.collection._supports_creating
parent: com.microsoft.azure.management.resources.fluentcore.collection
href: com.microsoft.azure.management.resources.fluentcore.collection._supports_creating.yml
name: SupportsCreating<T>
nameWithType: SupportsCreating<T>
fullName: com.microsoft.azure.management.resources.fluentcore.collection.SupportsCreating<T>
type: Interface
summary: >-
<p>Providing access to creating Azure top level resources. </p>
<p>(Note: this interface is not intended to be implemented by user code) </p>
syntax:
content: public interface SupportsCreating<T>
typeParameters:
- id: T
type: 8ce1ecb9
description: <p>the initial blank definition interface </p>
- uid: com.microsoft.azure.management.resources.fluentcore.collection._supports_listing
parent: com.microsoft.azure.management.resources.fluentcore.collection
href: com.microsoft.azure.management.resources.fluentcore.collection._supports_listing.yml
name: SupportsListing<T>
nameWithType: SupportsListing<T>
fullName: com.microsoft.azure.management.resources.fluentcore.collection.SupportsListing<T>
type: Interface
summary: >-
<p>Provides access to listing Azure resources of a specific type in a subscription. </p>
<p>(Note: this interface is not intended to be implemented by user code)</p>
<p></p>
syntax:
content: public interface SupportsListing<T>
typeParameters:
- id: T
type: 8ce1ecb9
description: <p>the fluent type of the resource </p>
- uid: com.microsoft.azure.management.resources.fluentcore.arm.collection._supports_getting_by_id
parent: com.microsoft.azure.management.resources.fluentcore.arm.collection
href: com.microsoft.azure.management.resources.fluentcore.arm.collection._supports_getting_by_id.yml
name: SupportsGettingById<T>
nameWithType: SupportsGettingById<T>
fullName: com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsGettingById<T>
type: Interface
summary: >-
<p>Provides access to getting a specific Azure resource based on its resource ID. </p>
<p>(Note this interface is not intended to be implemented by user code.)</p>
<p></p>
syntax:
content: public interface SupportsGettingById<T>
typeParameters:
- id: T
type: 8ce1ecb9
description: <p>the type of the resource collection </p>
- uid: com.microsoft.azure.management.resources.fluentcore.arm.collectionc5f43ffbf69fd8f6f2762a26b4886409
parent: com.microsoft.azure.management.resources.fluentcore.arm.collection
href: com.microsoft.azure.management.resources.fluentcore.arm.collectionc5f43ffbf69fd8f6f2762a26b4886409.yml
name: SupportsGettingByNameAsync<T>
nameWithType: SupportsGettingByNameAsync<T>
fullName: com.microsoft.azure.management.resources.fluentcore.arm.collection.SupportsGettingByNameAsync<T>
type: Interface
summary: >-
<p>Provides access to getting a specific resource based on its name. </p>
<p>(Note this interface is not intended to be implemented by user code.) </p>
syntax:
content: public interface SupportsGettingByNameAsync<T>
typeParameters:
- id: T
type: 8ce1ecb9
description: <p>the type of the resource collection </p>
- uid: com.microsoft.azure.management.resources.fluentcore.collection._supports_deleting_by_id
parent: com.microsoft.azure.management.resources.fluentcore.collection
href: com.microsoft.azure.management.resources.fluentcore.collection._supports_deleting_by_id.yml
name: SupportsDeletingById
nameWithType: SupportsDeletingById
fullName: com.microsoft.azure.management.resources.fluentcore.collection.SupportsDeletingById
type: Interface
summary: >-
<p>Provides access to deleting a resource from Azure, identifying it by its resource ID. </p>
<p>(Note: this interface is not intended to be implemented by user code) </p>
syntax:
content: public interface SupportsDeletingById
- uid: com.microsoft.azure.management.resources.fluentcore.collection._supports_deleting_by_name
parent: com.microsoft.azure.management.resources.fluentcore.collection
href: com.microsoft.azure.management.resources.fluentcore.collection._supports_deleting_by_name.yml
name: SupportsDeletingByName
nameWithType: SupportsDeletingByName
fullName: com.microsoft.azure.management.resources.fluentcore.collection.SupportsDeletingByName
type: Interface
summary: >-
<p>Provides access to deleting a resource from Azure, identifying it by its resource name. </p>
<p>(Note: this interface is not intended to be implemented by user code) </p>
syntax:
content: public interface SupportsDeletingByName
- uid: com.microsoft.azure.management.resources.fluentcore.arm.models._has_manager
parent: com.microsoft.azure.management.resources.fluentcore.arm.models
href: com.microsoft.azure.management.resources.fluentcore.arm.models._has_manager.yml
name: HasManager<ManagerT>
nameWithType: HasManager<ManagerT>
fullName: com.microsoft.azure.management.resources.fluentcore.arm.models.HasManager<ManagerT>
type: Interface
summary: <p>An interface representing a model that exposes a management client. </p>
syntax:
content: public interface HasManager<ManagerT>
typeParameters:
- id: ManagerT
type: 8b0aab42
description: <p>the manager client type </p>
- uid: com.microsoft.azure.management.resources.fluentcore.model._has_inner
parent: com.microsoft.azure.management.resources.fluentcore.model
href: com.microsoft.azure.management.resources.fluentcore.model._has_inner.yml
name: HasInner<T>
nameWithType: HasInner<T>
fullName: com.microsoft.azure.management.resources.fluentcore.model.HasInner<T>
type: Interface
summary: >-
<p>The wrapper around an inner object providing extended functionalities.</p>
<p></p>
syntax:
content: public interface HasInner<T>
typeParameters:
- id: T
type: 8ce1ecb9
description: <p>the type of the inner object. </p>
- uid: com.microsoft.azure.management.resources.fluentcore.arm.models._has_parent
parent: com.microsoft.azure.management.resources.fluentcore.arm.models
href: com.microsoft.azure.management.resources.fluentcore.arm.models._has_parent.yml
name: HasParent<ParentT>
nameWithType: HasParent<ParentT>
fullName: com.microsoft.azure.management.resources.fluentcore.arm.models.HasParent<ParentT>
type: Interface
summary: <p>An interface representing a child that has an immediately available parent. </p>
syntax:
content: public interface HasParent<ParentT>
typeParameters:
- id: ParentT
type: 18a275b1
description: <p>the parent type </p>
- uid: com.microsoft.azure.management.batchai.implementation._batch_a_i_clusters_impl